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::BlockHeader;
21 use bitcoin::blockdata::transaction::Transaction;
22 use bitcoin::blockdata::constants::ChainHash;
23 use bitcoin::network::constants::Network;
25 use bitcoin::hashes::Hash;
26 use bitcoin::hashes::sha256::Hash as Sha256;
27 use bitcoin::hash_types::{BlockHash, Txid};
29 use bitcoin::secp256k1::{SecretKey,PublicKey};
30 use bitcoin::secp256k1::Secp256k1;
31 use bitcoin::{LockTime, secp256k1, Sequence};
33 use crate::blinded_path::BlindedPath;
34 use crate::blinded_path::payment::{PaymentConstraints, ReceiveTlvs};
36 use crate::chain::{Confirm, ChannelMonitorUpdateStatus, Watch, BestBlock};
37 use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator};
38 use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
39 use crate::chain::transaction::{OutPoint, TransactionData};
41 use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination, PaymentFailureReason};
42 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
43 // construct one themselves.
44 use crate::ln::{inbound_payment, ChannelId, PaymentHash, PaymentPreimage, PaymentSecret};
45 use crate::ln::channel::{Channel, ChannelPhase, ChannelContext, ChannelError, ChannelUpdateStatus, ShutdownResult, UnfundedChannelContext, UpdateFulfillCommitFetch, OutboundV1Channel, InboundV1Channel};
46 use crate::ln::features::{Bolt12InvoiceFeatures, ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
47 #[cfg(any(feature = "_test_utils", test))]
48 use crate::ln::features::Bolt11InvoiceFeatures;
49 use crate::routing::gossip::NetworkGraph;
50 use crate::routing::router::{BlindedTail, DefaultRouter, InFlightHtlcs, Path, Payee, PaymentParameters, Route, RouteParameters, Router};
51 use crate::routing::scoring::{ProbabilisticScorer, ProbabilisticScoringFeeParameters};
53 use crate::ln::onion_utils;
54 use crate::ln::onion_utils::HTLCFailReason;
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::{Destination, OffersMessage, OffersMessageHandler, PendingOnionMessage, new_pending_onion_message};
67 use crate::sign::{EntropySource, KeysManager, NodeSigner, Recipient, SignerProvider, WriteableEcdsaChannelSigner};
68 use crate::util::config::{UserConfig, ChannelConfig, ChannelConfigUpdate};
69 use crate::util::wakers::{Future, Notifier};
70 use crate::util::scid_utils::fake_scid;
71 use crate::util::string::UntrustedString;
72 use crate::util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
73 use crate::util::logger::{Level, Logger};
74 use crate::util::errors::APIError;
76 use alloc::collections::{btree_map, BTreeMap};
79 use crate::prelude::*;
81 use core::cell::RefCell;
83 use crate::sync::{Arc, Mutex, RwLock, RwLockReadGuard, FairRwLock, LockTestExt, LockHeldState};
84 use core::sync::atomic::{AtomicUsize, AtomicBool, Ordering};
85 use core::time::Duration;
88 // Re-export this for use in the public API.
89 pub use crate::ln::outbound_payment::{PaymentSendFailure, ProbeSendFailure, Retry, RetryableSendFailure, RecipientOnionFields};
90 use crate::ln::script::ShutdownScript;
92 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
94 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
95 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
96 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
98 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
99 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
100 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
101 // before we forward it.
103 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
104 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
105 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
106 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
107 // our payment, which we can use to decode errors or inform the user that the payment was sent.
109 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
110 pub(super) enum PendingHTLCRouting {
112 onion_packet: msgs::OnionPacket,
113 /// The SCID from the onion that we should forward to. This could be a real SCID or a fake one
114 /// generated using `get_fake_scid` from the scid_utils::fake_scid module.
115 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
118 payment_data: msgs::FinalOnionHopData,
119 payment_metadata: Option<Vec<u8>>,
120 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
121 phantom_shared_secret: Option<[u8; 32]>,
122 /// See [`RecipientOnionFields::custom_tlvs`] for more info.
123 custom_tlvs: Vec<(u64, Vec<u8>)>,
126 /// This was added in 0.0.116 and will break deserialization on downgrades.
127 payment_data: Option<msgs::FinalOnionHopData>,
128 payment_preimage: PaymentPreimage,
129 payment_metadata: Option<Vec<u8>>,
130 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
131 /// See [`RecipientOnionFields::custom_tlvs`] for more info.
132 custom_tlvs: Vec<(u64, Vec<u8>)>,
136 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
137 pub(super) struct PendingHTLCInfo {
138 pub(super) routing: PendingHTLCRouting,
139 pub(super) incoming_shared_secret: [u8; 32],
140 payment_hash: PaymentHash,
142 pub(super) incoming_amt_msat: Option<u64>, // Added in 0.0.113
143 /// Sender intended amount to forward or receive (actual amount received
144 /// may overshoot this in either case)
145 pub(super) outgoing_amt_msat: u64,
146 pub(super) outgoing_cltv_value: u32,
147 /// The fee being skimmed off the top of this HTLC. If this is a forward, it'll be the fee we are
148 /// skimming. If we're receiving this HTLC, it's the fee that our counterparty skimmed.
149 pub(super) skimmed_fee_msat: Option<u64>,
152 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
153 pub(super) enum HTLCFailureMsg {
154 Relay(msgs::UpdateFailHTLC),
155 Malformed(msgs::UpdateFailMalformedHTLC),
158 /// Stores whether we can't forward an HTLC or relevant forwarding info
159 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
160 pub(super) enum PendingHTLCStatus {
161 Forward(PendingHTLCInfo),
162 Fail(HTLCFailureMsg),
165 pub(super) struct PendingAddHTLCInfo {
166 pub(super) forward_info: PendingHTLCInfo,
168 // These fields are produced in `forward_htlcs()` and consumed in
169 // `process_pending_htlc_forwards()` for constructing the
170 // `HTLCSource::PreviousHopData` for failed and forwarded
173 // Note that this may be an outbound SCID alias for the associated channel.
174 prev_short_channel_id: u64,
176 prev_funding_outpoint: OutPoint,
177 prev_user_channel_id: u128,
180 pub(super) enum HTLCForwardInfo {
181 AddHTLC(PendingAddHTLCInfo),
184 err_packet: msgs::OnionErrorPacket,
188 /// Tracks the inbound corresponding to an outbound HTLC
189 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
190 pub(crate) struct HTLCPreviousHopData {
191 // Note that this may be an outbound SCID alias for the associated channel.
192 short_channel_id: u64,
193 user_channel_id: Option<u128>,
195 incoming_packet_shared_secret: [u8; 32],
196 phantom_shared_secret: Option<[u8; 32]>,
198 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
199 // channel with a preimage provided by the forward channel.
204 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
206 /// This is only here for backwards-compatibility in serialization, in the future it can be
207 /// removed, breaking clients running 0.0.106 and earlier.
208 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
210 /// Contains the payer-provided preimage.
211 Spontaneous(PaymentPreimage),
214 /// HTLCs that are to us and can be failed/claimed by the user
215 struct ClaimableHTLC {
216 prev_hop: HTLCPreviousHopData,
218 /// The amount (in msats) of this MPP part
220 /// The amount (in msats) that the sender intended to be sent in this MPP
221 /// part (used for validating total MPP amount)
222 sender_intended_value: u64,
223 onion_payload: OnionPayload,
225 /// The total value received for a payment (sum of all MPP parts if the payment is a MPP).
226 /// Gets set to the amount reported when pushing [`Event::PaymentClaimable`].
227 total_value_received: Option<u64>,
228 /// The sender intended sum total of all MPP parts specified in the onion
230 /// The extra fee our counterparty skimmed off the top of this HTLC.
231 counterparty_skimmed_fee_msat: Option<u64>,
234 impl From<&ClaimableHTLC> for events::ClaimedHTLC {
235 fn from(val: &ClaimableHTLC) -> Self {
236 events::ClaimedHTLC {
237 channel_id: val.prev_hop.outpoint.to_channel_id(),
238 user_channel_id: val.prev_hop.user_channel_id.unwrap_or(0),
239 cltv_expiry: val.cltv_expiry,
240 value_msat: val.value,
245 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
246 /// a payment and ensure idempotency in LDK.
248 /// This is not exported to bindings users as we just use [u8; 32] directly
249 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
250 pub struct PaymentId(pub [u8; Self::LENGTH]);
253 /// Number of bytes in the id.
254 pub const LENGTH: usize = 32;
257 impl Writeable for PaymentId {
258 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
263 impl Readable for PaymentId {
264 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
265 let buf: [u8; 32] = Readable::read(r)?;
270 impl core::fmt::Display for PaymentId {
271 fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
272 crate::util::logger::DebugBytes(&self.0).fmt(f)
276 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
278 /// This is not exported to bindings users as we just use [u8; 32] directly
279 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
280 pub struct InterceptId(pub [u8; 32]);
282 impl Writeable for InterceptId {
283 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
288 impl Readable for InterceptId {
289 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
290 let buf: [u8; 32] = Readable::read(r)?;
295 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
296 /// Uniquely describes an HTLC by its source. Just the guaranteed-unique subset of [`HTLCSource`].
297 pub(crate) enum SentHTLCId {
298 PreviousHopData { short_channel_id: u64, htlc_id: u64 },
299 OutboundRoute { session_priv: SecretKey },
302 pub(crate) fn from_source(source: &HTLCSource) -> Self {
304 HTLCSource::PreviousHopData(hop_data) => Self::PreviousHopData {
305 short_channel_id: hop_data.short_channel_id,
306 htlc_id: hop_data.htlc_id,
308 HTLCSource::OutboundRoute { session_priv, .. } =>
309 Self::OutboundRoute { session_priv: *session_priv },
313 impl_writeable_tlv_based_enum!(SentHTLCId,
314 (0, PreviousHopData) => {
315 (0, short_channel_id, required),
316 (2, htlc_id, required),
318 (2, OutboundRoute) => {
319 (0, session_priv, required),
324 /// Tracks the inbound corresponding to an outbound HTLC
325 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
326 #[derive(Clone, Debug, PartialEq, Eq)]
327 pub(crate) enum HTLCSource {
328 PreviousHopData(HTLCPreviousHopData),
331 session_priv: SecretKey,
332 /// Technically we can recalculate this from the route, but we cache it here to avoid
333 /// doing a double-pass on route when we get a failure back
334 first_hop_htlc_msat: u64,
335 payment_id: PaymentId,
338 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
339 impl core::hash::Hash for HTLCSource {
340 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
342 HTLCSource::PreviousHopData(prev_hop_data) => {
344 prev_hop_data.hash(hasher);
346 HTLCSource::OutboundRoute { path, session_priv, payment_id, first_hop_htlc_msat } => {
349 session_priv[..].hash(hasher);
350 payment_id.hash(hasher);
351 first_hop_htlc_msat.hash(hasher);
357 #[cfg(all(feature = "_test_vectors", not(feature = "grind_signatures")))]
359 pub fn dummy() -> Self {
360 HTLCSource::OutboundRoute {
361 path: Path { hops: Vec::new(), blinded_tail: None },
362 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
363 first_hop_htlc_msat: 0,
364 payment_id: PaymentId([2; 32]),
368 #[cfg(debug_assertions)]
369 /// Checks whether this HTLCSource could possibly match the given HTLC output in a commitment
370 /// transaction. Useful to ensure different datastructures match up.
371 pub(crate) fn possibly_matches_output(&self, htlc: &super::chan_utils::HTLCOutputInCommitment) -> bool {
372 if let HTLCSource::OutboundRoute { first_hop_htlc_msat, .. } = self {
373 *first_hop_htlc_msat == htlc.amount_msat
375 // There's nothing we can check for forwarded HTLCs
381 struct InboundOnionErr {
387 /// This enum is used to specify which error data to send to peers when failing back an HTLC
388 /// using [`ChannelManager::fail_htlc_backwards_with_reason`].
390 /// For more info on failure codes, see <https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages>.
391 #[derive(Clone, Copy)]
392 pub enum FailureCode {
393 /// We had a temporary error processing the payment. Useful if no other error codes fit
394 /// and you want to indicate that the payer may want to retry.
395 TemporaryNodeFailure,
396 /// We have a required feature which was not in this onion. For example, you may require
397 /// some additional metadata that was not provided with this payment.
398 RequiredNodeFeatureMissing,
399 /// You may wish to use this when a `payment_preimage` is unknown, or the CLTV expiry of
400 /// the HTLC is too close to the current block height for safe handling.
401 /// Using this failure code in [`ChannelManager::fail_htlc_backwards_with_reason`] is
402 /// equivalent to calling [`ChannelManager::fail_htlc_backwards`].
403 IncorrectOrUnknownPaymentDetails,
404 /// We failed to process the payload after the onion was decrypted. You may wish to
405 /// use this when receiving custom HTLC TLVs with even type numbers that you don't recognize.
407 /// If available, the tuple data may include the type number and byte offset in the
408 /// decrypted byte stream where the failure occurred.
409 InvalidOnionPayload(Option<(u64, u16)>),
412 impl Into<u16> for FailureCode {
413 fn into(self) -> u16 {
415 FailureCode::TemporaryNodeFailure => 0x2000 | 2,
416 FailureCode::RequiredNodeFeatureMissing => 0x4000 | 0x2000 | 3,
417 FailureCode::IncorrectOrUnknownPaymentDetails => 0x4000 | 15,
418 FailureCode::InvalidOnionPayload(_) => 0x4000 | 22,
423 /// Error type returned across the peer_state mutex boundary. When an Err is generated for a
424 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
425 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
426 /// peer_state lock. We then return the set of things that need to be done outside the lock in
427 /// this struct and call handle_error!() on it.
429 struct MsgHandleErrInternal {
430 err: msgs::LightningError,
431 chan_id: Option<(ChannelId, u128)>, // If Some a channel of ours has been closed
432 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
433 channel_capacity: Option<u64>,
435 impl MsgHandleErrInternal {
437 fn send_err_msg_no_close(err: String, channel_id: ChannelId) -> Self {
439 err: LightningError {
441 action: msgs::ErrorAction::SendErrorMessage {
442 msg: msgs::ErrorMessage {
449 shutdown_finish: None,
450 channel_capacity: None,
454 fn from_no_close(err: msgs::LightningError) -> Self {
455 Self { err, chan_id: None, shutdown_finish: None, channel_capacity: None }
458 fn from_finish_shutdown(err: String, channel_id: ChannelId, user_channel_id: u128, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>, channel_capacity: u64) -> Self {
459 let err_msg = msgs::ErrorMessage { channel_id, data: err.clone() };
460 let action = if shutdown_res.monitor_update.is_some() {
461 // We have a closing `ChannelMonitorUpdate`, which means the channel was funded and we
462 // should disconnect our peer such that we force them to broadcast their latest
463 // commitment upon reconnecting.
464 msgs::ErrorAction::DisconnectPeer { msg: Some(err_msg) }
466 msgs::ErrorAction::SendErrorMessage { msg: err_msg }
469 err: LightningError { err, action },
470 chan_id: Some((channel_id, user_channel_id)),
471 shutdown_finish: Some((shutdown_res, channel_update)),
472 channel_capacity: Some(channel_capacity)
476 fn from_chan_no_close(err: ChannelError, channel_id: ChannelId) -> Self {
479 ChannelError::Warn(msg) => LightningError {
481 action: msgs::ErrorAction::SendWarningMessage {
482 msg: msgs::WarningMessage {
486 log_level: Level::Warn,
489 ChannelError::Ignore(msg) => LightningError {
491 action: msgs::ErrorAction::IgnoreError,
493 ChannelError::Close(msg) => LightningError {
495 action: msgs::ErrorAction::SendErrorMessage {
496 msg: msgs::ErrorMessage {
504 shutdown_finish: None,
505 channel_capacity: None,
509 fn closes_channel(&self) -> bool {
510 self.chan_id.is_some()
514 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
515 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
516 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
517 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
518 pub(super) const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
520 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
521 /// be sent in the order they appear in the return value, however sometimes the order needs to be
522 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
523 /// they were originally sent). In those cases, this enum is also returned.
524 #[derive(Clone, PartialEq)]
525 pub(super) enum RAACommitmentOrder {
526 /// Send the CommitmentUpdate messages first
528 /// Send the RevokeAndACK message first
532 /// Information about a payment which is currently being claimed.
533 struct ClaimingPayment {
535 payment_purpose: events::PaymentPurpose,
536 receiver_node_id: PublicKey,
537 htlcs: Vec<events::ClaimedHTLC>,
538 sender_intended_value: Option<u64>,
540 impl_writeable_tlv_based!(ClaimingPayment, {
541 (0, amount_msat, required),
542 (2, payment_purpose, required),
543 (4, receiver_node_id, required),
544 (5, htlcs, optional_vec),
545 (7, sender_intended_value, option),
548 struct ClaimablePayment {
549 purpose: events::PaymentPurpose,
550 onion_fields: Option<RecipientOnionFields>,
551 htlcs: Vec<ClaimableHTLC>,
554 /// Information about claimable or being-claimed payments
555 struct ClaimablePayments {
556 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
557 /// failed/claimed by the user.
559 /// Note that, no consistency guarantees are made about the channels given here actually
560 /// existing anymore by the time you go to read them!
562 /// When adding to the map, [`Self::pending_claiming_payments`] must also be checked to ensure
563 /// we don't get a duplicate payment.
564 claimable_payments: HashMap<PaymentHash, ClaimablePayment>,
566 /// Map from payment hash to the payment data for HTLCs which we have begun claiming, but which
567 /// are waiting on a [`ChannelMonitorUpdate`] to complete in order to be surfaced to the user
568 /// as an [`events::Event::PaymentClaimed`].
569 pending_claiming_payments: HashMap<PaymentHash, ClaimingPayment>,
572 /// Events which we process internally but cannot be processed immediately at the generation site
573 /// usually because we're running pre-full-init. They are handled immediately once we detect we are
574 /// running normally, and specifically must be processed before any other non-background
575 /// [`ChannelMonitorUpdate`]s are applied.
577 enum BackgroundEvent {
578 /// Handle a ChannelMonitorUpdate which closes the channel or for an already-closed channel.
579 /// This is only separated from [`Self::MonitorUpdateRegeneratedOnStartup`] as the
580 /// maybe-non-closing variant needs a public key to handle channel resumption, whereas if the
581 /// channel has been force-closed we do not need the counterparty node_id.
583 /// Note that any such events are lost on shutdown, so in general they must be updates which
584 /// are regenerated on startup.
585 ClosedMonitorUpdateRegeneratedOnStartup((OutPoint, ChannelMonitorUpdate)),
586 /// Handle a ChannelMonitorUpdate which may or may not close the channel and may unblock the
587 /// channel to continue normal operation.
589 /// In general this should be used rather than
590 /// [`Self::ClosedMonitorUpdateRegeneratedOnStartup`], however in cases where the
591 /// `counterparty_node_id` is not available as the channel has closed from a [`ChannelMonitor`]
592 /// error the other variant is acceptable.
594 /// Note that any such events are lost on shutdown, so in general they must be updates which
595 /// are regenerated on startup.
596 MonitorUpdateRegeneratedOnStartup {
597 counterparty_node_id: PublicKey,
598 funding_txo: OutPoint,
599 update: ChannelMonitorUpdate
601 /// Some [`ChannelMonitorUpdate`] (s) completed before we were serialized but we still have
602 /// them marked pending, thus we need to run any [`MonitorUpdateCompletionAction`] (s) pending
604 MonitorUpdatesComplete {
605 counterparty_node_id: PublicKey,
606 channel_id: ChannelId,
611 pub(crate) enum MonitorUpdateCompletionAction {
612 /// Indicates that a payment ultimately destined for us was claimed and we should emit an
613 /// [`events::Event::PaymentClaimed`] to the user if we haven't yet generated such an event for
614 /// this payment. Note that this is only best-effort. On restart it's possible such a duplicate
615 /// event can be generated.
616 PaymentClaimed { payment_hash: PaymentHash },
617 /// Indicates an [`events::Event`] should be surfaced to the user and possibly resume the
618 /// operation of another channel.
620 /// This is usually generated when we've forwarded an HTLC and want to block the outbound edge
621 /// from completing a monitor update which removes the payment preimage until the inbound edge
622 /// completes a monitor update containing the payment preimage. In that case, after the inbound
623 /// edge completes, we will surface an [`Event::PaymentForwarded`] as well as unblock the
625 EmitEventAndFreeOtherChannel {
626 event: events::Event,
627 downstream_counterparty_and_funding_outpoint: Option<(PublicKey, OutPoint, RAAMonitorUpdateBlockingAction)>,
629 /// Indicates we should immediately resume the operation of another channel, unless there is
630 /// some other reason why the channel is blocked. In practice this simply means immediately
631 /// removing the [`RAAMonitorUpdateBlockingAction`] provided from the blocking set.
633 /// This is usually generated when we've forwarded an HTLC and want to block the outbound edge
634 /// from completing a monitor update which removes the payment preimage until the inbound edge
635 /// completes a monitor update containing the payment preimage. However, we use this variant
636 /// instead of [`Self::EmitEventAndFreeOtherChannel`] when we discover that the claim was in
637 /// fact duplicative and we simply want to resume the outbound edge channel immediately.
639 /// This variant should thus never be written to disk, as it is processed inline rather than
640 /// stored for later processing.
641 FreeOtherChannelImmediately {
642 downstream_counterparty_node_id: PublicKey,
643 downstream_funding_outpoint: OutPoint,
644 blocking_action: RAAMonitorUpdateBlockingAction,
648 impl_writeable_tlv_based_enum_upgradable!(MonitorUpdateCompletionAction,
649 (0, PaymentClaimed) => { (0, payment_hash, required) },
650 // Note that FreeOtherChannelImmediately should never be written - we were supposed to free
651 // *immediately*. However, for simplicity we implement read/write here.
652 (1, FreeOtherChannelImmediately) => {
653 (0, downstream_counterparty_node_id, required),
654 (2, downstream_funding_outpoint, required),
655 (4, blocking_action, required),
657 (2, EmitEventAndFreeOtherChannel) => {
658 (0, event, upgradable_required),
659 // LDK prior to 0.0.116 did not have this field as the monitor update application order was
660 // required by clients. If we downgrade to something prior to 0.0.116 this may result in
661 // monitor updates which aren't properly blocked or resumed, however that's fine - we don't
662 // support async monitor updates even in LDK 0.0.116 and once we do we'll require no
663 // downgrades to prior versions.
664 (1, downstream_counterparty_and_funding_outpoint, option),
668 #[derive(Clone, Debug, PartialEq, Eq)]
669 pub(crate) enum EventCompletionAction {
670 ReleaseRAAChannelMonitorUpdate {
671 counterparty_node_id: PublicKey,
672 channel_funding_outpoint: OutPoint,
675 impl_writeable_tlv_based_enum!(EventCompletionAction,
676 (0, ReleaseRAAChannelMonitorUpdate) => {
677 (0, channel_funding_outpoint, required),
678 (2, counterparty_node_id, required),
682 #[derive(Clone, PartialEq, Eq, Debug)]
683 /// If something is blocked on the completion of an RAA-generated [`ChannelMonitorUpdate`] we track
684 /// the blocked action here. See enum variants for more info.
685 pub(crate) enum RAAMonitorUpdateBlockingAction {
686 /// A forwarded payment was claimed. We block the downstream channel completing its monitor
687 /// update which removes the HTLC preimage until the upstream channel has gotten the preimage
689 ForwardedPaymentInboundClaim {
690 /// The upstream channel ID (i.e. the inbound edge).
691 channel_id: ChannelId,
692 /// The HTLC ID on the inbound edge.
697 impl RAAMonitorUpdateBlockingAction {
698 fn from_prev_hop_data(prev_hop: &HTLCPreviousHopData) -> Self {
699 Self::ForwardedPaymentInboundClaim {
700 channel_id: prev_hop.outpoint.to_channel_id(),
701 htlc_id: prev_hop.htlc_id,
706 impl_writeable_tlv_based_enum!(RAAMonitorUpdateBlockingAction,
707 (0, ForwardedPaymentInboundClaim) => { (0, channel_id, required), (2, htlc_id, required) }
711 /// State we hold per-peer.
712 pub(super) struct PeerState<SP: Deref> where SP::Target: SignerProvider {
713 /// `channel_id` -> `ChannelPhase`
715 /// Holds all channels within corresponding `ChannelPhase`s where the peer is the counterparty.
716 pub(super) channel_by_id: HashMap<ChannelId, ChannelPhase<SP>>,
717 /// `temporary_channel_id` -> `InboundChannelRequest`.
719 /// When manual channel acceptance is enabled, this holds all unaccepted inbound channels where
720 /// the peer is the counterparty. If the channel is accepted, then the entry in this table is
721 /// removed, and an InboundV1Channel is created and placed in the `inbound_v1_channel_by_id` table. If
722 /// the channel is rejected, then the entry is simply removed.
723 pub(super) inbound_channel_request_by_id: HashMap<ChannelId, InboundChannelRequest>,
724 /// The latest `InitFeatures` we heard from the peer.
725 latest_features: InitFeatures,
726 /// Messages to send to the peer - pushed to in the same lock that they are generated in (except
727 /// for broadcast messages, where ordering isn't as strict).
728 pub(super) pending_msg_events: Vec<MessageSendEvent>,
729 /// Map from Channel IDs to pending [`ChannelMonitorUpdate`]s which have been passed to the
730 /// user but which have not yet completed.
732 /// Note that the channel may no longer exist. For example if the channel was closed but we
733 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
734 /// for a missing channel.
735 in_flight_monitor_updates: BTreeMap<OutPoint, Vec<ChannelMonitorUpdate>>,
736 /// Map from a specific channel to some action(s) that should be taken when all pending
737 /// [`ChannelMonitorUpdate`]s for the channel complete updating.
739 /// Note that because we generally only have one entry here a HashMap is pretty overkill. A
740 /// BTreeMap currently stores more than ten elements per leaf node, so even up to a few
741 /// channels with a peer this will just be one allocation and will amount to a linear list of
742 /// channels to walk, avoiding the whole hashing rigmarole.
744 /// Note that the channel may no longer exist. For example, if a channel was closed but we
745 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
746 /// for a missing channel. While a malicious peer could construct a second channel with the
747 /// same `temporary_channel_id` (or final `channel_id` in the case of 0conf channels or prior
748 /// to funding appearing on-chain), the downstream `ChannelMonitor` set is required to ensure
749 /// duplicates do not occur, so such channels should fail without a monitor update completing.
750 monitor_update_blocked_actions: BTreeMap<ChannelId, Vec<MonitorUpdateCompletionAction>>,
751 /// If another channel's [`ChannelMonitorUpdate`] needs to complete before a channel we have
752 /// with this peer can complete an RAA [`ChannelMonitorUpdate`] (e.g. because the RAA update
753 /// will remove a preimage that needs to be durably in an upstream channel first), we put an
754 /// entry here to note that the channel with the key's ID is blocked on a set of actions.
755 actions_blocking_raa_monitor_updates: BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
756 /// The peer is currently connected (i.e. we've seen a
757 /// [`ChannelMessageHandler::peer_connected`] and no corresponding
758 /// [`ChannelMessageHandler::peer_disconnected`].
762 impl <SP: Deref> PeerState<SP> where SP::Target: SignerProvider {
763 /// Indicates that a peer meets the criteria where we're ok to remove it from our storage.
764 /// If true is passed for `require_disconnected`, the function will return false if we haven't
765 /// disconnected from the node already, ie. `PeerState::is_connected` is set to `true`.
766 fn ok_to_remove(&self, require_disconnected: bool) -> bool {
767 if require_disconnected && self.is_connected {
770 self.channel_by_id.iter().filter(|(_, phase)| matches!(phase, ChannelPhase::Funded(_))).count() == 0
771 && self.monitor_update_blocked_actions.is_empty()
772 && self.in_flight_monitor_updates.is_empty()
775 // Returns a count of all channels we have with this peer, including unfunded channels.
776 fn total_channel_count(&self) -> usize {
777 self.channel_by_id.len() + self.inbound_channel_request_by_id.len()
780 // Returns a bool indicating if the given `channel_id` matches a channel we have with this peer.
781 fn has_channel(&self, channel_id: &ChannelId) -> bool {
782 self.channel_by_id.contains_key(channel_id) ||
783 self.inbound_channel_request_by_id.contains_key(channel_id)
787 /// A not-yet-accepted inbound (from counterparty) channel. Once
788 /// accepted, the parameters will be used to construct a channel.
789 pub(super) struct InboundChannelRequest {
790 /// The original OpenChannel message.
791 pub open_channel_msg: msgs::OpenChannel,
792 /// The number of ticks remaining before the request expires.
793 pub ticks_remaining: i32,
796 /// The number of ticks that may elapse while we're waiting for an unaccepted inbound channel to be
797 /// accepted. An unaccepted channel that exceeds this limit will be abandoned.
798 const UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS: i32 = 2;
800 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
801 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
803 /// For users who don't want to bother doing their own payment preimage storage, we also store that
806 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
807 /// and instead encoding it in the payment secret.
808 struct PendingInboundPayment {
809 /// The payment secret that the sender must use for us to accept this payment
810 payment_secret: PaymentSecret,
811 /// Time at which this HTLC expires - blocks with a header time above this value will result in
812 /// this payment being removed.
814 /// Arbitrary identifier the user specifies (or not)
815 user_payment_id: u64,
816 // Other required attributes of the payment, optionally enforced:
817 payment_preimage: Option<PaymentPreimage>,
818 min_value_msat: Option<u64>,
821 /// [`SimpleArcChannelManager`] is useful when you need a [`ChannelManager`] with a static lifetime, e.g.
822 /// when you're using `lightning-net-tokio` (since `tokio::spawn` requires parameters with static
823 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
824 /// [`SimpleRefChannelManager`] is the more appropriate type. Defining these type aliases prevents
825 /// issues such as overly long function definitions. Note that the `ChannelManager` can take any type
826 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
827 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
828 /// of [`KeysManager`] and [`DefaultRouter`].
830 /// This is not exported to bindings users as type aliases aren't supported in most languages.
831 #[cfg(not(c_bindings))]
832 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
840 Arc<NetworkGraph<Arc<L>>>,
842 Arc<RwLock<ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>>,
843 ProbabilisticScoringFeeParameters,
844 ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>,
849 /// [`SimpleRefChannelManager`] is a type alias for a ChannelManager reference, and is the reference
850 /// counterpart to the [`SimpleArcChannelManager`] type alias. Use this type by default when you don't
851 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
852 /// usage of lightning-net-tokio (since `tokio::spawn` requires parameters with static lifetimes).
853 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
854 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
855 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
856 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
857 /// of [`KeysManager`] and [`DefaultRouter`].
859 /// This is not exported to bindings users as type aliases aren't supported in most languages.
860 #[cfg(not(c_bindings))]
861 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> =
870 &'f NetworkGraph<&'g L>,
872 &'h RwLock<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>,
873 ProbabilisticScoringFeeParameters,
874 ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>
879 /// A trivial trait which describes any [`ChannelManager`].
881 /// This is not exported to bindings users as general cover traits aren't useful in other
883 pub trait AChannelManager {
884 /// A type implementing [`chain::Watch`].
885 type Watch: chain::Watch<Self::Signer> + ?Sized;
886 /// A type that may be dereferenced to [`Self::Watch`].
887 type M: Deref<Target = Self::Watch>;
888 /// A type implementing [`BroadcasterInterface`].
889 type Broadcaster: BroadcasterInterface + ?Sized;
890 /// A type that may be dereferenced to [`Self::Broadcaster`].
891 type T: Deref<Target = Self::Broadcaster>;
892 /// A type implementing [`EntropySource`].
893 type EntropySource: EntropySource + ?Sized;
894 /// A type that may be dereferenced to [`Self::EntropySource`].
895 type ES: Deref<Target = Self::EntropySource>;
896 /// A type implementing [`NodeSigner`].
897 type NodeSigner: NodeSigner + ?Sized;
898 /// A type that may be dereferenced to [`Self::NodeSigner`].
899 type NS: Deref<Target = Self::NodeSigner>;
900 /// A type implementing [`WriteableEcdsaChannelSigner`].
901 type Signer: WriteableEcdsaChannelSigner + Sized;
902 /// A type implementing [`SignerProvider`] for [`Self::Signer`].
903 type SignerProvider: SignerProvider<Signer = Self::Signer> + ?Sized;
904 /// A type that may be dereferenced to [`Self::SignerProvider`].
905 type SP: Deref<Target = Self::SignerProvider>;
906 /// A type implementing [`FeeEstimator`].
907 type FeeEstimator: FeeEstimator + ?Sized;
908 /// A type that may be dereferenced to [`Self::FeeEstimator`].
909 type F: Deref<Target = Self::FeeEstimator>;
910 /// A type implementing [`Router`].
911 type Router: Router + ?Sized;
912 /// A type that may be dereferenced to [`Self::Router`].
913 type R: Deref<Target = Self::Router>;
914 /// A type implementing [`Logger`].
915 type Logger: Logger + ?Sized;
916 /// A type that may be dereferenced to [`Self::Logger`].
917 type L: Deref<Target = Self::Logger>;
918 /// Returns a reference to the actual [`ChannelManager`] object.
919 fn get_cm(&self) -> &ChannelManager<Self::M, Self::T, Self::ES, Self::NS, Self::SP, Self::F, Self::R, Self::L>;
922 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> AChannelManager
923 for ChannelManager<M, T, ES, NS, SP, F, R, L>
925 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
926 T::Target: BroadcasterInterface,
927 ES::Target: EntropySource,
928 NS::Target: NodeSigner,
929 SP::Target: SignerProvider,
930 F::Target: FeeEstimator,
934 type Watch = M::Target;
936 type Broadcaster = T::Target;
938 type EntropySource = ES::Target;
940 type NodeSigner = NS::Target;
942 type Signer = <SP::Target as SignerProvider>::Signer;
943 type SignerProvider = SP::Target;
945 type FeeEstimator = F::Target;
947 type Router = R::Target;
949 type Logger = L::Target;
951 fn get_cm(&self) -> &ChannelManager<M, T, ES, NS, SP, F, R, L> { self }
954 /// Manager which keeps track of a number of channels and sends messages to the appropriate
955 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
957 /// Implements [`ChannelMessageHandler`], handling the multi-channel parts and passing things through
958 /// to individual Channels.
960 /// Implements [`Writeable`] to write out all channel state to disk. Implies [`peer_disconnected`] for
961 /// all peers during write/read (though does not modify this instance, only the instance being
962 /// serialized). This will result in any channels which have not yet exchanged [`funding_created`] (i.e.,
963 /// called [`funding_transaction_generated`] for outbound channels) being closed.
965 /// Note that you can be a bit lazier about writing out `ChannelManager` than you can be with
966 /// [`ChannelMonitor`]. With [`ChannelMonitor`] you MUST durably write each
967 /// [`ChannelMonitorUpdate`] before returning from
968 /// [`chain::Watch::watch_channel`]/[`update_channel`] or before completing async writes. With
969 /// `ChannelManager`s, writing updates happens out-of-band (and will prevent any other
970 /// `ChannelManager` operations from occurring during the serialization process). If the
971 /// deserialized version is out-of-date compared to the [`ChannelMonitor`] passed by reference to
972 /// [`read`], those channels will be force-closed based on the `ChannelMonitor` state and no funds
973 /// will be lost (modulo on-chain transaction fees).
975 /// Note that the deserializer is only implemented for `(`[`BlockHash`]`, `[`ChannelManager`]`)`, which
976 /// tells you the last block hash which was connected. You should get the best block tip before using the manager.
977 /// See [`chain::Listen`] and [`chain::Confirm`] for more details.
979 /// Note that `ChannelManager` is responsible for tracking liveness of its channels and generating
980 /// [`ChannelUpdate`] messages informing peers that the channel is temporarily disabled. To avoid
981 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
982 /// offline for a full minute. In order to track this, you must call
983 /// [`timer_tick_occurred`] roughly once per minute, though it doesn't have to be perfect.
985 /// To avoid trivial DoS issues, `ChannelManager` limits the number of inbound connections and
986 /// inbound channels without confirmed funding transactions. This may result in nodes which we do
987 /// not have a channel with being unable to connect to us or open new channels with us if we have
988 /// many peers with unfunded channels.
990 /// Because it is an indication of trust, inbound channels which we've accepted as 0conf are
991 /// exempted from the count of unfunded channels. Similarly, outbound channels and connections are
992 /// never limited. Please ensure you limit the count of such channels yourself.
994 /// Rather than using a plain `ChannelManager`, it is preferable to use either a [`SimpleArcChannelManager`]
995 /// a [`SimpleRefChannelManager`], for conciseness. See their documentation for more details, but
996 /// essentially you should default to using a [`SimpleRefChannelManager`], and use a
997 /// [`SimpleArcChannelManager`] when you require a `ChannelManager` with a static lifetime, such as when
998 /// you're using lightning-net-tokio.
1000 /// [`peer_disconnected`]: msgs::ChannelMessageHandler::peer_disconnected
1001 /// [`funding_created`]: msgs::FundingCreated
1002 /// [`funding_transaction_generated`]: Self::funding_transaction_generated
1003 /// [`BlockHash`]: bitcoin::hash_types::BlockHash
1004 /// [`update_channel`]: chain::Watch::update_channel
1005 /// [`ChannelUpdate`]: msgs::ChannelUpdate
1006 /// [`timer_tick_occurred`]: Self::timer_tick_occurred
1007 /// [`read`]: ReadableArgs::read
1010 // The tree structure below illustrates the lock order requirements for the different locks of the
1011 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
1012 // and should then be taken in the order of the lowest to the highest level in the tree.
1013 // Note that locks on different branches shall not be taken at the same time, as doing so will
1014 // create a new lock order for those specific locks in the order they were taken.
1018 // `pending_offers_messages`
1020 // `total_consistency_lock`
1022 // |__`forward_htlcs`
1024 // | |__`pending_intercepted_htlcs`
1026 // |__`per_peer_state`
1028 // |__`pending_inbound_payments`
1030 // |__`claimable_payments`
1032 // |__`pending_outbound_payments` // This field's struct contains a map of pending outbounds
1038 // |__`short_to_chan_info`
1040 // |__`outbound_scid_aliases`
1044 // |__`pending_events`
1046 // |__`pending_background_events`
1048 pub struct ChannelManager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
1050 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
1051 T::Target: BroadcasterInterface,
1052 ES::Target: EntropySource,
1053 NS::Target: NodeSigner,
1054 SP::Target: SignerProvider,
1055 F::Target: FeeEstimator,
1059 default_configuration: UserConfig,
1060 chain_hash: ChainHash,
1061 fee_estimator: LowerBoundedFeeEstimator<F>,
1067 /// See `ChannelManager` struct-level documentation for lock order requirements.
1069 pub(super) best_block: RwLock<BestBlock>,
1071 best_block: RwLock<BestBlock>,
1072 secp_ctx: Secp256k1<secp256k1::All>,
1074 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
1075 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
1076 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
1077 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
1079 /// See `ChannelManager` struct-level documentation for lock order requirements.
1080 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
1082 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
1083 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
1084 /// (if the channel has been force-closed), however we track them here to prevent duplicative
1085 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
1086 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
1087 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
1088 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
1089 /// after reloading from disk while replaying blocks against ChannelMonitors.
1091 /// See `PendingOutboundPayment` documentation for more info.
1093 /// See `ChannelManager` struct-level documentation for lock order requirements.
1094 pending_outbound_payments: OutboundPayments,
1096 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
1098 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
1099 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
1100 /// and via the classic SCID.
1102 /// Note that no consistency guarantees are made about the existence of a channel with the
1103 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
1105 /// See `ChannelManager` struct-level documentation for lock order requirements.
1107 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1109 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1110 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
1111 /// until the user tells us what we should do with them.
1113 /// See `ChannelManager` struct-level documentation for lock order requirements.
1114 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
1116 /// The sets of payments which are claimable or currently being claimed. See
1117 /// [`ClaimablePayments`]' individual field docs for more info.
1119 /// See `ChannelManager` struct-level documentation for lock order requirements.
1120 claimable_payments: Mutex<ClaimablePayments>,
1122 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
1123 /// and some closed channels which reached a usable state prior to being closed. This is used
1124 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
1125 /// active channel list on load.
1127 /// See `ChannelManager` struct-level documentation for lock order requirements.
1128 outbound_scid_aliases: Mutex<HashSet<u64>>,
1130 /// `channel_id` -> `counterparty_node_id`.
1132 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
1133 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
1134 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
1136 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
1137 /// the corresponding channel for the event, as we only have access to the `channel_id` during
1138 /// the handling of the events.
1140 /// Note that no consistency guarantees are made about the existence of a peer with the
1141 /// `counterparty_node_id` in our other maps.
1144 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
1145 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
1146 /// would break backwards compatability.
1147 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
1148 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
1149 /// required to access the channel with the `counterparty_node_id`.
1151 /// See `ChannelManager` struct-level documentation for lock order requirements.
1152 id_to_peer: Mutex<HashMap<ChannelId, PublicKey>>,
1154 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
1156 /// Outbound SCID aliases are added here once the channel is available for normal use, with
1157 /// SCIDs being added once the funding transaction is confirmed at the channel's required
1158 /// confirmation depth.
1160 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
1161 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
1162 /// channel with the `channel_id` in our other maps.
1164 /// See `ChannelManager` struct-level documentation for lock order requirements.
1166 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1168 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1170 our_network_pubkey: PublicKey,
1172 inbound_payment_key: inbound_payment::ExpandedKey,
1174 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
1175 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
1176 /// we encrypt the namespace identifier using these bytes.
1178 /// [fake scids]: crate::util::scid_utils::fake_scid
1179 fake_scid_rand_bytes: [u8; 32],
1181 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
1182 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
1183 /// keeping additional state.
1184 probing_cookie_secret: [u8; 32],
1186 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
1187 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
1188 /// very far in the past, and can only ever be up to two hours in the future.
1189 highest_seen_timestamp: AtomicUsize,
1191 /// The bulk of our storage. Currently the `per_peer_state` stores our channels on a per-peer
1192 /// basis, as well as the peer's latest features.
1194 /// If we are connected to a peer we always at least have an entry here, even if no channels
1195 /// are currently open with that peer.
1197 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
1198 /// operate on the inner value freely. This opens up for parallel per-peer operation for
1201 /// Note that the same thread must never acquire two inner `PeerState` locks at the same time.
1203 /// See `ChannelManager` struct-level documentation for lock order requirements.
1204 #[cfg(not(any(test, feature = "_test_utils")))]
1205 per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1206 #[cfg(any(test, feature = "_test_utils"))]
1207 pub(super) per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1209 /// The set of events which we need to give to the user to handle. In some cases an event may
1210 /// require some further action after the user handles it (currently only blocking a monitor
1211 /// update from being handed to the user to ensure the included changes to the channel state
1212 /// are handled by the user before they're persisted durably to disk). In that case, the second
1213 /// element in the tuple is set to `Some` with further details of the action.
1215 /// Note that events MUST NOT be removed from pending_events after deserialization, as they
1216 /// could be in the middle of being processed without the direct mutex held.
1218 /// See `ChannelManager` struct-level documentation for lock order requirements.
1219 #[cfg(not(any(test, feature = "_test_utils")))]
1220 pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1221 #[cfg(any(test, feature = "_test_utils"))]
1222 pub(crate) pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1224 /// A simple atomic flag to ensure only one task at a time can be processing events asynchronously.
1225 pending_events_processor: AtomicBool,
1227 /// If we are running during init (either directly during the deserialization method or in
1228 /// block connection methods which run after deserialization but before normal operation) we
1229 /// cannot provide the user with [`ChannelMonitorUpdate`]s through the normal update flow -
1230 /// prior to normal operation the user may not have loaded the [`ChannelMonitor`]s into their
1231 /// [`ChainMonitor`] and thus attempting to update it will fail or panic.
1233 /// Thus, we place them here to be handled as soon as possible once we are running normally.
1235 /// See `ChannelManager` struct-level documentation for lock order requirements.
1237 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
1238 pending_background_events: Mutex<Vec<BackgroundEvent>>,
1239 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
1240 /// Essentially just when we're serializing ourselves out.
1241 /// Taken first everywhere where we are making changes before any other locks.
1242 /// When acquiring this lock in read mode, rather than acquiring it directly, call
1243 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
1244 /// Notifier the lock contains sends out a notification when the lock is released.
1245 total_consistency_lock: RwLock<()>,
1246 /// Tracks the progress of channels going through batch funding by whether funding_signed was
1247 /// received and the monitor has been persisted.
1249 /// This information does not need to be persisted as funding nodes can forget
1250 /// unfunded channels upon disconnection.
1251 funding_batch_states: Mutex<BTreeMap<Txid, Vec<(ChannelId, PublicKey, bool)>>>,
1253 background_events_processed_since_startup: AtomicBool,
1255 event_persist_notifier: Notifier,
1256 needs_persist_flag: AtomicBool,
1258 pending_offers_messages: Mutex<Vec<PendingOnionMessage<OffersMessage>>>,
1262 signer_provider: SP,
1267 /// Chain-related parameters used to construct a new `ChannelManager`.
1269 /// Typically, the block-specific parameters are derived from the best block hash for the network,
1270 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
1271 /// are not needed when deserializing a previously constructed `ChannelManager`.
1272 #[derive(Clone, Copy, PartialEq)]
1273 pub struct ChainParameters {
1274 /// The network for determining the `chain_hash` in Lightning messages.
1275 pub network: Network,
1277 /// The hash and height of the latest block successfully connected.
1279 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
1280 pub best_block: BestBlock,
1283 #[derive(Copy, Clone, PartialEq)]
1287 SkipPersistHandleEvents,
1288 SkipPersistNoEvents,
1291 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
1292 /// desirable to notify any listeners on `await_persistable_update_timeout`/
1293 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
1294 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
1295 /// sending the aforementioned notification (since the lock being released indicates that the
1296 /// updates are ready for persistence).
1298 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
1299 /// notify or not based on whether relevant changes have been made, providing a closure to
1300 /// `optionally_notify` which returns a `NotifyOption`.
1301 struct PersistenceNotifierGuard<'a, F: FnMut() -> NotifyOption> {
1302 event_persist_notifier: &'a Notifier,
1303 needs_persist_flag: &'a AtomicBool,
1305 // We hold onto this result so the lock doesn't get released immediately.
1306 _read_guard: RwLockReadGuard<'a, ()>,
1309 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
1310 /// Notifies any waiters and indicates that we need to persist, in addition to possibly having
1311 /// events to handle.
1313 /// This must always be called if the changes included a `ChannelMonitorUpdate`, as well as in
1314 /// other cases where losing the changes on restart may result in a force-close or otherwise
1316 fn notify_on_drop<C: AChannelManager>(cm: &'a C) -> PersistenceNotifierGuard<'a, impl FnMut() -> NotifyOption> {
1317 Self::optionally_notify(cm, || -> NotifyOption { NotifyOption::DoPersist })
1320 fn optionally_notify<F: FnMut() -> NotifyOption, C: AChannelManager>(cm: &'a C, mut persist_check: F)
1321 -> PersistenceNotifierGuard<'a, impl FnMut() -> NotifyOption> {
1322 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1323 let force_notify = cm.get_cm().process_background_events();
1325 PersistenceNotifierGuard {
1326 event_persist_notifier: &cm.get_cm().event_persist_notifier,
1327 needs_persist_flag: &cm.get_cm().needs_persist_flag,
1328 should_persist: move || {
1329 // Pick the "most" action between `persist_check` and the background events
1330 // processing and return that.
1331 let notify = persist_check();
1332 match (notify, force_notify) {
1333 (NotifyOption::DoPersist, _) => NotifyOption::DoPersist,
1334 (_, NotifyOption::DoPersist) => NotifyOption::DoPersist,
1335 (NotifyOption::SkipPersistHandleEvents, _) => NotifyOption::SkipPersistHandleEvents,
1336 (_, NotifyOption::SkipPersistHandleEvents) => NotifyOption::SkipPersistHandleEvents,
1337 _ => NotifyOption::SkipPersistNoEvents,
1340 _read_guard: read_guard,
1344 /// Note that if any [`ChannelMonitorUpdate`]s are possibly generated,
1345 /// [`ChannelManager::process_background_events`] MUST be called first (or
1346 /// [`Self::optionally_notify`] used).
1347 fn optionally_notify_skipping_background_events<F: Fn() -> NotifyOption, C: AChannelManager>
1348 (cm: &'a C, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
1349 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1351 PersistenceNotifierGuard {
1352 event_persist_notifier: &cm.get_cm().event_persist_notifier,
1353 needs_persist_flag: &cm.get_cm().needs_persist_flag,
1354 should_persist: persist_check,
1355 _read_guard: read_guard,
1360 impl<'a, F: FnMut() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
1361 fn drop(&mut self) {
1362 match (self.should_persist)() {
1363 NotifyOption::DoPersist => {
1364 self.needs_persist_flag.store(true, Ordering::Release);
1365 self.event_persist_notifier.notify()
1367 NotifyOption::SkipPersistHandleEvents =>
1368 self.event_persist_notifier.notify(),
1369 NotifyOption::SkipPersistNoEvents => {},
1374 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
1375 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
1377 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
1379 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
1380 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
1381 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
1382 /// the maximum required amount in lnd as of March 2021.
1383 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
1385 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
1386 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
1388 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
1390 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
1391 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
1392 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
1393 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
1394 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
1395 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
1396 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
1397 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
1398 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
1399 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
1400 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
1401 // routing failure for any HTLC sender picking up an LDK node among the first hops.
1402 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
1404 /// Minimum CLTV difference between the current block height and received inbound payments.
1405 /// Invoices generated for payment to us must set their `min_final_cltv_expiry_delta` field to at least
1407 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
1408 // any payments to succeed. Further, we don't want payments to fail if a block was found while
1409 // a payment was being routed, so we add an extra block to be safe.
1410 pub const MIN_FINAL_CLTV_EXPIRY_DELTA: u16 = HTLC_FAIL_BACK_BUFFER as u16 + 3;
1412 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
1413 // ie that if the next-hop peer fails the HTLC within
1414 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
1415 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
1416 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
1417 // LATENCY_GRACE_PERIOD_BLOCKS.
1420 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;
1422 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
1423 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
1426 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
1428 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
1429 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
1431 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is disconnected
1432 /// until we mark the channel disabled and gossip the update.
1433 pub(crate) const DISABLE_GOSSIP_TICKS: u8 = 10;
1435 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is connected until
1436 /// we mark the channel enabled and gossip the update.
1437 pub(crate) const ENABLE_GOSSIP_TICKS: u8 = 5;
1439 /// The maximum number of unfunded channels we can have per-peer before we start rejecting new
1440 /// (inbound) ones. The number of peers with unfunded channels is limited separately in
1441 /// [`MAX_UNFUNDED_CHANNEL_PEERS`].
1442 const MAX_UNFUNDED_CHANS_PER_PEER: usize = 4;
1444 /// The maximum number of peers from which we will allow pending unfunded channels. Once we reach
1445 /// this many peers we reject new (inbound) channels from peers with which we don't have a channel.
1446 const MAX_UNFUNDED_CHANNEL_PEERS: usize = 50;
1448 /// The maximum number of peers which we do not have a (funded) channel with. Once we reach this
1449 /// many peers we reject new (inbound) connections.
1450 const MAX_NO_CHANNEL_PEERS: usize = 250;
1452 /// Information needed for constructing an invoice route hint for this channel.
1453 #[derive(Clone, Debug, PartialEq)]
1454 pub struct CounterpartyForwardingInfo {
1455 /// Base routing fee in millisatoshis.
1456 pub fee_base_msat: u32,
1457 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
1458 pub fee_proportional_millionths: u32,
1459 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
1460 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
1461 /// `cltv_expiry_delta` for more details.
1462 pub cltv_expiry_delta: u16,
1465 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
1466 /// to better separate parameters.
1467 #[derive(Clone, Debug, PartialEq)]
1468 pub struct ChannelCounterparty {
1469 /// The node_id of our counterparty
1470 pub node_id: PublicKey,
1471 /// The Features the channel counterparty provided upon last connection.
1472 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
1473 /// many routing-relevant features are present in the init context.
1474 pub features: InitFeatures,
1475 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
1476 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
1477 /// claiming at least this value on chain.
1479 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
1481 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
1482 pub unspendable_punishment_reserve: u64,
1483 /// Information on the fees and requirements that the counterparty requires when forwarding
1484 /// payments to us through this channel.
1485 pub forwarding_info: Option<CounterpartyForwardingInfo>,
1486 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
1487 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
1488 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
1489 pub outbound_htlc_minimum_msat: Option<u64>,
1490 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
1491 pub outbound_htlc_maximum_msat: Option<u64>,
1494 /// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
1495 #[derive(Clone, Debug, PartialEq)]
1496 pub struct ChannelDetails {
1497 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
1498 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
1499 /// Note that this means this value is *not* persistent - it can change once during the
1500 /// lifetime of the channel.
1501 pub channel_id: ChannelId,
1502 /// Parameters which apply to our counterparty. See individual fields for more information.
1503 pub counterparty: ChannelCounterparty,
1504 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
1505 /// our counterparty already.
1507 /// Note that, if this has been set, `channel_id` will be equivalent to
1508 /// `funding_txo.unwrap().to_channel_id()`.
1509 pub funding_txo: Option<OutPoint>,
1510 /// The features which this channel operates with. See individual features for more info.
1512 /// `None` until negotiation completes and the channel type is finalized.
1513 pub channel_type: Option<ChannelTypeFeatures>,
1514 /// The position of the funding transaction in the chain. None if the funding transaction has
1515 /// not yet been confirmed and the channel fully opened.
1517 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1518 /// payments instead of this. See [`get_inbound_payment_scid`].
1520 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1521 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1523 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1524 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1525 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1526 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1527 /// [`confirmations_required`]: Self::confirmations_required
1528 pub short_channel_id: Option<u64>,
1529 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1530 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1531 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1534 /// This will be `None` as long as the channel is not available for routing outbound payments.
1536 /// [`short_channel_id`]: Self::short_channel_id
1537 /// [`confirmations_required`]: Self::confirmations_required
1538 pub outbound_scid_alias: Option<u64>,
1539 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1540 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1541 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1542 /// when they see a payment to be routed to us.
1544 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1545 /// previous values for inbound payment forwarding.
1547 /// [`short_channel_id`]: Self::short_channel_id
1548 pub inbound_scid_alias: Option<u64>,
1549 /// The value, in satoshis, of this channel as appears in the funding output
1550 pub channel_value_satoshis: u64,
1551 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1552 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1553 /// this value on chain.
1555 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1557 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1559 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1560 pub unspendable_punishment_reserve: Option<u64>,
1561 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
1562 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
1563 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
1564 /// `user_channel_id` will be randomized for an inbound channel. This may be zero for objects
1565 /// serialized with LDK versions prior to 0.0.113.
1567 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
1568 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
1569 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
1570 pub user_channel_id: u128,
1571 /// The currently negotiated fee rate denominated in satoshi per 1000 weight units,
1572 /// which is applied to commitment and HTLC transactions.
1574 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
1575 pub feerate_sat_per_1000_weight: Option<u32>,
1576 /// Our total balance. This is the amount we would get if we close the channel.
1577 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1578 /// amount is not likely to be recoverable on close.
1580 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1581 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1582 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1583 /// This does not consider any on-chain fees.
1585 /// See also [`ChannelDetails::outbound_capacity_msat`]
1586 pub balance_msat: u64,
1587 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1588 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1589 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1590 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1592 /// See also [`ChannelDetails::balance_msat`]
1594 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1595 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1596 /// should be able to spend nearly this amount.
1597 pub outbound_capacity_msat: u64,
1598 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1599 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1600 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1601 /// to use a limit as close as possible to the HTLC limit we can currently send.
1603 /// See also [`ChannelDetails::next_outbound_htlc_minimum_msat`],
1604 /// [`ChannelDetails::balance_msat`], and [`ChannelDetails::outbound_capacity_msat`].
1605 pub next_outbound_htlc_limit_msat: u64,
1606 /// The minimum value for sending a single HTLC to the remote peer. This is the equivalent of
1607 /// [`ChannelDetails::next_outbound_htlc_limit_msat`] but represents a lower-bound, rather than
1608 /// an upper-bound. This is intended for use when routing, allowing us to ensure we pick a
1609 /// route which is valid.
1610 pub next_outbound_htlc_minimum_msat: u64,
1611 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1612 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1613 /// available for inclusion in new inbound HTLCs).
1614 /// Note that there are some corner cases not fully handled here, so the actual available
1615 /// inbound capacity may be slightly higher than this.
1617 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1618 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1619 /// However, our counterparty should be able to spend nearly this amount.
1620 pub inbound_capacity_msat: u64,
1621 /// The number of required confirmations on the funding transaction before the funding will be
1622 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1623 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1624 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1625 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1627 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1629 /// [`is_outbound`]: ChannelDetails::is_outbound
1630 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1631 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1632 pub confirmations_required: Option<u32>,
1633 /// The current number of confirmations on the funding transaction.
1635 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1636 pub confirmations: Option<u32>,
1637 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1638 /// until we can claim our funds after we force-close the channel. During this time our
1639 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1640 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1641 /// time to claim our non-HTLC-encumbered funds.
1643 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1644 pub force_close_spend_delay: Option<u16>,
1645 /// True if the channel was initiated (and thus funded) by us.
1646 pub is_outbound: bool,
1647 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1648 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1649 /// required confirmation count has been reached (and we were connected to the peer at some
1650 /// point after the funding transaction received enough confirmations). The required
1651 /// confirmation count is provided in [`confirmations_required`].
1653 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1654 pub is_channel_ready: bool,
1655 /// The stage of the channel's shutdown.
1656 /// `None` for `ChannelDetails` serialized on LDK versions prior to 0.0.116.
1657 pub channel_shutdown_state: Option<ChannelShutdownState>,
1658 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1659 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1661 /// This is a strict superset of `is_channel_ready`.
1662 pub is_usable: bool,
1663 /// True if this channel is (or will be) publicly-announced.
1664 pub is_public: bool,
1665 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1666 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1667 pub inbound_htlc_minimum_msat: Option<u64>,
1668 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1669 pub inbound_htlc_maximum_msat: Option<u64>,
1670 /// Set of configurable parameters that affect channel operation.
1672 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1673 pub config: Option<ChannelConfig>,
1676 impl ChannelDetails {
1677 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1678 /// This should be used for providing invoice hints or in any other context where our
1679 /// counterparty will forward a payment to us.
1681 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1682 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1683 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1684 self.inbound_scid_alias.or(self.short_channel_id)
1687 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1688 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1689 /// we're sending or forwarding a payment outbound over this channel.
1691 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1692 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1693 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1694 self.short_channel_id.or(self.outbound_scid_alias)
1697 fn from_channel_context<SP: Deref, F: Deref>(
1698 context: &ChannelContext<SP>, best_block_height: u32, latest_features: InitFeatures,
1699 fee_estimator: &LowerBoundedFeeEstimator<F>
1702 SP::Target: SignerProvider,
1703 F::Target: FeeEstimator
1705 let balance = context.get_available_balances(fee_estimator);
1706 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1707 context.get_holder_counterparty_selected_channel_reserve_satoshis();
1709 channel_id: context.channel_id(),
1710 counterparty: ChannelCounterparty {
1711 node_id: context.get_counterparty_node_id(),
1712 features: latest_features,
1713 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1714 forwarding_info: context.counterparty_forwarding_info(),
1715 // Ensures that we have actually received the `htlc_minimum_msat` value
1716 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1717 // message (as they are always the first message from the counterparty).
1718 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1719 // default `0` value set by `Channel::new_outbound`.
1720 outbound_htlc_minimum_msat: if context.have_received_message() {
1721 Some(context.get_counterparty_htlc_minimum_msat()) } else { None },
1722 outbound_htlc_maximum_msat: context.get_counterparty_htlc_maximum_msat(),
1724 funding_txo: context.get_funding_txo(),
1725 // Note that accept_channel (or open_channel) is always the first message, so
1726 // `have_received_message` indicates that type negotiation has completed.
1727 channel_type: if context.have_received_message() { Some(context.get_channel_type().clone()) } else { None },
1728 short_channel_id: context.get_short_channel_id(),
1729 outbound_scid_alias: if context.is_usable() { Some(context.outbound_scid_alias()) } else { None },
1730 inbound_scid_alias: context.latest_inbound_scid_alias(),
1731 channel_value_satoshis: context.get_value_satoshis(),
1732 feerate_sat_per_1000_weight: Some(context.get_feerate_sat_per_1000_weight()),
1733 unspendable_punishment_reserve: to_self_reserve_satoshis,
1734 balance_msat: balance.balance_msat,
1735 inbound_capacity_msat: balance.inbound_capacity_msat,
1736 outbound_capacity_msat: balance.outbound_capacity_msat,
1737 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1738 next_outbound_htlc_minimum_msat: balance.next_outbound_htlc_minimum_msat,
1739 user_channel_id: context.get_user_id(),
1740 confirmations_required: context.minimum_depth(),
1741 confirmations: Some(context.get_funding_tx_confirmations(best_block_height)),
1742 force_close_spend_delay: context.get_counterparty_selected_contest_delay(),
1743 is_outbound: context.is_outbound(),
1744 is_channel_ready: context.is_usable(),
1745 is_usable: context.is_live(),
1746 is_public: context.should_announce(),
1747 inbound_htlc_minimum_msat: Some(context.get_holder_htlc_minimum_msat()),
1748 inbound_htlc_maximum_msat: context.get_holder_htlc_maximum_msat(),
1749 config: Some(context.config()),
1750 channel_shutdown_state: Some(context.shutdown_state()),
1755 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
1756 /// Further information on the details of the channel shutdown.
1757 /// Upon channels being forced closed (i.e. commitment transaction confirmation detected
1758 /// by `ChainMonitor`), ChannelShutdownState will be set to `ShutdownComplete` or
1759 /// the channel will be removed shortly.
1760 /// Also note, that in normal operation, peers could disconnect at any of these states
1761 /// and require peer re-connection before making progress onto other states
1762 pub enum ChannelShutdownState {
1763 /// Channel has not sent or received a shutdown message.
1765 /// Local node has sent a shutdown message for this channel.
1767 /// Shutdown message exchanges have concluded and the channels are in the midst of
1768 /// resolving all existing open HTLCs before closing can continue.
1770 /// All HTLCs have been resolved, nodes are currently negotiating channel close onchain fee rates.
1771 NegotiatingClosingFee,
1772 /// We've successfully negotiated a closing_signed dance. At this point `ChannelManager` is about
1773 /// to drop the channel.
1777 /// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
1778 /// These include payments that have yet to find a successful path, or have unresolved HTLCs.
1779 #[derive(Debug, PartialEq)]
1780 pub enum RecentPaymentDetails {
1781 /// When an invoice was requested and thus a payment has not yet been sent.
1783 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1784 /// a payment and ensure idempotency in LDK.
1785 payment_id: PaymentId,
1787 /// When a payment is still being sent and awaiting successful delivery.
1789 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1790 /// a payment and ensure idempotency in LDK.
1791 payment_id: PaymentId,
1792 /// Hash of the payment that is currently being sent but has yet to be fulfilled or
1794 payment_hash: PaymentHash,
1795 /// Total amount (in msat, excluding fees) across all paths for this payment,
1796 /// not just the amount currently inflight.
1799 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
1800 /// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
1801 /// payment is removed from tracking.
1803 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1804 /// a payment and ensure idempotency in LDK.
1805 payment_id: PaymentId,
1806 /// Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
1807 /// made before LDK version 0.0.104.
1808 payment_hash: Option<PaymentHash>,
1810 /// After a payment's retries are exhausted per the provided [`Retry`], or it is explicitly
1811 /// abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
1812 /// pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
1814 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1815 /// a payment and ensure idempotency in LDK.
1816 payment_id: PaymentId,
1817 /// Hash of the payment that we have given up trying to send.
1818 payment_hash: PaymentHash,
1822 /// Route hints used in constructing invoices for [phantom node payents].
1824 /// [phantom node payments]: crate::sign::PhantomKeysManager
1826 pub struct PhantomRouteHints {
1827 /// The list of channels to be included in the invoice route hints.
1828 pub channels: Vec<ChannelDetails>,
1829 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1831 pub phantom_scid: u64,
1832 /// The pubkey of the real backing node that would ultimately receive the payment.
1833 pub real_node_pubkey: PublicKey,
1836 macro_rules! handle_error {
1837 ($self: ident, $internal: expr, $counterparty_node_id: expr) => { {
1838 // In testing, ensure there are no deadlocks where the lock is already held upon
1839 // entering the macro.
1840 debug_assert_ne!($self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
1841 debug_assert_ne!($self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
1845 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish, channel_capacity }) => {
1846 let mut msg_events = Vec::with_capacity(2);
1848 if let Some((shutdown_res, update_option)) = shutdown_finish {
1849 $self.finish_close_channel(shutdown_res);
1850 if let Some(update) = update_option {
1851 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1855 if let Some((channel_id, user_channel_id)) = chan_id {
1856 $self.pending_events.lock().unwrap().push_back((events::Event::ChannelClosed {
1857 channel_id, user_channel_id,
1858 reason: ClosureReason::ProcessingError { err: err.err.clone() },
1859 counterparty_node_id: Some($counterparty_node_id),
1860 channel_capacity_sats: channel_capacity,
1865 log_error!($self.logger, "{}", err.err);
1866 if let msgs::ErrorAction::IgnoreError = err.action {
1868 msg_events.push(events::MessageSendEvent::HandleError {
1869 node_id: $counterparty_node_id,
1870 action: err.action.clone()
1874 if !msg_events.is_empty() {
1875 let per_peer_state = $self.per_peer_state.read().unwrap();
1876 if let Some(peer_state_mutex) = per_peer_state.get(&$counterparty_node_id) {
1877 let mut peer_state = peer_state_mutex.lock().unwrap();
1878 peer_state.pending_msg_events.append(&mut msg_events);
1882 // Return error in case higher-API need one
1887 ($self: ident, $internal: expr) => {
1890 Err((chan, msg_handle_err)) => {
1891 let counterparty_node_id = chan.get_counterparty_node_id();
1892 handle_error!($self, Err(msg_handle_err), counterparty_node_id).map_err(|err| (chan, err))
1898 macro_rules! update_maps_on_chan_removal {
1899 ($self: expr, $channel_context: expr) => {{
1900 $self.id_to_peer.lock().unwrap().remove(&$channel_context.channel_id());
1901 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1902 if let Some(short_id) = $channel_context.get_short_channel_id() {
1903 short_to_chan_info.remove(&short_id);
1905 // If the channel was never confirmed on-chain prior to its closure, remove the
1906 // outbound SCID alias we used for it from the collision-prevention set. While we
1907 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1908 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1909 // opening a million channels with us which are closed before we ever reach the funding
1911 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel_context.outbound_scid_alias());
1912 debug_assert!(alias_removed);
1914 short_to_chan_info.remove(&$channel_context.outbound_scid_alias());
1918 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1919 macro_rules! convert_chan_phase_err {
1920 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, MANUAL_CHANNEL_UPDATE, $channel_update: expr) => {
1922 ChannelError::Warn(msg) => {
1923 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), *$channel_id))
1925 ChannelError::Ignore(msg) => {
1926 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), *$channel_id))
1928 ChannelError::Close(msg) => {
1929 log_error!($self.logger, "Closing channel {} due to close-required error: {}", $channel_id, msg);
1930 update_maps_on_chan_removal!($self, $channel.context);
1931 let shutdown_res = $channel.context.force_shutdown(true);
1932 let user_id = $channel.context.get_user_id();
1933 let channel_capacity_satoshis = $channel.context.get_value_satoshis();
1935 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, user_id,
1936 shutdown_res, $channel_update, channel_capacity_satoshis))
1940 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, FUNDED_CHANNEL) => {
1941 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, { $self.get_channel_update_for_broadcast($channel).ok() })
1943 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, UNFUNDED_CHANNEL) => {
1944 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, None)
1946 ($self: ident, $err: expr, $channel_phase: expr, $channel_id: expr) => {
1947 match $channel_phase {
1948 ChannelPhase::Funded(channel) => {
1949 convert_chan_phase_err!($self, $err, channel, $channel_id, FUNDED_CHANNEL)
1951 ChannelPhase::UnfundedOutboundV1(channel) => {
1952 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
1954 ChannelPhase::UnfundedInboundV1(channel) => {
1955 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
1961 macro_rules! break_chan_phase_entry {
1962 ($self: ident, $res: expr, $entry: expr) => {
1966 let key = *$entry.key();
1967 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
1969 $entry.remove_entry();
1977 macro_rules! try_chan_phase_entry {
1978 ($self: ident, $res: expr, $entry: expr) => {
1982 let key = *$entry.key();
1983 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
1985 $entry.remove_entry();
1993 macro_rules! remove_channel_phase {
1994 ($self: expr, $entry: expr) => {
1996 let channel = $entry.remove_entry().1;
1997 update_maps_on_chan_removal!($self, &channel.context());
2003 macro_rules! send_channel_ready {
2004 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
2005 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
2006 node_id: $channel.context.get_counterparty_node_id(),
2007 msg: $channel_ready_msg,
2009 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
2010 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
2011 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
2012 let outbound_alias_insert = short_to_chan_info.insert($channel.context.outbound_scid_alias(), ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
2013 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
2014 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
2015 if let Some(real_scid) = $channel.context.get_short_channel_id() {
2016 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
2017 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
2018 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
2023 macro_rules! emit_channel_pending_event {
2024 ($locked_events: expr, $channel: expr) => {
2025 if $channel.context.should_emit_channel_pending_event() {
2026 $locked_events.push_back((events::Event::ChannelPending {
2027 channel_id: $channel.context.channel_id(),
2028 former_temporary_channel_id: $channel.context.temporary_channel_id(),
2029 counterparty_node_id: $channel.context.get_counterparty_node_id(),
2030 user_channel_id: $channel.context.get_user_id(),
2031 funding_txo: $channel.context.get_funding_txo().unwrap().into_bitcoin_outpoint(),
2033 $channel.context.set_channel_pending_event_emitted();
2038 macro_rules! emit_channel_ready_event {
2039 ($locked_events: expr, $channel: expr) => {
2040 if $channel.context.should_emit_channel_ready_event() {
2041 debug_assert!($channel.context.channel_pending_event_emitted());
2042 $locked_events.push_back((events::Event::ChannelReady {
2043 channel_id: $channel.context.channel_id(),
2044 user_channel_id: $channel.context.get_user_id(),
2045 counterparty_node_id: $channel.context.get_counterparty_node_id(),
2046 channel_type: $channel.context.get_channel_type().clone(),
2048 $channel.context.set_channel_ready_event_emitted();
2053 macro_rules! handle_monitor_update_completion {
2054 ($self: ident, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
2055 let mut updates = $chan.monitor_updating_restored(&$self.logger,
2056 &$self.node_signer, $self.chain_hash, &$self.default_configuration,
2057 $self.best_block.read().unwrap().height());
2058 let counterparty_node_id = $chan.context.get_counterparty_node_id();
2059 let channel_update = if updates.channel_ready.is_some() && $chan.context.is_usable() {
2060 // We only send a channel_update in the case where we are just now sending a
2061 // channel_ready and the channel is in a usable state. We may re-send a
2062 // channel_update later through the announcement_signatures process for public
2063 // channels, but there's no reason not to just inform our counterparty of our fees
2065 if let Ok(msg) = $self.get_channel_update_for_unicast($chan) {
2066 Some(events::MessageSendEvent::SendChannelUpdate {
2067 node_id: counterparty_node_id,
2073 let update_actions = $peer_state.monitor_update_blocked_actions
2074 .remove(&$chan.context.channel_id()).unwrap_or(Vec::new());
2076 let htlc_forwards = $self.handle_channel_resumption(
2077 &mut $peer_state.pending_msg_events, $chan, updates.raa,
2078 updates.commitment_update, updates.order, updates.accepted_htlcs,
2079 updates.funding_broadcastable, updates.channel_ready,
2080 updates.announcement_sigs);
2081 if let Some(upd) = channel_update {
2082 $peer_state.pending_msg_events.push(upd);
2085 let channel_id = $chan.context.channel_id();
2086 let unbroadcasted_batch_funding_txid = $chan.context.unbroadcasted_batch_funding_txid();
2087 core::mem::drop($peer_state_lock);
2088 core::mem::drop($per_peer_state_lock);
2090 // If the channel belongs to a batch funding transaction, the progress of the batch
2091 // should be updated as we have received funding_signed and persisted the monitor.
2092 if let Some(txid) = unbroadcasted_batch_funding_txid {
2093 let mut funding_batch_states = $self.funding_batch_states.lock().unwrap();
2094 let mut batch_completed = false;
2095 if let Some(batch_state) = funding_batch_states.get_mut(&txid) {
2096 let channel_state = batch_state.iter_mut().find(|(chan_id, pubkey, _)| (
2097 *chan_id == channel_id &&
2098 *pubkey == counterparty_node_id
2100 if let Some(channel_state) = channel_state {
2101 channel_state.2 = true;
2103 debug_assert!(false, "Missing channel batch state for channel which completed initial monitor update");
2105 batch_completed = batch_state.iter().all(|(_, _, completed)| *completed);
2107 debug_assert!(false, "Missing batch state for channel which completed initial monitor update");
2110 // When all channels in a batched funding transaction have become ready, it is not necessary
2111 // to track the progress of the batch anymore and the state of the channels can be updated.
2112 if batch_completed {
2113 let removed_batch_state = funding_batch_states.remove(&txid).into_iter().flatten();
2114 let per_peer_state = $self.per_peer_state.read().unwrap();
2115 let mut batch_funding_tx = None;
2116 for (channel_id, counterparty_node_id, _) in removed_batch_state {
2117 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2118 let mut peer_state = peer_state_mutex.lock().unwrap();
2119 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
2120 batch_funding_tx = batch_funding_tx.or_else(|| chan.context.unbroadcasted_funding());
2121 chan.set_batch_ready();
2122 let mut pending_events = $self.pending_events.lock().unwrap();
2123 emit_channel_pending_event!(pending_events, chan);
2127 if let Some(tx) = batch_funding_tx {
2128 log_info!($self.logger, "Broadcasting batch funding transaction with txid {}", tx.txid());
2129 $self.tx_broadcaster.broadcast_transactions(&[&tx]);
2134 $self.handle_monitor_update_completion_actions(update_actions);
2136 if let Some(forwards) = htlc_forwards {
2137 $self.forward_htlcs(&mut [forwards][..]);
2139 $self.finalize_claims(updates.finalized_claimed_htlcs);
2140 for failure in updates.failed_htlcs.drain(..) {
2141 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2142 $self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
2147 macro_rules! handle_new_monitor_update {
2148 ($self: ident, $update_res: expr, $chan: expr, _internal, $completed: expr) => { {
2149 debug_assert!($self.background_events_processed_since_startup.load(Ordering::Acquire));
2151 ChannelMonitorUpdateStatus::UnrecoverableError => {
2152 let err_str = "ChannelMonitor[Update] persistence failed unrecoverably. This indicates we cannot continue normal operation and must shut down.";
2153 log_error!($self.logger, "{}", err_str);
2154 panic!("{}", err_str);
2156 ChannelMonitorUpdateStatus::InProgress => {
2157 log_debug!($self.logger, "ChannelMonitor update for {} in flight, holding messages until the update completes.",
2158 &$chan.context.channel_id());
2161 ChannelMonitorUpdateStatus::Completed => {
2167 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr, INITIAL_MONITOR) => {
2168 handle_new_monitor_update!($self, $update_res, $chan, _internal,
2169 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan))
2171 ($self: ident, $funding_txo: expr, $update: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
2172 let in_flight_updates = $peer_state.in_flight_monitor_updates.entry($funding_txo)
2173 .or_insert_with(Vec::new);
2174 // During startup, we push monitor updates as background events through to here in
2175 // order to replay updates that were in-flight when we shut down. Thus, we have to
2176 // filter for uniqueness here.
2177 let idx = in_flight_updates.iter().position(|upd| upd == &$update)
2178 .unwrap_or_else(|| {
2179 in_flight_updates.push($update);
2180 in_flight_updates.len() - 1
2182 let update_res = $self.chain_monitor.update_channel($funding_txo, &in_flight_updates[idx]);
2183 handle_new_monitor_update!($self, update_res, $chan, _internal,
2185 let _ = in_flight_updates.remove(idx);
2186 if in_flight_updates.is_empty() && $chan.blocked_monitor_updates_pending() == 0 {
2187 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan);
2193 macro_rules! process_events_body {
2194 ($self: expr, $event_to_handle: expr, $handle_event: expr) => {
2195 let mut processed_all_events = false;
2196 while !processed_all_events {
2197 if $self.pending_events_processor.compare_exchange(false, true, Ordering::Acquire, Ordering::Relaxed).is_err() {
2204 // We'll acquire our total consistency lock so that we can be sure no other
2205 // persists happen while processing monitor events.
2206 let _read_guard = $self.total_consistency_lock.read().unwrap();
2208 // Because `handle_post_event_actions` may send `ChannelMonitorUpdate`s to the user we must
2209 // ensure any startup-generated background events are handled first.
2210 result = $self.process_background_events();
2212 // TODO: This behavior should be documented. It's unintuitive that we query
2213 // ChannelMonitors when clearing other events.
2214 if $self.process_pending_monitor_events() {
2215 result = NotifyOption::DoPersist;
2219 let pending_events = $self.pending_events.lock().unwrap().clone();
2220 let num_events = pending_events.len();
2221 if !pending_events.is_empty() {
2222 result = NotifyOption::DoPersist;
2225 let mut post_event_actions = Vec::new();
2227 for (event, action_opt) in pending_events {
2228 $event_to_handle = event;
2230 if let Some(action) = action_opt {
2231 post_event_actions.push(action);
2236 let mut pending_events = $self.pending_events.lock().unwrap();
2237 pending_events.drain(..num_events);
2238 processed_all_events = pending_events.is_empty();
2239 // Note that `push_pending_forwards_ev` relies on `pending_events_processor` being
2240 // updated here with the `pending_events` lock acquired.
2241 $self.pending_events_processor.store(false, Ordering::Release);
2244 if !post_event_actions.is_empty() {
2245 $self.handle_post_event_actions(post_event_actions);
2246 // If we had some actions, go around again as we may have more events now
2247 processed_all_events = false;
2251 NotifyOption::DoPersist => {
2252 $self.needs_persist_flag.store(true, Ordering::Release);
2253 $self.event_persist_notifier.notify();
2255 NotifyOption::SkipPersistHandleEvents =>
2256 $self.event_persist_notifier.notify(),
2257 NotifyOption::SkipPersistNoEvents => {},
2263 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>
2265 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
2266 T::Target: BroadcasterInterface,
2267 ES::Target: EntropySource,
2268 NS::Target: NodeSigner,
2269 SP::Target: SignerProvider,
2270 F::Target: FeeEstimator,
2274 /// Constructs a new `ChannelManager` to hold several channels and route between them.
2276 /// The current time or latest block header time can be provided as the `current_timestamp`.
2278 /// This is the main "logic hub" for all channel-related actions, and implements
2279 /// [`ChannelMessageHandler`].
2281 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
2283 /// Users need to notify the new `ChannelManager` when a new block is connected or
2284 /// disconnected using its [`block_connected`] and [`block_disconnected`] methods, starting
2285 /// from after [`params.best_block.block_hash`]. See [`chain::Listen`] and [`chain::Confirm`] for
2288 /// [`block_connected`]: chain::Listen::block_connected
2289 /// [`block_disconnected`]: chain::Listen::block_disconnected
2290 /// [`params.best_block.block_hash`]: chain::BestBlock::block_hash
2292 fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, entropy_source: ES,
2293 node_signer: NS, signer_provider: SP, config: UserConfig, params: ChainParameters,
2294 current_timestamp: u32,
2296 let mut secp_ctx = Secp256k1::new();
2297 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
2298 let inbound_pmt_key_material = node_signer.get_inbound_payment_key_material();
2299 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
2301 default_configuration: config.clone(),
2302 chain_hash: ChainHash::using_genesis_block(params.network),
2303 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
2308 best_block: RwLock::new(params.best_block),
2310 outbound_scid_aliases: Mutex::new(HashSet::new()),
2311 pending_inbound_payments: Mutex::new(HashMap::new()),
2312 pending_outbound_payments: OutboundPayments::new(),
2313 forward_htlcs: Mutex::new(HashMap::new()),
2314 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments: HashMap::new(), pending_claiming_payments: HashMap::new() }),
2315 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
2316 id_to_peer: Mutex::new(HashMap::new()),
2317 short_to_chan_info: FairRwLock::new(HashMap::new()),
2319 our_network_pubkey: node_signer.get_node_id(Recipient::Node).unwrap(),
2322 inbound_payment_key: expanded_inbound_key,
2323 fake_scid_rand_bytes: entropy_source.get_secure_random_bytes(),
2325 probing_cookie_secret: entropy_source.get_secure_random_bytes(),
2327 highest_seen_timestamp: AtomicUsize::new(current_timestamp as usize),
2329 per_peer_state: FairRwLock::new(HashMap::new()),
2331 pending_events: Mutex::new(VecDeque::new()),
2332 pending_events_processor: AtomicBool::new(false),
2333 pending_background_events: Mutex::new(Vec::new()),
2334 total_consistency_lock: RwLock::new(()),
2335 background_events_processed_since_startup: AtomicBool::new(false),
2336 event_persist_notifier: Notifier::new(),
2337 needs_persist_flag: AtomicBool::new(false),
2338 funding_batch_states: Mutex::new(BTreeMap::new()),
2340 pending_offers_messages: Mutex::new(Vec::new()),
2350 /// Gets the current configuration applied to all new channels.
2351 pub fn get_current_default_configuration(&self) -> &UserConfig {
2352 &self.default_configuration
2355 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
2356 let height = self.best_block.read().unwrap().height();
2357 let mut outbound_scid_alias = 0;
2360 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
2361 outbound_scid_alias += 1;
2363 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
2365 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
2369 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"); }
2374 /// Creates a new outbound channel to the given remote node and with the given value.
2376 /// `user_channel_id` will be provided back as in
2377 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
2378 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
2379 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
2380 /// is simply copied to events and otherwise ignored.
2382 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
2383 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
2385 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be opened due to failing to
2386 /// generate a shutdown scriptpubkey or destination script set by
2387 /// [`SignerProvider::get_shutdown_scriptpubkey`] or [`SignerProvider::get_destination_script`].
2389 /// Note that we do not check if you are currently connected to the given peer. If no
2390 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
2391 /// the channel eventually being silently forgotten (dropped on reload).
2393 /// If `temporary_channel_id` is specified, it will be used as the temporary channel ID of the
2394 /// channel. Otherwise, a random one will be generated for you.
2396 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
2397 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
2398 /// [`ChannelDetails::channel_id`] until after
2399 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
2400 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
2401 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
2403 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
2404 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
2405 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
2406 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> {
2407 if channel_value_satoshis < 1000 {
2408 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
2411 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2412 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
2413 debug_assert!(&self.total_consistency_lock.try_write().is_err());
2415 let per_peer_state = self.per_peer_state.read().unwrap();
2417 let peer_state_mutex = per_peer_state.get(&their_network_key)
2418 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Not connected to node: {}", their_network_key) })?;
2420 let mut peer_state = peer_state_mutex.lock().unwrap();
2422 if let Some(temporary_channel_id) = temporary_channel_id {
2423 if peer_state.channel_by_id.contains_key(&temporary_channel_id) {
2424 return Err(APIError::APIMisuseError{ err: format!("Channel with temporary channel ID {} already exists!", temporary_channel_id)});
2429 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
2430 let their_features = &peer_state.latest_features;
2431 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
2432 match OutboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider, their_network_key,
2433 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
2434 self.best_block.read().unwrap().height(), outbound_scid_alias, temporary_channel_id)
2438 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
2443 let res = channel.get_open_channel(self.chain_hash);
2445 let temporary_channel_id = channel.context.channel_id();
2446 match peer_state.channel_by_id.entry(temporary_channel_id) {
2447 hash_map::Entry::Occupied(_) => {
2449 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
2451 panic!("RNG is bad???");
2454 hash_map::Entry::Vacant(entry) => { entry.insert(ChannelPhase::UnfundedOutboundV1(channel)); }
2457 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
2458 node_id: their_network_key,
2461 Ok(temporary_channel_id)
2464 fn list_funded_channels_with_filter<Fn: FnMut(&(&ChannelId, &Channel<SP>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
2465 // Allocate our best estimate of the number of channels we have in the `res`
2466 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2467 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2468 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2469 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2470 // the same channel.
2471 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2473 let best_block_height = self.best_block.read().unwrap().height();
2474 let per_peer_state = self.per_peer_state.read().unwrap();
2475 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2476 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2477 let peer_state = &mut *peer_state_lock;
2478 res.extend(peer_state.channel_by_id.iter()
2479 .filter_map(|(chan_id, phase)| match phase {
2480 // Only `Channels` in the `ChannelPhase::Funded` phase can be considered funded.
2481 ChannelPhase::Funded(chan) => Some((chan_id, chan)),
2485 .map(|(_channel_id, channel)| {
2486 ChannelDetails::from_channel_context(&channel.context, best_block_height,
2487 peer_state.latest_features.clone(), &self.fee_estimator)
2495 /// Gets the list of open channels, in random order. See [`ChannelDetails`] field documentation for
2496 /// more information.
2497 pub fn list_channels(&self) -> Vec<ChannelDetails> {
2498 // Allocate our best estimate of the number of channels we have in the `res`
2499 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2500 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2501 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2502 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2503 // the same channel.
2504 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2506 let best_block_height = self.best_block.read().unwrap().height();
2507 let per_peer_state = self.per_peer_state.read().unwrap();
2508 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2509 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2510 let peer_state = &mut *peer_state_lock;
2511 for context in peer_state.channel_by_id.iter().map(|(_, phase)| phase.context()) {
2512 let details = ChannelDetails::from_channel_context(context, best_block_height,
2513 peer_state.latest_features.clone(), &self.fee_estimator);
2521 /// Gets the list of usable channels, in random order. Useful as an argument to
2522 /// [`Router::find_route`] to ensure non-announced channels are used.
2524 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
2525 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
2527 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
2528 // Note we use is_live here instead of usable which leads to somewhat confused
2529 // internal/external nomenclature, but that's ok cause that's probably what the user
2530 // really wanted anyway.
2531 self.list_funded_channels_with_filter(|&(_, ref channel)| channel.context.is_live())
2534 /// Gets the list of channels we have with a given counterparty, in random order.
2535 pub fn list_channels_with_counterparty(&self, counterparty_node_id: &PublicKey) -> Vec<ChannelDetails> {
2536 let best_block_height = self.best_block.read().unwrap().height();
2537 let per_peer_state = self.per_peer_state.read().unwrap();
2539 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
2540 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2541 let peer_state = &mut *peer_state_lock;
2542 let features = &peer_state.latest_features;
2543 let context_to_details = |context| {
2544 ChannelDetails::from_channel_context(context, best_block_height, features.clone(), &self.fee_estimator)
2546 return peer_state.channel_by_id
2548 .map(|(_, phase)| phase.context())
2549 .map(context_to_details)
2555 /// Returns in an undefined order recent payments that -- if not fulfilled -- have yet to find a
2556 /// successful path, or have unresolved HTLCs.
2558 /// This can be useful for payments that may have been prepared, but ultimately not sent, as a
2559 /// result of a crash. If such a payment exists, is not listed here, and an
2560 /// [`Event::PaymentSent`] has not been received, you may consider resending the payment.
2562 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2563 pub fn list_recent_payments(&self) -> Vec<RecentPaymentDetails> {
2564 self.pending_outbound_payments.pending_outbound_payments.lock().unwrap().iter()
2565 .filter_map(|(payment_id, pending_outbound_payment)| match pending_outbound_payment {
2566 PendingOutboundPayment::AwaitingInvoice { .. } => {
2567 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2569 // InvoiceReceived is an intermediate state and doesn't need to be exposed
2570 PendingOutboundPayment::InvoiceReceived { .. } => {
2571 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2573 PendingOutboundPayment::Retryable { payment_hash, total_msat, .. } => {
2574 Some(RecentPaymentDetails::Pending {
2575 payment_id: *payment_id,
2576 payment_hash: *payment_hash,
2577 total_msat: *total_msat,
2580 PendingOutboundPayment::Abandoned { payment_hash, .. } => {
2581 Some(RecentPaymentDetails::Abandoned { payment_id: *payment_id, payment_hash: *payment_hash })
2583 PendingOutboundPayment::Fulfilled { payment_hash, .. } => {
2584 Some(RecentPaymentDetails::Fulfilled { payment_id: *payment_id, payment_hash: *payment_hash })
2586 PendingOutboundPayment::Legacy { .. } => None
2591 /// Helper function that issues the channel close events
2592 fn issue_channel_close_events(&self, context: &ChannelContext<SP>, closure_reason: ClosureReason) {
2593 let mut pending_events_lock = self.pending_events.lock().unwrap();
2594 match context.unbroadcasted_funding() {
2595 Some(transaction) => {
2596 pending_events_lock.push_back((events::Event::DiscardFunding {
2597 channel_id: context.channel_id(), transaction
2602 pending_events_lock.push_back((events::Event::ChannelClosed {
2603 channel_id: context.channel_id(),
2604 user_channel_id: context.get_user_id(),
2605 reason: closure_reason,
2606 counterparty_node_id: Some(context.get_counterparty_node_id()),
2607 channel_capacity_sats: Some(context.get_value_satoshis()),
2611 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> {
2612 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2614 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
2615 let shutdown_result;
2617 let per_peer_state = self.per_peer_state.read().unwrap();
2619 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2620 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2622 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2623 let peer_state = &mut *peer_state_lock;
2625 match peer_state.channel_by_id.entry(channel_id.clone()) {
2626 hash_map::Entry::Occupied(mut chan_phase_entry) => {
2627 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
2628 let funding_txo_opt = chan.context.get_funding_txo();
2629 let their_features = &peer_state.latest_features;
2630 let (shutdown_msg, mut monitor_update_opt, htlcs, local_shutdown_result) =
2631 chan.get_shutdown(&self.signer_provider, their_features, target_feerate_sats_per_1000_weight, override_shutdown_script)?;
2632 failed_htlcs = htlcs;
2633 shutdown_result = local_shutdown_result;
2634 debug_assert_eq!(shutdown_result.is_some(), chan.is_shutdown());
2636 // We can send the `shutdown` message before updating the `ChannelMonitor`
2637 // here as we don't need the monitor update to complete until we send a
2638 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
2639 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2640 node_id: *counterparty_node_id,
2644 debug_assert!(monitor_update_opt.is_none() || !chan.is_shutdown(),
2645 "We can't both complete shutdown and generate a monitor update");
2647 // Update the monitor with the shutdown script if necessary.
2648 if let Some(monitor_update) = monitor_update_opt.take() {
2649 handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
2650 peer_state_lock, peer_state, per_peer_state, chan);
2654 if chan.is_shutdown() {
2655 if let ChannelPhase::Funded(chan) = remove_channel_phase!(self, chan_phase_entry) {
2656 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&chan) {
2657 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2661 self.issue_channel_close_events(&chan.context, ClosureReason::HolderForceClosed);
2667 hash_map::Entry::Vacant(_) => {
2668 // If we reach this point, it means that the channel_id either refers to an unfunded channel or
2669 // it does not exist for this peer. Either way, we can attempt to force-close it.
2671 // An appropriate error will be returned for non-existence of the channel if that's the case.
2672 mem::drop(peer_state_lock);
2673 mem::drop(per_peer_state);
2674 return self.force_close_channel_with_peer(&channel_id, counterparty_node_id, None, false).map(|_| ())
2679 for htlc_source in failed_htlcs.drain(..) {
2680 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2681 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
2682 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
2685 if let Some(shutdown_result) = shutdown_result {
2686 self.finish_close_channel(shutdown_result);
2692 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2693 /// will be accepted on the given channel, and after additional timeout/the closing of all
2694 /// pending HTLCs, the channel will be closed on chain.
2696 /// * If we are the channel initiator, we will pay between our [`ChannelCloseMinimum`] and
2697 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`NonAnchorChannelFee`]
2699 /// * If our counterparty is the channel initiator, we will require a channel closing
2700 /// transaction feerate of at least our [`ChannelCloseMinimum`] feerate or the feerate which
2701 /// would appear on a force-closure transaction, whichever is lower. We will allow our
2702 /// counterparty to pay as much fee as they'd like, however.
2704 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2706 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2707 /// generate a shutdown scriptpubkey or destination script set by
2708 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2711 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2712 /// [`ChannelCloseMinimum`]: crate::chain::chaininterface::ConfirmationTarget::ChannelCloseMinimum
2713 /// [`NonAnchorChannelFee`]: crate::chain::chaininterface::ConfirmationTarget::NonAnchorChannelFee
2714 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2715 pub fn close_channel(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey) -> Result<(), APIError> {
2716 self.close_channel_internal(channel_id, counterparty_node_id, None, None)
2719 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2720 /// will be accepted on the given channel, and after additional timeout/the closing of all
2721 /// pending HTLCs, the channel will be closed on chain.
2723 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
2724 /// the channel being closed or not:
2725 /// * If we are the channel initiator, we will pay at least this feerate on the closing
2726 /// transaction. The upper-bound is set by
2727 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`NonAnchorChannelFee`]
2728 /// fee estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
2729 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
2730 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
2731 /// will appear on a force-closure transaction, whichever is lower).
2733 /// The `shutdown_script` provided will be used as the `scriptPubKey` for the closing transaction.
2734 /// Will fail if a shutdown script has already been set for this channel by
2735 /// ['ChannelHandshakeConfig::commit_upfront_shutdown_pubkey`]. The given shutdown script must
2736 /// also be compatible with our and the counterparty's features.
2738 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2740 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2741 /// generate a shutdown scriptpubkey or destination script set by
2742 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2745 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2746 /// [`NonAnchorChannelFee`]: crate::chain::chaininterface::ConfirmationTarget::NonAnchorChannelFee
2747 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2748 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> {
2749 self.close_channel_internal(channel_id, counterparty_node_id, target_feerate_sats_per_1000_weight, shutdown_script)
2752 fn finish_close_channel(&self, mut shutdown_res: ShutdownResult) {
2753 debug_assert_ne!(self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
2754 #[cfg(debug_assertions)]
2755 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
2756 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
2759 log_debug!(self.logger, "Finishing closure of channel with {} HTLCs to fail", shutdown_res.dropped_outbound_htlcs.len());
2760 for htlc_source in shutdown_res.dropped_outbound_htlcs.drain(..) {
2761 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
2762 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2763 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2764 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
2766 if let Some((_, funding_txo, monitor_update)) = shutdown_res.monitor_update {
2767 // There isn't anything we can do if we get an update failure - we're already
2768 // force-closing. The monitor update on the required in-memory copy should broadcast
2769 // the latest local state, which is the best we can do anyway. Thus, it is safe to
2770 // ignore the result here.
2771 let _ = self.chain_monitor.update_channel(funding_txo, &monitor_update);
2773 let mut shutdown_results = Vec::new();
2774 if let Some(txid) = shutdown_res.unbroadcasted_batch_funding_txid {
2775 let mut funding_batch_states = self.funding_batch_states.lock().unwrap();
2776 let affected_channels = funding_batch_states.remove(&txid).into_iter().flatten();
2777 let per_peer_state = self.per_peer_state.read().unwrap();
2778 let mut has_uncompleted_channel = None;
2779 for (channel_id, counterparty_node_id, state) in affected_channels {
2780 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2781 let mut peer_state = peer_state_mutex.lock().unwrap();
2782 if let Some(mut chan) = peer_state.channel_by_id.remove(&channel_id) {
2783 update_maps_on_chan_removal!(self, &chan.context());
2784 self.issue_channel_close_events(&chan.context(), ClosureReason::FundingBatchClosure);
2785 shutdown_results.push(chan.context_mut().force_shutdown(false));
2788 has_uncompleted_channel = Some(has_uncompleted_channel.map_or(!state, |v| v || !state));
2791 has_uncompleted_channel.unwrap_or(true),
2792 "Closing a batch where all channels have completed initial monitor update",
2795 for shutdown_result in shutdown_results.drain(..) {
2796 self.finish_close_channel(shutdown_result);
2800 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
2801 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
2802 fn force_close_channel_with_peer(&self, channel_id: &ChannelId, peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
2803 -> Result<PublicKey, APIError> {
2804 let per_peer_state = self.per_peer_state.read().unwrap();
2805 let peer_state_mutex = per_peer_state.get(peer_node_id)
2806 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", peer_node_id) })?;
2807 let (update_opt, counterparty_node_id) = {
2808 let mut peer_state = peer_state_mutex.lock().unwrap();
2809 let closure_reason = if let Some(peer_msg) = peer_msg {
2810 ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(peer_msg.to_string()) }
2812 ClosureReason::HolderForceClosed
2814 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(channel_id.clone()) {
2815 log_error!(self.logger, "Force-closing channel {}", channel_id);
2816 self.issue_channel_close_events(&chan_phase_entry.get().context(), closure_reason);
2817 let mut chan_phase = remove_channel_phase!(self, chan_phase_entry);
2818 mem::drop(peer_state);
2819 mem::drop(per_peer_state);
2821 ChannelPhase::Funded(mut chan) => {
2822 self.finish_close_channel(chan.context.force_shutdown(broadcast));
2823 (self.get_channel_update_for_broadcast(&chan).ok(), chan.context.get_counterparty_node_id())
2825 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => {
2826 self.finish_close_channel(chan_phase.context_mut().force_shutdown(false));
2827 // Unfunded channel has no update
2828 (None, chan_phase.context().get_counterparty_node_id())
2831 } else if peer_state.inbound_channel_request_by_id.remove(channel_id).is_some() {
2832 log_error!(self.logger, "Force-closing channel {}", &channel_id);
2833 // N.B. that we don't send any channel close event here: we
2834 // don't have a user_channel_id, and we never sent any opening
2836 (None, *peer_node_id)
2838 return Err(APIError::ChannelUnavailable{ err: format!("Channel with id {} not found for the passed counterparty node_id {}", channel_id, peer_node_id) });
2841 if let Some(update) = update_opt {
2842 // Try to send the `BroadcastChannelUpdate` to the peer we just force-closed on, but if
2843 // not try to broadcast it via whatever peer we have.
2844 let per_peer_state = self.per_peer_state.read().unwrap();
2845 let a_peer_state_opt = per_peer_state.get(peer_node_id)
2846 .ok_or(per_peer_state.values().next());
2847 if let Ok(a_peer_state_mutex) = a_peer_state_opt {
2848 let mut a_peer_state = a_peer_state_mutex.lock().unwrap();
2849 a_peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2855 Ok(counterparty_node_id)
2858 fn force_close_sending_error(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
2859 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2860 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
2861 Ok(counterparty_node_id) => {
2862 let per_peer_state = self.per_peer_state.read().unwrap();
2863 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2864 let mut peer_state = peer_state_mutex.lock().unwrap();
2865 peer_state.pending_msg_events.push(
2866 events::MessageSendEvent::HandleError {
2867 node_id: counterparty_node_id,
2868 action: msgs::ErrorAction::DisconnectPeer {
2869 msg: Some(msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() })
2880 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
2881 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
2882 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
2884 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
2885 -> Result<(), APIError> {
2886 self.force_close_sending_error(channel_id, counterparty_node_id, true)
2889 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
2890 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
2891 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
2893 /// You can always get the latest local transaction(s) to broadcast from
2894 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
2895 pub fn force_close_without_broadcasting_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
2896 -> Result<(), APIError> {
2897 self.force_close_sending_error(channel_id, counterparty_node_id, false)
2900 /// Force close all channels, immediately broadcasting the latest local commitment transaction
2901 /// for each to the chain and rejecting new HTLCs on each.
2902 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
2903 for chan in self.list_channels() {
2904 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
2908 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
2909 /// local transaction(s).
2910 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
2911 for chan in self.list_channels() {
2912 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
2916 fn construct_fwd_pending_htlc_info(
2917 &self, msg: &msgs::UpdateAddHTLC, hop_data: msgs::InboundOnionPayload, hop_hmac: [u8; 32],
2918 new_packet_bytes: [u8; onion_utils::ONION_DATA_LEN], shared_secret: [u8; 32],
2919 next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
2920 ) -> Result<PendingHTLCInfo, InboundOnionErr> {
2921 debug_assert!(next_packet_pubkey_opt.is_some());
2922 let outgoing_packet = msgs::OnionPacket {
2924 public_key: next_packet_pubkey_opt.unwrap_or(Err(secp256k1::Error::InvalidPublicKey)),
2925 hop_data: new_packet_bytes,
2929 let (short_channel_id, amt_to_forward, outgoing_cltv_value) = match hop_data {
2930 msgs::InboundOnionPayload::Forward { short_channel_id, amt_to_forward, outgoing_cltv_value } =>
2931 (short_channel_id, amt_to_forward, outgoing_cltv_value),
2932 msgs::InboundOnionPayload::Receive { .. } | msgs::InboundOnionPayload::BlindedReceive { .. } =>
2933 return Err(InboundOnionErr {
2934 msg: "Final Node OnionHopData provided for us as an intermediary node",
2935 err_code: 0x4000 | 22,
2936 err_data: Vec::new(),
2940 Ok(PendingHTLCInfo {
2941 routing: PendingHTLCRouting::Forward {
2942 onion_packet: outgoing_packet,
2945 payment_hash: msg.payment_hash,
2946 incoming_shared_secret: shared_secret,
2947 incoming_amt_msat: Some(msg.amount_msat),
2948 outgoing_amt_msat: amt_to_forward,
2949 outgoing_cltv_value,
2950 skimmed_fee_msat: None,
2954 fn construct_recv_pending_htlc_info(
2955 &self, hop_data: msgs::InboundOnionPayload, shared_secret: [u8; 32], payment_hash: PaymentHash,
2956 amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>, allow_underpay: bool,
2957 counterparty_skimmed_fee_msat: Option<u64>,
2958 ) -> Result<PendingHTLCInfo, InboundOnionErr> {
2959 let (payment_data, keysend_preimage, custom_tlvs, onion_amt_msat, outgoing_cltv_value, payment_metadata) = match hop_data {
2960 msgs::InboundOnionPayload::Receive {
2961 payment_data, keysend_preimage, custom_tlvs, amt_msat, outgoing_cltv_value, payment_metadata, ..
2963 (payment_data, keysend_preimage, custom_tlvs, amt_msat, outgoing_cltv_value, payment_metadata),
2964 msgs::InboundOnionPayload::BlindedReceive {
2965 amt_msat, total_msat, outgoing_cltv_value, payment_secret, ..
2967 let payment_data = msgs::FinalOnionHopData { payment_secret, total_msat };
2968 (Some(payment_data), None, Vec::new(), amt_msat, outgoing_cltv_value, None)
2970 msgs::InboundOnionPayload::Forward { .. } => {
2971 return Err(InboundOnionErr {
2972 err_code: 0x4000|22,
2973 err_data: Vec::new(),
2974 msg: "Got non final data with an HMAC of 0",
2978 // final_incorrect_cltv_expiry
2979 if outgoing_cltv_value > cltv_expiry {
2980 return Err(InboundOnionErr {
2981 msg: "Upstream node set CLTV to less than the CLTV set by the sender",
2983 err_data: cltv_expiry.to_be_bytes().to_vec()
2986 // final_expiry_too_soon
2987 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
2988 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
2990 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
2991 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
2992 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
2993 let current_height: u32 = self.best_block.read().unwrap().height();
2994 if cltv_expiry <= current_height + HTLC_FAIL_BACK_BUFFER + 1 {
2995 let mut err_data = Vec::with_capacity(12);
2996 err_data.extend_from_slice(&amt_msat.to_be_bytes());
2997 err_data.extend_from_slice(¤t_height.to_be_bytes());
2998 return Err(InboundOnionErr {
2999 err_code: 0x4000 | 15, err_data,
3000 msg: "The final CLTV expiry is too soon to handle",
3003 if (!allow_underpay && onion_amt_msat > amt_msat) ||
3004 (allow_underpay && onion_amt_msat >
3005 amt_msat.saturating_add(counterparty_skimmed_fee_msat.unwrap_or(0)))
3007 return Err(InboundOnionErr {
3009 err_data: amt_msat.to_be_bytes().to_vec(),
3010 msg: "Upstream node sent less than we were supposed to receive in payment",
3014 let routing = if let Some(payment_preimage) = keysend_preimage {
3015 // We need to check that the sender knows the keysend preimage before processing this
3016 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
3017 // could discover the final destination of X, by probing the adjacent nodes on the route
3018 // with a keysend payment of identical payment hash to X and observing the processing
3019 // time discrepancies due to a hash collision with X.
3020 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
3021 if hashed_preimage != payment_hash {
3022 return Err(InboundOnionErr {
3023 err_code: 0x4000|22,
3024 err_data: Vec::new(),
3025 msg: "Payment preimage didn't match payment hash",
3028 if !self.default_configuration.accept_mpp_keysend && payment_data.is_some() {
3029 return Err(InboundOnionErr {
3030 err_code: 0x4000|22,
3031 err_data: Vec::new(),
3032 msg: "We don't support MPP keysend payments",
3035 PendingHTLCRouting::ReceiveKeysend {
3039 incoming_cltv_expiry: outgoing_cltv_value,
3042 } else if let Some(data) = payment_data {
3043 PendingHTLCRouting::Receive {
3046 incoming_cltv_expiry: outgoing_cltv_value,
3047 phantom_shared_secret,
3051 return Err(InboundOnionErr {
3052 err_code: 0x4000|0x2000|3,
3053 err_data: Vec::new(),
3054 msg: "We require payment_secrets",
3057 Ok(PendingHTLCInfo {
3060 incoming_shared_secret: shared_secret,
3061 incoming_amt_msat: Some(amt_msat),
3062 outgoing_amt_msat: onion_amt_msat,
3063 outgoing_cltv_value,
3064 skimmed_fee_msat: counterparty_skimmed_fee_msat,
3068 fn decode_update_add_htlc_onion(
3069 &self, msg: &msgs::UpdateAddHTLC
3070 ) -> Result<(onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg> {
3071 macro_rules! return_malformed_err {
3072 ($msg: expr, $err_code: expr) => {
3074 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3075 return Err(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
3076 channel_id: msg.channel_id,
3077 htlc_id: msg.htlc_id,
3078 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
3079 failure_code: $err_code,
3085 if let Err(_) = msg.onion_routing_packet.public_key {
3086 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
3089 let shared_secret = self.node_signer.ecdh(
3090 Recipient::Node, &msg.onion_routing_packet.public_key.unwrap(), None
3091 ).unwrap().secret_bytes();
3093 if msg.onion_routing_packet.version != 0 {
3094 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
3095 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
3096 //the hash doesn't really serve any purpose - in the case of hashing all data, the
3097 //receiving node would have to brute force to figure out which version was put in the
3098 //packet by the node that send us the message, in the case of hashing the hop_data, the
3099 //node knows the HMAC matched, so they already know what is there...
3100 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
3102 macro_rules! return_err {
3103 ($msg: expr, $err_code: expr, $data: expr) => {
3105 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3106 return Err(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3107 channel_id: msg.channel_id,
3108 htlc_id: msg.htlc_id,
3109 reason: HTLCFailReason::reason($err_code, $data.to_vec())
3110 .get_encrypted_failure_packet(&shared_secret, &None),
3116 let next_hop = match onion_utils::decode_next_payment_hop(
3117 shared_secret, &msg.onion_routing_packet.hop_data[..], msg.onion_routing_packet.hmac,
3118 msg.payment_hash, &self.node_signer
3121 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
3122 return_malformed_err!(err_msg, err_code);
3124 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3125 return_err!(err_msg, err_code, &[0; 0]);
3128 let (outgoing_scid, outgoing_amt_msat, outgoing_cltv_value, next_packet_pk_opt) = match next_hop {
3129 onion_utils::Hop::Forward {
3130 next_hop_data: msgs::InboundOnionPayload::Forward {
3131 short_channel_id, amt_to_forward, outgoing_cltv_value
3134 let next_packet_pk = onion_utils::next_hop_pubkey(&self.secp_ctx,
3135 msg.onion_routing_packet.public_key.unwrap(), &shared_secret);
3136 (short_channel_id, amt_to_forward, outgoing_cltv_value, Some(next_packet_pk))
3138 // We'll do receive checks in [`Self::construct_pending_htlc_info`] so we have access to the
3139 // inbound channel's state.
3140 onion_utils::Hop::Receive { .. } => return Ok((next_hop, shared_secret, None)),
3141 onion_utils::Hop::Forward { next_hop_data: msgs::InboundOnionPayload::Receive { .. }, .. } |
3142 onion_utils::Hop::Forward { next_hop_data: msgs::InboundOnionPayload::BlindedReceive { .. }, .. } =>
3144 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0; 0]);
3148 // Perform outbound checks here instead of in [`Self::construct_pending_htlc_info`] because we
3149 // can't hold the outbound peer state lock at the same time as the inbound peer state lock.
3150 if let Some((err, mut code, chan_update)) = loop {
3151 let id_option = self.short_to_chan_info.read().unwrap().get(&outgoing_scid).cloned();
3152 let forwarding_chan_info_opt = match id_option {
3153 None => { // unknown_next_peer
3154 // Note that this is likely a timing oracle for detecting whether an scid is a
3155 // phantom or an intercept.
3156 if (self.default_configuration.accept_intercept_htlcs &&
3157 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, outgoing_scid, &self.chain_hash)) ||
3158 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, outgoing_scid, &self.chain_hash)
3162 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3165 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
3167 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
3168 let per_peer_state = self.per_peer_state.read().unwrap();
3169 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3170 if peer_state_mutex_opt.is_none() {
3171 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3173 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
3174 let peer_state = &mut *peer_state_lock;
3175 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id).map(
3176 |chan_phase| if let ChannelPhase::Funded(chan) = chan_phase { Some(chan) } else { None }
3179 // Channel was removed. The short_to_chan_info and channel_by_id maps
3180 // have no consistency guarantees.
3181 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3185 if !chan.context.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
3186 // Note that the behavior here should be identical to the above block - we
3187 // should NOT reveal the existence or non-existence of a private channel if
3188 // we don't allow forwards outbound over them.
3189 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
3191 if chan.context.get_channel_type().supports_scid_privacy() && outgoing_scid != chan.context.outbound_scid_alias() {
3192 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
3193 // "refuse to forward unless the SCID alias was used", so we pretend
3194 // we don't have the channel here.
3195 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
3197 let chan_update_opt = self.get_channel_update_for_onion(outgoing_scid, chan).ok();
3199 // Note that we could technically not return an error yet here and just hope
3200 // that the connection is reestablished or monitor updated by the time we get
3201 // around to doing the actual forward, but better to fail early if we can and
3202 // hopefully an attacker trying to path-trace payments cannot make this occur
3203 // on a small/per-node/per-channel scale.
3204 if !chan.context.is_live() { // channel_disabled
3205 // If the channel_update we're going to return is disabled (i.e. the
3206 // peer has been disabled for some time), return `channel_disabled`,
3207 // otherwise return `temporary_channel_failure`.
3208 if chan_update_opt.as_ref().map(|u| u.contents.flags & 2 == 2).unwrap_or(false) {
3209 break Some(("Forwarding channel has been disconnected for some time.", 0x1000 | 20, chan_update_opt));
3211 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 7, chan_update_opt));
3214 if outgoing_amt_msat < chan.context.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
3215 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
3217 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, outgoing_amt_msat, outgoing_cltv_value) {
3218 break Some((err, code, chan_update_opt));
3222 if (msg.cltv_expiry as u64) < (outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 {
3223 // We really should set `incorrect_cltv_expiry` here but as we're not
3224 // forwarding over a real channel we can't generate a channel_update
3225 // for it. Instead we just return a generic temporary_node_failure.
3227 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
3234 let cur_height = self.best_block.read().unwrap().height() + 1;
3235 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
3236 // but we want to be robust wrt to counterparty packet sanitization (see
3237 // HTLC_FAIL_BACK_BUFFER rationale).
3238 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
3239 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
3241 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
3242 break Some(("CLTV expiry is too far in the future", 21, None));
3244 // If the HTLC expires ~now, don't bother trying to forward it to our
3245 // counterparty. They should fail it anyway, but we don't want to bother with
3246 // the round-trips or risk them deciding they definitely want the HTLC and
3247 // force-closing to ensure they get it if we're offline.
3248 // We previously had a much more aggressive check here which tried to ensure
3249 // our counterparty receives an HTLC which has *our* risk threshold met on it,
3250 // but there is no need to do that, and since we're a bit conservative with our
3251 // risk threshold it just results in failing to forward payments.
3252 if (outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
3253 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
3259 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
3260 if let Some(chan_update) = chan_update {
3261 if code == 0x1000 | 11 || code == 0x1000 | 12 {
3262 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
3264 else if code == 0x1000 | 13 {
3265 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
3267 else if code == 0x1000 | 20 {
3268 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
3269 0u16.write(&mut res).expect("Writes cannot fail");
3271 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
3272 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
3273 chan_update.write(&mut res).expect("Writes cannot fail");
3274 } else if code & 0x1000 == 0x1000 {
3275 // If we're trying to return an error that requires a `channel_update` but
3276 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
3277 // generate an update), just use the generic "temporary_node_failure"
3281 return_err!(err, code, &res.0[..]);
3283 Ok((next_hop, shared_secret, next_packet_pk_opt))
3286 fn construct_pending_htlc_status<'a>(
3287 &self, msg: &msgs::UpdateAddHTLC, shared_secret: [u8; 32], decoded_hop: onion_utils::Hop,
3288 allow_underpay: bool, next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
3289 ) -> PendingHTLCStatus {
3290 macro_rules! return_err {
3291 ($msg: expr, $err_code: expr, $data: expr) => {
3293 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3294 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3295 channel_id: msg.channel_id,
3296 htlc_id: msg.htlc_id,
3297 reason: HTLCFailReason::reason($err_code, $data.to_vec())
3298 .get_encrypted_failure_packet(&shared_secret, &None),
3304 onion_utils::Hop::Receive(next_hop_data) => {
3306 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash,
3307 msg.amount_msat, msg.cltv_expiry, None, allow_underpay, msg.skimmed_fee_msat)
3310 // Note that we could obviously respond immediately with an update_fulfill_htlc
3311 // message, however that would leak that we are the recipient of this payment, so
3312 // instead we stay symmetric with the forwarding case, only responding (after a
3313 // delay) once they've send us a commitment_signed!
3314 PendingHTLCStatus::Forward(info)
3316 Err(InboundOnionErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3319 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
3320 match self.construct_fwd_pending_htlc_info(msg, next_hop_data, next_hop_hmac,
3321 new_packet_bytes, shared_secret, next_packet_pubkey_opt) {
3322 Ok(info) => PendingHTLCStatus::Forward(info),
3323 Err(InboundOnionErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3329 /// Gets the current [`channel_update`] for the given channel. This first checks if the channel is
3330 /// public, and thus should be called whenever the result is going to be passed out in a
3331 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
3333 /// Note that in [`internal_closing_signed`], this function is called without the `peer_state`
3334 /// corresponding to the channel's counterparty locked, as the channel been removed from the
3335 /// storage and the `peer_state` lock has been dropped.
3337 /// [`channel_update`]: msgs::ChannelUpdate
3338 /// [`internal_closing_signed`]: Self::internal_closing_signed
3339 fn get_channel_update_for_broadcast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3340 if !chan.context.should_announce() {
3341 return Err(LightningError {
3342 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
3343 action: msgs::ErrorAction::IgnoreError
3346 if chan.context.get_short_channel_id().is_none() {
3347 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
3349 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", &chan.context.channel_id());
3350 self.get_channel_update_for_unicast(chan)
3353 /// Gets the current [`channel_update`] for the given channel. This does not check if the channel
3354 /// is public (only returning an `Err` if the channel does not yet have an assigned SCID),
3355 /// and thus MUST NOT be called unless the recipient of the resulting message has already
3356 /// provided evidence that they know about the existence of the channel.
3358 /// Note that through [`internal_closing_signed`], this function is called without the
3359 /// `peer_state` corresponding to the channel's counterparty locked, as the channel been
3360 /// removed from the storage and the `peer_state` lock has been dropped.
3362 /// [`channel_update`]: msgs::ChannelUpdate
3363 /// [`internal_closing_signed`]: Self::internal_closing_signed
3364 fn get_channel_update_for_unicast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3365 log_trace!(self.logger, "Attempting to generate channel update for channel {}", &chan.context.channel_id());
3366 let short_channel_id = match chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias()) {
3367 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
3371 self.get_channel_update_for_onion(short_channel_id, chan)
3374 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3375 log_trace!(self.logger, "Generating channel update for channel {}", &chan.context.channel_id());
3376 let were_node_one = self.our_network_pubkey.serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
3378 let enabled = chan.context.is_usable() && match chan.channel_update_status() {
3379 ChannelUpdateStatus::Enabled => true,
3380 ChannelUpdateStatus::DisabledStaged(_) => true,
3381 ChannelUpdateStatus::Disabled => false,
3382 ChannelUpdateStatus::EnabledStaged(_) => false,
3385 let unsigned = msgs::UnsignedChannelUpdate {
3386 chain_hash: self.chain_hash,
3388 timestamp: chan.context.get_update_time_counter(),
3389 flags: (!were_node_one) as u8 | ((!enabled as u8) << 1),
3390 cltv_expiry_delta: chan.context.get_cltv_expiry_delta(),
3391 htlc_minimum_msat: chan.context.get_counterparty_htlc_minimum_msat(),
3392 htlc_maximum_msat: chan.context.get_announced_htlc_max_msat(),
3393 fee_base_msat: chan.context.get_outbound_forwarding_fee_base_msat(),
3394 fee_proportional_millionths: chan.context.get_fee_proportional_millionths(),
3395 excess_data: Vec::new(),
3397 // Panic on failure to signal LDK should be restarted to retry signing the `ChannelUpdate`.
3398 // If we returned an error and the `node_signer` cannot provide a signature for whatever
3399 // reason`, we wouldn't be able to receive inbound payments through the corresponding
3401 let sig = self.node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelUpdate(&unsigned)).unwrap();
3403 Ok(msgs::ChannelUpdate {
3410 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> {
3411 let _lck = self.total_consistency_lock.read().unwrap();
3412 self.send_payment_along_path(SendAlongPathArgs {
3413 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3418 fn send_payment_along_path(&self, args: SendAlongPathArgs) -> Result<(), APIError> {
3419 let SendAlongPathArgs {
3420 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3423 // The top-level caller should hold the total_consistency_lock read lock.
3424 debug_assert!(self.total_consistency_lock.try_write().is_err());
3426 log_trace!(self.logger,
3427 "Attempting to send payment with payment hash {} along path with next hop {}",
3428 payment_hash, path.hops.first().unwrap().short_channel_id);
3429 let prng_seed = self.entropy_source.get_secure_random_bytes();
3430 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
3432 let (onion_packet, htlc_msat, htlc_cltv) = onion_utils::create_payment_onion(
3433 &self.secp_ctx, &path, &session_priv, total_value, recipient_onion, cur_height,
3434 payment_hash, keysend_preimage, prng_seed
3437 let err: Result<(), _> = loop {
3438 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
3439 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
3440 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3443 let per_peer_state = self.per_peer_state.read().unwrap();
3444 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
3445 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
3446 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3447 let peer_state = &mut *peer_state_lock;
3448 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(id) {
3449 match chan_phase_entry.get_mut() {
3450 ChannelPhase::Funded(chan) => {
3451 if !chan.context.is_live() {
3452 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected".to_owned()});
3454 let funding_txo = chan.context.get_funding_txo().unwrap();
3455 let send_res = chan.send_htlc_and_commit(htlc_msat, payment_hash.clone(),
3456 htlc_cltv, HTLCSource::OutboundRoute {
3458 session_priv: session_priv.clone(),
3459 first_hop_htlc_msat: htlc_msat,
3461 }, onion_packet, None, &self.fee_estimator, &self.logger);
3462 match break_chan_phase_entry!(self, send_res, chan_phase_entry) {
3463 Some(monitor_update) => {
3464 match handle_new_monitor_update!(self, funding_txo, monitor_update, peer_state_lock, peer_state, per_peer_state, chan) {
3466 // Note that MonitorUpdateInProgress here indicates (per function
3467 // docs) that we will resend the commitment update once monitor
3468 // updating completes. Therefore, we must return an error
3469 // indicating that it is unsafe to retry the payment wholesale,
3470 // which we do in the send_payment check for
3471 // MonitorUpdateInProgress, below.
3472 return Err(APIError::MonitorUpdateInProgress);
3480 _ => return Err(APIError::ChannelUnavailable{err: "Channel to first hop is unfunded".to_owned()}),
3483 // The channel was likely removed after we fetched the id from the
3484 // `short_to_chan_info` map, but before we successfully locked the
3485 // `channel_by_id` map.
3486 // This can occur as no consistency guarantees exists between the two maps.
3487 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
3492 match handle_error!(self, err, path.hops.first().unwrap().pubkey) {
3493 Ok(_) => unreachable!(),
3495 Err(APIError::ChannelUnavailable { err: e.err })
3500 /// Sends a payment along a given route.
3502 /// Value parameters are provided via the last hop in route, see documentation for [`RouteHop`]
3503 /// fields for more info.
3505 /// May generate [`UpdateHTLCs`] message(s) event on success, which should be relayed (e.g. via
3506 /// [`PeerManager::process_events`]).
3508 /// # Avoiding Duplicate Payments
3510 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
3511 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
3512 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
3513 /// [`Event::PaymentSent`] or [`Event::PaymentFailed`]) LDK will not stop you from sending a
3514 /// second payment with the same [`PaymentId`].
3516 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
3517 /// tracking of payments, including state to indicate once a payment has completed. Because you
3518 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
3519 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
3520 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
3522 /// Additionally, in the scenario where we begin the process of sending a payment, but crash
3523 /// before `send_payment` returns (or prior to [`ChannelMonitorUpdate`] persistence if you're
3524 /// using [`ChannelMonitorUpdateStatus::InProgress`]), the payment may be lost on restart. See
3525 /// [`ChannelManager::list_recent_payments`] for more information.
3527 /// # Possible Error States on [`PaymentSendFailure`]
3529 /// Each path may have a different return value, and [`PaymentSendFailure`] may return a `Vec` with
3530 /// each entry matching the corresponding-index entry in the route paths, see
3531 /// [`PaymentSendFailure`] for more info.
3533 /// In general, a path may raise:
3534 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
3535 /// node public key) is specified.
3536 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available as it has been
3537 /// closed, doesn't exist, or the peer is currently disconnected.
3538 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
3539 /// relevant updates.
3541 /// Note that depending on the type of the [`PaymentSendFailure`] the HTLC may have been
3542 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
3543 /// different route unless you intend to pay twice!
3545 /// [`RouteHop`]: crate::routing::router::RouteHop
3546 /// [`Event::PaymentSent`]: events::Event::PaymentSent
3547 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
3548 /// [`UpdateHTLCs`]: events::MessageSendEvent::UpdateHTLCs
3549 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
3550 /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
3551 pub fn send_payment_with_route(&self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
3552 let best_block_height = self.best_block.read().unwrap().height();
3553 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3554 self.pending_outbound_payments
3555 .send_payment_with_route(route, payment_hash, recipient_onion, payment_id,
3556 &self.entropy_source, &self.node_signer, best_block_height,
3557 |args| self.send_payment_along_path(args))
3560 /// Similar to [`ChannelManager::send_payment_with_route`], but will automatically find a route based on
3561 /// `route_params` and retry failed payment paths based on `retry_strategy`.
3562 pub fn send_payment(&self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<(), RetryableSendFailure> {
3563 let best_block_height = self.best_block.read().unwrap().height();
3564 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3565 self.pending_outbound_payments
3566 .send_payment(payment_hash, recipient_onion, payment_id, retry_strategy, route_params,
3567 &self.router, self.list_usable_channels(), || self.compute_inflight_htlcs(),
3568 &self.entropy_source, &self.node_signer, best_block_height, &self.logger,
3569 &self.pending_events, |args| self.send_payment_along_path(args))
3573 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> {
3574 let best_block_height = self.best_block.read().unwrap().height();
3575 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3576 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, recipient_onion,
3577 keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.node_signer,
3578 best_block_height, |args| self.send_payment_along_path(args))
3582 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> {
3583 let best_block_height = self.best_block.read().unwrap().height();
3584 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, recipient_onion, payment_id, route, None, &self.entropy_source, best_block_height)
3588 pub(crate) fn test_set_payment_metadata(&self, payment_id: PaymentId, new_payment_metadata: Option<Vec<u8>>) {
3589 self.pending_outbound_payments.test_set_payment_metadata(payment_id, new_payment_metadata);
3592 pub(super) fn send_payment_for_bolt12_invoice(&self, invoice: &Bolt12Invoice, payment_id: PaymentId) -> Result<(), Bolt12PaymentError> {
3593 let best_block_height = self.best_block.read().unwrap().height();
3594 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3595 self.pending_outbound_payments
3596 .send_payment_for_bolt12_invoice(
3597 invoice, payment_id, &self.router, self.list_usable_channels(),
3598 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer,
3599 best_block_height, &self.logger, &self.pending_events,
3600 |args| self.send_payment_along_path(args)
3604 /// Signals that no further attempts for the given payment should occur. Useful if you have a
3605 /// pending outbound payment with retries remaining, but wish to stop retrying the payment before
3606 /// retries are exhausted.
3608 /// # Event Generation
3610 /// If no [`Event::PaymentFailed`] event had been generated before, one will be generated as soon
3611 /// as there are no remaining pending HTLCs for this payment.
3613 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
3614 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
3615 /// determine the ultimate status of a payment.
3617 /// # Requested Invoices
3619 /// In the case of paying a [`Bolt12Invoice`] via [`ChannelManager::pay_for_offer`], abandoning
3620 /// the payment prior to receiving the invoice will result in an [`Event::InvoiceRequestFailed`]
3621 /// and prevent any attempts at paying it once received. The other events may only be generated
3622 /// once the invoice has been received.
3624 /// # Restart Behavior
3626 /// If an [`Event::PaymentFailed`] is generated and we restart without first persisting the
3627 /// [`ChannelManager`], another [`Event::PaymentFailed`] may be generated; likewise for
3628 /// [`Event::InvoiceRequestFailed`].
3630 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
3631 pub fn abandon_payment(&self, payment_id: PaymentId) {
3632 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3633 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
3636 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
3637 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
3638 /// the preimage, it must be a cryptographically secure random value that no intermediate node
3639 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
3640 /// never reach the recipient.
3642 /// See [`send_payment`] documentation for more details on the return value of this function
3643 /// and idempotency guarantees provided by the [`PaymentId`] key.
3645 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
3646 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
3648 /// [`send_payment`]: Self::send_payment
3649 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
3650 let best_block_height = self.best_block.read().unwrap().height();
3651 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3652 self.pending_outbound_payments.send_spontaneous_payment_with_route(
3653 route, payment_preimage, recipient_onion, payment_id, &self.entropy_source,
3654 &self.node_signer, best_block_height, |args| self.send_payment_along_path(args))
3657 /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
3658 /// based on `route_params` and retry failed payment paths based on `retry_strategy`.
3660 /// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous
3663 /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
3664 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> {
3665 let best_block_height = self.best_block.read().unwrap().height();
3666 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3667 self.pending_outbound_payments.send_spontaneous_payment(payment_preimage, recipient_onion,
3668 payment_id, retry_strategy, route_params, &self.router, self.list_usable_channels(),
3669 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
3670 &self.logger, &self.pending_events, |args| self.send_payment_along_path(args))
3673 /// Send a payment that is probing the given route for liquidity. We calculate the
3674 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
3675 /// us to easily discern them from real payments.
3676 pub fn send_probe(&self, path: Path) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
3677 let best_block_height = self.best_block.read().unwrap().height();
3678 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3679 self.pending_outbound_payments.send_probe(path, self.probing_cookie_secret,
3680 &self.entropy_source, &self.node_signer, best_block_height,
3681 |args| self.send_payment_along_path(args))
3684 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
3687 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
3688 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
3691 /// Sends payment probes over all paths of a route that would be used to pay the given
3692 /// amount to the given `node_id`.
3694 /// See [`ChannelManager::send_preflight_probes`] for more information.
3695 pub fn send_spontaneous_preflight_probes(
3696 &self, node_id: PublicKey, amount_msat: u64, final_cltv_expiry_delta: u32,
3697 liquidity_limit_multiplier: Option<u64>,
3698 ) -> Result<Vec<(PaymentHash, PaymentId)>, ProbeSendFailure> {
3699 let payment_params =
3700 PaymentParameters::from_node_id(node_id, final_cltv_expiry_delta);
3702 let route_params = RouteParameters::from_payment_params_and_value(payment_params, amount_msat);
3704 self.send_preflight_probes(route_params, liquidity_limit_multiplier)
3707 /// Sends payment probes over all paths of a route that would be used to pay a route found
3708 /// according to the given [`RouteParameters`].
3710 /// This may be used to send "pre-flight" probes, i.e., to train our scorer before conducting
3711 /// the actual payment. Note this is only useful if there likely is sufficient time for the
3712 /// probe to settle before sending out the actual payment, e.g., when waiting for user
3713 /// confirmation in a wallet UI.
3715 /// Otherwise, there is a chance the probe could take up some liquidity needed to complete the
3716 /// actual payment. Users should therefore be cautious and might avoid sending probes if
3717 /// liquidity is scarce and/or they don't expect the probe to return before they send the
3718 /// payment. To mitigate this issue, channels with available liquidity less than the required
3719 /// amount times the given `liquidity_limit_multiplier` won't be used to send pre-flight
3720 /// probes. If `None` is given as `liquidity_limit_multiplier`, it defaults to `3`.
3721 pub fn send_preflight_probes(
3722 &self, route_params: RouteParameters, liquidity_limit_multiplier: Option<u64>,
3723 ) -> Result<Vec<(PaymentHash, PaymentId)>, ProbeSendFailure> {
3724 let liquidity_limit_multiplier = liquidity_limit_multiplier.unwrap_or(3);
3726 let payer = self.get_our_node_id();
3727 let usable_channels = self.list_usable_channels();
3728 let first_hops = usable_channels.iter().collect::<Vec<_>>();
3729 let inflight_htlcs = self.compute_inflight_htlcs();
3733 .find_route(&payer, &route_params, Some(&first_hops), inflight_htlcs)
3735 log_error!(self.logger, "Failed to find path for payment probe: {:?}", e);
3736 ProbeSendFailure::RouteNotFound
3739 let mut used_liquidity_map = HashMap::with_capacity(first_hops.len());
3741 let mut res = Vec::new();
3743 for mut path in route.paths {
3744 // If the last hop is probably an unannounced channel we refrain from probing all the
3745 // way through to the end and instead probe up to the second-to-last channel.
3746 while let Some(last_path_hop) = path.hops.last() {
3747 if last_path_hop.maybe_announced_channel {
3748 // We found a potentially announced last hop.
3751 // Drop the last hop, as it's likely unannounced.
3754 "Avoided sending payment probe all the way to last hop {} as it is likely unannounced.",
3755 last_path_hop.short_channel_id
3757 let final_value_msat = path.final_value_msat();
3759 if let Some(new_last) = path.hops.last_mut() {
3760 new_last.fee_msat += final_value_msat;
3765 if path.hops.len() < 2 {
3768 "Skipped sending payment probe over path with less than two hops."
3773 if let Some(first_path_hop) = path.hops.first() {
3774 if let Some(first_hop) = first_hops.iter().find(|h| {
3775 h.get_outbound_payment_scid() == Some(first_path_hop.short_channel_id)
3777 let path_value = path.final_value_msat() + path.fee_msat();
3778 let used_liquidity =
3779 used_liquidity_map.entry(first_path_hop.short_channel_id).or_insert(0);
3781 if first_hop.next_outbound_htlc_limit_msat
3782 < (*used_liquidity + path_value) * liquidity_limit_multiplier
3784 log_debug!(self.logger, "Skipped sending payment probe to avoid putting channel {} under the liquidity limit.", first_path_hop.short_channel_id);
3787 *used_liquidity += path_value;
3792 res.push(self.send_probe(path).map_err(|e| {
3793 log_error!(self.logger, "Failed to send pre-flight probe: {:?}", e);
3794 ProbeSendFailure::SendingFailed(e)
3801 /// Handles the generation of a funding transaction, optionally (for tests) with a function
3802 /// which checks the correctness of the funding transaction given the associated channel.
3803 fn funding_transaction_generated_intern<FundingOutput: FnMut(&OutboundV1Channel<SP>, &Transaction) -> Result<OutPoint, APIError>>(
3804 &self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, is_batch_funding: bool,
3805 mut find_funding_output: FundingOutput,
3806 ) -> Result<(), APIError> {
3807 let per_peer_state = self.per_peer_state.read().unwrap();
3808 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3809 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3811 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3812 let peer_state = &mut *peer_state_lock;
3813 let (chan, msg_opt) = match peer_state.channel_by_id.remove(temporary_channel_id) {
3814 Some(ChannelPhase::UnfundedOutboundV1(chan)) => {
3815 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
3817 let funding_res = chan.get_funding_created(funding_transaction, funding_txo, is_batch_funding, &self.logger)
3818 .map_err(|(mut chan, e)| if let ChannelError::Close(msg) = e {
3819 let channel_id = chan.context.channel_id();
3820 let user_id = chan.context.get_user_id();
3821 let shutdown_res = chan.context.force_shutdown(false);
3822 let channel_capacity = chan.context.get_value_satoshis();
3823 (chan, MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, user_id, shutdown_res, None, channel_capacity))
3824 } else { unreachable!(); });
3826 Ok((chan, funding_msg)) => (chan, funding_msg),
3827 Err((chan, err)) => {
3828 mem::drop(peer_state_lock);
3829 mem::drop(per_peer_state);
3831 let _: Result<(), _> = handle_error!(self, Err(err), chan.context.get_counterparty_node_id());
3832 return Err(APIError::ChannelUnavailable {
3833 err: "Signer refused to sign the initial commitment transaction".to_owned()
3839 peer_state.channel_by_id.insert(*temporary_channel_id, phase);
3840 return Err(APIError::APIMisuseError {
3842 "Channel with id {} for the passed counterparty node_id {} is not an unfunded, outbound V1 channel",
3843 temporary_channel_id, counterparty_node_id),
3846 None => return Err(APIError::ChannelUnavailable {err: format!(
3847 "Channel with id {} not found for the passed counterparty node_id {}",
3848 temporary_channel_id, counterparty_node_id),
3852 if let Some(msg) = msg_opt {
3853 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
3854 node_id: chan.context.get_counterparty_node_id(),
3858 match peer_state.channel_by_id.entry(chan.context.channel_id()) {
3859 hash_map::Entry::Occupied(_) => {
3860 panic!("Generated duplicate funding txid?");
3862 hash_map::Entry::Vacant(e) => {
3863 let mut id_to_peer = self.id_to_peer.lock().unwrap();
3864 if id_to_peer.insert(chan.context.channel_id(), chan.context.get_counterparty_node_id()).is_some() {
3865 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
3867 e.insert(ChannelPhase::Funded(chan));
3874 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
3875 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, false, |_, tx| {
3876 Ok(OutPoint { txid: tx.txid(), index: output_index })
3880 /// Call this upon creation of a funding transaction for the given channel.
3882 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
3883 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
3885 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
3886 /// across the p2p network.
3888 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
3889 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
3891 /// May panic if the output found in the funding transaction is duplicative with some other
3892 /// channel (note that this should be trivially prevented by using unique funding transaction
3893 /// keys per-channel).
3895 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
3896 /// counterparty's signature the funding transaction will automatically be broadcast via the
3897 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
3899 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
3900 /// not currently support replacing a funding transaction on an existing channel. Instead,
3901 /// create a new channel with a conflicting funding transaction.
3903 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
3904 /// the wallet software generating the funding transaction to apply anti-fee sniping as
3905 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
3906 /// for more details.
3908 /// [`Event::FundingGenerationReady`]: crate::events::Event::FundingGenerationReady
3909 /// [`Event::ChannelClosed`]: crate::events::Event::ChannelClosed
3910 pub fn funding_transaction_generated(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
3911 self.batch_funding_transaction_generated(&[(temporary_channel_id, counterparty_node_id)], funding_transaction)
3914 /// Call this upon creation of a batch funding transaction for the given channels.
3916 /// Return values are identical to [`Self::funding_transaction_generated`], respective to
3917 /// each individual channel and transaction output.
3919 /// Do NOT broadcast the funding transaction yourself. This batch funding transaction
3920 /// will only be broadcast when we have safely received and persisted the counterparty's
3921 /// signature for each channel.
3923 /// If there is an error, all channels in the batch are to be considered closed.
3924 pub fn batch_funding_transaction_generated(&self, temporary_channels: &[(&ChannelId, &PublicKey)], funding_transaction: Transaction) -> Result<(), APIError> {
3925 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3926 let mut result = Ok(());
3928 if !funding_transaction.is_coin_base() {
3929 for inp in funding_transaction.input.iter() {
3930 if inp.witness.is_empty() {
3931 result = result.and(Err(APIError::APIMisuseError {
3932 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
3937 if funding_transaction.output.len() > u16::max_value() as usize {
3938 result = result.and(Err(APIError::APIMisuseError {
3939 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
3943 let height = self.best_block.read().unwrap().height();
3944 // Transactions are evaluated as final by network mempools if their locktime is strictly
3945 // lower than the next block height. However, the modules constituting our Lightning
3946 // node might not have perfect sync about their blockchain views. Thus, if the wallet
3947 // module is ahead of LDK, only allow one more block of headroom.
3948 if !funding_transaction.input.iter().all(|input| input.sequence == Sequence::MAX) && LockTime::from(funding_transaction.lock_time).is_block_height() && funding_transaction.lock_time.0 > height + 1 {
3949 result = result.and(Err(APIError::APIMisuseError {
3950 err: "Funding transaction absolute timelock is non-final".to_owned()
3955 let txid = funding_transaction.txid();
3956 let is_batch_funding = temporary_channels.len() > 1;
3957 let mut funding_batch_states = if is_batch_funding {
3958 Some(self.funding_batch_states.lock().unwrap())
3962 let mut funding_batch_state = funding_batch_states.as_mut().and_then(|states| {
3963 match states.entry(txid) {
3964 btree_map::Entry::Occupied(_) => {
3965 result = result.clone().and(Err(APIError::APIMisuseError {
3966 err: "Batch funding transaction with the same txid already exists".to_owned()
3970 btree_map::Entry::Vacant(vacant) => Some(vacant.insert(Vec::new())),
3973 for &(temporary_channel_id, counterparty_node_id) in temporary_channels {
3974 result = result.and_then(|_| self.funding_transaction_generated_intern(
3975 temporary_channel_id,
3976 counterparty_node_id,
3977 funding_transaction.clone(),
3980 let mut output_index = None;
3981 let expected_spk = chan.context.get_funding_redeemscript().to_v0_p2wsh();
3982 for (idx, outp) in tx.output.iter().enumerate() {
3983 if outp.script_pubkey == expected_spk && outp.value == chan.context.get_value_satoshis() {
3984 if output_index.is_some() {
3985 return Err(APIError::APIMisuseError {
3986 err: "Multiple outputs matched the expected script and value".to_owned()
3989 output_index = Some(idx as u16);
3992 if output_index.is_none() {
3993 return Err(APIError::APIMisuseError {
3994 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
3997 let outpoint = OutPoint { txid: tx.txid(), index: output_index.unwrap() };
3998 if let Some(funding_batch_state) = funding_batch_state.as_mut() {
3999 funding_batch_state.push((outpoint.to_channel_id(), *counterparty_node_id, false));
4005 if let Err(ref e) = result {
4006 // Remaining channels need to be removed on any error.
4007 let e = format!("Error in transaction funding: {:?}", e);
4008 let mut channels_to_remove = Vec::new();
4009 channels_to_remove.extend(funding_batch_states.as_mut()
4010 .and_then(|states| states.remove(&txid))
4011 .into_iter().flatten()
4012 .map(|(chan_id, node_id, _state)| (chan_id, node_id))
4014 channels_to_remove.extend(temporary_channels.iter()
4015 .map(|(&chan_id, &node_id)| (chan_id, node_id))
4017 let mut shutdown_results = Vec::new();
4019 let per_peer_state = self.per_peer_state.read().unwrap();
4020 for (channel_id, counterparty_node_id) in channels_to_remove {
4021 per_peer_state.get(&counterparty_node_id)
4022 .map(|peer_state_mutex| peer_state_mutex.lock().unwrap())
4023 .and_then(|mut peer_state| peer_state.channel_by_id.remove(&channel_id))
4025 update_maps_on_chan_removal!(self, &chan.context());
4026 self.issue_channel_close_events(&chan.context(), ClosureReason::ProcessingError { err: e.clone() });
4027 shutdown_results.push(chan.context_mut().force_shutdown(false));
4031 for shutdown_result in shutdown_results.drain(..) {
4032 self.finish_close_channel(shutdown_result);
4038 /// Atomically applies partial updates to the [`ChannelConfig`] of the given channels.
4040 /// Once the updates are applied, each eligible channel (advertised with a known short channel
4041 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
4042 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
4043 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
4045 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
4046 /// `counterparty_node_id` is provided.
4048 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
4049 /// below [`MIN_CLTV_EXPIRY_DELTA`].
4051 /// If an error is returned, none of the updates should be considered applied.
4053 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
4054 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
4055 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
4056 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
4057 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4058 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
4059 /// [`APIMisuseError`]: APIError::APIMisuseError
4060 pub fn update_partial_channel_config(
4061 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config_update: &ChannelConfigUpdate,
4062 ) -> Result<(), APIError> {
4063 if config_update.cltv_expiry_delta.map(|delta| delta < MIN_CLTV_EXPIRY_DELTA).unwrap_or(false) {
4064 return Err(APIError::APIMisuseError {
4065 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
4069 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4070 let per_peer_state = self.per_peer_state.read().unwrap();
4071 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4072 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
4073 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4074 let peer_state = &mut *peer_state_lock;
4075 for channel_id in channel_ids {
4076 if !peer_state.has_channel(channel_id) {
4077 return Err(APIError::ChannelUnavailable {
4078 err: format!("Channel with id {} not found for the passed counterparty node_id {}", channel_id, counterparty_node_id),
4082 for channel_id in channel_ids {
4083 if let Some(channel_phase) = peer_state.channel_by_id.get_mut(channel_id) {
4084 let mut config = channel_phase.context().config();
4085 config.apply(config_update);
4086 if !channel_phase.context_mut().update_config(&config) {
4089 if let ChannelPhase::Funded(channel) = channel_phase {
4090 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
4091 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
4092 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
4093 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4094 node_id: channel.context.get_counterparty_node_id(),
4101 // This should not be reachable as we've already checked for non-existence in the previous channel_id loop.
4102 debug_assert!(false);
4103 return Err(APIError::ChannelUnavailable {
4105 "Channel with ID {} for passed counterparty_node_id {} disappeared after we confirmed its existence - this should not be reachable!",
4106 channel_id, counterparty_node_id),
4113 /// Atomically updates the [`ChannelConfig`] for the given channels.
4115 /// Once the updates are applied, each eligible channel (advertised with a known short channel
4116 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
4117 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
4118 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
4120 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
4121 /// `counterparty_node_id` is provided.
4123 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
4124 /// below [`MIN_CLTV_EXPIRY_DELTA`].
4126 /// If an error is returned, none of the updates should be considered applied.
4128 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
4129 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
4130 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
4131 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
4132 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4133 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
4134 /// [`APIMisuseError`]: APIError::APIMisuseError
4135 pub fn update_channel_config(
4136 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config: &ChannelConfig,
4137 ) -> Result<(), APIError> {
4138 return self.update_partial_channel_config(counterparty_node_id, channel_ids, &(*config).into());
4141 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
4142 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
4144 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
4145 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
4147 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
4148 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
4149 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
4150 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
4151 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
4153 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
4154 /// you from forwarding more than you received. See
4155 /// [`HTLCIntercepted::expected_outbound_amount_msat`] for more on forwarding a different amount
4158 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
4161 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
4162 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
4163 /// [`HTLCIntercepted::expected_outbound_amount_msat`]: events::Event::HTLCIntercepted::expected_outbound_amount_msat
4164 // TODO: when we move to deciding the best outbound channel at forward time, only take
4165 // `next_node_id` and not `next_hop_channel_id`
4166 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> {
4167 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4169 let next_hop_scid = {
4170 let peer_state_lock = self.per_peer_state.read().unwrap();
4171 let peer_state_mutex = peer_state_lock.get(&next_node_id)
4172 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) })?;
4173 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4174 let peer_state = &mut *peer_state_lock;
4175 match peer_state.channel_by_id.get(next_hop_channel_id) {
4176 Some(ChannelPhase::Funded(chan)) => {
4177 if !chan.context.is_usable() {
4178 return Err(APIError::ChannelUnavailable {
4179 err: format!("Channel with id {} not fully established", next_hop_channel_id)
4182 chan.context.get_short_channel_id().unwrap_or(chan.context.outbound_scid_alias())
4184 Some(_) => return Err(APIError::ChannelUnavailable {
4185 err: format!("Channel with id {} for the passed counterparty node_id {} is still opening.",
4186 next_hop_channel_id, next_node_id)
4188 None => return Err(APIError::ChannelUnavailable {
4189 err: format!("Channel with id {} not found for the passed counterparty node_id {}",
4190 next_hop_channel_id, next_node_id)
4195 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
4196 .ok_or_else(|| APIError::APIMisuseError {
4197 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
4200 let routing = match payment.forward_info.routing {
4201 PendingHTLCRouting::Forward { onion_packet, .. } => {
4202 PendingHTLCRouting::Forward { onion_packet, short_channel_id: next_hop_scid }
4204 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
4206 let skimmed_fee_msat =
4207 payment.forward_info.outgoing_amt_msat.saturating_sub(amt_to_forward_msat);
4208 let pending_htlc_info = PendingHTLCInfo {
4209 skimmed_fee_msat: if skimmed_fee_msat == 0 { None } else { Some(skimmed_fee_msat) },
4210 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
4213 let mut per_source_pending_forward = [(
4214 payment.prev_short_channel_id,
4215 payment.prev_funding_outpoint,
4216 payment.prev_user_channel_id,
4217 vec![(pending_htlc_info, payment.prev_htlc_id)]
4219 self.forward_htlcs(&mut per_source_pending_forward);
4223 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
4224 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
4226 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
4229 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
4230 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
4231 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4233 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
4234 .ok_or_else(|| APIError::APIMisuseError {
4235 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
4238 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
4239 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4240 short_channel_id: payment.prev_short_channel_id,
4241 user_channel_id: Some(payment.prev_user_channel_id),
4242 outpoint: payment.prev_funding_outpoint,
4243 htlc_id: payment.prev_htlc_id,
4244 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
4245 phantom_shared_secret: None,
4248 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
4249 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
4250 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
4251 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
4256 /// Processes HTLCs which are pending waiting on random forward delay.
4258 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
4259 /// Will likely generate further events.
4260 pub fn process_pending_htlc_forwards(&self) {
4261 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4263 let mut new_events = VecDeque::new();
4264 let mut failed_forwards = Vec::new();
4265 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
4267 let mut forward_htlcs = HashMap::new();
4268 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
4270 for (short_chan_id, mut pending_forwards) in forward_htlcs {
4271 if short_chan_id != 0 {
4272 macro_rules! forwarding_channel_not_found {
4274 for forward_info in pending_forwards.drain(..) {
4275 match forward_info {
4276 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4277 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4278 forward_info: PendingHTLCInfo {
4279 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
4280 outgoing_cltv_value, ..
4283 macro_rules! failure_handler {
4284 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
4285 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
4287 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4288 short_channel_id: prev_short_channel_id,
4289 user_channel_id: Some(prev_user_channel_id),
4290 outpoint: prev_funding_outpoint,
4291 htlc_id: prev_htlc_id,
4292 incoming_packet_shared_secret: incoming_shared_secret,
4293 phantom_shared_secret: $phantom_ss,
4296 let reason = if $next_hop_unknown {
4297 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
4299 HTLCDestination::FailedPayment{ payment_hash }
4302 failed_forwards.push((htlc_source, payment_hash,
4303 HTLCFailReason::reason($err_code, $err_data),
4309 macro_rules! fail_forward {
4310 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
4312 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
4316 macro_rules! failed_payment {
4317 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
4319 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
4323 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
4324 let phantom_pubkey_res = self.node_signer.get_node_id(Recipient::PhantomNode);
4325 if phantom_pubkey_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.chain_hash) {
4326 let phantom_shared_secret = self.node_signer.ecdh(Recipient::PhantomNode, &onion_packet.public_key.unwrap(), None).unwrap().secret_bytes();
4327 let next_hop = match onion_utils::decode_next_payment_hop(
4328 phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac,
4329 payment_hash, &self.node_signer
4332 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
4333 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
4334 // In this scenario, the phantom would have sent us an
4335 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
4336 // if it came from us (the second-to-last hop) but contains the sha256
4338 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
4340 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
4341 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
4345 onion_utils::Hop::Receive(hop_data) => {
4346 match self.construct_recv_pending_htlc_info(hop_data,
4347 incoming_shared_secret, payment_hash, outgoing_amt_msat,
4348 outgoing_cltv_value, Some(phantom_shared_secret), false, None)
4350 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
4351 Err(InboundOnionErr { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
4357 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
4360 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
4363 HTLCForwardInfo::FailHTLC { .. } => {
4364 // Channel went away before we could fail it. This implies
4365 // the channel is now on chain and our counterparty is
4366 // trying to broadcast the HTLC-Timeout, but that's their
4367 // problem, not ours.
4373 let chan_info_opt = self.short_to_chan_info.read().unwrap().get(&short_chan_id).cloned();
4374 let (counterparty_node_id, forward_chan_id) = match chan_info_opt {
4375 Some((cp_id, chan_id)) => (cp_id, chan_id),
4377 forwarding_channel_not_found!();
4381 let per_peer_state = self.per_peer_state.read().unwrap();
4382 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
4383 if peer_state_mutex_opt.is_none() {
4384 forwarding_channel_not_found!();
4387 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4388 let peer_state = &mut *peer_state_lock;
4389 if let Some(ChannelPhase::Funded(ref mut chan)) = peer_state.channel_by_id.get_mut(&forward_chan_id) {
4390 for forward_info in pending_forwards.drain(..) {
4391 match forward_info {
4392 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4393 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4394 forward_info: PendingHTLCInfo {
4395 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
4396 routing: PendingHTLCRouting::Forward { onion_packet, .. }, skimmed_fee_msat, ..
4399 log_trace!(self.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);
4400 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4401 short_channel_id: prev_short_channel_id,
4402 user_channel_id: Some(prev_user_channel_id),
4403 outpoint: prev_funding_outpoint,
4404 htlc_id: prev_htlc_id,
4405 incoming_packet_shared_secret: incoming_shared_secret,
4406 // Phantom payments are only PendingHTLCRouting::Receive.
4407 phantom_shared_secret: None,
4409 if let Err(e) = chan.queue_add_htlc(outgoing_amt_msat,
4410 payment_hash, outgoing_cltv_value, htlc_source.clone(),
4411 onion_packet, skimmed_fee_msat, &self.fee_estimator,
4414 if let ChannelError::Ignore(msg) = e {
4415 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", &payment_hash, msg);
4417 panic!("Stated return value requirements in send_htlc() were not met");
4419 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan);
4420 failed_forwards.push((htlc_source, payment_hash,
4421 HTLCFailReason::reason(failure_code, data),
4422 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!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
4432 if let Err(e) = chan.queue_fail_htlc(
4433 htlc_id, err_packet, &self.logger
4435 if let ChannelError::Ignore(msg) = e {
4436 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
4438 panic!("Stated return value requirements in queue_fail_htlc() were not met");
4440 // fail-backs are best-effort, we probably already have one
4441 // pending, and if not that's OK, if not, the channel is on
4442 // the chain and sending the HTLC-Timeout is their problem.
4449 forwarding_channel_not_found!();
4453 'next_forwardable_htlc: for forward_info in pending_forwards.drain(..) {
4454 match forward_info {
4455 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4456 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4457 forward_info: PendingHTLCInfo {
4458 routing, incoming_shared_secret, payment_hash, incoming_amt_msat, outgoing_amt_msat,
4459 skimmed_fee_msat, ..
4462 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret, mut onion_fields) = match routing {
4463 PendingHTLCRouting::Receive { payment_data, payment_metadata, incoming_cltv_expiry, phantom_shared_secret, custom_tlvs } => {
4464 let _legacy_hop_data = Some(payment_data.clone());
4465 let onion_fields = RecipientOnionFields { payment_secret: Some(payment_data.payment_secret),
4466 payment_metadata, custom_tlvs };
4467 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data },
4468 Some(payment_data), phantom_shared_secret, onion_fields)
4470 PendingHTLCRouting::ReceiveKeysend { payment_data, payment_preimage, payment_metadata, incoming_cltv_expiry, custom_tlvs } => {
4471 let onion_fields = RecipientOnionFields {
4472 payment_secret: payment_data.as_ref().map(|data| data.payment_secret),
4476 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage),
4477 payment_data, None, onion_fields)
4480 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
4483 let claimable_htlc = ClaimableHTLC {
4484 prev_hop: HTLCPreviousHopData {
4485 short_channel_id: prev_short_channel_id,
4486 user_channel_id: Some(prev_user_channel_id),
4487 outpoint: prev_funding_outpoint,
4488 htlc_id: prev_htlc_id,
4489 incoming_packet_shared_secret: incoming_shared_secret,
4490 phantom_shared_secret,
4492 // We differentiate the received value from the sender intended value
4493 // if possible so that we don't prematurely mark MPP payments complete
4494 // if routing nodes overpay
4495 value: incoming_amt_msat.unwrap_or(outgoing_amt_msat),
4496 sender_intended_value: outgoing_amt_msat,
4498 total_value_received: None,
4499 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
4502 counterparty_skimmed_fee_msat: skimmed_fee_msat,
4505 let mut committed_to_claimable = false;
4507 macro_rules! fail_htlc {
4508 ($htlc: expr, $payment_hash: expr) => {
4509 debug_assert!(!committed_to_claimable);
4510 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
4511 htlc_msat_height_data.extend_from_slice(
4512 &self.best_block.read().unwrap().height().to_be_bytes(),
4514 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
4515 short_channel_id: $htlc.prev_hop.short_channel_id,
4516 user_channel_id: $htlc.prev_hop.user_channel_id,
4517 outpoint: prev_funding_outpoint,
4518 htlc_id: $htlc.prev_hop.htlc_id,
4519 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
4520 phantom_shared_secret,
4522 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
4523 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
4525 continue 'next_forwardable_htlc;
4528 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
4529 let mut receiver_node_id = self.our_network_pubkey;
4530 if phantom_shared_secret.is_some() {
4531 receiver_node_id = self.node_signer.get_node_id(Recipient::PhantomNode)
4532 .expect("Failed to get node_id for phantom node recipient");
4535 macro_rules! check_total_value {
4536 ($purpose: expr) => {{
4537 let mut payment_claimable_generated = false;
4538 let is_keysend = match $purpose {
4539 events::PaymentPurpose::SpontaneousPayment(_) => true,
4540 events::PaymentPurpose::InvoicePayment { .. } => false,
4542 let mut claimable_payments = self.claimable_payments.lock().unwrap();
4543 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
4544 fail_htlc!(claimable_htlc, payment_hash);
4546 let ref mut claimable_payment = claimable_payments.claimable_payments
4547 .entry(payment_hash)
4548 // Note that if we insert here we MUST NOT fail_htlc!()
4549 .or_insert_with(|| {
4550 committed_to_claimable = true;
4552 purpose: $purpose.clone(), htlcs: Vec::new(), onion_fields: None,
4555 if $purpose != claimable_payment.purpose {
4556 let log_keysend = |keysend| if keysend { "keysend" } else { "non-keysend" };
4557 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));
4558 fail_htlc!(claimable_htlc, payment_hash);
4560 if !self.default_configuration.accept_mpp_keysend && is_keysend && !claimable_payment.htlcs.is_empty() {
4561 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);
4562 fail_htlc!(claimable_htlc, payment_hash);
4564 if let Some(earlier_fields) = &mut claimable_payment.onion_fields {
4565 if earlier_fields.check_merge(&mut onion_fields).is_err() {
4566 fail_htlc!(claimable_htlc, payment_hash);
4569 claimable_payment.onion_fields = Some(onion_fields);
4571 let ref mut htlcs = &mut claimable_payment.htlcs;
4572 let mut total_value = claimable_htlc.sender_intended_value;
4573 let mut earliest_expiry = claimable_htlc.cltv_expiry;
4574 for htlc in htlcs.iter() {
4575 total_value += htlc.sender_intended_value;
4576 earliest_expiry = cmp::min(earliest_expiry, htlc.cltv_expiry);
4577 if htlc.total_msat != claimable_htlc.total_msat {
4578 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
4579 &payment_hash, claimable_htlc.total_msat, htlc.total_msat);
4580 total_value = msgs::MAX_VALUE_MSAT;
4582 if total_value >= msgs::MAX_VALUE_MSAT { break; }
4584 // The condition determining whether an MPP is complete must
4585 // match exactly the condition used in `timer_tick_occurred`
4586 if total_value >= msgs::MAX_VALUE_MSAT {
4587 fail_htlc!(claimable_htlc, payment_hash);
4588 } else if total_value - claimable_htlc.sender_intended_value >= claimable_htlc.total_msat {
4589 log_trace!(self.logger, "Failing HTLC with payment_hash {} as payment is already claimable",
4591 fail_htlc!(claimable_htlc, payment_hash);
4592 } else if total_value >= claimable_htlc.total_msat {
4593 #[allow(unused_assignments)] {
4594 committed_to_claimable = true;
4596 let prev_channel_id = prev_funding_outpoint.to_channel_id();
4597 htlcs.push(claimable_htlc);
4598 let amount_msat = htlcs.iter().map(|htlc| htlc.value).sum();
4599 htlcs.iter_mut().for_each(|htlc| htlc.total_value_received = Some(amount_msat));
4600 let counterparty_skimmed_fee_msat = htlcs.iter()
4601 .map(|htlc| htlc.counterparty_skimmed_fee_msat.unwrap_or(0)).sum();
4602 debug_assert!(total_value.saturating_sub(amount_msat) <=
4603 counterparty_skimmed_fee_msat);
4604 new_events.push_back((events::Event::PaymentClaimable {
4605 receiver_node_id: Some(receiver_node_id),
4609 counterparty_skimmed_fee_msat,
4610 via_channel_id: Some(prev_channel_id),
4611 via_user_channel_id: Some(prev_user_channel_id),
4612 claim_deadline: Some(earliest_expiry - HTLC_FAIL_BACK_BUFFER),
4613 onion_fields: claimable_payment.onion_fields.clone(),
4615 payment_claimable_generated = true;
4617 // Nothing to do - we haven't reached the total
4618 // payment value yet, wait until we receive more
4620 htlcs.push(claimable_htlc);
4621 #[allow(unused_assignments)] {
4622 committed_to_claimable = true;
4625 payment_claimable_generated
4629 // Check that the payment hash and secret are known. Note that we
4630 // MUST take care to handle the "unknown payment hash" and
4631 // "incorrect payment secret" cases here identically or we'd expose
4632 // that we are the ultimate recipient of the given payment hash.
4633 // Further, we must not expose whether we have any other HTLCs
4634 // associated with the same payment_hash pending or not.
4635 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4636 match payment_secrets.entry(payment_hash) {
4637 hash_map::Entry::Vacant(_) => {
4638 match claimable_htlc.onion_payload {
4639 OnionPayload::Invoice { .. } => {
4640 let payment_data = payment_data.unwrap();
4641 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) {
4642 Ok(result) => result,
4644 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as payment verification failed", &payment_hash);
4645 fail_htlc!(claimable_htlc, payment_hash);
4648 if let Some(min_final_cltv_expiry_delta) = min_final_cltv_expiry_delta {
4649 let expected_min_expiry_height = (self.current_best_block().height() + min_final_cltv_expiry_delta as u32) as u64;
4650 if (cltv_expiry as u64) < expected_min_expiry_height {
4651 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as its CLTV expiry was too soon (had {}, earliest expected {})",
4652 &payment_hash, cltv_expiry, expected_min_expiry_height);
4653 fail_htlc!(claimable_htlc, payment_hash);
4656 let purpose = events::PaymentPurpose::InvoicePayment {
4657 payment_preimage: payment_preimage.clone(),
4658 payment_secret: payment_data.payment_secret,
4660 check_total_value!(purpose);
4662 OnionPayload::Spontaneous(preimage) => {
4663 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
4664 check_total_value!(purpose);
4668 hash_map::Entry::Occupied(inbound_payment) => {
4669 if let OnionPayload::Spontaneous(_) = claimable_htlc.onion_payload {
4670 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);
4671 fail_htlc!(claimable_htlc, payment_hash);
4673 let payment_data = payment_data.unwrap();
4674 if inbound_payment.get().payment_secret != payment_data.payment_secret {
4675 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", &payment_hash);
4676 fail_htlc!(claimable_htlc, payment_hash);
4677 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
4678 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
4679 &payment_hash, payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
4680 fail_htlc!(claimable_htlc, payment_hash);
4682 let purpose = events::PaymentPurpose::InvoicePayment {
4683 payment_preimage: inbound_payment.get().payment_preimage,
4684 payment_secret: payment_data.payment_secret,
4686 let payment_claimable_generated = check_total_value!(purpose);
4687 if payment_claimable_generated {
4688 inbound_payment.remove_entry();
4694 HTLCForwardInfo::FailHTLC { .. } => {
4695 panic!("Got pending fail of our own HTLC");
4703 let best_block_height = self.best_block.read().unwrap().height();
4704 self.pending_outbound_payments.check_retry_payments(&self.router, || self.list_usable_channels(),
4705 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
4706 &self.pending_events, &self.logger, |args| self.send_payment_along_path(args));
4708 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
4709 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4711 self.forward_htlcs(&mut phantom_receives);
4713 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
4714 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
4715 // nice to do the work now if we can rather than while we're trying to get messages in the
4717 self.check_free_holding_cells();
4719 if new_events.is_empty() { return }
4720 let mut events = self.pending_events.lock().unwrap();
4721 events.append(&mut new_events);
4724 /// Free the background events, generally called from [`PersistenceNotifierGuard`] constructors.
4726 /// Expects the caller to have a total_consistency_lock read lock.
4727 fn process_background_events(&self) -> NotifyOption {
4728 debug_assert_ne!(self.total_consistency_lock.held_by_thread(), LockHeldState::NotHeldByThread);
4730 self.background_events_processed_since_startup.store(true, Ordering::Release);
4732 let mut background_events = Vec::new();
4733 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
4734 if background_events.is_empty() {
4735 return NotifyOption::SkipPersistNoEvents;
4738 for event in background_events.drain(..) {
4740 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((funding_txo, update)) => {
4741 // The channel has already been closed, so no use bothering to care about the
4742 // monitor updating completing.
4743 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4745 BackgroundEvent::MonitorUpdateRegeneratedOnStartup { counterparty_node_id, funding_txo, update } => {
4746 let mut updated_chan = false;
4748 let per_peer_state = self.per_peer_state.read().unwrap();
4749 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4750 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4751 let peer_state = &mut *peer_state_lock;
4752 match peer_state.channel_by_id.entry(funding_txo.to_channel_id()) {
4753 hash_map::Entry::Occupied(mut chan_phase) => {
4754 if let ChannelPhase::Funded(chan) = chan_phase.get_mut() {
4755 updated_chan = true;
4756 handle_new_monitor_update!(self, funding_txo, update.clone(),
4757 peer_state_lock, peer_state, per_peer_state, chan);
4759 debug_assert!(false, "We shouldn't have an update for a non-funded channel");
4762 hash_map::Entry::Vacant(_) => {},
4767 // TODO: Track this as in-flight even though the channel is closed.
4768 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4771 BackgroundEvent::MonitorUpdatesComplete { counterparty_node_id, channel_id } => {
4772 let per_peer_state = self.per_peer_state.read().unwrap();
4773 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4774 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4775 let peer_state = &mut *peer_state_lock;
4776 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
4777 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, chan);
4779 let update_actions = peer_state.monitor_update_blocked_actions
4780 .remove(&channel_id).unwrap_or(Vec::new());
4781 mem::drop(peer_state_lock);
4782 mem::drop(per_peer_state);
4783 self.handle_monitor_update_completion_actions(update_actions);
4789 NotifyOption::DoPersist
4792 #[cfg(any(test, feature = "_test_utils"))]
4793 /// Process background events, for functional testing
4794 pub fn test_process_background_events(&self) {
4795 let _lck = self.total_consistency_lock.read().unwrap();
4796 let _ = self.process_background_events();
4799 fn update_channel_fee(&self, chan_id: &ChannelId, chan: &mut Channel<SP>, new_feerate: u32) -> NotifyOption {
4800 if !chan.context.is_outbound() { return NotifyOption::SkipPersistNoEvents; }
4801 // If the feerate has decreased by less than half, don't bother
4802 if new_feerate <= chan.context.get_feerate_sat_per_1000_weight() && new_feerate * 2 > chan.context.get_feerate_sat_per_1000_weight() {
4803 if new_feerate != chan.context.get_feerate_sat_per_1000_weight() {
4804 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
4805 chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4807 return NotifyOption::SkipPersistNoEvents;
4809 if !chan.context.is_live() {
4810 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {} as it cannot currently be updated (probably the peer is disconnected).",
4811 chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4812 return NotifyOption::SkipPersistNoEvents;
4814 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
4815 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4817 chan.queue_update_fee(new_feerate, &self.fee_estimator, &self.logger);
4818 NotifyOption::DoPersist
4822 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
4823 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
4824 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
4825 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
4826 pub fn maybe_update_chan_fees(&self) {
4827 PersistenceNotifierGuard::optionally_notify(self, || {
4828 let mut should_persist = NotifyOption::SkipPersistNoEvents;
4830 let non_anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::NonAnchorChannelFee);
4831 let anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::AnchorChannelFee);
4833 let per_peer_state = self.per_peer_state.read().unwrap();
4834 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
4835 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4836 let peer_state = &mut *peer_state_lock;
4837 for (chan_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
4838 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
4840 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4845 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4846 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4854 /// Performs actions which should happen on startup and roughly once per minute thereafter.
4856 /// This currently includes:
4857 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
4858 /// * Broadcasting [`ChannelUpdate`] messages if we've been disconnected from our peer for more
4859 /// than a minute, informing the network that they should no longer attempt to route over
4861 /// * Expiring a channel's previous [`ChannelConfig`] if necessary to only allow forwarding HTLCs
4862 /// with the current [`ChannelConfig`].
4863 /// * Removing peers which have disconnected but and no longer have any channels.
4864 /// * Force-closing and removing channels which have not completed establishment in a timely manner.
4865 /// * Forgetting about stale outbound payments, either those that have already been fulfilled
4866 /// or those awaiting an invoice that hasn't been delivered in the necessary amount of time.
4867 /// The latter is determined using the system clock in `std` and the highest seen block time
4868 /// minus two hours in `no-std`.
4870 /// Note that this may cause reentrancy through [`chain::Watch::update_channel`] calls or feerate
4871 /// estimate fetches.
4873 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4874 /// [`ChannelConfig`]: crate::util::config::ChannelConfig
4875 pub fn timer_tick_occurred(&self) {
4876 PersistenceNotifierGuard::optionally_notify(self, || {
4877 let mut should_persist = NotifyOption::SkipPersistNoEvents;
4879 let non_anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::NonAnchorChannelFee);
4880 let anchor_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::AnchorChannelFee);
4882 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
4883 let mut timed_out_mpp_htlcs = Vec::new();
4884 let mut pending_peers_awaiting_removal = Vec::new();
4885 let mut shutdown_channels = Vec::new();
4887 let mut process_unfunded_channel_tick = |
4888 chan_id: &ChannelId,
4889 context: &mut ChannelContext<SP>,
4890 unfunded_context: &mut UnfundedChannelContext,
4891 pending_msg_events: &mut Vec<MessageSendEvent>,
4892 counterparty_node_id: PublicKey,
4894 context.maybe_expire_prev_config();
4895 if unfunded_context.should_expire_unfunded_channel() {
4896 log_error!(self.logger,
4897 "Force-closing pending channel with ID {} for not establishing in a timely manner", chan_id);
4898 update_maps_on_chan_removal!(self, &context);
4899 self.issue_channel_close_events(&context, ClosureReason::HolderForceClosed);
4900 shutdown_channels.push(context.force_shutdown(false));
4901 pending_msg_events.push(MessageSendEvent::HandleError {
4902 node_id: counterparty_node_id,
4903 action: msgs::ErrorAction::SendErrorMessage {
4904 msg: msgs::ErrorMessage {
4905 channel_id: *chan_id,
4906 data: "Force-closing pending channel due to timeout awaiting establishment handshake".to_owned(),
4917 let per_peer_state = self.per_peer_state.read().unwrap();
4918 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
4919 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4920 let peer_state = &mut *peer_state_lock;
4921 let pending_msg_events = &mut peer_state.pending_msg_events;
4922 let counterparty_node_id = *counterparty_node_id;
4923 peer_state.channel_by_id.retain(|chan_id, phase| {
4925 ChannelPhase::Funded(chan) => {
4926 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4931 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4932 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4934 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
4935 let (needs_close, err) = convert_chan_phase_err!(self, e, chan, chan_id, FUNDED_CHANNEL);
4936 handle_errors.push((Err(err), counterparty_node_id));
4937 if needs_close { return false; }
4940 match chan.channel_update_status() {
4941 ChannelUpdateStatus::Enabled if !chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(0)),
4942 ChannelUpdateStatus::Disabled if chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(0)),
4943 ChannelUpdateStatus::DisabledStaged(_) if chan.context.is_live()
4944 => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
4945 ChannelUpdateStatus::EnabledStaged(_) if !chan.context.is_live()
4946 => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
4947 ChannelUpdateStatus::DisabledStaged(mut n) if !chan.context.is_live() => {
4949 if n >= DISABLE_GOSSIP_TICKS {
4950 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
4951 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4952 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4956 should_persist = NotifyOption::DoPersist;
4958 chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(n));
4961 ChannelUpdateStatus::EnabledStaged(mut n) if chan.context.is_live() => {
4963 if n >= ENABLE_GOSSIP_TICKS {
4964 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
4965 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4966 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4970 should_persist = NotifyOption::DoPersist;
4972 chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(n));
4978 chan.context.maybe_expire_prev_config();
4980 if chan.should_disconnect_peer_awaiting_response() {
4981 log_debug!(self.logger, "Disconnecting peer {} due to not making any progress on channel {}",
4982 counterparty_node_id, chan_id);
4983 pending_msg_events.push(MessageSendEvent::HandleError {
4984 node_id: counterparty_node_id,
4985 action: msgs::ErrorAction::DisconnectPeerWithWarning {
4986 msg: msgs::WarningMessage {
4987 channel_id: *chan_id,
4988 data: "Disconnecting due to timeout awaiting response".to_owned(),
4996 ChannelPhase::UnfundedInboundV1(chan) => {
4997 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
4998 pending_msg_events, counterparty_node_id)
5000 ChannelPhase::UnfundedOutboundV1(chan) => {
5001 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
5002 pending_msg_events, counterparty_node_id)
5007 for (chan_id, req) in peer_state.inbound_channel_request_by_id.iter_mut() {
5008 if { req.ticks_remaining -= 1 ; req.ticks_remaining } <= 0 {
5009 log_error!(self.logger, "Force-closing unaccepted inbound channel {} for not accepting in a timely manner", &chan_id);
5010 peer_state.pending_msg_events.push(
5011 events::MessageSendEvent::HandleError {
5012 node_id: counterparty_node_id,
5013 action: msgs::ErrorAction::SendErrorMessage {
5014 msg: msgs::ErrorMessage { channel_id: chan_id.clone(), data: "Channel force-closed".to_owned() }
5020 peer_state.inbound_channel_request_by_id.retain(|_, req| req.ticks_remaining > 0);
5022 if peer_state.ok_to_remove(true) {
5023 pending_peers_awaiting_removal.push(counterparty_node_id);
5028 // When a peer disconnects but still has channels, the peer's `peer_state` entry in the
5029 // `per_peer_state` is not removed by the `peer_disconnected` function. If the channels
5030 // of to that peer is later closed while still being disconnected (i.e. force closed),
5031 // we therefore need to remove the peer from `peer_state` separately.
5032 // To avoid having to take the `per_peer_state` `write` lock once the channels are
5033 // closed, we instead remove such peers awaiting removal here on a timer, to limit the
5034 // negative effects on parallelism as much as possible.
5035 if pending_peers_awaiting_removal.len() > 0 {
5036 let mut per_peer_state = self.per_peer_state.write().unwrap();
5037 for counterparty_node_id in pending_peers_awaiting_removal {
5038 match per_peer_state.entry(counterparty_node_id) {
5039 hash_map::Entry::Occupied(entry) => {
5040 // Remove the entry if the peer is still disconnected and we still
5041 // have no channels to the peer.
5042 let remove_entry = {
5043 let peer_state = entry.get().lock().unwrap();
5044 peer_state.ok_to_remove(true)
5047 entry.remove_entry();
5050 hash_map::Entry::Vacant(_) => { /* The PeerState has already been removed */ }
5055 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
5056 if payment.htlcs.is_empty() {
5057 // This should be unreachable
5058 debug_assert!(false);
5061 if let OnionPayload::Invoice { .. } = payment.htlcs[0].onion_payload {
5062 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
5063 // In this case we're not going to handle any timeouts of the parts here.
5064 // This condition determining whether the MPP is complete here must match
5065 // exactly the condition used in `process_pending_htlc_forwards`.
5066 if payment.htlcs[0].total_msat <= payment.htlcs.iter()
5067 .fold(0, |total, htlc| total + htlc.sender_intended_value)
5070 } else if payment.htlcs.iter_mut().any(|htlc| {
5071 htlc.timer_ticks += 1;
5072 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
5074 timed_out_mpp_htlcs.extend(payment.htlcs.drain(..)
5075 .map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
5082 for htlc_source in timed_out_mpp_htlcs.drain(..) {
5083 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
5084 let reason = HTLCFailReason::from_failure_code(23);
5085 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
5086 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
5089 for (err, counterparty_node_id) in handle_errors.drain(..) {
5090 let _ = handle_error!(self, err, counterparty_node_id);
5093 for shutdown_res in shutdown_channels {
5094 self.finish_close_channel(shutdown_res);
5097 #[cfg(feature = "std")]
5098 let duration_since_epoch = std::time::SystemTime::now()
5099 .duration_since(std::time::SystemTime::UNIX_EPOCH)
5100 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
5101 #[cfg(not(feature = "std"))]
5102 let duration_since_epoch = Duration::from_secs(
5103 self.highest_seen_timestamp.load(Ordering::Acquire).saturating_sub(7200) as u64
5106 self.pending_outbound_payments.remove_stale_payments(
5107 duration_since_epoch, &self.pending_events
5110 // Technically we don't need to do this here, but if we have holding cell entries in a
5111 // channel that need freeing, it's better to do that here and block a background task
5112 // than block the message queueing pipeline.
5113 if self.check_free_holding_cells() {
5114 should_persist = NotifyOption::DoPersist;
5121 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
5122 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
5123 /// along the path (including in our own channel on which we received it).
5125 /// Note that in some cases around unclean shutdown, it is possible the payment may have
5126 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
5127 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
5128 /// may have already been failed automatically by LDK if it was nearing its expiration time.
5130 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
5131 /// [`ChannelManager::claim_funds`]), you should still monitor for
5132 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
5133 /// startup during which time claims that were in-progress at shutdown may be replayed.
5134 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
5135 self.fail_htlc_backwards_with_reason(payment_hash, FailureCode::IncorrectOrUnknownPaymentDetails);
5138 /// This is a variant of [`ChannelManager::fail_htlc_backwards`] that allows you to specify the
5139 /// reason for the failure.
5141 /// See [`FailureCode`] for valid failure codes.
5142 pub fn fail_htlc_backwards_with_reason(&self, payment_hash: &PaymentHash, failure_code: FailureCode) {
5143 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5145 let removed_source = self.claimable_payments.lock().unwrap().claimable_payments.remove(payment_hash);
5146 if let Some(payment) = removed_source {
5147 for htlc in payment.htlcs {
5148 let reason = self.get_htlc_fail_reason_from_failure_code(failure_code, &htlc);
5149 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5150 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
5151 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5156 /// Gets error data to form an [`HTLCFailReason`] given a [`FailureCode`] and [`ClaimableHTLC`].
5157 fn get_htlc_fail_reason_from_failure_code(&self, failure_code: FailureCode, htlc: &ClaimableHTLC) -> HTLCFailReason {
5158 match failure_code {
5159 FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(failure_code.into()),
5160 FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(failure_code.into()),
5161 FailureCode::IncorrectOrUnknownPaymentDetails => {
5162 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5163 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5164 HTLCFailReason::reason(failure_code.into(), htlc_msat_height_data)
5166 FailureCode::InvalidOnionPayload(data) => {
5167 let fail_data = match data {
5168 Some((typ, offset)) => [BigSize(typ).encode(), offset.encode()].concat(),
5171 HTLCFailReason::reason(failure_code.into(), fail_data)
5176 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
5177 /// that we want to return and a channel.
5179 /// This is for failures on the channel on which the HTLC was *received*, not failures
5181 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<SP>) -> (u16, Vec<u8>) {
5182 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
5183 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
5184 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
5185 // an inbound SCID alias before the real SCID.
5186 let scid_pref = if chan.context.should_announce() {
5187 chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias())
5189 chan.context.latest_inbound_scid_alias().or(chan.context.get_short_channel_id())
5191 if let Some(scid) = scid_pref {
5192 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
5194 (0x4000|10, Vec::new())
5199 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
5200 /// that we want to return and a channel.
5201 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<SP>) -> (u16, Vec<u8>) {
5202 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
5203 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
5204 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
5205 if desired_err_code == 0x1000 | 20 {
5206 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
5207 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
5208 0u16.write(&mut enc).expect("Writes cannot fail");
5210 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
5211 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
5212 upd.write(&mut enc).expect("Writes cannot fail");
5213 (desired_err_code, enc.0)
5215 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
5216 // which means we really shouldn't have gotten a payment to be forwarded over this
5217 // channel yet, or if we did it's from a route hint. Either way, returning an error of
5218 // PERM|no_such_channel should be fine.
5219 (0x4000|10, Vec::new())
5223 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
5224 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
5225 // be surfaced to the user.
5226 fn fail_holding_cell_htlcs(
5227 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: ChannelId,
5228 counterparty_node_id: &PublicKey
5230 let (failure_code, onion_failure_data) = {
5231 let per_peer_state = self.per_peer_state.read().unwrap();
5232 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
5233 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5234 let peer_state = &mut *peer_state_lock;
5235 match peer_state.channel_by_id.entry(channel_id) {
5236 hash_map::Entry::Occupied(chan_phase_entry) => {
5237 if let ChannelPhase::Funded(chan) = chan_phase_entry.get() {
5238 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan)
5240 // We shouldn't be trying to fail holding cell HTLCs on an unfunded channel.
5241 debug_assert!(false);
5242 (0x4000|10, Vec::new())
5245 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
5247 } else { (0x4000|10, Vec::new()) }
5250 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
5251 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
5252 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
5253 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
5257 /// Fails an HTLC backwards to the sender of it to us.
5258 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
5259 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
5260 // Ensure that no peer state channel storage lock is held when calling this function.
5261 // This ensures that future code doesn't introduce a lock-order requirement for
5262 // `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
5263 // this function with any `per_peer_state` peer lock acquired would.
5264 #[cfg(debug_assertions)]
5265 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
5266 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
5269 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
5270 //identify whether we sent it or not based on the (I presume) very different runtime
5271 //between the branches here. We should make this async and move it into the forward HTLCs
5274 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5275 // from block_connected which may run during initialization prior to the chain_monitor
5276 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
5278 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, .. } => {
5279 if self.pending_outbound_payments.fail_htlc(source, payment_hash, onion_error, path,
5280 session_priv, payment_id, self.probing_cookie_secret, &self.secp_ctx,
5281 &self.pending_events, &self.logger)
5282 { self.push_pending_forwards_ev(); }
5284 HTLCSource::PreviousHopData(HTLCPreviousHopData { ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret, ref phantom_shared_secret, ref outpoint, .. }) => {
5285 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with {:?}", &payment_hash, onion_error);
5286 let err_packet = onion_error.get_encrypted_failure_packet(incoming_packet_shared_secret, phantom_shared_secret);
5288 let mut push_forward_ev = false;
5289 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
5290 if forward_htlcs.is_empty() {
5291 push_forward_ev = true;
5293 match forward_htlcs.entry(*short_channel_id) {
5294 hash_map::Entry::Occupied(mut entry) => {
5295 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet });
5297 hash_map::Entry::Vacant(entry) => {
5298 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }));
5301 mem::drop(forward_htlcs);
5302 if push_forward_ev { self.push_pending_forwards_ev(); }
5303 let mut pending_events = self.pending_events.lock().unwrap();
5304 pending_events.push_back((events::Event::HTLCHandlingFailed {
5305 prev_channel_id: outpoint.to_channel_id(),
5306 failed_next_destination: destination,
5312 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
5313 /// [`MessageSendEvent`]s needed to claim the payment.
5315 /// This method is guaranteed to ensure the payment has been claimed but only if the current
5316 /// height is strictly below [`Event::PaymentClaimable::claim_deadline`]. To avoid race
5317 /// conditions, you should wait for an [`Event::PaymentClaimed`] before considering the payment
5318 /// successful. It will generally be available in the next [`process_pending_events`] call.
5320 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
5321 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
5322 /// event matches your expectation. If you fail to do so and call this method, you may provide
5323 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
5325 /// This function will fail the payment if it has custom TLVs with even type numbers, as we
5326 /// will assume they are unknown. If you intend to accept even custom TLVs, you should use
5327 /// [`claim_funds_with_known_custom_tlvs`].
5329 /// [`Event::PaymentClaimable`]: crate::events::Event::PaymentClaimable
5330 /// [`Event::PaymentClaimable::claim_deadline`]: crate::events::Event::PaymentClaimable::claim_deadline
5331 /// [`Event::PaymentClaimed`]: crate::events::Event::PaymentClaimed
5332 /// [`process_pending_events`]: EventsProvider::process_pending_events
5333 /// [`create_inbound_payment`]: Self::create_inbound_payment
5334 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5335 /// [`claim_funds_with_known_custom_tlvs`]: Self::claim_funds_with_known_custom_tlvs
5336 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
5337 self.claim_payment_internal(payment_preimage, false);
5340 /// This is a variant of [`claim_funds`] that allows accepting a payment with custom TLVs with
5341 /// even type numbers.
5345 /// You MUST check you've understood all even TLVs before using this to
5346 /// claim, otherwise you may unintentionally agree to some protocol you do not understand.
5348 /// [`claim_funds`]: Self::claim_funds
5349 pub fn claim_funds_with_known_custom_tlvs(&self, payment_preimage: PaymentPreimage) {
5350 self.claim_payment_internal(payment_preimage, true);
5353 fn claim_payment_internal(&self, payment_preimage: PaymentPreimage, custom_tlvs_known: bool) {
5354 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
5356 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5359 let mut claimable_payments = self.claimable_payments.lock().unwrap();
5360 if let Some(payment) = claimable_payments.claimable_payments.remove(&payment_hash) {
5361 let mut receiver_node_id = self.our_network_pubkey;
5362 for htlc in payment.htlcs.iter() {
5363 if htlc.prev_hop.phantom_shared_secret.is_some() {
5364 let phantom_pubkey = self.node_signer.get_node_id(Recipient::PhantomNode)
5365 .expect("Failed to get node_id for phantom node recipient");
5366 receiver_node_id = phantom_pubkey;
5371 let htlcs = payment.htlcs.iter().map(events::ClaimedHTLC::from).collect();
5372 let sender_intended_value = payment.htlcs.first().map(|htlc| htlc.total_msat);
5373 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
5374 ClaimingPayment { amount_msat: payment.htlcs.iter().map(|source| source.value).sum(),
5375 payment_purpose: payment.purpose, receiver_node_id, htlcs, sender_intended_value
5377 if dup_purpose.is_some() {
5378 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
5379 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
5383 if let Some(RecipientOnionFields { ref custom_tlvs, .. }) = payment.onion_fields {
5384 if !custom_tlvs_known && custom_tlvs.iter().any(|(typ, _)| typ % 2 == 0) {
5385 log_info!(self.logger, "Rejecting payment with payment hash {} as we cannot accept payment with unknown even TLVs: {}",
5386 &payment_hash, log_iter!(custom_tlvs.iter().map(|(typ, _)| typ).filter(|typ| *typ % 2 == 0)));
5387 claimable_payments.pending_claiming_payments.remove(&payment_hash);
5388 mem::drop(claimable_payments);
5389 for htlc in payment.htlcs {
5390 let reason = self.get_htlc_fail_reason_from_failure_code(FailureCode::InvalidOnionPayload(None), &htlc);
5391 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5392 let receiver = HTLCDestination::FailedPayment { payment_hash };
5393 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5402 debug_assert!(!sources.is_empty());
5404 // Just in case one HTLC has been failed between when we generated the `PaymentClaimable`
5405 // and when we got here we need to check that the amount we're about to claim matches the
5406 // amount we told the user in the last `PaymentClaimable`. We also do a sanity-check that
5407 // the MPP parts all have the same `total_msat`.
5408 let mut claimable_amt_msat = 0;
5409 let mut prev_total_msat = None;
5410 let mut expected_amt_msat = None;
5411 let mut valid_mpp = true;
5412 let mut errs = Vec::new();
5413 let per_peer_state = self.per_peer_state.read().unwrap();
5414 for htlc in sources.iter() {
5415 if prev_total_msat.is_some() && prev_total_msat != Some(htlc.total_msat) {
5416 log_error!(self.logger, "Somehow ended up with an MPP payment with different expected total amounts - this should not be reachable!");
5417 debug_assert!(false);
5421 prev_total_msat = Some(htlc.total_msat);
5423 if expected_amt_msat.is_some() && expected_amt_msat != htlc.total_value_received {
5424 log_error!(self.logger, "Somehow ended up with an MPP payment with different received total amounts - this should not be reachable!");
5425 debug_assert!(false);
5429 expected_amt_msat = htlc.total_value_received;
5430 claimable_amt_msat += htlc.value;
5432 mem::drop(per_peer_state);
5433 if sources.is_empty() || expected_amt_msat.is_none() {
5434 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5435 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
5438 if claimable_amt_msat != expected_amt_msat.unwrap() {
5439 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5440 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
5441 expected_amt_msat.unwrap(), claimable_amt_msat);
5445 for htlc in sources.drain(..) {
5446 if let Err((pk, err)) = self.claim_funds_from_hop(
5447 htlc.prev_hop, payment_preimage,
5448 |_, definitely_duplicate| {
5449 debug_assert!(!definitely_duplicate, "We shouldn't claim duplicatively from a payment");
5450 Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash })
5453 if let msgs::ErrorAction::IgnoreError = err.err.action {
5454 // We got a temporary failure updating monitor, but will claim the
5455 // HTLC when the monitor updating is restored (or on chain).
5456 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
5457 } else { errs.push((pk, err)); }
5462 for htlc in sources.drain(..) {
5463 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5464 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5465 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5466 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
5467 let receiver = HTLCDestination::FailedPayment { payment_hash };
5468 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5470 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5473 // Now we can handle any errors which were generated.
5474 for (counterparty_node_id, err) in errs.drain(..) {
5475 let res: Result<(), _> = Err(err);
5476 let _ = handle_error!(self, res, counterparty_node_id);
5480 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>, bool) -> Option<MonitorUpdateCompletionAction>>(&self,
5481 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
5482 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
5483 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
5485 // If we haven't yet run background events assume we're still deserializing and shouldn't
5486 // actually pass `ChannelMonitorUpdate`s to users yet. Instead, queue them up as
5487 // `BackgroundEvent`s.
5488 let during_init = !self.background_events_processed_since_startup.load(Ordering::Acquire);
5490 // As we may call handle_monitor_update_completion_actions in rather rare cases, check that
5491 // the required mutexes are not held before we start.
5492 debug_assert_ne!(self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
5493 debug_assert_ne!(self.claimable_payments.held_by_thread(), LockHeldState::HeldByThread);
5496 let per_peer_state = self.per_peer_state.read().unwrap();
5497 let chan_id = prev_hop.outpoint.to_channel_id();
5498 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
5499 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
5503 let peer_state_opt = counterparty_node_id_opt.as_ref().map(
5504 |counterparty_node_id| per_peer_state.get(counterparty_node_id)
5505 .map(|peer_mutex| peer_mutex.lock().unwrap())
5508 if peer_state_opt.is_some() {
5509 let mut peer_state_lock = peer_state_opt.unwrap();
5510 let peer_state = &mut *peer_state_lock;
5511 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(chan_id) {
5512 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
5513 let counterparty_node_id = chan.context.get_counterparty_node_id();
5514 let fulfill_res = chan.get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger);
5517 UpdateFulfillCommitFetch::NewClaim { htlc_value_msat, monitor_update } => {
5518 if let Some(action) = completion_action(Some(htlc_value_msat), false) {
5519 log_trace!(self.logger, "Tracking monitor update completion action for channel {}: {:?}",
5521 peer_state.monitor_update_blocked_actions.entry(chan_id).or_insert(Vec::new()).push(action);
5524 handle_new_monitor_update!(self, prev_hop.outpoint, monitor_update, peer_state_lock,
5525 peer_state, per_peer_state, chan);
5527 // If we're running during init we cannot update a monitor directly -
5528 // they probably haven't actually been loaded yet. Instead, push the
5529 // monitor update as a background event.
5530 self.pending_background_events.lock().unwrap().push(
5531 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
5532 counterparty_node_id,
5533 funding_txo: prev_hop.outpoint,
5534 update: monitor_update.clone(),
5538 UpdateFulfillCommitFetch::DuplicateClaim {} => {
5539 let action = if let Some(action) = completion_action(None, true) {
5544 mem::drop(peer_state_lock);
5546 log_trace!(self.logger, "Completing monitor update completion action for channel {} as claim was redundant: {:?}",
5548 let (node_id, funding_outpoint, blocker) =
5549 if let MonitorUpdateCompletionAction::FreeOtherChannelImmediately {
5550 downstream_counterparty_node_id: node_id,
5551 downstream_funding_outpoint: funding_outpoint,
5552 blocking_action: blocker,
5554 (node_id, funding_outpoint, blocker)
5556 debug_assert!(false,
5557 "Duplicate claims should always free another channel immediately");
5560 if let Some(peer_state_mtx) = per_peer_state.get(&node_id) {
5561 let mut peer_state = peer_state_mtx.lock().unwrap();
5562 if let Some(blockers) = peer_state
5563 .actions_blocking_raa_monitor_updates
5564 .get_mut(&funding_outpoint.to_channel_id())
5566 let mut found_blocker = false;
5567 blockers.retain(|iter| {
5568 // Note that we could actually be blocked, in
5569 // which case we need to only remove the one
5570 // blocker which was added duplicatively.
5571 let first_blocker = !found_blocker;
5572 if *iter == blocker { found_blocker = true; }
5573 *iter != blocker || !first_blocker
5575 debug_assert!(found_blocker);
5578 debug_assert!(false);
5587 let preimage_update = ChannelMonitorUpdate {
5588 update_id: CLOSED_CHANNEL_UPDATE_ID,
5589 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
5595 // We update the ChannelMonitor on the backward link, after
5596 // receiving an `update_fulfill_htlc` from the forward link.
5597 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, &preimage_update);
5598 if update_res != ChannelMonitorUpdateStatus::Completed {
5599 // TODO: This needs to be handled somehow - if we receive a monitor update
5600 // with a preimage we *must* somehow manage to propagate it to the upstream
5601 // channel, or we must have an ability to receive the same event and try
5602 // again on restart.
5603 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
5604 payment_preimage, update_res);
5607 // If we're running during init we cannot update a monitor directly - they probably
5608 // haven't actually been loaded yet. Instead, push the monitor update as a background
5610 // Note that while it's safe to use `ClosedMonitorUpdateRegeneratedOnStartup` here (the
5611 // channel is already closed) we need to ultimately handle the monitor update
5612 // completion action only after we've completed the monitor update. This is the only
5613 // way to guarantee this update *will* be regenerated on startup (otherwise if this was
5614 // from a forwarded HTLC the downstream preimage may be deleted before we claim
5615 // upstream). Thus, we need to transition to some new `BackgroundEvent` type which will
5616 // complete the monitor update completion action from `completion_action`.
5617 self.pending_background_events.lock().unwrap().push(
5618 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((
5619 prev_hop.outpoint, preimage_update,
5622 // Note that we do process the completion action here. This totally could be a
5623 // duplicate claim, but we have no way of knowing without interrogating the
5624 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
5625 // generally always allowed to be duplicative (and it's specifically noted in
5626 // `PaymentForwarded`).
5627 self.handle_monitor_update_completion_actions(completion_action(None, false));
5631 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
5632 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
5635 fn claim_funds_internal(&self, source: HTLCSource, payment_preimage: PaymentPreimage,
5636 forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, startup_replay: bool,
5637 next_channel_counterparty_node_id: Option<PublicKey>, next_channel_outpoint: OutPoint
5640 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
5641 debug_assert!(self.background_events_processed_since_startup.load(Ordering::Acquire),
5642 "We don't support claim_htlc claims during startup - monitors may not be available yet");
5643 if let Some(pubkey) = next_channel_counterparty_node_id {
5644 debug_assert_eq!(pubkey, path.hops[0].pubkey);
5646 let ev_completion_action = EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
5647 channel_funding_outpoint: next_channel_outpoint,
5648 counterparty_node_id: path.hops[0].pubkey,
5650 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage,
5651 session_priv, path, from_onchain, ev_completion_action, &self.pending_events,
5654 HTLCSource::PreviousHopData(hop_data) => {
5655 let prev_outpoint = hop_data.outpoint;
5656 let completed_blocker = RAAMonitorUpdateBlockingAction::from_prev_hop_data(&hop_data);
5657 #[cfg(debug_assertions)]
5658 let claiming_chan_funding_outpoint = hop_data.outpoint;
5659 let res = self.claim_funds_from_hop(hop_data, payment_preimage,
5660 |htlc_claim_value_msat, definitely_duplicate| {
5661 let chan_to_release =
5662 if let Some(node_id) = next_channel_counterparty_node_id {
5663 Some((node_id, next_channel_outpoint, completed_blocker))
5665 // We can only get `None` here if we are processing a
5666 // `ChannelMonitor`-originated event, in which case we
5667 // don't care about ensuring we wake the downstream
5668 // channel's monitor updating - the channel is already
5673 if definitely_duplicate && startup_replay {
5674 // On startup we may get redundant claims which are related to
5675 // monitor updates still in flight. In that case, we shouldn't
5676 // immediately free, but instead let that monitor update complete
5677 // in the background.
5678 #[cfg(debug_assertions)] {
5679 let background_events = self.pending_background_events.lock().unwrap();
5680 // There should be a `BackgroundEvent` pending...
5681 assert!(background_events.iter().any(|ev| {
5683 // to apply a monitor update that blocked the claiming channel,
5684 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
5685 funding_txo, update, ..
5687 if *funding_txo == claiming_chan_funding_outpoint {
5688 assert!(update.updates.iter().any(|upd|
5689 if let ChannelMonitorUpdateStep::PaymentPreimage {
5690 payment_preimage: update_preimage
5692 payment_preimage == *update_preimage
5698 // or the channel we'd unblock is already closed,
5699 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup(
5700 (funding_txo, monitor_update)
5702 if *funding_txo == next_channel_outpoint {
5703 assert_eq!(monitor_update.updates.len(), 1);
5705 monitor_update.updates[0],
5706 ChannelMonitorUpdateStep::ChannelForceClosed { .. }
5711 // or the monitor update has completed and will unblock
5712 // immediately once we get going.
5713 BackgroundEvent::MonitorUpdatesComplete {
5716 *channel_id == claiming_chan_funding_outpoint.to_channel_id(),
5718 }), "{:?}", *background_events);
5721 } else if definitely_duplicate {
5722 if let Some(other_chan) = chan_to_release {
5723 Some(MonitorUpdateCompletionAction::FreeOtherChannelImmediately {
5724 downstream_counterparty_node_id: other_chan.0,
5725 downstream_funding_outpoint: other_chan.1,
5726 blocking_action: other_chan.2,
5730 let fee_earned_msat = if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
5731 if let Some(claimed_htlc_value) = htlc_claim_value_msat {
5732 Some(claimed_htlc_value - forwarded_htlc_value)
5735 Some(MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5736 event: events::Event::PaymentForwarded {
5738 claim_from_onchain_tx: from_onchain,
5739 prev_channel_id: Some(prev_outpoint.to_channel_id()),
5740 next_channel_id: Some(next_channel_outpoint.to_channel_id()),
5741 outbound_amount_forwarded_msat: forwarded_htlc_value_msat,
5743 downstream_counterparty_and_funding_outpoint: chan_to_release,
5747 if let Err((pk, err)) = res {
5748 let result: Result<(), _> = Err(err);
5749 let _ = handle_error!(self, result, pk);
5755 /// Gets the node_id held by this ChannelManager
5756 pub fn get_our_node_id(&self) -> PublicKey {
5757 self.our_network_pubkey.clone()
5760 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
5761 debug_assert_ne!(self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
5762 debug_assert_ne!(self.claimable_payments.held_by_thread(), LockHeldState::HeldByThread);
5763 debug_assert_ne!(self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
5765 for action in actions.into_iter() {
5767 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
5768 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5769 if let Some(ClaimingPayment {
5771 payment_purpose: purpose,
5774 sender_intended_value: sender_intended_total_msat,
5776 self.pending_events.lock().unwrap().push_back((events::Event::PaymentClaimed {
5780 receiver_node_id: Some(receiver_node_id),
5782 sender_intended_total_msat,
5786 MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5787 event, downstream_counterparty_and_funding_outpoint
5789 self.pending_events.lock().unwrap().push_back((event, None));
5790 if let Some((node_id, funding_outpoint, blocker)) = downstream_counterparty_and_funding_outpoint {
5791 self.handle_monitor_update_release(node_id, funding_outpoint, Some(blocker));
5794 MonitorUpdateCompletionAction::FreeOtherChannelImmediately {
5795 downstream_counterparty_node_id, downstream_funding_outpoint, blocking_action,
5797 self.handle_monitor_update_release(
5798 downstream_counterparty_node_id,
5799 downstream_funding_outpoint,
5800 Some(blocking_action),
5807 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
5808 /// update completion.
5809 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
5810 channel: &mut Channel<SP>, raa: Option<msgs::RevokeAndACK>,
5811 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
5812 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
5813 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
5814 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
5815 log_trace!(self.logger, "Handling channel resumption for channel {} with {} RAA, {} commitment update, {} pending forwards, {}broadcasting funding, {} channel ready, {} announcement",
5816 &channel.context.channel_id(),
5817 if raa.is_some() { "an" } else { "no" },
5818 if commitment_update.is_some() { "a" } else { "no" }, pending_forwards.len(),
5819 if funding_broadcastable.is_some() { "" } else { "not " },
5820 if channel_ready.is_some() { "sending" } else { "without" },
5821 if announcement_sigs.is_some() { "sending" } else { "without" });
5823 let mut htlc_forwards = None;
5825 let counterparty_node_id = channel.context.get_counterparty_node_id();
5826 if !pending_forwards.is_empty() {
5827 htlc_forwards = Some((channel.context.get_short_channel_id().unwrap_or(channel.context.outbound_scid_alias()),
5828 channel.context.get_funding_txo().unwrap(), channel.context.get_user_id(), pending_forwards));
5831 if let Some(msg) = channel_ready {
5832 send_channel_ready!(self, pending_msg_events, channel, msg);
5834 if let Some(msg) = announcement_sigs {
5835 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5836 node_id: counterparty_node_id,
5841 macro_rules! handle_cs { () => {
5842 if let Some(update) = commitment_update {
5843 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5844 node_id: counterparty_node_id,
5849 macro_rules! handle_raa { () => {
5850 if let Some(revoke_and_ack) = raa {
5851 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
5852 node_id: counterparty_node_id,
5853 msg: revoke_and_ack,
5858 RAACommitmentOrder::CommitmentFirst => {
5862 RAACommitmentOrder::RevokeAndACKFirst => {
5868 if let Some(tx) = funding_broadcastable {
5869 log_info!(self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
5870 self.tx_broadcaster.broadcast_transactions(&[&tx]);
5874 let mut pending_events = self.pending_events.lock().unwrap();
5875 emit_channel_pending_event!(pending_events, channel);
5876 emit_channel_ready_event!(pending_events, channel);
5882 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
5883 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
5885 let counterparty_node_id = match counterparty_node_id {
5886 Some(cp_id) => cp_id.clone(),
5888 // TODO: Once we can rely on the counterparty_node_id from the
5889 // monitor event, this and the id_to_peer map should be removed.
5890 let id_to_peer = self.id_to_peer.lock().unwrap();
5891 match id_to_peer.get(&funding_txo.to_channel_id()) {
5892 Some(cp_id) => cp_id.clone(),
5897 let per_peer_state = self.per_peer_state.read().unwrap();
5898 let mut peer_state_lock;
5899 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
5900 if peer_state_mutex_opt.is_none() { return }
5901 peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5902 let peer_state = &mut *peer_state_lock;
5904 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&funding_txo.to_channel_id()) {
5907 let update_actions = peer_state.monitor_update_blocked_actions
5908 .remove(&funding_txo.to_channel_id()).unwrap_or(Vec::new());
5909 mem::drop(peer_state_lock);
5910 mem::drop(per_peer_state);
5911 self.handle_monitor_update_completion_actions(update_actions);
5914 let remaining_in_flight =
5915 if let Some(pending) = peer_state.in_flight_monitor_updates.get_mut(funding_txo) {
5916 pending.retain(|upd| upd.update_id > highest_applied_update_id);
5919 log_trace!(self.logger, "ChannelMonitor updated to {}. Current highest is {}. {} pending in-flight updates.",
5920 highest_applied_update_id, channel.context.get_latest_monitor_update_id(),
5921 remaining_in_flight);
5922 if !channel.is_awaiting_monitor_update() || channel.context.get_latest_monitor_update_id() != highest_applied_update_id {
5925 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, channel);
5928 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
5930 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
5931 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
5934 /// The `user_channel_id` parameter will be provided back in
5935 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5936 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5938 /// Note that this method will return an error and reject the channel, if it requires support
5939 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
5940 /// used to accept such channels.
5942 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5943 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5944 pub fn accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5945 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
5948 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
5949 /// it as confirmed immediately.
5951 /// The `user_channel_id` parameter will be provided back in
5952 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5953 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5955 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
5956 /// and (if the counterparty agrees), enables forwarding of payments immediately.
5958 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
5959 /// transaction and blindly assumes that it will eventually confirm.
5961 /// If it does not confirm before we decide to close the channel, or if the funding transaction
5962 /// does not pay to the correct script the correct amount, *you will lose funds*.
5964 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5965 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5966 pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5967 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
5970 fn do_accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
5971 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5973 let peers_without_funded_channels =
5974 self.peers_without_funded_channels(|peer| { peer.total_channel_count() > 0 });
5975 let per_peer_state = self.per_peer_state.read().unwrap();
5976 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5977 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
5978 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5979 let peer_state = &mut *peer_state_lock;
5980 let is_only_peer_channel = peer_state.total_channel_count() == 1;
5982 // Find (and remove) the channel in the unaccepted table. If it's not there, something weird is
5983 // happening and return an error. N.B. that we create channel with an outbound SCID of zero so
5984 // that we can delay allocating the SCID until after we're sure that the checks below will
5986 let mut channel = match peer_state.inbound_channel_request_by_id.remove(temporary_channel_id) {
5987 Some(unaccepted_channel) => {
5988 let best_block_height = self.best_block.read().unwrap().height();
5989 InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
5990 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features,
5991 &unaccepted_channel.open_channel_msg, user_channel_id, &self.default_configuration, best_block_height,
5992 &self.logger, accept_0conf).map_err(|e| APIError::ChannelUnavailable { err: e.to_string() })
5994 _ => Err(APIError::APIMisuseError { err: "No such channel awaiting to be accepted.".to_owned() })
5998 // This should have been correctly configured by the call to InboundV1Channel::new.
5999 debug_assert!(channel.context.minimum_depth().unwrap() == 0);
6000 } else if channel.context.get_channel_type().requires_zero_conf() {
6001 let send_msg_err_event = events::MessageSendEvent::HandleError {
6002 node_id: channel.context.get_counterparty_node_id(),
6003 action: msgs::ErrorAction::SendErrorMessage{
6004 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
6007 peer_state.pending_msg_events.push(send_msg_err_event);
6008 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
6010 // If this peer already has some channels, a new channel won't increase our number of peers
6011 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
6012 // channels per-peer we can accept channels from a peer with existing ones.
6013 if is_only_peer_channel && peers_without_funded_channels >= MAX_UNFUNDED_CHANNEL_PEERS {
6014 let send_msg_err_event = events::MessageSendEvent::HandleError {
6015 node_id: channel.context.get_counterparty_node_id(),
6016 action: msgs::ErrorAction::SendErrorMessage{
6017 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "Have too many peers with unfunded channels, not accepting new ones".to_owned(), }
6020 peer_state.pending_msg_events.push(send_msg_err_event);
6021 return Err(APIError::APIMisuseError { err: "Too many peers with unfunded channels, refusing to accept new ones".to_owned() });
6025 // Now that we know we have a channel, assign an outbound SCID alias.
6026 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
6027 channel.context.set_outbound_scid_alias(outbound_scid_alias);
6029 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
6030 node_id: channel.context.get_counterparty_node_id(),
6031 msg: channel.accept_inbound_channel(),
6034 peer_state.channel_by_id.insert(temporary_channel_id.clone(), ChannelPhase::UnfundedInboundV1(channel));
6039 /// Gets the number of peers which match the given filter and do not have any funded, outbound,
6040 /// or 0-conf channels.
6042 /// The filter is called for each peer and provided with the number of unfunded, inbound, and
6043 /// non-0-conf channels we have with the peer.
6044 fn peers_without_funded_channels<Filter>(&self, maybe_count_peer: Filter) -> usize
6045 where Filter: Fn(&PeerState<SP>) -> bool {
6046 let mut peers_without_funded_channels = 0;
6047 let best_block_height = self.best_block.read().unwrap().height();
6049 let peer_state_lock = self.per_peer_state.read().unwrap();
6050 for (_, peer_mtx) in peer_state_lock.iter() {
6051 let peer = peer_mtx.lock().unwrap();
6052 if !maybe_count_peer(&*peer) { continue; }
6053 let num_unfunded_channels = Self::unfunded_channel_count(&peer, best_block_height);
6054 if num_unfunded_channels == peer.total_channel_count() {
6055 peers_without_funded_channels += 1;
6059 return peers_without_funded_channels;
6062 fn unfunded_channel_count(
6063 peer: &PeerState<SP>, best_block_height: u32
6065 let mut num_unfunded_channels = 0;
6066 for (_, phase) in peer.channel_by_id.iter() {
6068 ChannelPhase::Funded(chan) => {
6069 // This covers non-zero-conf inbound `Channel`s that we are currently monitoring, but those
6070 // which have not yet had any confirmations on-chain.
6071 if !chan.context.is_outbound() && chan.context.minimum_depth().unwrap_or(1) != 0 &&
6072 chan.context.get_funding_tx_confirmations(best_block_height) == 0
6074 num_unfunded_channels += 1;
6077 ChannelPhase::UnfundedInboundV1(chan) => {
6078 if chan.context.minimum_depth().unwrap_or(1) != 0 {
6079 num_unfunded_channels += 1;
6082 ChannelPhase::UnfundedOutboundV1(_) => {
6083 // Outbound channels don't contribute to the unfunded count in the DoS context.
6088 num_unfunded_channels + peer.inbound_channel_request_by_id.len()
6091 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
6092 // Note that the ChannelManager is NOT re-persisted on disk after this, so any changes are
6093 // likely to be lost on restart!
6094 if msg.chain_hash != self.chain_hash {
6095 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
6098 if !self.default_configuration.accept_inbound_channels {
6099 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
6102 // Get the number of peers with channels, but without funded ones. We don't care too much
6103 // about peers that never open a channel, so we filter by peers that have at least one
6104 // channel, and then limit the number of those with unfunded channels.
6105 let channeled_peers_without_funding =
6106 self.peers_without_funded_channels(|node| node.total_channel_count() > 0);
6108 let per_peer_state = self.per_peer_state.read().unwrap();
6109 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6111 debug_assert!(false);
6112 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())
6114 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6115 let peer_state = &mut *peer_state_lock;
6117 // If this peer already has some channels, a new channel won't increase our number of peers
6118 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
6119 // channels per-peer we can accept channels from a peer with existing ones.
6120 if peer_state.total_channel_count() == 0 &&
6121 channeled_peers_without_funding >= MAX_UNFUNDED_CHANNEL_PEERS &&
6122 !self.default_configuration.manually_accept_inbound_channels
6124 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6125 "Have too many peers with unfunded channels, not accepting new ones".to_owned(),
6126 msg.temporary_channel_id.clone()));
6129 let best_block_height = self.best_block.read().unwrap().height();
6130 if Self::unfunded_channel_count(peer_state, best_block_height) >= MAX_UNFUNDED_CHANS_PER_PEER {
6131 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6132 format!("Refusing more than {} unfunded channels.", MAX_UNFUNDED_CHANS_PER_PEER),
6133 msg.temporary_channel_id.clone()));
6136 let channel_id = msg.temporary_channel_id;
6137 let channel_exists = peer_state.has_channel(&channel_id);
6139 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision for the same peer!".to_owned(), msg.temporary_channel_id.clone()));
6142 // If we're doing manual acceptance checks on the channel, then defer creation until we're sure we want to accept.
6143 if self.default_configuration.manually_accept_inbound_channels {
6144 let mut pending_events = self.pending_events.lock().unwrap();
6145 pending_events.push_back((events::Event::OpenChannelRequest {
6146 temporary_channel_id: msg.temporary_channel_id.clone(),
6147 counterparty_node_id: counterparty_node_id.clone(),
6148 funding_satoshis: msg.funding_satoshis,
6149 push_msat: msg.push_msat,
6150 channel_type: msg.channel_type.clone().unwrap(),
6152 peer_state.inbound_channel_request_by_id.insert(channel_id, InboundChannelRequest {
6153 open_channel_msg: msg.clone(),
6154 ticks_remaining: UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS,
6159 // Otherwise create the channel right now.
6160 let mut random_bytes = [0u8; 16];
6161 random_bytes.copy_from_slice(&self.entropy_source.get_secure_random_bytes()[..16]);
6162 let user_channel_id = u128::from_be_bytes(random_bytes);
6163 let mut channel = match InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
6164 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id,
6165 &self.default_configuration, best_block_height, &self.logger, /*is_0conf=*/false)
6168 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
6173 let channel_type = channel.context.get_channel_type();
6174 if channel_type.requires_zero_conf() {
6175 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
6177 if channel_type.requires_anchors_zero_fee_htlc_tx() {
6178 return Err(MsgHandleErrInternal::send_err_msg_no_close("No channels with anchor outputs accepted".to_owned(), msg.temporary_channel_id.clone()));
6181 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
6182 channel.context.set_outbound_scid_alias(outbound_scid_alias);
6184 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
6185 node_id: counterparty_node_id.clone(),
6186 msg: channel.accept_inbound_channel(),
6188 peer_state.channel_by_id.insert(channel_id, ChannelPhase::UnfundedInboundV1(channel));
6192 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
6193 // Note that the ChannelManager is NOT re-persisted on disk after this, so any changes are
6194 // likely to be lost on restart!
6195 let (value, output_script, user_id) = {
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)
6202 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6203 let peer_state = &mut *peer_state_lock;
6204 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
6205 hash_map::Entry::Occupied(mut phase) => {
6206 match phase.get_mut() {
6207 ChannelPhase::UnfundedOutboundV1(chan) => {
6208 try_chan_phase_entry!(self, chan.accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &peer_state.latest_features), phase);
6209 (chan.context.get_value_satoshis(), chan.context.get_funding_redeemscript().to_v0_p2wsh(), chan.context.get_user_id())
6212 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));
6216 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))
6219 let mut pending_events = self.pending_events.lock().unwrap();
6220 pending_events.push_back((events::Event::FundingGenerationReady {
6221 temporary_channel_id: msg.temporary_channel_id,
6222 counterparty_node_id: *counterparty_node_id,
6223 channel_value_satoshis: value,
6225 user_channel_id: user_id,
6230 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
6231 let best_block = *self.best_block.read().unwrap();
6233 let per_peer_state = self.per_peer_state.read().unwrap();
6234 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6236 debug_assert!(false);
6237 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)
6240 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6241 let peer_state = &mut *peer_state_lock;
6242 let (chan, funding_msg_opt, monitor) =
6243 match peer_state.channel_by_id.remove(&msg.temporary_channel_id) {
6244 Some(ChannelPhase::UnfundedInboundV1(inbound_chan)) => {
6245 match inbound_chan.funding_created(msg, best_block, &self.signer_provider, &self.logger) {
6247 Err((mut inbound_chan, err)) => {
6248 // We've already removed this inbound channel from the map in `PeerState`
6249 // above so at this point we just need to clean up any lingering entries
6250 // concerning this channel as it is safe to do so.
6251 update_maps_on_chan_removal!(self, &inbound_chan.context);
6252 let user_id = inbound_chan.context.get_user_id();
6253 let shutdown_res = inbound_chan.context.force_shutdown(false);
6254 return Err(MsgHandleErrInternal::from_finish_shutdown(format!("{}", err),
6255 msg.temporary_channel_id, user_id, shutdown_res, None, inbound_chan.context.get_value_satoshis()));
6259 Some(ChannelPhase::Funded(_)) | Some(ChannelPhase::UnfundedOutboundV1(_)) => {
6260 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got an unexpected funding_created message from peer with counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id));
6262 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))
6265 match peer_state.channel_by_id.entry(chan.context.channel_id()) {
6266 hash_map::Entry::Occupied(_) => {
6267 Err(MsgHandleErrInternal::send_err_msg_no_close(
6268 "Already had channel with the new channel_id".to_owned(),
6269 chan.context.channel_id()
6272 hash_map::Entry::Vacant(e) => {
6273 let mut id_to_peer_lock = self.id_to_peer.lock().unwrap();
6274 match id_to_peer_lock.entry(chan.context.channel_id()) {
6275 hash_map::Entry::Occupied(_) => {
6276 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6277 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
6278 chan.context.channel_id()))
6280 hash_map::Entry::Vacant(i_e) => {
6281 let monitor_res = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
6282 if let Ok(persist_state) = monitor_res {
6283 i_e.insert(chan.context.get_counterparty_node_id());
6284 mem::drop(id_to_peer_lock);
6286 // There's no problem signing a counterparty's funding transaction if our monitor
6287 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
6288 // accepted payment from yet. We do, however, need to wait to send our channel_ready
6289 // until we have persisted our monitor.
6290 if let Some(msg) = funding_msg_opt {
6291 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
6292 node_id: counterparty_node_id.clone(),
6297 if let ChannelPhase::Funded(chan) = e.insert(ChannelPhase::Funded(chan)) {
6298 handle_new_monitor_update!(self, persist_state, peer_state_lock, peer_state,
6299 per_peer_state, chan, INITIAL_MONITOR);
6301 unreachable!("This must be a funded channel as we just inserted it.");
6305 log_error!(self.logger, "Persisting initial ChannelMonitor failed, implying the funding outpoint was duplicated");
6306 let channel_id = match funding_msg_opt {
6307 Some(msg) => msg.channel_id,
6308 None => chan.context.channel_id(),
6310 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6311 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
6320 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
6321 let best_block = *self.best_block.read().unwrap();
6322 let per_peer_state = self.per_peer_state.read().unwrap();
6323 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6325 debug_assert!(false);
6326 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6329 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6330 let peer_state = &mut *peer_state_lock;
6331 match peer_state.channel_by_id.entry(msg.channel_id) {
6332 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6333 match chan_phase_entry.get_mut() {
6334 ChannelPhase::Funded(ref mut chan) => {
6335 let monitor = try_chan_phase_entry!(self,
6336 chan.funding_signed(&msg, best_block, &self.signer_provider, &self.logger), chan_phase_entry);
6337 if let Ok(persist_status) = self.chain_monitor.watch_channel(chan.context.get_funding_txo().unwrap(), monitor) {
6338 handle_new_monitor_update!(self, persist_status, peer_state_lock, peer_state, per_peer_state, chan, INITIAL_MONITOR);
6341 try_chan_phase_entry!(self, Err(ChannelError::Close("Channel funding outpoint was a duplicate".to_owned())), chan_phase_entry)
6345 return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id));
6349 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
6353 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
6354 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6355 // closing a channel), so any changes are likely to be lost on restart!
6356 let per_peer_state = self.per_peer_state.read().unwrap();
6357 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6359 debug_assert!(false);
6360 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6362 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6363 let peer_state = &mut *peer_state_lock;
6364 match peer_state.channel_by_id.entry(msg.channel_id) {
6365 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6366 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6367 let announcement_sigs_opt = try_chan_phase_entry!(self, chan.channel_ready(&msg, &self.node_signer,
6368 self.chain_hash, &self.default_configuration, &self.best_block.read().unwrap(), &self.logger), chan_phase_entry);
6369 if let Some(announcement_sigs) = announcement_sigs_opt {
6370 log_trace!(self.logger, "Sending announcement_signatures for channel {}", chan.context.channel_id());
6371 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
6372 node_id: counterparty_node_id.clone(),
6373 msg: announcement_sigs,
6375 } else if chan.context.is_usable() {
6376 // If we're sending an announcement_signatures, we'll send the (public)
6377 // channel_update after sending a channel_announcement when we receive our
6378 // counterparty's announcement_signatures. Thus, we only bother to send a
6379 // channel_update here if the channel is not public, i.e. we're not sending an
6380 // announcement_signatures.
6381 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", chan.context.channel_id());
6382 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
6383 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
6384 node_id: counterparty_node_id.clone(),
6391 let mut pending_events = self.pending_events.lock().unwrap();
6392 emit_channel_ready_event!(pending_events, chan);
6397 try_chan_phase_entry!(self, Err(ChannelError::Close(
6398 "Got a channel_ready message for an unfunded channel!".into())), chan_phase_entry)
6401 hash_map::Entry::Vacant(_) => {
6402 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))
6407 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
6408 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)> = Vec::new();
6409 let mut finish_shutdown = None;
6411 let per_peer_state = self.per_peer_state.read().unwrap();
6412 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6414 debug_assert!(false);
6415 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6417 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6418 let peer_state = &mut *peer_state_lock;
6419 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(msg.channel_id.clone()) {
6420 let phase = chan_phase_entry.get_mut();
6422 ChannelPhase::Funded(chan) => {
6423 if !chan.received_shutdown() {
6424 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
6426 if chan.sent_shutdown() { " after we initiated shutdown" } else { "" });
6429 let funding_txo_opt = chan.context.get_funding_txo();
6430 let (shutdown, monitor_update_opt, htlcs) = try_chan_phase_entry!(self,
6431 chan.shutdown(&self.signer_provider, &peer_state.latest_features, &msg), chan_phase_entry);
6432 dropped_htlcs = htlcs;
6434 if let Some(msg) = shutdown {
6435 // We can send the `shutdown` message before updating the `ChannelMonitor`
6436 // here as we don't need the monitor update to complete until we send a
6437 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
6438 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
6439 node_id: *counterparty_node_id,
6443 // Update the monitor with the shutdown script if necessary.
6444 if let Some(monitor_update) = monitor_update_opt {
6445 handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
6446 peer_state_lock, peer_state, per_peer_state, chan);
6449 ChannelPhase::UnfundedInboundV1(_) | ChannelPhase::UnfundedOutboundV1(_) => {
6450 let context = phase.context_mut();
6451 log_error!(self.logger, "Immediately closing unfunded channel {} as peer asked to cooperatively shut it down (which is unnecessary)", &msg.channel_id);
6452 self.issue_channel_close_events(&context, ClosureReason::CounterpartyCoopClosedUnfundedChannel);
6453 let mut chan = remove_channel_phase!(self, chan_phase_entry);
6454 finish_shutdown = Some(chan.context_mut().force_shutdown(false));
6458 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))
6461 for htlc_source in dropped_htlcs.drain(..) {
6462 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
6463 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
6464 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
6466 if let Some(shutdown_res) = finish_shutdown {
6467 self.finish_close_channel(shutdown_res);
6473 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
6474 let per_peer_state = self.per_peer_state.read().unwrap();
6475 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6477 debug_assert!(false);
6478 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6480 let (tx, chan_option, shutdown_result) = {
6481 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6482 let peer_state = &mut *peer_state_lock;
6483 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
6484 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6485 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6486 let (closing_signed, tx, shutdown_result) = try_chan_phase_entry!(self, chan.closing_signed(&self.fee_estimator, &msg), chan_phase_entry);
6487 debug_assert_eq!(shutdown_result.is_some(), chan.is_shutdown());
6488 if let Some(msg) = closing_signed {
6489 peer_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
6490 node_id: counterparty_node_id.clone(),
6495 // We're done with this channel, we've got a signed closing transaction and
6496 // will send the closing_signed back to the remote peer upon return. This
6497 // also implies there are no pending HTLCs left on the channel, so we can
6498 // fully delete it from tracking (the channel monitor is still around to
6499 // watch for old state broadcasts)!
6500 (tx, Some(remove_channel_phase!(self, chan_phase_entry)), shutdown_result)
6501 } else { (tx, None, shutdown_result) }
6503 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6504 "Got a closing_signed message for an unfunded channel!".into())), chan_phase_entry);
6507 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))
6510 if let Some(broadcast_tx) = tx {
6511 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
6512 self.tx_broadcaster.broadcast_transactions(&[&broadcast_tx]);
6514 if let Some(ChannelPhase::Funded(chan)) = chan_option {
6515 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6516 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6517 let peer_state = &mut *peer_state_lock;
6518 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6522 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
6524 mem::drop(per_peer_state);
6525 if let Some(shutdown_result) = shutdown_result {
6526 self.finish_close_channel(shutdown_result);
6531 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
6532 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
6533 //determine the state of the payment based on our response/if we forward anything/the time
6534 //we take to respond. We should take care to avoid allowing such an attack.
6536 //TODO: There exists a further attack where a node may garble the onion data, forward it to
6537 //us repeatedly garbled in different ways, and compare our error messages, which are
6538 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
6539 //but we should prevent it anyway.
6541 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6542 // closing a channel), so any changes are likely to be lost on restart!
6544 let decoded_hop_res = self.decode_update_add_htlc_onion(msg);
6545 let per_peer_state = self.per_peer_state.read().unwrap();
6546 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6548 debug_assert!(false);
6549 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6551 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6552 let peer_state = &mut *peer_state_lock;
6553 match peer_state.channel_by_id.entry(msg.channel_id) {
6554 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6555 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6556 let pending_forward_info = match decoded_hop_res {
6557 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
6558 self.construct_pending_htlc_status(msg, shared_secret, next_hop,
6559 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt),
6560 Err(e) => PendingHTLCStatus::Fail(e)
6562 let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
6563 // If the update_add is completely bogus, the call will Err and we will close,
6564 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
6565 // want to reject the new HTLC and fail it backwards instead of forwarding.
6566 match pending_forward_info {
6567 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
6568 let reason = if (error_code & 0x1000) != 0 {
6569 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
6570 HTLCFailReason::reason(real_code, error_data)
6572 HTLCFailReason::from_failure_code(error_code)
6573 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
6574 let msg = msgs::UpdateFailHTLC {
6575 channel_id: msg.channel_id,
6576 htlc_id: msg.htlc_id,
6579 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
6581 _ => pending_forward_info
6584 try_chan_phase_entry!(self, chan.update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.fee_estimator, &self.logger), chan_phase_entry);
6586 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6587 "Got an update_add_htlc message for an unfunded channel!".into())), chan_phase_entry);
6590 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))
6595 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
6597 let (htlc_source, forwarded_htlc_value) = {
6598 let per_peer_state = self.per_peer_state.read().unwrap();
6599 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6601 debug_assert!(false);
6602 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6604 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6605 let peer_state = &mut *peer_state_lock;
6606 match peer_state.channel_by_id.entry(msg.channel_id) {
6607 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6608 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6609 let res = try_chan_phase_entry!(self, chan.update_fulfill_htlc(&msg), chan_phase_entry);
6610 if let HTLCSource::PreviousHopData(prev_hop) = &res.0 {
6611 log_trace!(self.logger,
6612 "Holding the next revoke_and_ack from {} until the preimage is durably persisted in the inbound edge's ChannelMonitor",
6614 peer_state.actions_blocking_raa_monitor_updates.entry(msg.channel_id)
6615 .or_insert_with(Vec::new)
6616 .push(RAAMonitorUpdateBlockingAction::from_prev_hop_data(&prev_hop));
6618 // Note that we do not need to push an `actions_blocking_raa_monitor_updates`
6619 // entry here, even though we *do* need to block the next RAA monitor update.
6620 // We do this instead in the `claim_funds_internal` by attaching a
6621 // `ReleaseRAAChannelMonitorUpdate` action to the event generated when the
6622 // outbound HTLC is claimed. This is guaranteed to all complete before we
6623 // process the RAA as messages are processed from single peers serially.
6624 funding_txo = chan.context.get_funding_txo().expect("We won't accept a fulfill until funded");
6627 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6628 "Got an update_fulfill_htlc message for an unfunded channel!".into())), chan_phase_entry);
6631 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))
6634 self.claim_funds_internal(htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, false, Some(*counterparty_node_id), funding_txo);
6638 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
6639 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6640 // closing a channel), so any changes are likely to be lost on restart!
6641 let per_peer_state = self.per_peer_state.read().unwrap();
6642 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6644 debug_assert!(false);
6645 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6647 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6648 let peer_state = &mut *peer_state_lock;
6649 match peer_state.channel_by_id.entry(msg.channel_id) {
6650 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6651 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6652 try_chan_phase_entry!(self, chan.update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan_phase_entry);
6654 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6655 "Got an update_fail_htlc message for an unfunded channel!".into())), chan_phase_entry);
6658 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))
6663 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
6664 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6665 // closing a channel), so any changes are likely to be lost on restart!
6666 let per_peer_state = self.per_peer_state.read().unwrap();
6667 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6669 debug_assert!(false);
6670 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6672 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6673 let peer_state = &mut *peer_state_lock;
6674 match peer_state.channel_by_id.entry(msg.channel_id) {
6675 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6676 if (msg.failure_code & 0x8000) == 0 {
6677 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
6678 try_chan_phase_entry!(self, Err(chan_err), chan_phase_entry);
6680 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6681 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);
6683 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6684 "Got an update_fail_malformed_htlc message for an unfunded channel!".into())), chan_phase_entry);
6688 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))
6692 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
6693 let per_peer_state = self.per_peer_state.read().unwrap();
6694 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6696 debug_assert!(false);
6697 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6699 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6700 let peer_state = &mut *peer_state_lock;
6701 match peer_state.channel_by_id.entry(msg.channel_id) {
6702 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6703 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6704 let funding_txo = chan.context.get_funding_txo();
6705 let monitor_update_opt = try_chan_phase_entry!(self, chan.commitment_signed(&msg, &self.logger), chan_phase_entry);
6706 if let Some(monitor_update) = monitor_update_opt {
6707 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update, peer_state_lock,
6708 peer_state, per_peer_state, chan);
6712 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6713 "Got a commitment_signed message for an unfunded channel!".into())), chan_phase_entry);
6716 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))
6721 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
6722 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
6723 let mut push_forward_event = false;
6724 let mut new_intercept_events = VecDeque::new();
6725 let mut failed_intercept_forwards = Vec::new();
6726 if !pending_forwards.is_empty() {
6727 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
6728 let scid = match forward_info.routing {
6729 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
6730 PendingHTLCRouting::Receive { .. } => 0,
6731 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
6733 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
6734 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
6736 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
6737 let forward_htlcs_empty = forward_htlcs.is_empty();
6738 match forward_htlcs.entry(scid) {
6739 hash_map::Entry::Occupied(mut entry) => {
6740 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6741 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
6743 hash_map::Entry::Vacant(entry) => {
6744 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
6745 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.chain_hash)
6747 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).into_inner());
6748 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
6749 match pending_intercepts.entry(intercept_id) {
6750 hash_map::Entry::Vacant(entry) => {
6751 new_intercept_events.push_back((events::Event::HTLCIntercepted {
6752 requested_next_hop_scid: scid,
6753 payment_hash: forward_info.payment_hash,
6754 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
6755 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
6758 entry.insert(PendingAddHTLCInfo {
6759 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
6761 hash_map::Entry::Occupied(_) => {
6762 log_info!(self.logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
6763 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
6764 short_channel_id: prev_short_channel_id,
6765 user_channel_id: Some(prev_user_channel_id),
6766 outpoint: prev_funding_outpoint,
6767 htlc_id: prev_htlc_id,
6768 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
6769 phantom_shared_secret: None,
6772 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
6773 HTLCFailReason::from_failure_code(0x4000 | 10),
6774 HTLCDestination::InvalidForward { requested_forward_scid: scid },
6779 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
6780 // payments are being processed.
6781 if forward_htlcs_empty {
6782 push_forward_event = true;
6784 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6785 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
6792 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
6793 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
6796 if !new_intercept_events.is_empty() {
6797 let mut events = self.pending_events.lock().unwrap();
6798 events.append(&mut new_intercept_events);
6800 if push_forward_event { self.push_pending_forwards_ev() }
6804 fn push_pending_forwards_ev(&self) {
6805 let mut pending_events = self.pending_events.lock().unwrap();
6806 let is_processing_events = self.pending_events_processor.load(Ordering::Acquire);
6807 let num_forward_events = pending_events.iter().filter(|(ev, _)|
6808 if let events::Event::PendingHTLCsForwardable { .. } = ev { true } else { false }
6810 // We only want to push a PendingHTLCsForwardable event if no others are queued. Processing
6811 // events is done in batches and they are not removed until we're done processing each
6812 // batch. Since handling a `PendingHTLCsForwardable` event will call back into the
6813 // `ChannelManager`, we'll still see the original forwarding event not removed. Phantom
6814 // payments will need an additional forwarding event before being claimed to make them look
6815 // real by taking more time.
6816 if (is_processing_events && num_forward_events <= 1) || num_forward_events < 1 {
6817 pending_events.push_back((Event::PendingHTLCsForwardable {
6818 time_forwardable: Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
6823 /// Checks whether [`ChannelMonitorUpdate`]s generated by the receipt of a remote
6824 /// [`msgs::RevokeAndACK`] should be held for the given channel until some other action
6825 /// completes. Note that this needs to happen in the same [`PeerState`] mutex as any release of
6826 /// the [`ChannelMonitorUpdate`] in question.
6827 fn raa_monitor_updates_held(&self,
6828 actions_blocking_raa_monitor_updates: &BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
6829 channel_funding_outpoint: OutPoint, counterparty_node_id: PublicKey
6831 actions_blocking_raa_monitor_updates
6832 .get(&channel_funding_outpoint.to_channel_id()).map(|v| !v.is_empty()).unwrap_or(false)
6833 || self.pending_events.lock().unwrap().iter().any(|(_, action)| {
6834 action == &Some(EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
6835 channel_funding_outpoint,
6836 counterparty_node_id,
6841 #[cfg(any(test, feature = "_test_utils"))]
6842 pub(crate) fn test_raa_monitor_updates_held(&self,
6843 counterparty_node_id: PublicKey, channel_id: ChannelId
6845 let per_peer_state = self.per_peer_state.read().unwrap();
6846 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
6847 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
6848 let peer_state = &mut *peer_state_lck;
6850 if let Some(chan) = peer_state.channel_by_id.get(&channel_id) {
6851 return self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
6852 chan.context().get_funding_txo().unwrap(), counterparty_node_id);
6858 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
6859 let htlcs_to_fail = {
6860 let per_peer_state = self.per_peer_state.read().unwrap();
6861 let mut peer_state_lock = per_peer_state.get(counterparty_node_id)
6863 debug_assert!(false);
6864 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6865 }).map(|mtx| mtx.lock().unwrap())?;
6866 let peer_state = &mut *peer_state_lock;
6867 match peer_state.channel_by_id.entry(msg.channel_id) {
6868 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6869 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6870 let funding_txo_opt = chan.context.get_funding_txo();
6871 let mon_update_blocked = if let Some(funding_txo) = funding_txo_opt {
6872 self.raa_monitor_updates_held(
6873 &peer_state.actions_blocking_raa_monitor_updates, funding_txo,
6874 *counterparty_node_id)
6876 let (htlcs_to_fail, monitor_update_opt) = try_chan_phase_entry!(self,
6877 chan.revoke_and_ack(&msg, &self.fee_estimator, &self.logger, mon_update_blocked), chan_phase_entry);
6878 if let Some(monitor_update) = monitor_update_opt {
6879 let funding_txo = funding_txo_opt
6880 .expect("Funding outpoint must have been set for RAA handling to succeed");
6881 handle_new_monitor_update!(self, funding_txo, monitor_update,
6882 peer_state_lock, peer_state, per_peer_state, chan);
6886 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6887 "Got a revoke_and_ack message for an unfunded channel!".into())), chan_phase_entry);
6890 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))
6893 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
6897 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
6898 let per_peer_state = self.per_peer_state.read().unwrap();
6899 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6901 debug_assert!(false);
6902 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6904 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6905 let peer_state = &mut *peer_state_lock;
6906 match peer_state.channel_by_id.entry(msg.channel_id) {
6907 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6908 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6909 try_chan_phase_entry!(self, chan.update_fee(&self.fee_estimator, &msg, &self.logger), chan_phase_entry);
6911 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6912 "Got an update_fee message for an unfunded channel!".into())), chan_phase_entry);
6915 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))
6920 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
6921 let per_peer_state = self.per_peer_state.read().unwrap();
6922 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6924 debug_assert!(false);
6925 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6927 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6928 let peer_state = &mut *peer_state_lock;
6929 match peer_state.channel_by_id.entry(msg.channel_id) {
6930 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6931 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6932 if !chan.context.is_usable() {
6933 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
6936 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
6937 msg: try_chan_phase_entry!(self, chan.announcement_signatures(
6938 &self.node_signer, self.chain_hash, self.best_block.read().unwrap().height(),
6939 msg, &self.default_configuration
6940 ), chan_phase_entry),
6941 // Note that announcement_signatures fails if the channel cannot be announced,
6942 // so get_channel_update_for_broadcast will never fail by the time we get here.
6943 update_msg: Some(self.get_channel_update_for_broadcast(chan).unwrap()),
6946 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6947 "Got an announcement_signatures message for an unfunded channel!".into())), chan_phase_entry);
6950 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))
6955 /// Returns DoPersist if anything changed, otherwise either SkipPersistNoEvents or an Err.
6956 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
6957 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
6958 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
6960 // It's not a local channel
6961 return Ok(NotifyOption::SkipPersistNoEvents)
6964 let per_peer_state = self.per_peer_state.read().unwrap();
6965 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
6966 if peer_state_mutex_opt.is_none() {
6967 return Ok(NotifyOption::SkipPersistNoEvents)
6969 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
6970 let peer_state = &mut *peer_state_lock;
6971 match peer_state.channel_by_id.entry(chan_id) {
6972 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6973 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6974 if chan.context.get_counterparty_node_id() != *counterparty_node_id {
6975 if chan.context.should_announce() {
6976 // If the announcement is about a channel of ours which is public, some
6977 // other peer may simply be forwarding all its gossip to us. Don't provide
6978 // a scary-looking error message and return Ok instead.
6979 return Ok(NotifyOption::SkipPersistNoEvents);
6981 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));
6983 let were_node_one = self.get_our_node_id().serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
6984 let msg_from_node_one = msg.contents.flags & 1 == 0;
6985 if were_node_one == msg_from_node_one {
6986 return Ok(NotifyOption::SkipPersistNoEvents);
6988 log_debug!(self.logger, "Received channel_update {:?} for channel {}.", msg, chan_id);
6989 let did_change = try_chan_phase_entry!(self, chan.channel_update(&msg), chan_phase_entry);
6990 // If nothing changed after applying their update, we don't need to bother
6993 return Ok(NotifyOption::SkipPersistNoEvents);
6997 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6998 "Got a channel_update for an unfunded channel!".into())), chan_phase_entry);
7001 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersistNoEvents)
7003 Ok(NotifyOption::DoPersist)
7006 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<NotifyOption, MsgHandleErrInternal> {
7008 let need_lnd_workaround = {
7009 let per_peer_state = self.per_peer_state.read().unwrap();
7011 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
7013 debug_assert!(false);
7014 MsgHandleErrInternal::send_err_msg_no_close(
7015 format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id),
7019 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7020 let peer_state = &mut *peer_state_lock;
7021 match peer_state.channel_by_id.entry(msg.channel_id) {
7022 hash_map::Entry::Occupied(mut chan_phase_entry) => {
7023 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7024 // Currently, we expect all holding cell update_adds to be dropped on peer
7025 // disconnect, so Channel's reestablish will never hand us any holding cell
7026 // freed HTLCs to fail backwards. If in the future we no longer drop pending
7027 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
7028 let responses = try_chan_phase_entry!(self, chan.channel_reestablish(
7029 msg, &self.logger, &self.node_signer, self.chain_hash,
7030 &self.default_configuration, &*self.best_block.read().unwrap()), chan_phase_entry);
7031 let mut channel_update = None;
7032 if let Some(msg) = responses.shutdown_msg {
7033 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
7034 node_id: counterparty_node_id.clone(),
7037 } else if chan.context.is_usable() {
7038 // If the channel is in a usable state (ie the channel is not being shut
7039 // down), send a unicast channel_update to our counterparty to make sure
7040 // they have the latest channel parameters.
7041 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
7042 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
7043 node_id: chan.context.get_counterparty_node_id(),
7048 let need_lnd_workaround = chan.context.workaround_lnd_bug_4006.take();
7049 htlc_forwards = self.handle_channel_resumption(
7050 &mut peer_state.pending_msg_events, chan, responses.raa, responses.commitment_update, responses.order,
7051 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
7052 if let Some(upd) = channel_update {
7053 peer_state.pending_msg_events.push(upd);
7057 return try_chan_phase_entry!(self, Err(ChannelError::Close(
7058 "Got a channel_reestablish message for an unfunded channel!".into())), chan_phase_entry);
7061 hash_map::Entry::Vacant(_) => {
7062 log_debug!(self.logger, "Sending bogus ChannelReestablish for unknown channel {} to force channel closure",
7063 log_bytes!(msg.channel_id.0));
7064 // Unfortunately, lnd doesn't force close on errors
7065 // (https://github.com/lightningnetwork/lnd/blob/abb1e3463f3a83bbb843d5c399869dbe930ad94f/htlcswitch/link.go#L2119).
7066 // One of the few ways to get an lnd counterparty to force close is by
7067 // replicating what they do when restoring static channel backups (SCBs). They
7068 // send an invalid `ChannelReestablish` with `0` commitment numbers and an
7069 // invalid `your_last_per_commitment_secret`.
7071 // Since we received a `ChannelReestablish` for a channel that doesn't exist, we
7072 // can assume it's likely the channel closed from our point of view, but it
7073 // remains open on the counterparty's side. By sending this bogus
7074 // `ChannelReestablish` message now as a response to theirs, we trigger them to
7075 // force close broadcasting their latest state. If the closing transaction from
7076 // our point of view remains unconfirmed, it'll enter a race with the
7077 // counterparty's to-be-broadcast latest commitment transaction.
7078 peer_state.pending_msg_events.push(MessageSendEvent::SendChannelReestablish {
7079 node_id: *counterparty_node_id,
7080 msg: msgs::ChannelReestablish {
7081 channel_id: msg.channel_id,
7082 next_local_commitment_number: 0,
7083 next_remote_commitment_number: 0,
7084 your_last_per_commitment_secret: [1u8; 32],
7085 my_current_per_commitment_point: PublicKey::from_slice(&[2u8; 33]).unwrap(),
7086 next_funding_txid: None,
7089 return Err(MsgHandleErrInternal::send_err_msg_no_close(
7090 format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}",
7091 counterparty_node_id), msg.channel_id)
7097 let mut persist = NotifyOption::SkipPersistHandleEvents;
7098 if let Some(forwards) = htlc_forwards {
7099 self.forward_htlcs(&mut [forwards][..]);
7100 persist = NotifyOption::DoPersist;
7103 if let Some(channel_ready_msg) = need_lnd_workaround {
7104 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
7109 /// Process pending events from the [`chain::Watch`], returning whether any events were processed.
7110 fn process_pending_monitor_events(&self) -> bool {
7111 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
7113 let mut failed_channels = Vec::new();
7114 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
7115 let has_pending_monitor_events = !pending_monitor_events.is_empty();
7116 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
7117 for monitor_event in monitor_events.drain(..) {
7118 match monitor_event {
7119 MonitorEvent::HTLCEvent(htlc_update) => {
7120 if let Some(preimage) = htlc_update.payment_preimage {
7121 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", preimage);
7122 self.claim_funds_internal(htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, false, counterparty_node_id, funding_outpoint);
7124 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", &htlc_update.payment_hash);
7125 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
7126 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
7127 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
7130 MonitorEvent::HolderForceClosed(funding_outpoint) => {
7131 let counterparty_node_id_opt = match counterparty_node_id {
7132 Some(cp_id) => Some(cp_id),
7134 // TODO: Once we can rely on the counterparty_node_id from the
7135 // monitor event, this and the id_to_peer map should be removed.
7136 let id_to_peer = self.id_to_peer.lock().unwrap();
7137 id_to_peer.get(&funding_outpoint.to_channel_id()).cloned()
7140 if let Some(counterparty_node_id) = counterparty_node_id_opt {
7141 let per_peer_state = self.per_peer_state.read().unwrap();
7142 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
7143 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7144 let peer_state = &mut *peer_state_lock;
7145 let pending_msg_events = &mut peer_state.pending_msg_events;
7146 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(funding_outpoint.to_channel_id()) {
7147 if let ChannelPhase::Funded(mut chan) = remove_channel_phase!(self, chan_phase_entry) {
7148 failed_channels.push(chan.context.force_shutdown(false));
7149 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
7150 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7154 self.issue_channel_close_events(&chan.context, ClosureReason::HolderForceClosed);
7155 pending_msg_events.push(events::MessageSendEvent::HandleError {
7156 node_id: chan.context.get_counterparty_node_id(),
7157 action: msgs::ErrorAction::DisconnectPeer {
7158 msg: Some(msgs::ErrorMessage { channel_id: chan.context.channel_id(), data: "Channel force-closed".to_owned() })
7166 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
7167 self.channel_monitor_updated(&funding_txo, monitor_update_id, counterparty_node_id.as_ref());
7173 for failure in failed_channels.drain(..) {
7174 self.finish_close_channel(failure);
7177 has_pending_monitor_events
7180 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
7181 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
7182 /// update events as a separate process method here.
7184 pub fn process_monitor_events(&self) {
7185 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7186 self.process_pending_monitor_events();
7189 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
7190 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
7191 /// update was applied.
7192 fn check_free_holding_cells(&self) -> bool {
7193 let mut has_monitor_update = false;
7194 let mut failed_htlcs = Vec::new();
7196 // Walk our list of channels and find any that need to update. Note that when we do find an
7197 // update, if it includes actions that must be taken afterwards, we have to drop the
7198 // per-peer state lock as well as the top level per_peer_state lock. Thus, we loop until we
7199 // manage to go through all our peers without finding a single channel to update.
7201 let per_peer_state = self.per_peer_state.read().unwrap();
7202 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7204 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7205 let peer_state: &mut PeerState<_> = &mut *peer_state_lock;
7206 for (channel_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
7207 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
7209 let counterparty_node_id = chan.context.get_counterparty_node_id();
7210 let funding_txo = chan.context.get_funding_txo();
7211 let (monitor_opt, holding_cell_failed_htlcs) =
7212 chan.maybe_free_holding_cell_htlcs(&self.fee_estimator, &self.logger);
7213 if !holding_cell_failed_htlcs.is_empty() {
7214 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id, counterparty_node_id));
7216 if let Some(monitor_update) = monitor_opt {
7217 has_monitor_update = true;
7219 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update,
7220 peer_state_lock, peer_state, per_peer_state, chan);
7221 continue 'peer_loop;
7230 let has_update = has_monitor_update || !failed_htlcs.is_empty();
7231 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
7232 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
7238 /// When a call to a [`ChannelSigner`] method returns an error, this indicates that the signer
7239 /// is (temporarily) unavailable, and the operation should be retried later.
7241 /// This method allows for that retry - either checking for any signer-pending messages to be
7242 /// attempted in every channel, or in the specifically provided channel.
7244 /// [`ChannelSigner`]: crate::sign::ChannelSigner
7245 #[cfg(test)] // This is only implemented for one signer method, and should be private until we
7246 // actually finish implementing it fully.
7247 pub fn signer_unblocked(&self, channel_opt: Option<(PublicKey, ChannelId)>) {
7248 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7250 let unblock_chan = |phase: &mut ChannelPhase<SP>, pending_msg_events: &mut Vec<MessageSendEvent>| {
7251 let node_id = phase.context().get_counterparty_node_id();
7252 if let ChannelPhase::Funded(chan) = phase {
7253 let msgs = chan.signer_maybe_unblocked(&self.logger);
7254 if let Some(updates) = msgs.commitment_update {
7255 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
7260 if let Some(msg) = msgs.funding_signed {
7261 pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
7266 if let Some(msg) = msgs.funding_created {
7267 pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
7272 if let Some(msg) = msgs.channel_ready {
7273 send_channel_ready!(self, pending_msg_events, chan, msg);
7278 let per_peer_state = self.per_peer_state.read().unwrap();
7279 if let Some((counterparty_node_id, channel_id)) = channel_opt {
7280 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
7281 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7282 let peer_state = &mut *peer_state_lock;
7283 if let Some(chan) = peer_state.channel_by_id.get_mut(&channel_id) {
7284 unblock_chan(chan, &mut peer_state.pending_msg_events);
7288 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7289 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7290 let peer_state = &mut *peer_state_lock;
7291 for (_, chan) in peer_state.channel_by_id.iter_mut() {
7292 unblock_chan(chan, &mut peer_state.pending_msg_events);
7298 /// Check whether any channels have finished removing all pending updates after a shutdown
7299 /// exchange and can now send a closing_signed.
7300 /// Returns whether any closing_signed messages were generated.
7301 fn maybe_generate_initial_closing_signed(&self) -> bool {
7302 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
7303 let mut has_update = false;
7304 let mut shutdown_results = Vec::new();
7306 let per_peer_state = self.per_peer_state.read().unwrap();
7308 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7309 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7310 let peer_state = &mut *peer_state_lock;
7311 let pending_msg_events = &mut peer_state.pending_msg_events;
7312 peer_state.channel_by_id.retain(|channel_id, phase| {
7314 ChannelPhase::Funded(chan) => {
7315 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
7316 Ok((msg_opt, tx_opt, shutdown_result_opt)) => {
7317 if let Some(msg) = msg_opt {
7319 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
7320 node_id: chan.context.get_counterparty_node_id(), msg,
7323 debug_assert_eq!(shutdown_result_opt.is_some(), chan.is_shutdown());
7324 if let Some(shutdown_result) = shutdown_result_opt {
7325 shutdown_results.push(shutdown_result);
7327 if let Some(tx) = tx_opt {
7328 // We're done with this channel. We got a closing_signed and sent back
7329 // a closing_signed with a closing transaction to broadcast.
7330 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
7331 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7336 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
7338 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
7339 self.tx_broadcaster.broadcast_transactions(&[&tx]);
7340 update_maps_on_chan_removal!(self, &chan.context);
7346 let (close_channel, res) = convert_chan_phase_err!(self, e, chan, channel_id, FUNDED_CHANNEL);
7347 handle_errors.push((chan.context.get_counterparty_node_id(), Err(res)));
7352 _ => true, // Retain unfunded channels if present.
7358 for (counterparty_node_id, err) in handle_errors.drain(..) {
7359 let _ = handle_error!(self, err, counterparty_node_id);
7362 for shutdown_result in shutdown_results.drain(..) {
7363 self.finish_close_channel(shutdown_result);
7369 /// Handle a list of channel failures during a block_connected or block_disconnected call,
7370 /// pushing the channel monitor update (if any) to the background events queue and removing the
7372 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
7373 for mut failure in failed_channels.drain(..) {
7374 // Either a commitment transactions has been confirmed on-chain or
7375 // Channel::block_disconnected detected that the funding transaction has been
7376 // reorganized out of the main chain.
7377 // We cannot broadcast our latest local state via monitor update (as
7378 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
7379 // so we track the update internally and handle it when the user next calls
7380 // timer_tick_occurred, guaranteeing we're running normally.
7381 if let Some((counterparty_node_id, funding_txo, update)) = failure.monitor_update.take() {
7382 assert_eq!(update.updates.len(), 1);
7383 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
7384 assert!(should_broadcast);
7385 } else { unreachable!(); }
7386 self.pending_background_events.lock().unwrap().push(
7387 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
7388 counterparty_node_id, funding_txo, update
7391 self.finish_close_channel(failure);
7395 /// Creates an [`OfferBuilder`] such that the [`Offer`] it builds is recognized by the
7396 /// [`ChannelManager`] when handling [`InvoiceRequest`] messages for the offer. The offer will
7397 /// not have an expiration unless otherwise set on the builder.
7401 /// Uses a one-hop [`BlindedPath`] for the offer with [`ChannelManager::get_our_node_id`] as the
7402 /// introduction node and a derived signing pubkey for recipient privacy. As such, currently,
7403 /// the node must be announced. Otherwise, there is no way to find a path to the introduction
7404 /// node in order to send the [`InvoiceRequest`].
7408 /// Requires a direct connection to the introduction node in the responding [`InvoiceRequest`]'s
7411 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
7413 /// [`Offer`]: crate::offers::offer::Offer
7414 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
7415 pub fn create_offer_builder(
7416 &self, description: String
7417 ) -> OfferBuilder<DerivedMetadata, secp256k1::All> {
7418 let node_id = self.get_our_node_id();
7419 let expanded_key = &self.inbound_payment_key;
7420 let entropy = &*self.entropy_source;
7421 let secp_ctx = &self.secp_ctx;
7422 let path = self.create_one_hop_blinded_path();
7424 OfferBuilder::deriving_signing_pubkey(description, node_id, expanded_key, entropy, secp_ctx)
7425 .chain_hash(self.chain_hash)
7429 /// Creates a [`RefundBuilder`] such that the [`Refund`] it builds is recognized by the
7430 /// [`ChannelManager`] when handling [`Bolt12Invoice`] messages for the refund.
7434 /// The provided `payment_id` is used to ensure that only one invoice is paid for the refund.
7435 /// See [Avoiding Duplicate Payments] for other requirements once the payment has been sent.
7437 /// The builder will have the provided expiration set. Any changes to the expiration on the
7438 /// returned builder will not be honored by [`ChannelManager`]. For `no-std`, the highest seen
7439 /// block time minus two hours is used for the current time when determining if the refund has
7442 /// To revoke the refund, use [`ChannelManager::abandon_payment`] prior to receiving the
7443 /// invoice. If abandoned, or an invoice isn't received before expiration, the payment will fail
7444 /// with an [`Event::InvoiceRequestFailed`].
7446 /// If `max_total_routing_fee_msat` is not specified, The default from
7447 /// [`RouteParameters::from_payment_params_and_value`] is applied.
7451 /// Uses a one-hop [`BlindedPath`] for the refund with [`ChannelManager::get_our_node_id`] as
7452 /// the introduction node and a derived payer id for payer privacy. As such, currently, the
7453 /// node must be announced. Otherwise, there is no way to find a path to the introduction node
7454 /// in order to send the [`Bolt12Invoice`].
7458 /// Requires a direct connection to an introduction node in the responding
7459 /// [`Bolt12Invoice::payment_paths`].
7463 /// Errors if a duplicate `payment_id` is provided given the caveats in the aforementioned link
7464 /// or if `amount_msats` is invalid.
7466 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
7468 /// [`Refund`]: crate::offers::refund::Refund
7469 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
7470 /// [`Bolt12Invoice::payment_paths`]: crate::offers::invoice::Bolt12Invoice::payment_paths
7471 pub fn create_refund_builder(
7472 &self, description: String, amount_msats: u64, absolute_expiry: Duration,
7473 payment_id: PaymentId, retry_strategy: Retry, max_total_routing_fee_msat: Option<u64>
7474 ) -> Result<RefundBuilder<secp256k1::All>, Bolt12SemanticError> {
7475 let node_id = self.get_our_node_id();
7476 let expanded_key = &self.inbound_payment_key;
7477 let entropy = &*self.entropy_source;
7478 let secp_ctx = &self.secp_ctx;
7479 let path = self.create_one_hop_blinded_path();
7481 let builder = RefundBuilder::deriving_payer_id(
7482 description, node_id, expanded_key, entropy, secp_ctx, amount_msats, payment_id
7484 .chain_hash(self.chain_hash)
7485 .absolute_expiry(absolute_expiry)
7488 let expiration = StaleExpiration::AbsoluteTimeout(absolute_expiry);
7489 self.pending_outbound_payments
7490 .add_new_awaiting_invoice(
7491 payment_id, expiration, retry_strategy, max_total_routing_fee_msat,
7493 .map_err(|_| Bolt12SemanticError::DuplicatePaymentId)?;
7498 /// Pays for an [`Offer`] using the given parameters by creating an [`InvoiceRequest`] and
7499 /// enqueuing it to be sent via an onion message. [`ChannelManager`] will pay the actual
7500 /// [`Bolt12Invoice`] once it is received.
7502 /// Uses [`InvoiceRequestBuilder`] such that the [`InvoiceRequest`] it builds is recognized by
7503 /// the [`ChannelManager`] when handling a [`Bolt12Invoice`] message in response to the request.
7504 /// The optional parameters are used in the builder, if `Some`:
7505 /// - `quantity` for [`InvoiceRequest::quantity`] which must be set if
7506 /// [`Offer::expects_quantity`] is `true`.
7507 /// - `amount_msats` if overpaying what is required for the given `quantity` is desired, and
7508 /// - `payer_note` for [`InvoiceRequest::payer_note`].
7510 /// If `max_total_routing_fee_msat` is not specified, The default from
7511 /// [`RouteParameters::from_payment_params_and_value`] is applied.
7515 /// The provided `payment_id` is used to ensure that only one invoice is paid for the request
7516 /// when received. See [Avoiding Duplicate Payments] for other requirements once the payment has
7519 /// To revoke the request, use [`ChannelManager::abandon_payment`] prior to receiving the
7520 /// invoice. If abandoned, or an invoice isn't received in a reasonable amount of time, the
7521 /// payment will fail with an [`Event::InvoiceRequestFailed`].
7525 /// Uses a one-hop [`BlindedPath`] for the reply path with [`ChannelManager::get_our_node_id`]
7526 /// as the introduction node and a derived payer id for payer privacy. As such, currently, the
7527 /// node must be announced. Otherwise, there is no way to find a path to the introduction node
7528 /// in order to send the [`Bolt12Invoice`].
7532 /// Requires a direct connection to an introduction node in [`Offer::paths`] or to
7533 /// [`Offer::signing_pubkey`], if empty. A similar restriction applies to the responding
7534 /// [`Bolt12Invoice::payment_paths`].
7538 /// Errors if a duplicate `payment_id` is provided given the caveats in the aforementioned link
7539 /// or if the provided parameters are invalid for the offer.
7541 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
7542 /// [`InvoiceRequest::quantity`]: crate::offers::invoice_request::InvoiceRequest::quantity
7543 /// [`InvoiceRequest::payer_note`]: crate::offers::invoice_request::InvoiceRequest::payer_note
7544 /// [`InvoiceRequestBuilder`]: crate::offers::invoice_request::InvoiceRequestBuilder
7545 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
7546 /// [`Bolt12Invoice::payment_paths`]: crate::offers::invoice::Bolt12Invoice::payment_paths
7547 /// [Avoiding Duplicate Payments]: #avoiding-duplicate-payments
7548 pub fn pay_for_offer(
7549 &self, offer: &Offer, quantity: Option<u64>, amount_msats: Option<u64>,
7550 payer_note: Option<String>, payment_id: PaymentId, retry_strategy: Retry,
7551 max_total_routing_fee_msat: Option<u64>
7552 ) -> Result<(), Bolt12SemanticError> {
7553 let expanded_key = &self.inbound_payment_key;
7554 let entropy = &*self.entropy_source;
7555 let secp_ctx = &self.secp_ctx;
7558 .request_invoice_deriving_payer_id(expanded_key, entropy, secp_ctx, payment_id)?
7559 .chain_hash(self.chain_hash)?;
7560 let builder = match quantity {
7562 Some(quantity) => builder.quantity(quantity)?,
7564 let builder = match amount_msats {
7566 Some(amount_msats) => builder.amount_msats(amount_msats)?,
7568 let builder = match payer_note {
7570 Some(payer_note) => builder.payer_note(payer_note),
7573 let invoice_request = builder.build_and_sign()?;
7574 let reply_path = self.create_one_hop_blinded_path();
7576 let expiration = StaleExpiration::TimerTicks(1);
7577 self.pending_outbound_payments
7578 .add_new_awaiting_invoice(
7579 payment_id, expiration, retry_strategy, max_total_routing_fee_msat
7581 .map_err(|_| Bolt12SemanticError::DuplicatePaymentId)?;
7583 let mut pending_offers_messages = self.pending_offers_messages.lock().unwrap();
7584 if offer.paths().is_empty() {
7585 let message = new_pending_onion_message(
7586 OffersMessage::InvoiceRequest(invoice_request),
7587 Destination::Node(offer.signing_pubkey()),
7590 pending_offers_messages.push(message);
7592 // Send as many invoice requests as there are paths in the offer (with an upper bound).
7593 // Using only one path could result in a failure if the path no longer exists. But only
7594 // one invoice for a given payment id will be paid, even if more than one is received.
7595 const REQUEST_LIMIT: usize = 10;
7596 for path in offer.paths().into_iter().take(REQUEST_LIMIT) {
7597 let message = new_pending_onion_message(
7598 OffersMessage::InvoiceRequest(invoice_request.clone()),
7599 Destination::BlindedPath(path.clone()),
7600 Some(reply_path.clone()),
7602 pending_offers_messages.push(message);
7609 /// Creates a [`Bolt12Invoice`] for a [`Refund`] and enqueues it to be sent via an onion
7612 /// The resulting invoice uses a [`PaymentHash`] recognized by the [`ChannelManager`] and a
7613 /// [`BlindedPath`] containing the [`PaymentSecret`] needed to reconstruct the corresponding
7614 /// [`PaymentPreimage`].
7618 /// Requires a direct connection to an introduction node in [`Refund::paths`] or to
7619 /// [`Refund::payer_id`], if empty. This request is best effort; an invoice will be sent to each
7620 /// node meeting the aforementioned criteria, but there's no guarantee that they will be
7621 /// received and no retries will be made.
7623 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
7624 pub fn request_refund_payment(&self, refund: &Refund) -> Result<(), Bolt12SemanticError> {
7625 let expanded_key = &self.inbound_payment_key;
7626 let entropy = &*self.entropy_source;
7627 let secp_ctx = &self.secp_ctx;
7629 let amount_msats = refund.amount_msats();
7630 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
7632 match self.create_inbound_payment(Some(amount_msats), relative_expiry, None) {
7633 Ok((payment_hash, payment_secret)) => {
7634 let payment_paths = vec![
7635 self.create_one_hop_blinded_payment_path(payment_secret),
7637 #[cfg(not(feature = "no-std"))]
7638 let builder = refund.respond_using_derived_keys(
7639 payment_paths, payment_hash, expanded_key, entropy
7641 #[cfg(feature = "no-std")]
7642 let created_at = Duration::from_secs(
7643 self.highest_seen_timestamp.load(Ordering::Acquire) as u64
7645 #[cfg(feature = "no-std")]
7646 let builder = refund.respond_using_derived_keys_no_std(
7647 payment_paths, payment_hash, created_at, expanded_key, entropy
7649 let invoice = builder.allow_mpp().build_and_sign(secp_ctx)?;
7650 let reply_path = self.create_one_hop_blinded_path();
7652 let mut pending_offers_messages = self.pending_offers_messages.lock().unwrap();
7653 if refund.paths().is_empty() {
7654 let message = new_pending_onion_message(
7655 OffersMessage::Invoice(invoice),
7656 Destination::Node(refund.payer_id()),
7659 pending_offers_messages.push(message);
7661 for path in refund.paths() {
7662 let message = new_pending_onion_message(
7663 OffersMessage::Invoice(invoice.clone()),
7664 Destination::BlindedPath(path.clone()),
7665 Some(reply_path.clone()),
7667 pending_offers_messages.push(message);
7673 Err(()) => Err(Bolt12SemanticError::InvalidAmount),
7677 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
7680 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
7681 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
7683 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
7684 /// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
7685 /// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
7686 /// passed directly to [`claim_funds`].
7688 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
7690 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
7691 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
7695 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
7696 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
7698 /// Errors if `min_value_msat` is greater than total bitcoin supply.
7700 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
7701 /// on versions of LDK prior to 0.0.114.
7703 /// [`claim_funds`]: Self::claim_funds
7704 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
7705 /// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
7706 /// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
7707 /// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
7708 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
7709 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
7710 min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
7711 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs,
7712 &self.entropy_source, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
7713 min_final_cltv_expiry_delta)
7716 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
7717 /// stored external to LDK.
7719 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
7720 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
7721 /// the `min_value_msat` provided here, if one is provided.
7723 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
7724 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
7727 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
7728 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
7729 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
7730 /// sender "proof-of-payment" unless they have paid the required amount.
7732 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
7733 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
7734 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
7735 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
7736 /// invoices when no timeout is set.
7738 /// Note that we use block header time to time-out pending inbound payments (with some margin
7739 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
7740 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
7741 /// If you need exact expiry semantics, you should enforce them upon receipt of
7742 /// [`PaymentClaimable`].
7744 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
7745 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
7747 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
7748 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
7752 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
7753 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
7755 /// Errors if `min_value_msat` is greater than total bitcoin supply.
7757 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
7758 /// on versions of LDK prior to 0.0.114.
7760 /// [`create_inbound_payment`]: Self::create_inbound_payment
7761 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
7762 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>,
7763 invoice_expiry_delta_secs: u32, min_final_cltv_expiry: Option<u16>) -> Result<PaymentSecret, ()> {
7764 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash,
7765 invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
7766 min_final_cltv_expiry)
7769 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
7770 /// previously returned from [`create_inbound_payment`].
7772 /// [`create_inbound_payment`]: Self::create_inbound_payment
7773 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
7774 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
7777 /// Creates a one-hop blinded path with [`ChannelManager::get_our_node_id`] as the introduction
7779 fn create_one_hop_blinded_path(&self) -> BlindedPath {
7780 let entropy_source = self.entropy_source.deref();
7781 let secp_ctx = &self.secp_ctx;
7782 BlindedPath::one_hop_for_message(self.get_our_node_id(), entropy_source, secp_ctx).unwrap()
7785 /// Creates a one-hop blinded path with [`ChannelManager::get_our_node_id`] as the introduction
7787 fn create_one_hop_blinded_payment_path(
7788 &self, payment_secret: PaymentSecret
7789 ) -> (BlindedPayInfo, BlindedPath) {
7790 let entropy_source = self.entropy_source.deref();
7791 let secp_ctx = &self.secp_ctx;
7793 let payee_node_id = self.get_our_node_id();
7794 let max_cltv_expiry = self.best_block.read().unwrap().height() + LATENCY_GRACE_PERIOD_BLOCKS;
7795 let payee_tlvs = ReceiveTlvs {
7797 payment_constraints: PaymentConstraints {
7799 htlc_minimum_msat: 1,
7802 // TODO: Err for overflow?
7803 BlindedPath::one_hop_for_payment(
7804 payee_node_id, payee_tlvs, entropy_source, secp_ctx
7808 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
7809 /// are used when constructing the phantom invoice's route hints.
7811 /// [phantom node payments]: crate::sign::PhantomKeysManager
7812 pub fn get_phantom_scid(&self) -> u64 {
7813 let best_block_height = self.best_block.read().unwrap().height();
7814 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
7816 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
7817 // Ensure the generated scid doesn't conflict with a real channel.
7818 match short_to_chan_info.get(&scid_candidate) {
7819 Some(_) => continue,
7820 None => return scid_candidate
7825 /// Gets route hints for use in receiving [phantom node payments].
7827 /// [phantom node payments]: crate::sign::PhantomKeysManager
7828 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
7830 channels: self.list_usable_channels(),
7831 phantom_scid: self.get_phantom_scid(),
7832 real_node_pubkey: self.get_our_node_id(),
7836 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
7837 /// used when constructing the route hints for HTLCs intended to be intercepted. See
7838 /// [`ChannelManager::forward_intercepted_htlc`].
7840 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
7841 /// times to get a unique scid.
7842 pub fn get_intercept_scid(&self) -> u64 {
7843 let best_block_height = self.best_block.read().unwrap().height();
7844 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
7846 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.chain_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
7847 // Ensure the generated scid doesn't conflict with a real channel.
7848 if short_to_chan_info.contains_key(&scid_candidate) { continue }
7849 return scid_candidate
7853 /// Gets inflight HTLC information by processing pending outbound payments that are in
7854 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
7855 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
7856 let mut inflight_htlcs = InFlightHtlcs::new();
7858 let per_peer_state = self.per_peer_state.read().unwrap();
7859 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7860 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7861 let peer_state = &mut *peer_state_lock;
7862 for chan in peer_state.channel_by_id.values().filter_map(
7863 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
7865 for (htlc_source, _) in chan.inflight_htlc_sources() {
7866 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
7867 inflight_htlcs.process_path(path, self.get_our_node_id());
7876 #[cfg(any(test, feature = "_test_utils"))]
7877 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
7878 let events = core::cell::RefCell::new(Vec::new());
7879 let event_handler = |event: events::Event| events.borrow_mut().push(event);
7880 self.process_pending_events(&event_handler);
7884 #[cfg(feature = "_test_utils")]
7885 pub fn push_pending_event(&self, event: events::Event) {
7886 let mut events = self.pending_events.lock().unwrap();
7887 events.push_back((event, None));
7891 pub fn pop_pending_event(&self) -> Option<events::Event> {
7892 let mut events = self.pending_events.lock().unwrap();
7893 events.pop_front().map(|(e, _)| e)
7897 pub fn has_pending_payments(&self) -> bool {
7898 self.pending_outbound_payments.has_pending_payments()
7902 pub fn clear_pending_payments(&self) {
7903 self.pending_outbound_payments.clear_pending_payments()
7906 /// When something which was blocking a channel from updating its [`ChannelMonitor`] (e.g. an
7907 /// [`Event`] being handled) completes, this should be called to restore the channel to normal
7908 /// operation. It will double-check that nothing *else* is also blocking the same channel from
7909 /// making progress and then let any blocked [`ChannelMonitorUpdate`]s fly.
7910 fn handle_monitor_update_release(&self, counterparty_node_id: PublicKey, channel_funding_outpoint: OutPoint, mut completed_blocker: Option<RAAMonitorUpdateBlockingAction>) {
7912 let per_peer_state = self.per_peer_state.read().unwrap();
7913 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
7914 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
7915 let peer_state = &mut *peer_state_lck;
7917 if let Some(blocker) = completed_blocker.take() {
7918 // Only do this on the first iteration of the loop.
7919 if let Some(blockers) = peer_state.actions_blocking_raa_monitor_updates
7920 .get_mut(&channel_funding_outpoint.to_channel_id())
7922 blockers.retain(|iter| iter != &blocker);
7926 if self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
7927 channel_funding_outpoint, counterparty_node_id) {
7928 // Check that, while holding the peer lock, we don't have anything else
7929 // blocking monitor updates for this channel. If we do, release the monitor
7930 // update(s) when those blockers complete.
7931 log_trace!(self.logger, "Delaying monitor unlock for channel {} as another channel's mon update needs to complete first",
7932 &channel_funding_outpoint.to_channel_id());
7936 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(channel_funding_outpoint.to_channel_id()) {
7937 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7938 debug_assert_eq!(chan.context.get_funding_txo().unwrap(), channel_funding_outpoint);
7939 if let Some((monitor_update, further_update_exists)) = chan.unblock_next_blocked_monitor_update() {
7940 log_debug!(self.logger, "Unlocking monitor updating for channel {} and updating monitor",
7941 channel_funding_outpoint.to_channel_id());
7942 handle_new_monitor_update!(self, channel_funding_outpoint, monitor_update,
7943 peer_state_lck, peer_state, per_peer_state, chan);
7944 if further_update_exists {
7945 // If there are more `ChannelMonitorUpdate`s to process, restart at the
7950 log_trace!(self.logger, "Unlocked monitor updating for channel {} without monitors to update",
7951 channel_funding_outpoint.to_channel_id());
7956 log_debug!(self.logger,
7957 "Got a release post-RAA monitor update for peer {} but the channel is gone",
7958 log_pubkey!(counterparty_node_id));
7964 fn handle_post_event_actions(&self, actions: Vec<EventCompletionAction>) {
7965 for action in actions {
7967 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
7968 channel_funding_outpoint, counterparty_node_id
7970 self.handle_monitor_update_release(counterparty_node_id, channel_funding_outpoint, None);
7976 /// Processes any events asynchronously in the order they were generated since the last call
7977 /// using the given event handler.
7979 /// See the trait-level documentation of [`EventsProvider`] for requirements.
7980 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
7984 process_events_body!(self, ev, { handler(ev).await });
7988 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>
7990 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7991 T::Target: BroadcasterInterface,
7992 ES::Target: EntropySource,
7993 NS::Target: NodeSigner,
7994 SP::Target: SignerProvider,
7995 F::Target: FeeEstimator,
7999 /// Returns `MessageSendEvent`s strictly ordered per-peer, in the order they were generated.
8000 /// The returned array will contain `MessageSendEvent`s for different peers if
8001 /// `MessageSendEvent`s to more than one peer exists, but `MessageSendEvent`s to the same peer
8002 /// is always placed next to each other.
8004 /// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
8005 /// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
8006 /// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
8007 /// will randomly be placed first or last in the returned array.
8009 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
8010 /// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
8011 /// the `MessageSendEvent`s to the specific peer they were generated under.
8012 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
8013 let events = RefCell::new(Vec::new());
8014 PersistenceNotifierGuard::optionally_notify(self, || {
8015 let mut result = NotifyOption::SkipPersistNoEvents;
8017 // TODO: This behavior should be documented. It's unintuitive that we query
8018 // ChannelMonitors when clearing other events.
8019 if self.process_pending_monitor_events() {
8020 result = NotifyOption::DoPersist;
8023 if self.check_free_holding_cells() {
8024 result = NotifyOption::DoPersist;
8026 if self.maybe_generate_initial_closing_signed() {
8027 result = NotifyOption::DoPersist;
8030 let mut pending_events = Vec::new();
8031 let per_peer_state = self.per_peer_state.read().unwrap();
8032 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
8033 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8034 let peer_state = &mut *peer_state_lock;
8035 if peer_state.pending_msg_events.len() > 0 {
8036 pending_events.append(&mut peer_state.pending_msg_events);
8040 if !pending_events.is_empty() {
8041 events.replace(pending_events);
8050 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>
8052 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8053 T::Target: BroadcasterInterface,
8054 ES::Target: EntropySource,
8055 NS::Target: NodeSigner,
8056 SP::Target: SignerProvider,
8057 F::Target: FeeEstimator,
8061 /// Processes events that must be periodically handled.
8063 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
8064 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
8065 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
8067 process_events_body!(self, ev, handler.handle_event(ev));
8071 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>
8073 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8074 T::Target: BroadcasterInterface,
8075 ES::Target: EntropySource,
8076 NS::Target: NodeSigner,
8077 SP::Target: SignerProvider,
8078 F::Target: FeeEstimator,
8082 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
8084 let best_block = self.best_block.read().unwrap();
8085 assert_eq!(best_block.block_hash(), header.prev_blockhash,
8086 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
8087 assert_eq!(best_block.height(), height - 1,
8088 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
8091 self.transactions_confirmed(header, txdata, height);
8092 self.best_block_updated(header, height);
8095 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
8096 let _persistence_guard =
8097 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8098 self, || -> NotifyOption { NotifyOption::DoPersist });
8099 let new_height = height - 1;
8101 let mut best_block = self.best_block.write().unwrap();
8102 assert_eq!(best_block.block_hash(), header.block_hash(),
8103 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
8104 assert_eq!(best_block.height(), height,
8105 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
8106 *best_block = BestBlock::new(header.prev_blockhash, new_height)
8109 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, &self.logger));
8113 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>
8115 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8116 T::Target: BroadcasterInterface,
8117 ES::Target: EntropySource,
8118 NS::Target: NodeSigner,
8119 SP::Target: SignerProvider,
8120 F::Target: FeeEstimator,
8124 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
8125 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
8126 // during initialization prior to the chain_monitor being fully configured in some cases.
8127 // See the docs for `ChannelManagerReadArgs` for more.
8129 let block_hash = header.block_hash();
8130 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
8132 let _persistence_guard =
8133 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8134 self, || -> NotifyOption { NotifyOption::DoPersist });
8135 self.do_chain_event(Some(height), |channel| channel.transactions_confirmed(&block_hash, height, txdata, self.chain_hash, &self.node_signer, &self.default_configuration, &self.logger)
8136 .map(|(a, b)| (a, Vec::new(), b)));
8138 let last_best_block_height = self.best_block.read().unwrap().height();
8139 if height < last_best_block_height {
8140 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
8141 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, &self.logger));
8145 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
8146 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
8147 // during initialization prior to the chain_monitor being fully configured in some cases.
8148 // See the docs for `ChannelManagerReadArgs` for more.
8150 let block_hash = header.block_hash();
8151 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
8153 let _persistence_guard =
8154 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8155 self, || -> NotifyOption { NotifyOption::DoPersist });
8156 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
8158 self.do_chain_event(Some(height), |channel| channel.best_block_updated(height, header.time, self.chain_hash, &self.node_signer, &self.default_configuration, &self.logger));
8160 macro_rules! max_time {
8161 ($timestamp: expr) => {
8163 // Update $timestamp to be the max of its current value and the block
8164 // timestamp. This should keep us close to the current time without relying on
8165 // having an explicit local time source.
8166 // Just in case we end up in a race, we loop until we either successfully
8167 // update $timestamp or decide we don't need to.
8168 let old_serial = $timestamp.load(Ordering::Acquire);
8169 if old_serial >= header.time as usize { break; }
8170 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
8176 max_time!(self.highest_seen_timestamp);
8177 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
8178 payment_secrets.retain(|_, inbound_payment| {
8179 inbound_payment.expiry_time > header.time as u64
8183 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
8184 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
8185 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
8186 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8187 let peer_state = &mut *peer_state_lock;
8188 for chan in peer_state.channel_by_id.values().filter_map(|phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }) {
8189 if let (Some(funding_txo), Some(block_hash)) = (chan.context.get_funding_txo(), chan.context.get_funding_tx_confirmed_in()) {
8190 res.push((funding_txo.txid, Some(block_hash)));
8197 fn transaction_unconfirmed(&self, txid: &Txid) {
8198 let _persistence_guard =
8199 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
8200 self, || -> NotifyOption { NotifyOption::DoPersist });
8201 self.do_chain_event(None, |channel| {
8202 if let Some(funding_txo) = channel.context.get_funding_txo() {
8203 if funding_txo.txid == *txid {
8204 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
8205 } else { Ok((None, Vec::new(), None)) }
8206 } else { Ok((None, Vec::new(), None)) }
8211 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>
8213 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8214 T::Target: BroadcasterInterface,
8215 ES::Target: EntropySource,
8216 NS::Target: NodeSigner,
8217 SP::Target: SignerProvider,
8218 F::Target: FeeEstimator,
8222 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
8223 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
8225 fn do_chain_event<FN: Fn(&mut Channel<SP>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
8226 (&self, height_opt: Option<u32>, f: FN) {
8227 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
8228 // during initialization prior to the chain_monitor being fully configured in some cases.
8229 // See the docs for `ChannelManagerReadArgs` for more.
8231 let mut failed_channels = Vec::new();
8232 let mut timed_out_htlcs = Vec::new();
8234 let per_peer_state = self.per_peer_state.read().unwrap();
8235 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
8236 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8237 let peer_state = &mut *peer_state_lock;
8238 let pending_msg_events = &mut peer_state.pending_msg_events;
8239 peer_state.channel_by_id.retain(|_, phase| {
8241 // Retain unfunded channels.
8242 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => true,
8243 ChannelPhase::Funded(channel) => {
8244 let res = f(channel);
8245 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
8246 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
8247 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
8248 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
8249 HTLCDestination::NextHopChannel { node_id: Some(channel.context.get_counterparty_node_id()), channel_id: channel.context.channel_id() }));
8251 if let Some(channel_ready) = channel_ready_opt {
8252 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
8253 if channel.context.is_usable() {
8254 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", channel.context.channel_id());
8255 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
8256 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
8257 node_id: channel.context.get_counterparty_node_id(),
8262 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", channel.context.channel_id());
8267 let mut pending_events = self.pending_events.lock().unwrap();
8268 emit_channel_ready_event!(pending_events, channel);
8271 if let Some(announcement_sigs) = announcement_sigs {
8272 log_trace!(self.logger, "Sending announcement_signatures for channel {}", channel.context.channel_id());
8273 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
8274 node_id: channel.context.get_counterparty_node_id(),
8275 msg: announcement_sigs,
8277 if let Some(height) = height_opt {
8278 if let Some(announcement) = channel.get_signed_channel_announcement(&self.node_signer, self.chain_hash, height, &self.default_configuration) {
8279 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
8281 // Note that announcement_signatures fails if the channel cannot be announced,
8282 // so get_channel_update_for_broadcast will never fail by the time we get here.
8283 update_msg: Some(self.get_channel_update_for_broadcast(channel).unwrap()),
8288 if channel.is_our_channel_ready() {
8289 if let Some(real_scid) = channel.context.get_short_channel_id() {
8290 // If we sent a 0conf channel_ready, and now have an SCID, we add it
8291 // to the short_to_chan_info map here. Note that we check whether we
8292 // can relay using the real SCID at relay-time (i.e.
8293 // enforce option_scid_alias then), and if the funding tx is ever
8294 // un-confirmed we force-close the channel, ensuring short_to_chan_info
8295 // is always consistent.
8296 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
8297 let scid_insert = short_to_chan_info.insert(real_scid, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8298 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.context.get_counterparty_node_id(), channel.context.channel_id()),
8299 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
8300 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
8303 } else if let Err(reason) = res {
8304 update_maps_on_chan_removal!(self, &channel.context);
8305 // It looks like our counterparty went on-chain or funding transaction was
8306 // reorged out of the main chain. Close the channel.
8307 failed_channels.push(channel.context.force_shutdown(true));
8308 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
8309 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
8313 let reason_message = format!("{}", reason);
8314 self.issue_channel_close_events(&channel.context, reason);
8315 pending_msg_events.push(events::MessageSendEvent::HandleError {
8316 node_id: channel.context.get_counterparty_node_id(),
8317 action: msgs::ErrorAction::DisconnectPeer {
8318 msg: Some(msgs::ErrorMessage {
8319 channel_id: channel.context.channel_id(),
8320 data: reason_message,
8333 if let Some(height) = height_opt {
8334 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
8335 payment.htlcs.retain(|htlc| {
8336 // If height is approaching the number of blocks we think it takes us to get
8337 // our commitment transaction confirmed before the HTLC expires, plus the
8338 // number of blocks we generally consider it to take to do a commitment update,
8339 // just give up on it and fail the HTLC.
8340 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
8341 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
8342 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
8344 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
8345 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
8346 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
8350 !payment.htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
8353 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
8354 intercepted_htlcs.retain(|_, htlc| {
8355 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
8356 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
8357 short_channel_id: htlc.prev_short_channel_id,
8358 user_channel_id: Some(htlc.prev_user_channel_id),
8359 htlc_id: htlc.prev_htlc_id,
8360 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
8361 phantom_shared_secret: None,
8362 outpoint: htlc.prev_funding_outpoint,
8365 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
8366 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
8367 _ => unreachable!(),
8369 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
8370 HTLCFailReason::from_failure_code(0x2000 | 2),
8371 HTLCDestination::InvalidForward { requested_forward_scid }));
8372 log_trace!(self.logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
8378 self.handle_init_event_channel_failures(failed_channels);
8380 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
8381 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
8385 /// Gets a [`Future`] that completes when this [`ChannelManager`] may need to be persisted or
8386 /// may have events that need processing.
8388 /// In order to check if this [`ChannelManager`] needs persisting, call
8389 /// [`Self::get_and_clear_needs_persistence`].
8391 /// Note that callbacks registered on the [`Future`] MUST NOT call back into this
8392 /// [`ChannelManager`] and should instead register actions to be taken later.
8393 pub fn get_event_or_persistence_needed_future(&self) -> Future {
8394 self.event_persist_notifier.get_future()
8397 /// Returns true if this [`ChannelManager`] needs to be persisted.
8398 pub fn get_and_clear_needs_persistence(&self) -> bool {
8399 self.needs_persist_flag.swap(false, Ordering::AcqRel)
8402 #[cfg(any(test, feature = "_test_utils"))]
8403 pub fn get_event_or_persist_condvar_value(&self) -> bool {
8404 self.event_persist_notifier.notify_pending()
8407 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
8408 /// [`chain::Confirm`] interfaces.
8409 pub fn current_best_block(&self) -> BestBlock {
8410 self.best_block.read().unwrap().clone()
8413 /// Fetches the set of [`NodeFeatures`] flags that are provided by or required by
8414 /// [`ChannelManager`].
8415 pub fn node_features(&self) -> NodeFeatures {
8416 provided_node_features(&self.default_configuration)
8419 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags that are provided by or required by
8420 /// [`ChannelManager`].
8422 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
8423 /// or not. Thus, this method is not public.
8424 #[cfg(any(feature = "_test_utils", test))]
8425 pub fn bolt11_invoice_features(&self) -> Bolt11InvoiceFeatures {
8426 provided_bolt11_invoice_features(&self.default_configuration)
8429 /// Fetches the set of [`Bolt12InvoiceFeatures`] flags that are provided by or required by
8430 /// [`ChannelManager`].
8431 fn bolt12_invoice_features(&self) -> Bolt12InvoiceFeatures {
8432 provided_bolt12_invoice_features(&self.default_configuration)
8435 /// Fetches the set of [`ChannelFeatures`] flags that are provided by or required by
8436 /// [`ChannelManager`].
8437 pub fn channel_features(&self) -> ChannelFeatures {
8438 provided_channel_features(&self.default_configuration)
8441 /// Fetches the set of [`ChannelTypeFeatures`] flags that are provided by or required by
8442 /// [`ChannelManager`].
8443 pub fn channel_type_features(&self) -> ChannelTypeFeatures {
8444 provided_channel_type_features(&self.default_configuration)
8447 /// Fetches the set of [`InitFeatures`] flags that are provided by or required by
8448 /// [`ChannelManager`].
8449 pub fn init_features(&self) -> InitFeatures {
8450 provided_init_features(&self.default_configuration)
8454 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8455 ChannelMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
8457 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8458 T::Target: BroadcasterInterface,
8459 ES::Target: EntropySource,
8460 NS::Target: NodeSigner,
8461 SP::Target: SignerProvider,
8462 F::Target: FeeEstimator,
8466 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) {
8467 // Note that we never need to persist the updated ChannelManager for an inbound
8468 // open_channel message - pre-funded channels are never written so there should be no
8469 // change to the contents.
8470 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8471 let res = self.internal_open_channel(counterparty_node_id, msg);
8472 let persist = match &res {
8473 Err(e) if e.closes_channel() => {
8474 debug_assert!(false, "We shouldn't close a new channel");
8475 NotifyOption::DoPersist
8477 _ => NotifyOption::SkipPersistHandleEvents,
8479 let _ = handle_error!(self, res, *counterparty_node_id);
8484 fn handle_open_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
8485 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8486 "Dual-funded channels not supported".to_owned(),
8487 msg.temporary_channel_id.clone())), *counterparty_node_id);
8490 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
8491 // Note that we never need to persist the updated ChannelManager for an inbound
8492 // accept_channel message - pre-funded channels are never written so there should be no
8493 // change to the contents.
8494 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8495 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, msg), *counterparty_node_id);
8496 NotifyOption::SkipPersistHandleEvents
8500 fn handle_accept_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
8501 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8502 "Dual-funded channels not supported".to_owned(),
8503 msg.temporary_channel_id.clone())), *counterparty_node_id);
8506 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
8507 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8508 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
8511 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
8512 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8513 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
8516 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
8517 // Note that we never need to persist the updated ChannelManager for an inbound
8518 // channel_ready message - while the channel's state will change, any channel_ready message
8519 // will ultimately be re-sent on startup and the `ChannelMonitor` won't be updated so we
8520 // will not force-close the channel on startup.
8521 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8522 let res = self.internal_channel_ready(counterparty_node_id, msg);
8523 let persist = match &res {
8524 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8525 _ => NotifyOption::SkipPersistHandleEvents,
8527 let _ = handle_error!(self, res, *counterparty_node_id);
8532 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
8533 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8534 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
8537 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
8538 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8539 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
8542 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
8543 // Note that we never need to persist the updated ChannelManager for an inbound
8544 // update_add_htlc message - the message itself doesn't change our channel state only the
8545 // `commitment_signed` message afterwards will.
8546 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8547 let res = self.internal_update_add_htlc(counterparty_node_id, msg);
8548 let persist = match &res {
8549 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8550 Err(_) => NotifyOption::SkipPersistHandleEvents,
8551 Ok(()) => NotifyOption::SkipPersistNoEvents,
8553 let _ = handle_error!(self, res, *counterparty_node_id);
8558 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
8559 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8560 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
8563 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
8564 // Note that we never need to persist the updated ChannelManager for an inbound
8565 // update_fail_htlc message - the message itself doesn't change our channel state only the
8566 // `commitment_signed` message afterwards will.
8567 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8568 let res = self.internal_update_fail_htlc(counterparty_node_id, msg);
8569 let persist = match &res {
8570 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8571 Err(_) => NotifyOption::SkipPersistHandleEvents,
8572 Ok(()) => NotifyOption::SkipPersistNoEvents,
8574 let _ = handle_error!(self, res, *counterparty_node_id);
8579 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
8580 // Note that we never need to persist the updated ChannelManager for an inbound
8581 // update_fail_malformed_htlc message - the message itself doesn't change our channel state
8582 // only the `commitment_signed` message afterwards will.
8583 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8584 let res = self.internal_update_fail_malformed_htlc(counterparty_node_id, msg);
8585 let persist = match &res {
8586 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8587 Err(_) => NotifyOption::SkipPersistHandleEvents,
8588 Ok(()) => NotifyOption::SkipPersistNoEvents,
8590 let _ = handle_error!(self, res, *counterparty_node_id);
8595 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
8596 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8597 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
8600 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
8601 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8602 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
8605 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
8606 // Note that we never need to persist the updated ChannelManager for an inbound
8607 // update_fee message - the message itself doesn't change our channel state only the
8608 // `commitment_signed` message afterwards will.
8609 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8610 let res = self.internal_update_fee(counterparty_node_id, msg);
8611 let persist = match &res {
8612 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8613 Err(_) => NotifyOption::SkipPersistHandleEvents,
8614 Ok(()) => NotifyOption::SkipPersistNoEvents,
8616 let _ = handle_error!(self, res, *counterparty_node_id);
8621 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
8622 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8623 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
8626 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
8627 PersistenceNotifierGuard::optionally_notify(self, || {
8628 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
8631 NotifyOption::DoPersist
8636 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
8637 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
8638 let res = self.internal_channel_reestablish(counterparty_node_id, msg);
8639 let persist = match &res {
8640 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8641 Err(_) => NotifyOption::SkipPersistHandleEvents,
8642 Ok(persist) => *persist,
8644 let _ = handle_error!(self, res, *counterparty_node_id);
8649 fn peer_disconnected(&self, counterparty_node_id: &PublicKey) {
8650 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(
8651 self, || NotifyOption::SkipPersistHandleEvents);
8652 let mut failed_channels = Vec::new();
8653 let mut per_peer_state = self.per_peer_state.write().unwrap();
8655 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates.",
8656 log_pubkey!(counterparty_node_id));
8657 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
8658 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8659 let peer_state = &mut *peer_state_lock;
8660 let pending_msg_events = &mut peer_state.pending_msg_events;
8661 peer_state.channel_by_id.retain(|_, phase| {
8662 let context = match phase {
8663 ChannelPhase::Funded(chan) => {
8664 if chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger).is_ok() {
8665 // We only retain funded channels that are not shutdown.
8670 // Unfunded channels will always be removed.
8671 ChannelPhase::UnfundedOutboundV1(chan) => {
8674 ChannelPhase::UnfundedInboundV1(chan) => {
8678 // Clean up for removal.
8679 update_maps_on_chan_removal!(self, &context);
8680 self.issue_channel_close_events(&context, ClosureReason::DisconnectedPeer);
8681 failed_channels.push(context.force_shutdown(false));
8684 // Note that we don't bother generating any events for pre-accept channels -
8685 // they're not considered "channels" yet from the PoV of our events interface.
8686 peer_state.inbound_channel_request_by_id.clear();
8687 pending_msg_events.retain(|msg| {
8689 // V1 Channel Establishment
8690 &events::MessageSendEvent::SendAcceptChannel { .. } => false,
8691 &events::MessageSendEvent::SendOpenChannel { .. } => false,
8692 &events::MessageSendEvent::SendFundingCreated { .. } => false,
8693 &events::MessageSendEvent::SendFundingSigned { .. } => false,
8694 // V2 Channel Establishment
8695 &events::MessageSendEvent::SendAcceptChannelV2 { .. } => false,
8696 &events::MessageSendEvent::SendOpenChannelV2 { .. } => false,
8697 // Common Channel Establishment
8698 &events::MessageSendEvent::SendChannelReady { .. } => false,
8699 &events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
8700 // Interactive Transaction Construction
8701 &events::MessageSendEvent::SendTxAddInput { .. } => false,
8702 &events::MessageSendEvent::SendTxAddOutput { .. } => false,
8703 &events::MessageSendEvent::SendTxRemoveInput { .. } => false,
8704 &events::MessageSendEvent::SendTxRemoveOutput { .. } => false,
8705 &events::MessageSendEvent::SendTxComplete { .. } => false,
8706 &events::MessageSendEvent::SendTxSignatures { .. } => false,
8707 &events::MessageSendEvent::SendTxInitRbf { .. } => false,
8708 &events::MessageSendEvent::SendTxAckRbf { .. } => false,
8709 &events::MessageSendEvent::SendTxAbort { .. } => false,
8710 // Channel Operations
8711 &events::MessageSendEvent::UpdateHTLCs { .. } => false,
8712 &events::MessageSendEvent::SendRevokeAndACK { .. } => false,
8713 &events::MessageSendEvent::SendClosingSigned { .. } => false,
8714 &events::MessageSendEvent::SendShutdown { .. } => false,
8715 &events::MessageSendEvent::SendChannelReestablish { .. } => false,
8716 &events::MessageSendEvent::HandleError { .. } => false,
8718 &events::MessageSendEvent::SendChannelAnnouncement { .. } => false,
8719 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
8720 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
8721 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
8722 &events::MessageSendEvent::SendChannelUpdate { .. } => false,
8723 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
8724 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
8725 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
8726 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
8729 debug_assert!(peer_state.is_connected, "A disconnected peer cannot disconnect");
8730 peer_state.is_connected = false;
8731 peer_state.ok_to_remove(true)
8732 } else { debug_assert!(false, "Unconnected peer disconnected"); true }
8735 per_peer_state.remove(counterparty_node_id);
8737 mem::drop(per_peer_state);
8739 for failure in failed_channels.drain(..) {
8740 self.finish_close_channel(failure);
8744 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init, inbound: bool) -> Result<(), ()> {
8745 if !init_msg.features.supports_static_remote_key() {
8746 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting", log_pubkey!(counterparty_node_id));
8750 let mut res = Ok(());
8752 PersistenceNotifierGuard::optionally_notify(self, || {
8753 // If we have too many peers connected which don't have funded channels, disconnect the
8754 // peer immediately (as long as it doesn't have funded channels). If we have a bunch of
8755 // unfunded channels taking up space in memory for disconnected peers, we still let new
8756 // peers connect, but we'll reject new channels from them.
8757 let connected_peers_without_funded_channels = self.peers_without_funded_channels(|node| node.is_connected);
8758 let inbound_peer_limited = inbound && connected_peers_without_funded_channels >= MAX_NO_CHANNEL_PEERS;
8761 let mut peer_state_lock = self.per_peer_state.write().unwrap();
8762 match peer_state_lock.entry(counterparty_node_id.clone()) {
8763 hash_map::Entry::Vacant(e) => {
8764 if inbound_peer_limited {
8766 return NotifyOption::SkipPersistNoEvents;
8768 e.insert(Mutex::new(PeerState {
8769 channel_by_id: HashMap::new(),
8770 inbound_channel_request_by_id: HashMap::new(),
8771 latest_features: init_msg.features.clone(),
8772 pending_msg_events: Vec::new(),
8773 in_flight_monitor_updates: BTreeMap::new(),
8774 monitor_update_blocked_actions: BTreeMap::new(),
8775 actions_blocking_raa_monitor_updates: BTreeMap::new(),
8779 hash_map::Entry::Occupied(e) => {
8780 let mut peer_state = e.get().lock().unwrap();
8781 peer_state.latest_features = init_msg.features.clone();
8783 let best_block_height = self.best_block.read().unwrap().height();
8784 if inbound_peer_limited &&
8785 Self::unfunded_channel_count(&*peer_state, best_block_height) ==
8786 peer_state.channel_by_id.len()
8789 return NotifyOption::SkipPersistNoEvents;
8792 debug_assert!(!peer_state.is_connected, "A peer shouldn't be connected twice");
8793 peer_state.is_connected = true;
8798 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
8800 let per_peer_state = self.per_peer_state.read().unwrap();
8801 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
8802 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8803 let peer_state = &mut *peer_state_lock;
8804 let pending_msg_events = &mut peer_state.pending_msg_events;
8806 peer_state.channel_by_id.iter_mut().filter_map(|(_, phase)|
8807 if let ChannelPhase::Funded(chan) = phase { Some(chan) } else {
8808 // Since unfunded channel maps are cleared upon disconnecting a peer, and they're not persisted
8809 // (so won't be recovered after a crash), they shouldn't exist here and we would never need to
8810 // worry about closing and removing them.
8811 debug_assert!(false);
8815 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
8816 node_id: chan.context.get_counterparty_node_id(),
8817 msg: chan.get_channel_reestablish(&self.logger),
8822 return NotifyOption::SkipPersistHandleEvents;
8823 //TODO: Also re-broadcast announcement_signatures
8828 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
8829 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8831 match &msg.data as &str {
8832 "cannot co-op close channel w/ active htlcs"|
8833 "link failed to shutdown" =>
8835 // LND hasn't properly handled shutdown messages ever, and force-closes any time we
8836 // send one while HTLCs are still present. The issue is tracked at
8837 // https://github.com/lightningnetwork/lnd/issues/6039 and has had multiple patches
8838 // to fix it but none so far have managed to land upstream. The issue appears to be
8839 // very low priority for the LND team despite being marked "P1".
8840 // We're not going to bother handling this in a sensible way, instead simply
8841 // repeating the Shutdown message on repeat until morale improves.
8842 if !msg.channel_id.is_zero() {
8843 let per_peer_state = self.per_peer_state.read().unwrap();
8844 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
8845 if peer_state_mutex_opt.is_none() { return; }
8846 let mut peer_state = peer_state_mutex_opt.unwrap().lock().unwrap();
8847 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get(&msg.channel_id) {
8848 if let Some(msg) = chan.get_outbound_shutdown() {
8849 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
8850 node_id: *counterparty_node_id,
8854 peer_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
8855 node_id: *counterparty_node_id,
8856 action: msgs::ErrorAction::SendWarningMessage {
8857 msg: msgs::WarningMessage {
8858 channel_id: msg.channel_id,
8859 data: "You appear to be exhibiting LND bug 6039, we'll keep sending you shutdown messages until you handle them correctly".to_owned()
8861 log_level: Level::Trace,
8871 if msg.channel_id.is_zero() {
8872 let channel_ids: Vec<ChannelId> = {
8873 let per_peer_state = self.per_peer_state.read().unwrap();
8874 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
8875 if peer_state_mutex_opt.is_none() { return; }
8876 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
8877 let peer_state = &mut *peer_state_lock;
8878 // Note that we don't bother generating any events for pre-accept channels -
8879 // they're not considered "channels" yet from the PoV of our events interface.
8880 peer_state.inbound_channel_request_by_id.clear();
8881 peer_state.channel_by_id.keys().cloned().collect()
8883 for channel_id in channel_ids {
8884 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
8885 let _ = self.force_close_channel_with_peer(&channel_id, counterparty_node_id, Some(&msg.data), true);
8889 // First check if we can advance the channel type and try again.
8890 let per_peer_state = self.per_peer_state.read().unwrap();
8891 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
8892 if peer_state_mutex_opt.is_none() { return; }
8893 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
8894 let peer_state = &mut *peer_state_lock;
8895 if let Some(ChannelPhase::UnfundedOutboundV1(chan)) = peer_state.channel_by_id.get_mut(&msg.channel_id) {
8896 if let Ok(msg) = chan.maybe_handle_error_without_close(self.chain_hash, &self.fee_estimator) {
8897 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
8898 node_id: *counterparty_node_id,
8906 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
8907 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
8911 fn provided_node_features(&self) -> NodeFeatures {
8912 provided_node_features(&self.default_configuration)
8915 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
8916 provided_init_features(&self.default_configuration)
8919 fn get_chain_hashes(&self) -> Option<Vec<ChainHash>> {
8920 Some(vec![self.chain_hash])
8923 fn handle_tx_add_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddInput) {
8924 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8925 "Dual-funded channels not supported".to_owned(),
8926 msg.channel_id.clone())), *counterparty_node_id);
8929 fn handle_tx_add_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
8930 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8931 "Dual-funded channels not supported".to_owned(),
8932 msg.channel_id.clone())), *counterparty_node_id);
8935 fn handle_tx_remove_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
8936 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8937 "Dual-funded channels not supported".to_owned(),
8938 msg.channel_id.clone())), *counterparty_node_id);
8941 fn handle_tx_remove_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
8942 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8943 "Dual-funded channels not supported".to_owned(),
8944 msg.channel_id.clone())), *counterparty_node_id);
8947 fn handle_tx_complete(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxComplete) {
8948 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8949 "Dual-funded channels not supported".to_owned(),
8950 msg.channel_id.clone())), *counterparty_node_id);
8953 fn handle_tx_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxSignatures) {
8954 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8955 "Dual-funded channels not supported".to_owned(),
8956 msg.channel_id.clone())), *counterparty_node_id);
8959 fn handle_tx_init_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
8960 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8961 "Dual-funded channels not supported".to_owned(),
8962 msg.channel_id.clone())), *counterparty_node_id);
8965 fn handle_tx_ack_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
8966 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8967 "Dual-funded channels not supported".to_owned(),
8968 msg.channel_id.clone())), *counterparty_node_id);
8971 fn handle_tx_abort(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAbort) {
8972 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8973 "Dual-funded channels not supported".to_owned(),
8974 msg.channel_id.clone())), *counterparty_node_id);
8978 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8979 OffersMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
8981 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8982 T::Target: BroadcasterInterface,
8983 ES::Target: EntropySource,
8984 NS::Target: NodeSigner,
8985 SP::Target: SignerProvider,
8986 F::Target: FeeEstimator,
8990 fn handle_message(&self, message: OffersMessage) -> Option<OffersMessage> {
8991 let secp_ctx = &self.secp_ctx;
8992 let expanded_key = &self.inbound_payment_key;
8995 OffersMessage::InvoiceRequest(invoice_request) => {
8996 let amount_msats = match InvoiceBuilder::<DerivedSigningPubkey>::amount_msats(
8999 Ok(amount_msats) => Some(amount_msats),
9000 Err(error) => return Some(OffersMessage::InvoiceError(error.into())),
9002 let invoice_request = match invoice_request.verify(expanded_key, secp_ctx) {
9003 Ok(invoice_request) => invoice_request,
9005 let error = Bolt12SemanticError::InvalidMetadata;
9006 return Some(OffersMessage::InvoiceError(error.into()));
9009 let relative_expiry = DEFAULT_RELATIVE_EXPIRY.as_secs() as u32;
9011 match self.create_inbound_payment(amount_msats, relative_expiry, None) {
9012 Ok((payment_hash, payment_secret)) if invoice_request.keys.is_some() => {
9013 let payment_paths = vec![
9014 self.create_one_hop_blinded_payment_path(payment_secret),
9016 #[cfg(not(feature = "no-std"))]
9017 let builder = invoice_request.respond_using_derived_keys(
9018 payment_paths, payment_hash
9020 #[cfg(feature = "no-std")]
9021 let created_at = Duration::from_secs(
9022 self.highest_seen_timestamp.load(Ordering::Acquire) as u64
9024 #[cfg(feature = "no-std")]
9025 let builder = invoice_request.respond_using_derived_keys_no_std(
9026 payment_paths, payment_hash, created_at
9028 match builder.and_then(|b| b.allow_mpp().build_and_sign(secp_ctx)) {
9029 Ok(invoice) => Some(OffersMessage::Invoice(invoice)),
9030 Err(error) => Some(OffersMessage::InvoiceError(error.into())),
9033 Ok((payment_hash, payment_secret)) => {
9034 let payment_paths = vec![
9035 self.create_one_hop_blinded_payment_path(payment_secret),
9037 #[cfg(not(feature = "no-std"))]
9038 let builder = invoice_request.respond_with(payment_paths, payment_hash);
9039 #[cfg(feature = "no-std")]
9040 let created_at = Duration::from_secs(
9041 self.highest_seen_timestamp.load(Ordering::Acquire) as u64
9043 #[cfg(feature = "no-std")]
9044 let builder = invoice_request.respond_with_no_std(
9045 payment_paths, payment_hash, created_at
9047 let response = builder.and_then(|builder| builder.allow_mpp().build())
9048 .map_err(|e| OffersMessage::InvoiceError(e.into()))
9050 match invoice.sign(|invoice| self.node_signer.sign_bolt12_invoice(invoice)) {
9051 Ok(invoice) => Ok(OffersMessage::Invoice(invoice)),
9052 Err(SignError::Signing(())) => Err(OffersMessage::InvoiceError(
9053 InvoiceError::from_string("Failed signing invoice".to_string())
9055 Err(SignError::Verification(_)) => Err(OffersMessage::InvoiceError(
9056 InvoiceError::from_string("Failed invoice signature verification".to_string())
9060 Ok(invoice) => Some(invoice),
9061 Err(error) => Some(error),
9065 Some(OffersMessage::InvoiceError(Bolt12SemanticError::InvalidAmount.into()))
9069 OffersMessage::Invoice(invoice) => {
9070 match invoice.verify(expanded_key, secp_ctx) {
9072 Some(OffersMessage::InvoiceError(InvoiceError::from_string("Unrecognized invoice".to_owned())))
9074 Ok(_) if invoice.invoice_features().requires_unknown_bits_from(&self.bolt12_invoice_features()) => {
9075 Some(OffersMessage::InvoiceError(Bolt12SemanticError::UnknownRequiredFeatures.into()))
9078 if let Err(e) = self.send_payment_for_bolt12_invoice(&invoice, payment_id) {
9079 log_trace!(self.logger, "Failed paying invoice: {:?}", e);
9080 Some(OffersMessage::InvoiceError(InvoiceError::from_string(format!("{:?}", e))))
9087 OffersMessage::InvoiceError(invoice_error) => {
9088 log_trace!(self.logger, "Received invoice_error: {}", invoice_error);
9094 fn release_pending_messages(&self) -> Vec<PendingOnionMessage<OffersMessage>> {
9095 core::mem::take(&mut self.pending_offers_messages.lock().unwrap())
9099 /// Fetches the set of [`NodeFeatures`] flags that are provided by or required by
9100 /// [`ChannelManager`].
9101 pub(crate) fn provided_node_features(config: &UserConfig) -> NodeFeatures {
9102 let mut node_features = provided_init_features(config).to_context();
9103 node_features.set_keysend_optional();
9107 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags that are provided by or required by
9108 /// [`ChannelManager`].
9110 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
9111 /// or not. Thus, this method is not public.
9112 #[cfg(any(feature = "_test_utils", test))]
9113 pub(crate) fn provided_bolt11_invoice_features(config: &UserConfig) -> Bolt11InvoiceFeatures {
9114 provided_init_features(config).to_context()
9117 /// Fetches the set of [`Bolt12InvoiceFeatures`] flags that are provided by or required by
9118 /// [`ChannelManager`].
9119 pub(crate) fn provided_bolt12_invoice_features(config: &UserConfig) -> Bolt12InvoiceFeatures {
9120 provided_init_features(config).to_context()
9123 /// Fetches the set of [`ChannelFeatures`] flags that are provided by or required by
9124 /// [`ChannelManager`].
9125 pub(crate) fn provided_channel_features(config: &UserConfig) -> ChannelFeatures {
9126 provided_init_features(config).to_context()
9129 /// Fetches the set of [`ChannelTypeFeatures`] flags that are provided by or required by
9130 /// [`ChannelManager`].
9131 pub(crate) fn provided_channel_type_features(config: &UserConfig) -> ChannelTypeFeatures {
9132 ChannelTypeFeatures::from_init(&provided_init_features(config))
9135 /// Fetches the set of [`InitFeatures`] flags that are provided by or required by
9136 /// [`ChannelManager`].
9137 pub fn provided_init_features(config: &UserConfig) -> InitFeatures {
9138 // Note that if new features are added here which other peers may (eventually) require, we
9139 // should also add the corresponding (optional) bit to the [`ChannelMessageHandler`] impl for
9140 // [`ErroringMessageHandler`].
9141 let mut features = InitFeatures::empty();
9142 features.set_data_loss_protect_required();
9143 features.set_upfront_shutdown_script_optional();
9144 features.set_variable_length_onion_required();
9145 features.set_static_remote_key_required();
9146 features.set_payment_secret_required();
9147 features.set_basic_mpp_optional();
9148 features.set_wumbo_optional();
9149 features.set_shutdown_any_segwit_optional();
9150 features.set_channel_type_optional();
9151 features.set_scid_privacy_optional();
9152 features.set_zero_conf_optional();
9153 if config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx {
9154 features.set_anchors_zero_fee_htlc_tx_optional();
9159 const SERIALIZATION_VERSION: u8 = 1;
9160 const MIN_SERIALIZATION_VERSION: u8 = 1;
9162 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
9163 (2, fee_base_msat, required),
9164 (4, fee_proportional_millionths, required),
9165 (6, cltv_expiry_delta, required),
9168 impl_writeable_tlv_based!(ChannelCounterparty, {
9169 (2, node_id, required),
9170 (4, features, required),
9171 (6, unspendable_punishment_reserve, required),
9172 (8, forwarding_info, option),
9173 (9, outbound_htlc_minimum_msat, option),
9174 (11, outbound_htlc_maximum_msat, option),
9177 impl Writeable for ChannelDetails {
9178 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9179 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
9180 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
9181 let user_channel_id_low = self.user_channel_id as u64;
9182 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
9183 write_tlv_fields!(writer, {
9184 (1, self.inbound_scid_alias, option),
9185 (2, self.channel_id, required),
9186 (3, self.channel_type, option),
9187 (4, self.counterparty, required),
9188 (5, self.outbound_scid_alias, option),
9189 (6, self.funding_txo, option),
9190 (7, self.config, option),
9191 (8, self.short_channel_id, option),
9192 (9, self.confirmations, option),
9193 (10, self.channel_value_satoshis, required),
9194 (12, self.unspendable_punishment_reserve, option),
9195 (14, user_channel_id_low, required),
9196 (16, self.balance_msat, required),
9197 (18, self.outbound_capacity_msat, required),
9198 (19, self.next_outbound_htlc_limit_msat, required),
9199 (20, self.inbound_capacity_msat, required),
9200 (21, self.next_outbound_htlc_minimum_msat, required),
9201 (22, self.confirmations_required, option),
9202 (24, self.force_close_spend_delay, option),
9203 (26, self.is_outbound, required),
9204 (28, self.is_channel_ready, required),
9205 (30, self.is_usable, required),
9206 (32, self.is_public, required),
9207 (33, self.inbound_htlc_minimum_msat, option),
9208 (35, self.inbound_htlc_maximum_msat, option),
9209 (37, user_channel_id_high_opt, option),
9210 (39, self.feerate_sat_per_1000_weight, option),
9211 (41, self.channel_shutdown_state, option),
9217 impl Readable for ChannelDetails {
9218 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9219 _init_and_read_len_prefixed_tlv_fields!(reader, {
9220 (1, inbound_scid_alias, option),
9221 (2, channel_id, required),
9222 (3, channel_type, option),
9223 (4, counterparty, required),
9224 (5, outbound_scid_alias, option),
9225 (6, funding_txo, option),
9226 (7, config, option),
9227 (8, short_channel_id, option),
9228 (9, confirmations, option),
9229 (10, channel_value_satoshis, required),
9230 (12, unspendable_punishment_reserve, option),
9231 (14, user_channel_id_low, required),
9232 (16, balance_msat, required),
9233 (18, outbound_capacity_msat, required),
9234 // Note that by the time we get past the required read above, outbound_capacity_msat will be
9235 // filled in, so we can safely unwrap it here.
9236 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
9237 (20, inbound_capacity_msat, required),
9238 (21, next_outbound_htlc_minimum_msat, (default_value, 0)),
9239 (22, confirmations_required, option),
9240 (24, force_close_spend_delay, option),
9241 (26, is_outbound, required),
9242 (28, is_channel_ready, required),
9243 (30, is_usable, required),
9244 (32, is_public, required),
9245 (33, inbound_htlc_minimum_msat, option),
9246 (35, inbound_htlc_maximum_msat, option),
9247 (37, user_channel_id_high_opt, option),
9248 (39, feerate_sat_per_1000_weight, option),
9249 (41, channel_shutdown_state, option),
9252 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
9253 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
9254 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
9255 let user_channel_id = user_channel_id_low as u128 +
9256 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
9260 channel_id: channel_id.0.unwrap(),
9262 counterparty: counterparty.0.unwrap(),
9263 outbound_scid_alias,
9267 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
9268 unspendable_punishment_reserve,
9270 balance_msat: balance_msat.0.unwrap(),
9271 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
9272 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
9273 next_outbound_htlc_minimum_msat: next_outbound_htlc_minimum_msat.0.unwrap(),
9274 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
9275 confirmations_required,
9277 force_close_spend_delay,
9278 is_outbound: is_outbound.0.unwrap(),
9279 is_channel_ready: is_channel_ready.0.unwrap(),
9280 is_usable: is_usable.0.unwrap(),
9281 is_public: is_public.0.unwrap(),
9282 inbound_htlc_minimum_msat,
9283 inbound_htlc_maximum_msat,
9284 feerate_sat_per_1000_weight,
9285 channel_shutdown_state,
9290 impl_writeable_tlv_based!(PhantomRouteHints, {
9291 (2, channels, required_vec),
9292 (4, phantom_scid, required),
9293 (6, real_node_pubkey, required),
9296 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
9298 (0, onion_packet, required),
9299 (2, short_channel_id, required),
9302 (0, payment_data, required),
9303 (1, phantom_shared_secret, option),
9304 (2, incoming_cltv_expiry, required),
9305 (3, payment_metadata, option),
9306 (5, custom_tlvs, optional_vec),
9308 (2, ReceiveKeysend) => {
9309 (0, payment_preimage, required),
9310 (2, incoming_cltv_expiry, required),
9311 (3, payment_metadata, option),
9312 (4, payment_data, option), // Added in 0.0.116
9313 (5, custom_tlvs, optional_vec),
9317 impl_writeable_tlv_based!(PendingHTLCInfo, {
9318 (0, routing, required),
9319 (2, incoming_shared_secret, required),
9320 (4, payment_hash, required),
9321 (6, outgoing_amt_msat, required),
9322 (8, outgoing_cltv_value, required),
9323 (9, incoming_amt_msat, option),
9324 (10, skimmed_fee_msat, option),
9328 impl Writeable for HTLCFailureMsg {
9329 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9331 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
9333 channel_id.write(writer)?;
9334 htlc_id.write(writer)?;
9335 reason.write(writer)?;
9337 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
9338 channel_id, htlc_id, sha256_of_onion, failure_code
9341 channel_id.write(writer)?;
9342 htlc_id.write(writer)?;
9343 sha256_of_onion.write(writer)?;
9344 failure_code.write(writer)?;
9351 impl Readable for HTLCFailureMsg {
9352 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9353 let id: u8 = Readable::read(reader)?;
9356 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
9357 channel_id: Readable::read(reader)?,
9358 htlc_id: Readable::read(reader)?,
9359 reason: Readable::read(reader)?,
9363 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
9364 channel_id: Readable::read(reader)?,
9365 htlc_id: Readable::read(reader)?,
9366 sha256_of_onion: Readable::read(reader)?,
9367 failure_code: Readable::read(reader)?,
9370 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
9371 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
9372 // messages contained in the variants.
9373 // In version 0.0.101, support for reading the variants with these types was added, and
9374 // we should migrate to writing these variants when UpdateFailHTLC or
9375 // UpdateFailMalformedHTLC get TLV fields.
9377 let length: BigSize = Readable::read(reader)?;
9378 let mut s = FixedLengthReader::new(reader, length.0);
9379 let res = Readable::read(&mut s)?;
9380 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
9381 Ok(HTLCFailureMsg::Relay(res))
9384 let length: BigSize = Readable::read(reader)?;
9385 let mut s = FixedLengthReader::new(reader, length.0);
9386 let res = Readable::read(&mut s)?;
9387 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
9388 Ok(HTLCFailureMsg::Malformed(res))
9390 _ => Err(DecodeError::UnknownRequiredFeature),
9395 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
9400 impl_writeable_tlv_based!(HTLCPreviousHopData, {
9401 (0, short_channel_id, required),
9402 (1, phantom_shared_secret, option),
9403 (2, outpoint, required),
9404 (4, htlc_id, required),
9405 (6, incoming_packet_shared_secret, required),
9406 (7, user_channel_id, option),
9409 impl Writeable for ClaimableHTLC {
9410 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9411 let (payment_data, keysend_preimage) = match &self.onion_payload {
9412 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
9413 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
9415 write_tlv_fields!(writer, {
9416 (0, self.prev_hop, required),
9417 (1, self.total_msat, required),
9418 (2, self.value, required),
9419 (3, self.sender_intended_value, required),
9420 (4, payment_data, option),
9421 (5, self.total_value_received, option),
9422 (6, self.cltv_expiry, required),
9423 (8, keysend_preimage, option),
9424 (10, self.counterparty_skimmed_fee_msat, option),
9430 impl Readable for ClaimableHTLC {
9431 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9432 _init_and_read_len_prefixed_tlv_fields!(reader, {
9433 (0, prev_hop, required),
9434 (1, total_msat, option),
9435 (2, value_ser, required),
9436 (3, sender_intended_value, option),
9437 (4, payment_data_opt, option),
9438 (5, total_value_received, option),
9439 (6, cltv_expiry, required),
9440 (8, keysend_preimage, option),
9441 (10, counterparty_skimmed_fee_msat, option),
9443 let payment_data: Option<msgs::FinalOnionHopData> = payment_data_opt;
9444 let value = value_ser.0.unwrap();
9445 let onion_payload = match keysend_preimage {
9447 if payment_data.is_some() {
9448 return Err(DecodeError::InvalidValue)
9450 if total_msat.is_none() {
9451 total_msat = Some(value);
9453 OnionPayload::Spontaneous(p)
9456 if total_msat.is_none() {
9457 if payment_data.is_none() {
9458 return Err(DecodeError::InvalidValue)
9460 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
9462 OnionPayload::Invoice { _legacy_hop_data: payment_data }
9466 prev_hop: prev_hop.0.unwrap(),
9469 sender_intended_value: sender_intended_value.unwrap_or(value),
9470 total_value_received,
9471 total_msat: total_msat.unwrap(),
9473 cltv_expiry: cltv_expiry.0.unwrap(),
9474 counterparty_skimmed_fee_msat,
9479 impl Readable for HTLCSource {
9480 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9481 let id: u8 = Readable::read(reader)?;
9484 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
9485 let mut first_hop_htlc_msat: u64 = 0;
9486 let mut path_hops = Vec::new();
9487 let mut payment_id = None;
9488 let mut payment_params: Option<PaymentParameters> = None;
9489 let mut blinded_tail: Option<BlindedTail> = None;
9490 read_tlv_fields!(reader, {
9491 (0, session_priv, required),
9492 (1, payment_id, option),
9493 (2, first_hop_htlc_msat, required),
9494 (4, path_hops, required_vec),
9495 (5, payment_params, (option: ReadableArgs, 0)),
9496 (6, blinded_tail, option),
9498 if payment_id.is_none() {
9499 // For backwards compat, if there was no payment_id written, use the session_priv bytes
9501 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
9503 let path = Path { hops: path_hops, blinded_tail };
9504 if path.hops.len() == 0 {
9505 return Err(DecodeError::InvalidValue);
9507 if let Some(params) = payment_params.as_mut() {
9508 if let Payee::Clear { ref mut final_cltv_expiry_delta, .. } = params.payee {
9509 if final_cltv_expiry_delta == &0 {
9510 *final_cltv_expiry_delta = path.final_cltv_expiry_delta().ok_or(DecodeError::InvalidValue)?;
9514 Ok(HTLCSource::OutboundRoute {
9515 session_priv: session_priv.0.unwrap(),
9516 first_hop_htlc_msat,
9518 payment_id: payment_id.unwrap(),
9521 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
9522 _ => Err(DecodeError::UnknownRequiredFeature),
9527 impl Writeable for HTLCSource {
9528 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
9530 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id } => {
9532 let payment_id_opt = Some(payment_id);
9533 write_tlv_fields!(writer, {
9534 (0, session_priv, required),
9535 (1, payment_id_opt, option),
9536 (2, first_hop_htlc_msat, required),
9537 // 3 was previously used to write a PaymentSecret for the payment.
9538 (4, path.hops, required_vec),
9539 (5, None::<PaymentParameters>, option), // payment_params in LDK versions prior to 0.0.115
9540 (6, path.blinded_tail, option),
9543 HTLCSource::PreviousHopData(ref field) => {
9545 field.write(writer)?;
9552 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
9553 (0, forward_info, required),
9554 (1, prev_user_channel_id, (default_value, 0)),
9555 (2, prev_short_channel_id, required),
9556 (4, prev_htlc_id, required),
9557 (6, prev_funding_outpoint, required),
9560 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
9562 (0, htlc_id, required),
9563 (2, err_packet, required),
9568 impl_writeable_tlv_based!(PendingInboundPayment, {
9569 (0, payment_secret, required),
9570 (2, expiry_time, required),
9571 (4, user_payment_id, required),
9572 (6, payment_preimage, required),
9573 (8, min_value_msat, required),
9576 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>
9578 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
9579 T::Target: BroadcasterInterface,
9580 ES::Target: EntropySource,
9581 NS::Target: NodeSigner,
9582 SP::Target: SignerProvider,
9583 F::Target: FeeEstimator,
9587 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
9588 let _consistency_lock = self.total_consistency_lock.write().unwrap();
9590 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
9592 self.chain_hash.write(writer)?;
9594 let best_block = self.best_block.read().unwrap();
9595 best_block.height().write(writer)?;
9596 best_block.block_hash().write(writer)?;
9599 let mut serializable_peer_count: u64 = 0;
9601 let per_peer_state = self.per_peer_state.read().unwrap();
9602 let mut number_of_funded_channels = 0;
9603 for (_, peer_state_mutex) in per_peer_state.iter() {
9604 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9605 let peer_state = &mut *peer_state_lock;
9606 if !peer_state.ok_to_remove(false) {
9607 serializable_peer_count += 1;
9610 number_of_funded_channels += peer_state.channel_by_id.iter().filter(
9611 |(_, phase)| if let ChannelPhase::Funded(chan) = phase { chan.context.is_funding_broadcast() } else { false }
9615 (number_of_funded_channels as u64).write(writer)?;
9617 for (_, peer_state_mutex) in per_peer_state.iter() {
9618 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9619 let peer_state = &mut *peer_state_lock;
9620 for channel in peer_state.channel_by_id.iter().filter_map(
9621 |(_, phase)| if let ChannelPhase::Funded(channel) = phase {
9622 if channel.context.is_funding_broadcast() { Some(channel) } else { None }
9625 channel.write(writer)?;
9631 let forward_htlcs = self.forward_htlcs.lock().unwrap();
9632 (forward_htlcs.len() as u64).write(writer)?;
9633 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
9634 short_channel_id.write(writer)?;
9635 (pending_forwards.len() as u64).write(writer)?;
9636 for forward in pending_forwards {
9637 forward.write(writer)?;
9642 let per_peer_state = self.per_peer_state.write().unwrap();
9644 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
9645 let claimable_payments = self.claimable_payments.lock().unwrap();
9646 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
9648 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
9649 let mut htlc_onion_fields: Vec<&_> = Vec::new();
9650 (claimable_payments.claimable_payments.len() as u64).write(writer)?;
9651 for (payment_hash, payment) in claimable_payments.claimable_payments.iter() {
9652 payment_hash.write(writer)?;
9653 (payment.htlcs.len() as u64).write(writer)?;
9654 for htlc in payment.htlcs.iter() {
9655 htlc.write(writer)?;
9657 htlc_purposes.push(&payment.purpose);
9658 htlc_onion_fields.push(&payment.onion_fields);
9661 let mut monitor_update_blocked_actions_per_peer = None;
9662 let mut peer_states = Vec::new();
9663 for (_, peer_state_mutex) in per_peer_state.iter() {
9664 // Because we're holding the owning `per_peer_state` write lock here there's no chance
9665 // of a lockorder violation deadlock - no other thread can be holding any
9666 // per_peer_state lock at all.
9667 peer_states.push(peer_state_mutex.unsafe_well_ordered_double_lock_self());
9670 (serializable_peer_count).write(writer)?;
9671 for ((peer_pubkey, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
9672 // Peers which we have no channels to should be dropped once disconnected. As we
9673 // disconnect all peers when shutting down and serializing the ChannelManager, we
9674 // consider all peers as disconnected here. There's therefore no need write peers with
9676 if !peer_state.ok_to_remove(false) {
9677 peer_pubkey.write(writer)?;
9678 peer_state.latest_features.write(writer)?;
9679 if !peer_state.monitor_update_blocked_actions.is_empty() {
9680 monitor_update_blocked_actions_per_peer
9681 .get_or_insert_with(Vec::new)
9682 .push((*peer_pubkey, &peer_state.monitor_update_blocked_actions));
9687 let events = self.pending_events.lock().unwrap();
9688 // LDK versions prior to 0.0.115 don't support post-event actions, thus if there's no
9689 // actions at all, skip writing the required TLV. Otherwise, pre-0.0.115 versions will
9690 // refuse to read the new ChannelManager.
9691 let events_not_backwards_compatible = events.iter().any(|(_, action)| action.is_some());
9692 if events_not_backwards_compatible {
9693 // If we're gonna write a even TLV that will overwrite our events anyway we might as
9694 // well save the space and not write any events here.
9695 0u64.write(writer)?;
9697 (events.len() as u64).write(writer)?;
9698 for (event, _) in events.iter() {
9699 event.write(writer)?;
9703 // LDK versions prior to 0.0.116 wrote the `pending_background_events`
9704 // `MonitorUpdateRegeneratedOnStartup`s here, however there was never a reason to do so -
9705 // the closing monitor updates were always effectively replayed on startup (either directly
9706 // by calling `broadcast_latest_holder_commitment_txn` on a `ChannelMonitor` during
9707 // deserialization or, in 0.0.115, by regenerating the monitor update itself).
9708 0u64.write(writer)?;
9710 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
9711 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
9712 // likely to be identical.
9713 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
9714 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
9716 (pending_inbound_payments.len() as u64).write(writer)?;
9717 for (hash, pending_payment) in pending_inbound_payments.iter() {
9718 hash.write(writer)?;
9719 pending_payment.write(writer)?;
9722 // For backwards compat, write the session privs and their total length.
9723 let mut num_pending_outbounds_compat: u64 = 0;
9724 for (_, outbound) in pending_outbound_payments.iter() {
9725 if !outbound.is_fulfilled() && !outbound.abandoned() {
9726 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
9729 num_pending_outbounds_compat.write(writer)?;
9730 for (_, outbound) in pending_outbound_payments.iter() {
9732 PendingOutboundPayment::Legacy { session_privs } |
9733 PendingOutboundPayment::Retryable { session_privs, .. } => {
9734 for session_priv in session_privs.iter() {
9735 session_priv.write(writer)?;
9738 PendingOutboundPayment::AwaitingInvoice { .. } => {},
9739 PendingOutboundPayment::InvoiceReceived { .. } => {},
9740 PendingOutboundPayment::Fulfilled { .. } => {},
9741 PendingOutboundPayment::Abandoned { .. } => {},
9745 // Encode without retry info for 0.0.101 compatibility.
9746 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
9747 for (id, outbound) in pending_outbound_payments.iter() {
9749 PendingOutboundPayment::Legacy { session_privs } |
9750 PendingOutboundPayment::Retryable { session_privs, .. } => {
9751 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
9757 let mut pending_intercepted_htlcs = None;
9758 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
9759 if our_pending_intercepts.len() != 0 {
9760 pending_intercepted_htlcs = Some(our_pending_intercepts);
9763 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
9764 if pending_claiming_payments.as_ref().unwrap().is_empty() {
9765 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
9766 // map. Thus, if there are no entries we skip writing a TLV for it.
9767 pending_claiming_payments = None;
9770 let mut in_flight_monitor_updates: Option<HashMap<(&PublicKey, &OutPoint), &Vec<ChannelMonitorUpdate>>> = None;
9771 for ((counterparty_id, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
9772 for (funding_outpoint, updates) in peer_state.in_flight_monitor_updates.iter() {
9773 if !updates.is_empty() {
9774 if in_flight_monitor_updates.is_none() { in_flight_monitor_updates = Some(HashMap::new()); }
9775 in_flight_monitor_updates.as_mut().unwrap().insert((counterparty_id, funding_outpoint), updates);
9780 write_tlv_fields!(writer, {
9781 (1, pending_outbound_payments_no_retry, required),
9782 (2, pending_intercepted_htlcs, option),
9783 (3, pending_outbound_payments, required),
9784 (4, pending_claiming_payments, option),
9785 (5, self.our_network_pubkey, required),
9786 (6, monitor_update_blocked_actions_per_peer, option),
9787 (7, self.fake_scid_rand_bytes, required),
9788 (8, if events_not_backwards_compatible { Some(&*events) } else { None }, option),
9789 (9, htlc_purposes, required_vec),
9790 (10, in_flight_monitor_updates, option),
9791 (11, self.probing_cookie_secret, required),
9792 (13, htlc_onion_fields, optional_vec),
9799 impl Writeable for VecDeque<(Event, Option<EventCompletionAction>)> {
9800 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
9801 (self.len() as u64).write(w)?;
9802 for (event, action) in self.iter() {
9805 #[cfg(debug_assertions)] {
9806 // Events are MaybeReadable, in some cases indicating that they shouldn't actually
9807 // be persisted and are regenerated on restart. However, if such an event has a
9808 // post-event-handling action we'll write nothing for the event and would have to
9809 // either forget the action or fail on deserialization (which we do below). Thus,
9810 // check that the event is sane here.
9811 let event_encoded = event.encode();
9812 let event_read: Option<Event> =
9813 MaybeReadable::read(&mut &event_encoded[..]).unwrap();
9814 if action.is_some() { assert!(event_read.is_some()); }
9820 impl Readable for VecDeque<(Event, Option<EventCompletionAction>)> {
9821 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9822 let len: u64 = Readable::read(reader)?;
9823 const MAX_ALLOC_SIZE: u64 = 1024 * 16;
9824 let mut events: Self = VecDeque::with_capacity(cmp::min(
9825 MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>() as u64,
9828 let ev_opt = MaybeReadable::read(reader)?;
9829 let action = Readable::read(reader)?;
9830 if let Some(ev) = ev_opt {
9831 events.push_back((ev, action));
9832 } else if action.is_some() {
9833 return Err(DecodeError::InvalidValue);
9840 impl_writeable_tlv_based_enum!(ChannelShutdownState,
9841 (0, NotShuttingDown) => {},
9842 (2, ShutdownInitiated) => {},
9843 (4, ResolvingHTLCs) => {},
9844 (6, NegotiatingClosingFee) => {},
9845 (8, ShutdownComplete) => {}, ;
9848 /// Arguments for the creation of a ChannelManager that are not deserialized.
9850 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
9852 /// 1) Deserialize all stored [`ChannelMonitor`]s.
9853 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
9854 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
9855 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
9856 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
9857 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
9858 /// same way you would handle a [`chain::Filter`] call using
9859 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
9860 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
9861 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
9862 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
9863 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
9864 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
9866 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
9867 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
9869 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
9870 /// call any other methods on the newly-deserialized [`ChannelManager`].
9872 /// Note that because some channels may be closed during deserialization, it is critical that you
9873 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
9874 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
9875 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
9876 /// not force-close the same channels but consider them live), you may end up revoking a state for
9877 /// which you've already broadcasted the transaction.
9879 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
9880 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
9882 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
9883 T::Target: BroadcasterInterface,
9884 ES::Target: EntropySource,
9885 NS::Target: NodeSigner,
9886 SP::Target: SignerProvider,
9887 F::Target: FeeEstimator,
9891 /// A cryptographically secure source of entropy.
9892 pub entropy_source: ES,
9894 /// A signer that is able to perform node-scoped cryptographic operations.
9895 pub node_signer: NS,
9897 /// The keys provider which will give us relevant keys. Some keys will be loaded during
9898 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
9900 pub signer_provider: SP,
9902 /// The fee_estimator for use in the ChannelManager in the future.
9904 /// No calls to the FeeEstimator will be made during deserialization.
9905 pub fee_estimator: F,
9906 /// The chain::Watch for use in the ChannelManager in the future.
9908 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
9909 /// you have deserialized ChannelMonitors separately and will add them to your
9910 /// chain::Watch after deserializing this ChannelManager.
9911 pub chain_monitor: M,
9913 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
9914 /// used to broadcast the latest local commitment transactions of channels which must be
9915 /// force-closed during deserialization.
9916 pub tx_broadcaster: T,
9917 /// The router which will be used in the ChannelManager in the future for finding routes
9918 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
9920 /// No calls to the router will be made during deserialization.
9922 /// The Logger for use in the ChannelManager and which may be used to log information during
9923 /// deserialization.
9925 /// Default settings used for new channels. Any existing channels will continue to use the
9926 /// runtime settings which were stored when the ChannelManager was serialized.
9927 pub default_config: UserConfig,
9929 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
9930 /// value.context.get_funding_txo() should be the key).
9932 /// If a monitor is inconsistent with the channel state during deserialization the channel will
9933 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
9934 /// is true for missing channels as well. If there is a monitor missing for which we find
9935 /// channel data Err(DecodeError::InvalidValue) will be returned.
9937 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
9940 /// This is not exported to bindings users because we have no HashMap bindings
9941 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>,
9944 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
9945 ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>
9947 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
9948 T::Target: BroadcasterInterface,
9949 ES::Target: EntropySource,
9950 NS::Target: NodeSigner,
9951 SP::Target: SignerProvider,
9952 F::Target: FeeEstimator,
9956 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
9957 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
9958 /// populate a HashMap directly from C.
9959 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,
9960 mut channel_monitors: Vec<&'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>) -> Self {
9962 entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
9963 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
9968 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
9969 // SipmleArcChannelManager type:
9970 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
9971 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, ES, NS, SP, F, R, L>>)
9973 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
9974 T::Target: BroadcasterInterface,
9975 ES::Target: EntropySource,
9976 NS::Target: NodeSigner,
9977 SP::Target: SignerProvider,
9978 F::Target: FeeEstimator,
9982 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
9983 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)>::read(reader, args)?;
9984 Ok((blockhash, Arc::new(chan_manager)))
9988 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
9989 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)
9991 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
9992 T::Target: BroadcasterInterface,
9993 ES::Target: EntropySource,
9994 NS::Target: NodeSigner,
9995 SP::Target: SignerProvider,
9996 F::Target: FeeEstimator,
10000 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
10001 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
10003 let chain_hash: ChainHash = Readable::read(reader)?;
10004 let best_block_height: u32 = Readable::read(reader)?;
10005 let best_block_hash: BlockHash = Readable::read(reader)?;
10007 let mut failed_htlcs = Vec::new();
10009 let channel_count: u64 = Readable::read(reader)?;
10010 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
10011 let mut funded_peer_channels: HashMap<PublicKey, HashMap<ChannelId, ChannelPhase<SP>>> = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
10012 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
10013 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
10014 let mut channel_closures = VecDeque::new();
10015 let mut close_background_events = Vec::new();
10016 for _ in 0..channel_count {
10017 let mut channel: Channel<SP> = Channel::read(reader, (
10018 &args.entropy_source, &args.signer_provider, best_block_height, &provided_channel_type_features(&args.default_config)
10020 let funding_txo = channel.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
10021 funding_txo_set.insert(funding_txo.clone());
10022 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
10023 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
10024 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
10025 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
10026 channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
10027 // But if the channel is behind of the monitor, close the channel:
10028 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
10029 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
10030 if channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
10031 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
10032 &channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
10034 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() {
10035 log_error!(args.logger, " The ChannelMonitor for channel {} is at holder commitment number {} but the ChannelManager is at holder commitment number {}.",
10036 &channel.context.channel_id(), monitor.get_cur_holder_commitment_number(), channel.get_cur_holder_commitment_transaction_number());
10038 if channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() {
10039 log_error!(args.logger, " The ChannelMonitor for channel {} is at revoked counterparty transaction number {} but the ChannelManager is at revoked counterparty transaction number {}.",
10040 &channel.context.channel_id(), monitor.get_min_seen_secret(), channel.get_revoked_counterparty_commitment_transaction_number());
10042 if channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() {
10043 log_error!(args.logger, " The ChannelMonitor for channel {} is at counterparty commitment transaction number {} but the ChannelManager is at counterparty commitment transaction number {}.",
10044 &channel.context.channel_id(), monitor.get_cur_counterparty_commitment_number(), channel.get_cur_counterparty_commitment_transaction_number());
10046 let mut shutdown_result = channel.context.force_shutdown(true);
10047 if shutdown_result.unbroadcasted_batch_funding_txid.is_some() {
10048 return Err(DecodeError::InvalidValue);
10050 if let Some((counterparty_node_id, funding_txo, update)) = shutdown_result.monitor_update {
10051 close_background_events.push(BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
10052 counterparty_node_id, funding_txo, update
10055 failed_htlcs.append(&mut shutdown_result.dropped_outbound_htlcs);
10056 channel_closures.push_back((events::Event::ChannelClosed {
10057 channel_id: channel.context.channel_id(),
10058 user_channel_id: channel.context.get_user_id(),
10059 reason: ClosureReason::OutdatedChannelManager,
10060 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
10061 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
10063 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
10064 let mut found_htlc = false;
10065 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
10066 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
10069 // If we have some HTLCs in the channel which are not present in the newer
10070 // ChannelMonitor, they have been removed and should be failed back to
10071 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
10072 // were actually claimed we'd have generated and ensured the previous-hop
10073 // claim update ChannelMonitor updates were persisted prior to persising
10074 // the ChannelMonitor update for the forward leg, so attempting to fail the
10075 // backwards leg of the HTLC will simply be rejected.
10076 log_info!(args.logger,
10077 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
10078 &channel.context.channel_id(), &payment_hash);
10079 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.context.get_counterparty_node_id(), channel.context.channel_id()));
10083 log_info!(args.logger, "Successfully loaded channel {} at update_id {} against monitor at update id {}",
10084 &channel.context.channel_id(), channel.context.get_latest_monitor_update_id(),
10085 monitor.get_latest_update_id());
10086 if let Some(short_channel_id) = channel.context.get_short_channel_id() {
10087 short_to_chan_info.insert(short_channel_id, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
10089 if channel.context.is_funding_broadcast() {
10090 id_to_peer.insert(channel.context.channel_id(), channel.context.get_counterparty_node_id());
10092 match funded_peer_channels.entry(channel.context.get_counterparty_node_id()) {
10093 hash_map::Entry::Occupied(mut entry) => {
10094 let by_id_map = entry.get_mut();
10095 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
10097 hash_map::Entry::Vacant(entry) => {
10098 let mut by_id_map = HashMap::new();
10099 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
10100 entry.insert(by_id_map);
10104 } else if channel.is_awaiting_initial_mon_persist() {
10105 // If we were persisted and shut down while the initial ChannelMonitor persistence
10106 // was in-progress, we never broadcasted the funding transaction and can still
10107 // safely discard the channel.
10108 let _ = channel.context.force_shutdown(false);
10109 channel_closures.push_back((events::Event::ChannelClosed {
10110 channel_id: channel.context.channel_id(),
10111 user_channel_id: channel.context.get_user_id(),
10112 reason: ClosureReason::DisconnectedPeer,
10113 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
10114 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
10117 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
10118 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
10119 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
10120 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
10121 log_error!(args.logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
10122 return Err(DecodeError::InvalidValue);
10126 for (funding_txo, _) in args.channel_monitors.iter() {
10127 if !funding_txo_set.contains(funding_txo) {
10128 log_info!(args.logger, "Queueing monitor update to ensure missing channel {} is force closed",
10129 &funding_txo.to_channel_id());
10130 let monitor_update = ChannelMonitorUpdate {
10131 update_id: CLOSED_CHANNEL_UPDATE_ID,
10132 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast: true }],
10134 close_background_events.push(BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((*funding_txo, monitor_update)));
10138 const MAX_ALLOC_SIZE: usize = 1024 * 64;
10139 let forward_htlcs_count: u64 = Readable::read(reader)?;
10140 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
10141 for _ in 0..forward_htlcs_count {
10142 let short_channel_id = Readable::read(reader)?;
10143 let pending_forwards_count: u64 = Readable::read(reader)?;
10144 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
10145 for _ in 0..pending_forwards_count {
10146 pending_forwards.push(Readable::read(reader)?);
10148 forward_htlcs.insert(short_channel_id, pending_forwards);
10151 let claimable_htlcs_count: u64 = Readable::read(reader)?;
10152 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
10153 for _ in 0..claimable_htlcs_count {
10154 let payment_hash = Readable::read(reader)?;
10155 let previous_hops_len: u64 = Readable::read(reader)?;
10156 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
10157 for _ in 0..previous_hops_len {
10158 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
10160 claimable_htlcs_list.push((payment_hash, previous_hops));
10163 let peer_state_from_chans = |channel_by_id| {
10166 inbound_channel_request_by_id: HashMap::new(),
10167 latest_features: InitFeatures::empty(),
10168 pending_msg_events: Vec::new(),
10169 in_flight_monitor_updates: BTreeMap::new(),
10170 monitor_update_blocked_actions: BTreeMap::new(),
10171 actions_blocking_raa_monitor_updates: BTreeMap::new(),
10172 is_connected: false,
10176 let peer_count: u64 = Readable::read(reader)?;
10177 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<SP>>)>()));
10178 for _ in 0..peer_count {
10179 let peer_pubkey = Readable::read(reader)?;
10180 let peer_chans = funded_peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new());
10181 let mut peer_state = peer_state_from_chans(peer_chans);
10182 peer_state.latest_features = Readable::read(reader)?;
10183 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
10186 let event_count: u64 = Readable::read(reader)?;
10187 let mut pending_events_read: VecDeque<(events::Event, Option<EventCompletionAction>)> =
10188 VecDeque::with_capacity(cmp::min(event_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>()));
10189 for _ in 0..event_count {
10190 match MaybeReadable::read(reader)? {
10191 Some(event) => pending_events_read.push_back((event, None)),
10196 let background_event_count: u64 = Readable::read(reader)?;
10197 for _ in 0..background_event_count {
10198 match <u8 as Readable>::read(reader)? {
10200 // LDK versions prior to 0.0.116 wrote pending `MonitorUpdateRegeneratedOnStartup`s here,
10201 // however we really don't (and never did) need them - we regenerate all
10202 // on-startup monitor updates.
10203 let _: OutPoint = Readable::read(reader)?;
10204 let _: ChannelMonitorUpdate = Readable::read(reader)?;
10206 _ => return Err(DecodeError::InvalidValue),
10210 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
10211 let highest_seen_timestamp: u32 = Readable::read(reader)?;
10213 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
10214 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
10215 for _ in 0..pending_inbound_payment_count {
10216 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
10217 return Err(DecodeError::InvalidValue);
10221 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
10222 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
10223 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
10224 for _ in 0..pending_outbound_payments_count_compat {
10225 let session_priv = Readable::read(reader)?;
10226 let payment = PendingOutboundPayment::Legacy {
10227 session_privs: [session_priv].iter().cloned().collect()
10229 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
10230 return Err(DecodeError::InvalidValue)
10234 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
10235 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
10236 let mut pending_outbound_payments = None;
10237 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
10238 let mut received_network_pubkey: Option<PublicKey> = None;
10239 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
10240 let mut probing_cookie_secret: Option<[u8; 32]> = None;
10241 let mut claimable_htlc_purposes = None;
10242 let mut claimable_htlc_onion_fields = None;
10243 let mut pending_claiming_payments = Some(HashMap::new());
10244 let mut monitor_update_blocked_actions_per_peer: Option<Vec<(_, BTreeMap<_, Vec<_>>)>> = Some(Vec::new());
10245 let mut events_override = None;
10246 let mut in_flight_monitor_updates: Option<HashMap<(PublicKey, OutPoint), Vec<ChannelMonitorUpdate>>> = None;
10247 read_tlv_fields!(reader, {
10248 (1, pending_outbound_payments_no_retry, option),
10249 (2, pending_intercepted_htlcs, option),
10250 (3, pending_outbound_payments, option),
10251 (4, pending_claiming_payments, option),
10252 (5, received_network_pubkey, option),
10253 (6, monitor_update_blocked_actions_per_peer, option),
10254 (7, fake_scid_rand_bytes, option),
10255 (8, events_override, option),
10256 (9, claimable_htlc_purposes, optional_vec),
10257 (10, in_flight_monitor_updates, option),
10258 (11, probing_cookie_secret, option),
10259 (13, claimable_htlc_onion_fields, optional_vec),
10261 if fake_scid_rand_bytes.is_none() {
10262 fake_scid_rand_bytes = Some(args.entropy_source.get_secure_random_bytes());
10265 if probing_cookie_secret.is_none() {
10266 probing_cookie_secret = Some(args.entropy_source.get_secure_random_bytes());
10269 if let Some(events) = events_override {
10270 pending_events_read = events;
10273 if !channel_closures.is_empty() {
10274 pending_events_read.append(&mut channel_closures);
10277 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
10278 pending_outbound_payments = Some(pending_outbound_payments_compat);
10279 } else if pending_outbound_payments.is_none() {
10280 let mut outbounds = HashMap::new();
10281 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
10282 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
10284 pending_outbound_payments = Some(outbounds);
10286 let pending_outbounds = OutboundPayments {
10287 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
10288 retry_lock: Mutex::new(())
10291 // We have to replay (or skip, if they were completed after we wrote the `ChannelManager`)
10292 // each `ChannelMonitorUpdate` in `in_flight_monitor_updates`. After doing so, we have to
10293 // check that each channel we have isn't newer than the latest `ChannelMonitorUpdate`(s) we
10294 // replayed, and for each monitor update we have to replay we have to ensure there's a
10295 // `ChannelMonitor` for it.
10297 // In order to do so we first walk all of our live channels (so that we can check their
10298 // state immediately after doing the update replays, when we have the `update_id`s
10299 // available) and then walk any remaining in-flight updates.
10301 // Because the actual handling of the in-flight updates is the same, it's macro'ized here:
10302 let mut pending_background_events = Vec::new();
10303 macro_rules! handle_in_flight_updates {
10304 ($counterparty_node_id: expr, $chan_in_flight_upds: expr, $funding_txo: expr,
10305 $monitor: expr, $peer_state: expr, $channel_info_log: expr
10307 let mut max_in_flight_update_id = 0;
10308 $chan_in_flight_upds.retain(|upd| upd.update_id > $monitor.get_latest_update_id());
10309 for update in $chan_in_flight_upds.iter() {
10310 log_trace!(args.logger, "Replaying ChannelMonitorUpdate {} for {}channel {}",
10311 update.update_id, $channel_info_log, &$funding_txo.to_channel_id());
10312 max_in_flight_update_id = cmp::max(max_in_flight_update_id, update.update_id);
10313 pending_background_events.push(
10314 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
10315 counterparty_node_id: $counterparty_node_id,
10316 funding_txo: $funding_txo,
10317 update: update.clone(),
10320 if $chan_in_flight_upds.is_empty() {
10321 // We had some updates to apply, but it turns out they had completed before we
10322 // were serialized, we just weren't notified of that. Thus, we may have to run
10323 // the completion actions for any monitor updates, but otherwise are done.
10324 pending_background_events.push(
10325 BackgroundEvent::MonitorUpdatesComplete {
10326 counterparty_node_id: $counterparty_node_id,
10327 channel_id: $funding_txo.to_channel_id(),
10330 if $peer_state.in_flight_monitor_updates.insert($funding_txo, $chan_in_flight_upds).is_some() {
10331 log_error!(args.logger, "Duplicate in-flight monitor update set for the same channel!");
10332 return Err(DecodeError::InvalidValue);
10334 max_in_flight_update_id
10338 for (counterparty_id, peer_state_mtx) in per_peer_state.iter_mut() {
10339 let mut peer_state_lock = peer_state_mtx.lock().unwrap();
10340 let peer_state = &mut *peer_state_lock;
10341 for phase in peer_state.channel_by_id.values() {
10342 if let ChannelPhase::Funded(chan) = phase {
10343 // Channels that were persisted have to be funded, otherwise they should have been
10345 let funding_txo = chan.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
10346 let monitor = args.channel_monitors.get(&funding_txo)
10347 .expect("We already checked for monitor presence when loading channels");
10348 let mut max_in_flight_update_id = monitor.get_latest_update_id();
10349 if let Some(in_flight_upds) = &mut in_flight_monitor_updates {
10350 if let Some(mut chan_in_flight_upds) = in_flight_upds.remove(&(*counterparty_id, funding_txo)) {
10351 max_in_flight_update_id = cmp::max(max_in_flight_update_id,
10352 handle_in_flight_updates!(*counterparty_id, chan_in_flight_upds,
10353 funding_txo, monitor, peer_state, ""));
10356 if chan.get_latest_unblocked_monitor_update_id() > max_in_flight_update_id {
10357 // If the channel is ahead of the monitor, return InvalidValue:
10358 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
10359 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} with update_id through {} in-flight",
10360 chan.context.channel_id(), monitor.get_latest_update_id(), max_in_flight_update_id);
10361 log_error!(args.logger, " but the ChannelManager is at update_id {}.", chan.get_latest_unblocked_monitor_update_id());
10362 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
10363 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
10364 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
10365 log_error!(args.logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
10366 return Err(DecodeError::InvalidValue);
10369 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
10370 // created in this `channel_by_id` map.
10371 debug_assert!(false);
10372 return Err(DecodeError::InvalidValue);
10377 if let Some(in_flight_upds) = in_flight_monitor_updates {
10378 for ((counterparty_id, funding_txo), mut chan_in_flight_updates) in in_flight_upds {
10379 if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
10380 // Now that we've removed all the in-flight monitor updates for channels that are
10381 // still open, we need to replay any monitor updates that are for closed channels,
10382 // creating the neccessary peer_state entries as we go.
10383 let peer_state_mutex = per_peer_state.entry(counterparty_id).or_insert_with(|| {
10384 Mutex::new(peer_state_from_chans(HashMap::new()))
10386 let mut peer_state = peer_state_mutex.lock().unwrap();
10387 handle_in_flight_updates!(counterparty_id, chan_in_flight_updates,
10388 funding_txo, monitor, peer_state, "closed ");
10390 log_error!(args.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!");
10391 log_error!(args.logger, " The ChannelMonitor for channel {} is missing.",
10392 &funding_txo.to_channel_id());
10393 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
10394 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
10395 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
10396 log_error!(args.logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
10397 return Err(DecodeError::InvalidValue);
10402 // Note that we have to do the above replays before we push new monitor updates.
10403 pending_background_events.append(&mut close_background_events);
10405 // If there's any preimages for forwarded HTLCs hanging around in ChannelMonitors we
10406 // should ensure we try them again on the inbound edge. We put them here and do so after we
10407 // have a fully-constructed `ChannelManager` at the end.
10408 let mut pending_claims_to_replay = Vec::new();
10411 // If we're tracking pending payments, ensure we haven't lost any by looking at the
10412 // ChannelMonitor data for any channels for which we do not have authorative state
10413 // (i.e. those for which we just force-closed above or we otherwise don't have a
10414 // corresponding `Channel` at all).
10415 // This avoids several edge-cases where we would otherwise "forget" about pending
10416 // payments which are still in-flight via their on-chain state.
10417 // We only rebuild the pending payments map if we were most recently serialized by
10419 for (_, monitor) in args.channel_monitors.iter() {
10420 let counterparty_opt = id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id());
10421 if counterparty_opt.is_none() {
10422 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
10423 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
10424 if path.hops.is_empty() {
10425 log_error!(args.logger, "Got an empty path for a pending payment");
10426 return Err(DecodeError::InvalidValue);
10429 let path_amt = path.final_value_msat();
10430 let mut session_priv_bytes = [0; 32];
10431 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
10432 match pending_outbounds.pending_outbound_payments.lock().unwrap().entry(payment_id) {
10433 hash_map::Entry::Occupied(mut entry) => {
10434 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
10435 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
10436 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), &htlc.payment_hash);
10438 hash_map::Entry::Vacant(entry) => {
10439 let path_fee = path.fee_msat();
10440 entry.insert(PendingOutboundPayment::Retryable {
10441 retry_strategy: None,
10442 attempts: PaymentAttempts::new(),
10443 payment_params: None,
10444 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
10445 payment_hash: htlc.payment_hash,
10446 payment_secret: None, // only used for retries, and we'll never retry on startup
10447 payment_metadata: None, // only used for retries, and we'll never retry on startup
10448 keysend_preimage: None, // only used for retries, and we'll never retry on startup
10449 custom_tlvs: Vec::new(), // only used for retries, and we'll never retry on startup
10450 pending_amt_msat: path_amt,
10451 pending_fee_msat: Some(path_fee),
10452 total_msat: path_amt,
10453 starting_block_height: best_block_height,
10454 remaining_max_total_routing_fee_msat: None, // only used for retries, and we'll never retry on startup
10456 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
10457 path_amt, &htlc.payment_hash, log_bytes!(session_priv_bytes));
10462 for (htlc_source, (htlc, preimage_opt)) in monitor.get_all_current_outbound_htlcs() {
10463 match htlc_source {
10464 HTLCSource::PreviousHopData(prev_hop_data) => {
10465 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
10466 info.prev_funding_outpoint == prev_hop_data.outpoint &&
10467 info.prev_htlc_id == prev_hop_data.htlc_id
10469 // The ChannelMonitor is now responsible for this HTLC's
10470 // failure/success and will let us know what its outcome is. If we
10471 // still have an entry for this HTLC in `forward_htlcs` or
10472 // `pending_intercepted_htlcs`, we were apparently not persisted after
10473 // the monitor was when forwarding the payment.
10474 forward_htlcs.retain(|_, forwards| {
10475 forwards.retain(|forward| {
10476 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
10477 if pending_forward_matches_htlc(&htlc_info) {
10478 log_info!(args.logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
10479 &htlc.payment_hash, &monitor.get_funding_txo().0.to_channel_id());
10484 !forwards.is_empty()
10486 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
10487 if pending_forward_matches_htlc(&htlc_info) {
10488 log_info!(args.logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
10489 &htlc.payment_hash, &monitor.get_funding_txo().0.to_channel_id());
10490 pending_events_read.retain(|(event, _)| {
10491 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
10492 intercepted_id != ev_id
10499 HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } => {
10500 if let Some(preimage) = preimage_opt {
10501 let pending_events = Mutex::new(pending_events_read);
10502 // Note that we set `from_onchain` to "false" here,
10503 // deliberately keeping the pending payment around forever.
10504 // Given it should only occur when we have a channel we're
10505 // force-closing for being stale that's okay.
10506 // The alternative would be to wipe the state when claiming,
10507 // generating a `PaymentPathSuccessful` event but regenerating
10508 // it and the `PaymentSent` on every restart until the
10509 // `ChannelMonitor` is removed.
10511 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
10512 channel_funding_outpoint: monitor.get_funding_txo().0,
10513 counterparty_node_id: path.hops[0].pubkey,
10515 pending_outbounds.claim_htlc(payment_id, preimage, session_priv,
10516 path, false, compl_action, &pending_events, &args.logger);
10517 pending_events_read = pending_events.into_inner().unwrap();
10524 // Whether the downstream channel was closed or not, try to re-apply any payment
10525 // preimages from it which may be needed in upstream channels for forwarded
10527 let outbound_claimed_htlcs_iter = monitor.get_all_current_outbound_htlcs()
10529 .filter_map(|(htlc_source, (htlc, preimage_opt))| {
10530 if let HTLCSource::PreviousHopData(_) = htlc_source {
10531 if let Some(payment_preimage) = preimage_opt {
10532 Some((htlc_source, payment_preimage, htlc.amount_msat,
10533 // Check if `counterparty_opt.is_none()` to see if the
10534 // downstream chan is closed (because we don't have a
10535 // channel_id -> peer map entry).
10536 counterparty_opt.is_none(),
10537 counterparty_opt.cloned().or(monitor.get_counterparty_node_id()),
10538 monitor.get_funding_txo().0))
10541 // If it was an outbound payment, we've handled it above - if a preimage
10542 // came in and we persisted the `ChannelManager` we either handled it and
10543 // are good to go or the channel force-closed - we don't have to handle the
10544 // channel still live case here.
10548 for tuple in outbound_claimed_htlcs_iter {
10549 pending_claims_to_replay.push(tuple);
10554 if !forward_htlcs.is_empty() || pending_outbounds.needs_abandon() {
10555 // If we have pending HTLCs to forward, assume we either dropped a
10556 // `PendingHTLCsForwardable` or the user received it but never processed it as they
10557 // shut down before the timer hit. Either way, set the time_forwardable to a small
10558 // constant as enough time has likely passed that we should simply handle the forwards
10559 // now, or at least after the user gets a chance to reconnect to our peers.
10560 pending_events_read.push_back((events::Event::PendingHTLCsForwardable {
10561 time_forwardable: Duration::from_secs(2),
10565 let inbound_pmt_key_material = args.node_signer.get_inbound_payment_key_material();
10566 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
10568 let mut claimable_payments = HashMap::with_capacity(claimable_htlcs_list.len());
10569 if let Some(purposes) = claimable_htlc_purposes {
10570 if purposes.len() != claimable_htlcs_list.len() {
10571 return Err(DecodeError::InvalidValue);
10573 if let Some(onion_fields) = claimable_htlc_onion_fields {
10574 if onion_fields.len() != claimable_htlcs_list.len() {
10575 return Err(DecodeError::InvalidValue);
10577 for (purpose, (onion, (payment_hash, htlcs))) in
10578 purposes.into_iter().zip(onion_fields.into_iter().zip(claimable_htlcs_list.into_iter()))
10580 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
10581 purpose, htlcs, onion_fields: onion,
10583 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
10586 for (purpose, (payment_hash, htlcs)) in purposes.into_iter().zip(claimable_htlcs_list.into_iter()) {
10587 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
10588 purpose, htlcs, onion_fields: None,
10590 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
10594 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
10595 // include a `_legacy_hop_data` in the `OnionPayload`.
10596 for (payment_hash, htlcs) in claimable_htlcs_list.drain(..) {
10597 if htlcs.is_empty() {
10598 return Err(DecodeError::InvalidValue);
10600 let purpose = match &htlcs[0].onion_payload {
10601 OnionPayload::Invoice { _legacy_hop_data } => {
10602 if let Some(hop_data) = _legacy_hop_data {
10603 events::PaymentPurpose::InvoicePayment {
10604 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
10605 Some(inbound_payment) => inbound_payment.payment_preimage,
10606 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
10607 Ok((payment_preimage, _)) => payment_preimage,
10609 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);
10610 return Err(DecodeError::InvalidValue);
10614 payment_secret: hop_data.payment_secret,
10616 } else { return Err(DecodeError::InvalidValue); }
10618 OnionPayload::Spontaneous(payment_preimage) =>
10619 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
10621 claimable_payments.insert(payment_hash, ClaimablePayment {
10622 purpose, htlcs, onion_fields: None,
10627 let mut secp_ctx = Secp256k1::new();
10628 secp_ctx.seeded_randomize(&args.entropy_source.get_secure_random_bytes());
10630 let our_network_pubkey = match args.node_signer.get_node_id(Recipient::Node) {
10632 Err(()) => return Err(DecodeError::InvalidValue)
10634 if let Some(network_pubkey) = received_network_pubkey {
10635 if network_pubkey != our_network_pubkey {
10636 log_error!(args.logger, "Key that was generated does not match the existing key.");
10637 return Err(DecodeError::InvalidValue);
10641 let mut outbound_scid_aliases = HashSet::new();
10642 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
10643 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
10644 let peer_state = &mut *peer_state_lock;
10645 for (chan_id, phase) in peer_state.channel_by_id.iter_mut() {
10646 if let ChannelPhase::Funded(chan) = phase {
10647 if chan.context.outbound_scid_alias() == 0 {
10648 let mut outbound_scid_alias;
10650 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
10651 .get_fake_scid(best_block_height, &chain_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.entropy_source);
10652 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
10654 chan.context.set_outbound_scid_alias(outbound_scid_alias);
10655 } else if !outbound_scid_aliases.insert(chan.context.outbound_scid_alias()) {
10656 // Note that in rare cases its possible to hit this while reading an older
10657 // channel if we just happened to pick a colliding outbound alias above.
10658 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
10659 return Err(DecodeError::InvalidValue);
10661 if chan.context.is_usable() {
10662 if short_to_chan_info.insert(chan.context.outbound_scid_alias(), (chan.context.get_counterparty_node_id(), *chan_id)).is_some() {
10663 // Note that in rare cases its possible to hit this while reading an older
10664 // channel if we just happened to pick a colliding outbound alias above.
10665 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
10666 return Err(DecodeError::InvalidValue);
10670 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
10671 // created in this `channel_by_id` map.
10672 debug_assert!(false);
10673 return Err(DecodeError::InvalidValue);
10678 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
10680 for (_, monitor) in args.channel_monitors.iter() {
10681 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
10682 if let Some(payment) = claimable_payments.remove(&payment_hash) {
10683 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", &payment_hash);
10684 let mut claimable_amt_msat = 0;
10685 let mut receiver_node_id = Some(our_network_pubkey);
10686 let phantom_shared_secret = payment.htlcs[0].prev_hop.phantom_shared_secret;
10687 if phantom_shared_secret.is_some() {
10688 let phantom_pubkey = args.node_signer.get_node_id(Recipient::PhantomNode)
10689 .expect("Failed to get node_id for phantom node recipient");
10690 receiver_node_id = Some(phantom_pubkey)
10692 for claimable_htlc in &payment.htlcs {
10693 claimable_amt_msat += claimable_htlc.value;
10695 // Add a holding-cell claim of the payment to the Channel, which should be
10696 // applied ~immediately on peer reconnection. Because it won't generate a
10697 // new commitment transaction we can just provide the payment preimage to
10698 // the corresponding ChannelMonitor and nothing else.
10700 // We do so directly instead of via the normal ChannelMonitor update
10701 // procedure as the ChainMonitor hasn't yet been initialized, implying
10702 // we're not allowed to call it directly yet. Further, we do the update
10703 // without incrementing the ChannelMonitor update ID as there isn't any
10705 // If we were to generate a new ChannelMonitor update ID here and then
10706 // crash before the user finishes block connect we'd end up force-closing
10707 // this channel as well. On the flip side, there's no harm in restarting
10708 // without the new monitor persisted - we'll end up right back here on
10710 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
10711 if let Some(peer_node_id) = id_to_peer.get(&previous_channel_id){
10712 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
10713 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
10714 let peer_state = &mut *peer_state_lock;
10715 if let Some(ChannelPhase::Funded(channel)) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
10716 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
10719 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
10720 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
10723 pending_events_read.push_back((events::Event::PaymentClaimed {
10726 purpose: payment.purpose,
10727 amount_msat: claimable_amt_msat,
10728 htlcs: payment.htlcs.iter().map(events::ClaimedHTLC::from).collect(),
10729 sender_intended_total_msat: payment.htlcs.first().map(|htlc| htlc.total_msat),
10735 for (node_id, monitor_update_blocked_actions) in monitor_update_blocked_actions_per_peer.unwrap() {
10736 if let Some(peer_state) = per_peer_state.get(&node_id) {
10737 for (_, actions) in monitor_update_blocked_actions.iter() {
10738 for action in actions.iter() {
10739 if let MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
10740 downstream_counterparty_and_funding_outpoint:
10741 Some((blocked_node_id, blocked_channel_outpoint, blocking_action)), ..
10743 if let Some(blocked_peer_state) = per_peer_state.get(&blocked_node_id) {
10744 log_trace!(args.logger,
10745 "Holding the next revoke_and_ack from {} until the preimage is durably persisted in the inbound edge's ChannelMonitor",
10746 blocked_channel_outpoint.to_channel_id());
10747 blocked_peer_state.lock().unwrap().actions_blocking_raa_monitor_updates
10748 .entry(blocked_channel_outpoint.to_channel_id())
10749 .or_insert_with(Vec::new).push(blocking_action.clone());
10751 // If the channel we were blocking has closed, we don't need to
10752 // worry about it - the blocked monitor update should never have
10753 // been released from the `Channel` object so it can't have
10754 // completed, and if the channel closed there's no reason to bother
10758 if let MonitorUpdateCompletionAction::FreeOtherChannelImmediately { .. } = action {
10759 debug_assert!(false, "Non-event-generating channel freeing should not appear in our queue");
10763 peer_state.lock().unwrap().monitor_update_blocked_actions = monitor_update_blocked_actions;
10765 log_error!(args.logger, "Got blocked actions without a per-peer-state for {}", node_id);
10766 return Err(DecodeError::InvalidValue);
10770 let channel_manager = ChannelManager {
10772 fee_estimator: bounded_fee_estimator,
10773 chain_monitor: args.chain_monitor,
10774 tx_broadcaster: args.tx_broadcaster,
10775 router: args.router,
10777 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
10779 inbound_payment_key: expanded_inbound_key,
10780 pending_inbound_payments: Mutex::new(pending_inbound_payments),
10781 pending_outbound_payments: pending_outbounds,
10782 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
10784 forward_htlcs: Mutex::new(forward_htlcs),
10785 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments, pending_claiming_payments: pending_claiming_payments.unwrap() }),
10786 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
10787 id_to_peer: Mutex::new(id_to_peer),
10788 short_to_chan_info: FairRwLock::new(short_to_chan_info),
10789 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
10791 probing_cookie_secret: probing_cookie_secret.unwrap(),
10793 our_network_pubkey,
10796 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
10798 per_peer_state: FairRwLock::new(per_peer_state),
10800 pending_events: Mutex::new(pending_events_read),
10801 pending_events_processor: AtomicBool::new(false),
10802 pending_background_events: Mutex::new(pending_background_events),
10803 total_consistency_lock: RwLock::new(()),
10804 background_events_processed_since_startup: AtomicBool::new(false),
10806 event_persist_notifier: Notifier::new(),
10807 needs_persist_flag: AtomicBool::new(false),
10809 funding_batch_states: Mutex::new(BTreeMap::new()),
10811 pending_offers_messages: Mutex::new(Vec::new()),
10813 entropy_source: args.entropy_source,
10814 node_signer: args.node_signer,
10815 signer_provider: args.signer_provider,
10817 logger: args.logger,
10818 default_configuration: args.default_config,
10821 for htlc_source in failed_htlcs.drain(..) {
10822 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
10823 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
10824 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
10825 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
10828 for (source, preimage, downstream_value, downstream_closed, downstream_node_id, downstream_funding) in pending_claims_to_replay {
10829 // We use `downstream_closed` in place of `from_onchain` here just as a guess - we
10830 // don't remember in the `ChannelMonitor` where we got a preimage from, but if the
10831 // channel is closed we just assume that it probably came from an on-chain claim.
10832 channel_manager.claim_funds_internal(source, preimage, Some(downstream_value),
10833 downstream_closed, true, downstream_node_id, downstream_funding);
10836 //TODO: Broadcast channel update for closed channels, but only after we've made a
10837 //connection or two.
10839 Ok((best_block_hash.clone(), channel_manager))
10845 use bitcoin::hashes::Hash;
10846 use bitcoin::hashes::sha256::Hash as Sha256;
10847 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
10848 use core::sync::atomic::Ordering;
10849 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
10850 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
10851 use crate::ln::ChannelId;
10852 use crate::ln::channelmanager::{inbound_payment, PaymentId, PaymentSendFailure, RecipientOnionFields, InterceptId};
10853 use crate::ln::functional_test_utils::*;
10854 use crate::ln::msgs::{self, ErrorAction};
10855 use crate::ln::msgs::ChannelMessageHandler;
10856 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
10857 use crate::util::errors::APIError;
10858 use crate::util::test_utils;
10859 use crate::util::config::{ChannelConfig, ChannelConfigUpdate};
10860 use crate::sign::EntropySource;
10863 fn test_notify_limits() {
10864 // Check that a few cases which don't require the persistence of a new ChannelManager,
10865 // indeed, do not cause the persistence of a new ChannelManager.
10866 let chanmon_cfgs = create_chanmon_cfgs(3);
10867 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
10868 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
10869 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
10871 // All nodes start with a persistable update pending as `create_network` connects each node
10872 // with all other nodes to make most tests simpler.
10873 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
10874 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
10875 assert!(nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
10877 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1);
10879 // We check that the channel info nodes have doesn't change too early, even though we try
10880 // to connect messages with new values
10881 chan.0.contents.fee_base_msat *= 2;
10882 chan.1.contents.fee_base_msat *= 2;
10883 let node_a_chan_info = nodes[0].node.list_channels_with_counterparty(
10884 &nodes[1].node.get_our_node_id()).pop().unwrap();
10885 let node_b_chan_info = nodes[1].node.list_channels_with_counterparty(
10886 &nodes[0].node.get_our_node_id()).pop().unwrap();
10888 // The first two nodes (which opened a channel) should now require fresh persistence
10889 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
10890 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
10891 // ... but the last node should not.
10892 assert!(!nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
10893 // After persisting the first two nodes they should no longer need fresh persistence.
10894 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
10895 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
10897 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
10898 // about the channel.
10899 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
10900 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
10901 assert!(!nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
10903 // The nodes which are a party to the channel should also ignore messages from unrelated
10905 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
10906 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
10907 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
10908 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
10909 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
10910 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
10912 // At this point the channel info given by peers should still be the same.
10913 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
10914 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
10916 // An earlier version of handle_channel_update didn't check the directionality of the
10917 // update message and would always update the local fee info, even if our peer was
10918 // (spuriously) forwarding us our own channel_update.
10919 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
10920 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
10921 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
10923 // First deliver each peers' own message, checking that the node doesn't need to be
10924 // persisted and that its channel info remains the same.
10925 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
10926 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
10927 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
10928 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
10929 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
10930 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
10932 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
10933 // the channel info has updated.
10934 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
10935 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
10936 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
10937 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
10938 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
10939 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
10943 fn test_keysend_dup_hash_partial_mpp() {
10944 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
10946 let chanmon_cfgs = create_chanmon_cfgs(2);
10947 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10948 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10949 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10950 create_announced_chan_between_nodes(&nodes, 0, 1);
10952 // First, send a partial MPP payment.
10953 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
10954 let mut mpp_route = route.clone();
10955 mpp_route.paths.push(mpp_route.paths[0].clone());
10957 let payment_id = PaymentId([42; 32]);
10958 // Use the utility function send_payment_along_path to send the payment with MPP data which
10959 // indicates there are more HTLCs coming.
10960 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.
10961 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
10962 RecipientOnionFields::secret_only(payment_secret), payment_id, &mpp_route).unwrap();
10963 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[0], &our_payment_hash,
10964 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
10965 check_added_monitors!(nodes[0], 1);
10966 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10967 assert_eq!(events.len(), 1);
10968 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
10970 // Next, send a keysend payment with the same payment_hash and make sure it fails.
10971 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
10972 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
10973 check_added_monitors!(nodes[0], 1);
10974 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10975 assert_eq!(events.len(), 1);
10976 let ev = events.drain(..).next().unwrap();
10977 let payment_event = SendEvent::from_event(ev);
10978 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
10979 check_added_monitors!(nodes[1], 0);
10980 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
10981 expect_pending_htlcs_forwardable!(nodes[1]);
10982 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
10983 check_added_monitors!(nodes[1], 1);
10984 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
10985 assert!(updates.update_add_htlcs.is_empty());
10986 assert!(updates.update_fulfill_htlcs.is_empty());
10987 assert_eq!(updates.update_fail_htlcs.len(), 1);
10988 assert!(updates.update_fail_malformed_htlcs.is_empty());
10989 assert!(updates.update_fee.is_none());
10990 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
10991 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
10992 expect_payment_failed!(nodes[0], our_payment_hash, true);
10994 // Send the second half of the original MPP payment.
10995 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[1], &our_payment_hash,
10996 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
10997 check_added_monitors!(nodes[0], 1);
10998 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10999 assert_eq!(events.len(), 1);
11000 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
11002 // Claim the full MPP payment. Note that we can't use a test utility like
11003 // claim_funds_along_route because the ordering of the messages causes the second half of the
11004 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
11005 // lightning messages manually.
11006 nodes[1].node.claim_funds(payment_preimage);
11007 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
11008 check_added_monitors!(nodes[1], 2);
11010 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11011 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
11012 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
11013 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
11014 check_added_monitors!(nodes[0], 1);
11015 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11016 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
11017 check_added_monitors!(nodes[1], 1);
11018 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11019 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
11020 check_added_monitors!(nodes[1], 1);
11021 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
11022 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
11023 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
11024 check_added_monitors!(nodes[0], 1);
11025 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
11026 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
11027 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11028 check_added_monitors!(nodes[0], 1);
11029 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
11030 check_added_monitors!(nodes[1], 1);
11031 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
11032 check_added_monitors!(nodes[1], 1);
11033 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
11034 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
11035 check_added_monitors!(nodes[0], 1);
11037 // Note that successful MPP payments will generate a single PaymentSent event upon the first
11038 // path's success and a PaymentPathSuccessful event for each path's success.
11039 let events = nodes[0].node.get_and_clear_pending_events();
11040 assert_eq!(events.len(), 2);
11042 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
11043 assert_eq!(payment_id, *actual_payment_id);
11044 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
11045 assert_eq!(route.paths[0], *path);
11047 _ => panic!("Unexpected event"),
11050 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
11051 assert_eq!(payment_id, *actual_payment_id);
11052 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
11053 assert_eq!(route.paths[0], *path);
11055 _ => panic!("Unexpected event"),
11060 fn test_keysend_dup_payment_hash() {
11061 do_test_keysend_dup_payment_hash(false);
11062 do_test_keysend_dup_payment_hash(true);
11065 fn do_test_keysend_dup_payment_hash(accept_mpp_keysend: bool) {
11066 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
11067 // outbound regular payment fails as expected.
11068 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
11069 // fails as expected.
11070 // (3): Test that a keysend payment with a duplicate payment hash to an existing keysend
11071 // payment fails as expected. When `accept_mpp_keysend` is false, this tests that we
11072 // reject MPP keysend payments, since in this case where the payment has no payment
11073 // secret, a keysend payment with a duplicate hash is basically an MPP keysend. If
11074 // `accept_mpp_keysend` is true, this tests that we only accept MPP keysends with
11075 // payment secrets and reject otherwise.
11076 let chanmon_cfgs = create_chanmon_cfgs(2);
11077 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11078 let mut mpp_keysend_cfg = test_default_channel_config();
11079 mpp_keysend_cfg.accept_mpp_keysend = accept_mpp_keysend;
11080 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(mpp_keysend_cfg)]);
11081 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11082 create_announced_chan_between_nodes(&nodes, 0, 1);
11083 let scorer = test_utils::TestScorer::new();
11084 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
11086 // To start (1), send a regular payment but don't claim it.
11087 let expected_route = [&nodes[1]];
11088 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &expected_route, 100_000);
11090 // Next, attempt a keysend payment and make sure it fails.
11091 let route_params = RouteParameters::from_payment_params_and_value(
11092 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(),
11093 TEST_FINAL_CLTV, false), 100_000);
11094 let route = find_route(
11095 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
11096 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11098 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11099 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
11100 check_added_monitors!(nodes[0], 1);
11101 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11102 assert_eq!(events.len(), 1);
11103 let ev = events.drain(..).next().unwrap();
11104 let payment_event = SendEvent::from_event(ev);
11105 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11106 check_added_monitors!(nodes[1], 0);
11107 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11108 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
11109 // fails), the second will process the resulting failure and fail the HTLC backward
11110 expect_pending_htlcs_forwardable!(nodes[1]);
11111 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
11112 check_added_monitors!(nodes[1], 1);
11113 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11114 assert!(updates.update_add_htlcs.is_empty());
11115 assert!(updates.update_fulfill_htlcs.is_empty());
11116 assert_eq!(updates.update_fail_htlcs.len(), 1);
11117 assert!(updates.update_fail_malformed_htlcs.is_empty());
11118 assert!(updates.update_fee.is_none());
11119 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11120 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11121 expect_payment_failed!(nodes[0], payment_hash, true);
11123 // Finally, claim the original payment.
11124 claim_payment(&nodes[0], &expected_route, payment_preimage);
11126 // To start (2), send a keysend payment but don't claim it.
11127 let payment_preimage = PaymentPreimage([42; 32]);
11128 let route = find_route(
11129 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
11130 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11132 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11133 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
11134 check_added_monitors!(nodes[0], 1);
11135 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11136 assert_eq!(events.len(), 1);
11137 let event = events.pop().unwrap();
11138 let path = vec![&nodes[1]];
11139 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
11141 // Next, attempt a regular payment and make sure it fails.
11142 let payment_secret = PaymentSecret([43; 32]);
11143 nodes[0].node.send_payment_with_route(&route, payment_hash,
11144 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
11145 check_added_monitors!(nodes[0], 1);
11146 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11147 assert_eq!(events.len(), 1);
11148 let ev = events.drain(..).next().unwrap();
11149 let payment_event = SendEvent::from_event(ev);
11150 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11151 check_added_monitors!(nodes[1], 0);
11152 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11153 expect_pending_htlcs_forwardable!(nodes[1]);
11154 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
11155 check_added_monitors!(nodes[1], 1);
11156 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11157 assert!(updates.update_add_htlcs.is_empty());
11158 assert!(updates.update_fulfill_htlcs.is_empty());
11159 assert_eq!(updates.update_fail_htlcs.len(), 1);
11160 assert!(updates.update_fail_malformed_htlcs.is_empty());
11161 assert!(updates.update_fee.is_none());
11162 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11163 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11164 expect_payment_failed!(nodes[0], payment_hash, true);
11166 // Finally, succeed the keysend payment.
11167 claim_payment(&nodes[0], &expected_route, payment_preimage);
11169 // To start (3), send a keysend payment but don't claim it.
11170 let payment_id_1 = PaymentId([44; 32]);
11171 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11172 RecipientOnionFields::spontaneous_empty(), payment_id_1).unwrap();
11173 check_added_monitors!(nodes[0], 1);
11174 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11175 assert_eq!(events.len(), 1);
11176 let event = events.pop().unwrap();
11177 let path = vec![&nodes[1]];
11178 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
11180 // Next, attempt a keysend payment and make sure it fails.
11181 let route_params = RouteParameters::from_payment_params_and_value(
11182 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
11185 let route = find_route(
11186 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
11187 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11189 let payment_id_2 = PaymentId([45; 32]);
11190 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
11191 RecipientOnionFields::spontaneous_empty(), payment_id_2).unwrap();
11192 check_added_monitors!(nodes[0], 1);
11193 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
11194 assert_eq!(events.len(), 1);
11195 let ev = events.drain(..).next().unwrap();
11196 let payment_event = SendEvent::from_event(ev);
11197 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
11198 check_added_monitors!(nodes[1], 0);
11199 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
11200 expect_pending_htlcs_forwardable!(nodes[1]);
11201 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
11202 check_added_monitors!(nodes[1], 1);
11203 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
11204 assert!(updates.update_add_htlcs.is_empty());
11205 assert!(updates.update_fulfill_htlcs.is_empty());
11206 assert_eq!(updates.update_fail_htlcs.len(), 1);
11207 assert!(updates.update_fail_malformed_htlcs.is_empty());
11208 assert!(updates.update_fee.is_none());
11209 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
11210 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
11211 expect_payment_failed!(nodes[0], payment_hash, true);
11213 // Finally, claim the original payment.
11214 claim_payment(&nodes[0], &expected_route, payment_preimage);
11218 fn test_keysend_hash_mismatch() {
11219 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
11220 // preimage doesn't match the msg's payment hash.
11221 let chanmon_cfgs = create_chanmon_cfgs(2);
11222 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11223 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11224 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11226 let payer_pubkey = nodes[0].node.get_our_node_id();
11227 let payee_pubkey = nodes[1].node.get_our_node_id();
11229 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
11230 let route_params = RouteParameters::from_payment_params_and_value(
11231 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
11232 let network_graph = nodes[0].network_graph.clone();
11233 let first_hops = nodes[0].node.list_usable_channels();
11234 let scorer = test_utils::TestScorer::new();
11235 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
11236 let route = find_route(
11237 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
11238 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11241 let test_preimage = PaymentPreimage([42; 32]);
11242 let mismatch_payment_hash = PaymentHash([43; 32]);
11243 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash,
11244 RecipientOnionFields::spontaneous_empty(), PaymentId(mismatch_payment_hash.0), &route).unwrap();
11245 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash,
11246 RecipientOnionFields::spontaneous_empty(), Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
11247 check_added_monitors!(nodes[0], 1);
11249 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11250 assert_eq!(updates.update_add_htlcs.len(), 1);
11251 assert!(updates.update_fulfill_htlcs.is_empty());
11252 assert!(updates.update_fail_htlcs.is_empty());
11253 assert!(updates.update_fail_malformed_htlcs.is_empty());
11254 assert!(updates.update_fee.is_none());
11255 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
11257 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "Payment preimage didn't match payment hash", 1);
11261 fn test_keysend_msg_with_secret_err() {
11262 // Test that we error as expected if we receive a keysend payment that includes a payment
11263 // secret when we don't support MPP keysend.
11264 let mut reject_mpp_keysend_cfg = test_default_channel_config();
11265 reject_mpp_keysend_cfg.accept_mpp_keysend = false;
11266 let chanmon_cfgs = create_chanmon_cfgs(2);
11267 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11268 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(reject_mpp_keysend_cfg)]);
11269 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11271 let payer_pubkey = nodes[0].node.get_our_node_id();
11272 let payee_pubkey = nodes[1].node.get_our_node_id();
11274 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
11275 let route_params = RouteParameters::from_payment_params_and_value(
11276 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
11277 let network_graph = nodes[0].network_graph.clone();
11278 let first_hops = nodes[0].node.list_usable_channels();
11279 let scorer = test_utils::TestScorer::new();
11280 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
11281 let route = find_route(
11282 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
11283 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
11286 let test_preimage = PaymentPreimage([42; 32]);
11287 let test_secret = PaymentSecret([43; 32]);
11288 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
11289 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash,
11290 RecipientOnionFields::secret_only(test_secret), PaymentId(payment_hash.0), &route).unwrap();
11291 nodes[0].node.test_send_payment_internal(&route, payment_hash,
11292 RecipientOnionFields::secret_only(test_secret), Some(test_preimage),
11293 PaymentId(payment_hash.0), None, session_privs).unwrap();
11294 check_added_monitors!(nodes[0], 1);
11296 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
11297 assert_eq!(updates.update_add_htlcs.len(), 1);
11298 assert!(updates.update_fulfill_htlcs.is_empty());
11299 assert!(updates.update_fail_htlcs.is_empty());
11300 assert!(updates.update_fail_malformed_htlcs.is_empty());
11301 assert!(updates.update_fee.is_none());
11302 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
11304 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "We don't support MPP keysend payments", 1);
11308 fn test_multi_hop_missing_secret() {
11309 let chanmon_cfgs = create_chanmon_cfgs(4);
11310 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
11311 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
11312 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
11314 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
11315 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
11316 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
11317 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
11319 // Marshall an MPP route.
11320 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
11321 let path = route.paths[0].clone();
11322 route.paths.push(path);
11323 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
11324 route.paths[0].hops[0].short_channel_id = chan_1_id;
11325 route.paths[0].hops[1].short_channel_id = chan_3_id;
11326 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
11327 route.paths[1].hops[0].short_channel_id = chan_2_id;
11328 route.paths[1].hops[1].short_channel_id = chan_4_id;
11330 match nodes[0].node.send_payment_with_route(&route, payment_hash,
11331 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0))
11333 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
11334 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err))
11336 _ => panic!("unexpected error")
11341 fn test_drop_disconnected_peers_when_removing_channels() {
11342 let chanmon_cfgs = create_chanmon_cfgs(2);
11343 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11344 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11345 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11347 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
11349 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
11350 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
11352 nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
11353 check_closed_broadcast!(nodes[0], true);
11354 check_added_monitors!(nodes[0], 1);
11355 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
11358 // Assert that nodes[1] is awaiting removal for nodes[0] once nodes[1] has been
11359 // disconnected and the channel between has been force closed.
11360 let nodes_0_per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
11361 // Assert that nodes[1] isn't removed before `timer_tick_occurred` has been executed.
11362 assert_eq!(nodes_0_per_peer_state.len(), 1);
11363 assert!(nodes_0_per_peer_state.get(&nodes[1].node.get_our_node_id()).is_some());
11366 nodes[0].node.timer_tick_occurred();
11369 // Assert that nodes[1] has now been removed.
11370 assert_eq!(nodes[0].node.per_peer_state.read().unwrap().len(), 0);
11375 fn bad_inbound_payment_hash() {
11376 // Add coverage for checking that a user-provided payment hash matches the payment secret.
11377 let chanmon_cfgs = create_chanmon_cfgs(2);
11378 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11379 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11380 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11382 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
11383 let payment_data = msgs::FinalOnionHopData {
11385 total_msat: 100_000,
11388 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
11389 // payment verification fails as expected.
11390 let mut bad_payment_hash = payment_hash.clone();
11391 bad_payment_hash.0[0] += 1;
11392 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) {
11393 Ok(_) => panic!("Unexpected ok"),
11395 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment", "Failing HTLC with user-generated payment_hash", 1);
11399 // Check that using the original payment hash succeeds.
11400 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());
11404 fn test_id_to_peer_coverage() {
11405 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
11406 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
11407 // the channel is successfully closed.
11408 let chanmon_cfgs = create_chanmon_cfgs(2);
11409 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11410 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11411 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11413 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None, None).unwrap();
11414 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11415 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
11416 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
11417 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
11419 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
11420 let channel_id = ChannelId::from_bytes(tx.txid().into_inner());
11422 // Ensure that the `id_to_peer` map is empty until either party has received the
11423 // funding transaction, and have the real `channel_id`.
11424 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
11425 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
11428 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
11430 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
11431 // as it has the funding transaction.
11432 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
11433 assert_eq!(nodes_0_lock.len(), 1);
11434 assert!(nodes_0_lock.contains_key(&channel_id));
11437 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
11439 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
11441 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
11443 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
11444 assert_eq!(nodes_0_lock.len(), 1);
11445 assert!(nodes_0_lock.contains_key(&channel_id));
11447 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
11450 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
11451 // as it has the funding transaction.
11452 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
11453 assert_eq!(nodes_1_lock.len(), 1);
11454 assert!(nodes_1_lock.contains_key(&channel_id));
11456 check_added_monitors!(nodes[1], 1);
11457 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
11458 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
11459 check_added_monitors!(nodes[0], 1);
11460 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
11461 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
11462 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
11463 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
11465 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
11466 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()));
11467 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
11468 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &nodes_1_shutdown);
11470 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
11471 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
11473 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
11474 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
11475 // fee for the closing transaction has been negotiated and the parties has the other
11476 // party's signature for the fee negotiated closing transaction.)
11477 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
11478 assert_eq!(nodes_0_lock.len(), 1);
11479 assert!(nodes_0_lock.contains_key(&channel_id));
11483 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
11484 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
11485 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
11486 // kept in the `nodes[1]`'s `id_to_peer` map.
11487 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
11488 assert_eq!(nodes_1_lock.len(), 1);
11489 assert!(nodes_1_lock.contains_key(&channel_id));
11492 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()));
11494 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
11495 // therefore has all it needs to fully close the channel (both signatures for the
11496 // closing transaction).
11497 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
11498 // fully closed by `nodes[0]`.
11499 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
11501 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
11502 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
11503 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
11504 assert_eq!(nodes_1_lock.len(), 1);
11505 assert!(nodes_1_lock.contains_key(&channel_id));
11508 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
11510 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
11512 // Assert that the channel has now been removed from both parties `id_to_peer` map once
11513 // they both have everything required to fully close the channel.
11514 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
11516 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
11518 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
11519 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
11522 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
11523 let expected_message = format!("Not connected to node: {}", expected_public_key);
11524 check_api_error_message(expected_message, res_err)
11527 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
11528 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
11529 check_api_error_message(expected_message, res_err)
11532 fn check_channel_unavailable_error<T>(res_err: Result<T, APIError>, expected_channel_id: ChannelId, peer_node_id: PublicKey) {
11533 let expected_message = format!("Channel with id {} not found for the passed counterparty node_id {}", expected_channel_id, peer_node_id);
11534 check_api_error_message(expected_message, res_err)
11537 fn check_api_misuse_error<T>(res_err: Result<T, APIError>) {
11538 let expected_message = "No such channel awaiting to be accepted.".to_string();
11539 check_api_error_message(expected_message, res_err)
11542 fn check_api_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
11544 Err(APIError::APIMisuseError { err }) => {
11545 assert_eq!(err, expected_err_message);
11547 Err(APIError::ChannelUnavailable { err }) => {
11548 assert_eq!(err, expected_err_message);
11550 Ok(_) => panic!("Unexpected Ok"),
11551 Err(_) => panic!("Unexpected Error"),
11556 fn test_api_calls_with_unkown_counterparty_node() {
11557 // Tests that our API functions that expects a `counterparty_node_id` as input, behaves as
11558 // expected if the `counterparty_node_id` is an unkown peer in the
11559 // `ChannelManager::per_peer_state` map.
11560 let chanmon_cfg = create_chanmon_cfgs(2);
11561 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
11562 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
11563 let nodes = create_network(2, &node_cfg, &node_chanmgr);
11566 let channel_id = ChannelId::from_bytes([4; 32]);
11567 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
11568 let intercept_id = InterceptId([0; 32]);
11570 // Test the API functions.
11571 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);
11573 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&channel_id, &unkown_public_key, 42), unkown_public_key);
11575 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
11577 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
11579 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
11581 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
11583 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
11587 fn test_api_calls_with_unavailable_channel() {
11588 // Tests that our API functions that expects a `counterparty_node_id` and a `channel_id`
11589 // as input, behaves as expected if the `counterparty_node_id` is a known peer in the
11590 // `ChannelManager::per_peer_state` map, but the peer state doesn't contain a channel with
11591 // the given `channel_id`.
11592 let chanmon_cfg = create_chanmon_cfgs(2);
11593 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
11594 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
11595 let nodes = create_network(2, &node_cfg, &node_chanmgr);
11597 let counterparty_node_id = nodes[1].node.get_our_node_id();
11600 let channel_id = ChannelId::from_bytes([4; 32]);
11602 // Test the API functions.
11603 check_api_misuse_error(nodes[0].node.accept_inbound_channel(&channel_id, &counterparty_node_id, 42));
11605 check_channel_unavailable_error(nodes[0].node.close_channel(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
11607 check_channel_unavailable_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
11609 check_channel_unavailable_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &counterparty_node_id), channel_id, counterparty_node_id);
11611 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);
11613 check_channel_unavailable_error(nodes[0].node.update_channel_config(&counterparty_node_id, &[channel_id], &ChannelConfig::default()), channel_id, counterparty_node_id);
11617 fn test_connection_limiting() {
11618 // Test that we limit un-channel'd peers and un-funded channels properly.
11619 let chanmon_cfgs = create_chanmon_cfgs(2);
11620 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11621 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11622 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11624 // Note that create_network connects the nodes together for us
11626 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
11627 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11629 let mut funding_tx = None;
11630 for idx in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
11631 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11632 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
11635 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
11636 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
11637 funding_tx = Some(tx.clone());
11638 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx).unwrap();
11639 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
11641 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
11642 check_added_monitors!(nodes[1], 1);
11643 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
11645 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
11647 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
11648 check_added_monitors!(nodes[0], 1);
11649 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
11651 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
11654 // A MAX_UNFUNDED_CHANS_PER_PEER + 1 channel will be summarily rejected
11655 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
11656 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11657 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
11658 open_channel_msg.temporary_channel_id);
11660 // Further, because all of our channels with nodes[0] are inbound, and none of them funded,
11661 // it doesn't count as a "protected" peer, i.e. it counts towards the MAX_NO_CHANNEL_PEERS
11663 let mut peer_pks = Vec::with_capacity(super::MAX_NO_CHANNEL_PEERS);
11664 for _ in 1..super::MAX_NO_CHANNEL_PEERS {
11665 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
11666 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
11667 peer_pks.push(random_pk);
11668 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
11669 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11672 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
11673 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
11674 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
11675 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11676 }, true).unwrap_err();
11678 // Also importantly, because nodes[0] isn't "protected", we will refuse a reconnection from
11679 // them if we have too many un-channel'd peers.
11680 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
11681 let chan_closed_events = nodes[1].node.get_and_clear_pending_events();
11682 assert_eq!(chan_closed_events.len(), super::MAX_UNFUNDED_CHANS_PER_PEER - 1);
11683 for ev in chan_closed_events {
11684 if let Event::ChannelClosed { .. } = ev { } else { panic!(); }
11686 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
11687 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11689 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
11690 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11691 }, true).unwrap_err();
11693 // but of course if the connection is outbound its allowed...
11694 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
11695 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11696 }, false).unwrap();
11697 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
11699 // Now nodes[0] is disconnected but still has a pending, un-funded channel lying around.
11700 // Even though we accept one more connection from new peers, we won't actually let them
11702 assert!(peer_pks.len() > super::MAX_UNFUNDED_CHANNEL_PEERS - 1);
11703 for i in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
11704 nodes[1].node.handle_open_channel(&peer_pks[i], &open_channel_msg);
11705 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, peer_pks[i]);
11706 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
11708 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
11709 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
11710 open_channel_msg.temporary_channel_id);
11712 // Of course, however, outbound channels are always allowed
11713 nodes[1].node.create_channel(last_random_pk, 100_000, 0, 42, None, None).unwrap();
11714 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, last_random_pk);
11716 // If we fund the first channel, nodes[0] has a live on-chain channel with us, it is now
11717 // "protected" and can connect again.
11718 mine_transaction(&nodes[1], funding_tx.as_ref().unwrap());
11719 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
11720 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11722 get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
11724 // Further, because the first channel was funded, we can open another channel with
11726 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
11727 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
11731 fn test_outbound_chans_unlimited() {
11732 // Test that we never refuse an outbound channel even if a peer is unfuned-channel-limited
11733 let chanmon_cfgs = create_chanmon_cfgs(2);
11734 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11735 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
11736 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11738 // Note that create_network connects the nodes together for us
11740 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
11741 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11743 for _ in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
11744 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11745 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
11746 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
11749 // Once we have MAX_UNFUNDED_CHANS_PER_PEER unfunded channels, new inbound channels will be
11751 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11752 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
11753 open_channel_msg.temporary_channel_id);
11755 // but we can still open an outbound channel.
11756 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
11757 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
11759 // but even with such an outbound channel, additional inbound channels will still fail.
11760 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11761 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
11762 open_channel_msg.temporary_channel_id);
11766 fn test_0conf_limiting() {
11767 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
11768 // flag set and (sometimes) accept channels as 0conf.
11769 let chanmon_cfgs = create_chanmon_cfgs(2);
11770 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11771 let mut settings = test_default_channel_config();
11772 settings.manually_accept_inbound_channels = true;
11773 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(settings)]);
11774 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11776 // Note that create_network connects the nodes together for us
11778 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
11779 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11781 // First, get us up to MAX_UNFUNDED_CHANNEL_PEERS so we can test at the edge
11782 for _ in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
11783 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
11784 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
11785 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
11786 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11789 nodes[1].node.handle_open_channel(&random_pk, &open_channel_msg);
11790 let events = nodes[1].node.get_and_clear_pending_events();
11792 Event::OpenChannelRequest { temporary_channel_id, .. } => {
11793 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23).unwrap();
11795 _ => panic!("Unexpected event"),
11797 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, random_pk);
11798 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
11801 // If we try to accept a channel from another peer non-0conf it will fail.
11802 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
11803 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
11804 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
11805 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
11807 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
11808 let events = nodes[1].node.get_and_clear_pending_events();
11810 Event::OpenChannelRequest { temporary_channel_id, .. } => {
11811 match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23) {
11812 Err(APIError::APIMisuseError { err }) =>
11813 assert_eq!(err, "Too many peers with unfunded channels, refusing to accept new ones"),
11817 _ => panic!("Unexpected event"),
11819 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
11820 open_channel_msg.temporary_channel_id);
11822 // ...however if we accept the same channel 0conf it should work just fine.
11823 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
11824 let events = nodes[1].node.get_and_clear_pending_events();
11826 Event::OpenChannelRequest { temporary_channel_id, .. } => {
11827 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23).unwrap();
11829 _ => panic!("Unexpected event"),
11831 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
11835 fn reject_excessively_underpaying_htlcs() {
11836 let chanmon_cfg = create_chanmon_cfgs(1);
11837 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
11838 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
11839 let node = create_network(1, &node_cfg, &node_chanmgr);
11840 let sender_intended_amt_msat = 100;
11841 let extra_fee_msat = 10;
11842 let hop_data = msgs::InboundOnionPayload::Receive {
11844 outgoing_cltv_value: 42,
11845 payment_metadata: None,
11846 keysend_preimage: None,
11847 payment_data: Some(msgs::FinalOnionHopData {
11848 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
11850 custom_tlvs: Vec::new(),
11852 // Check that if the amount we received + the penultimate hop extra fee is less than the sender
11853 // intended amount, we fail the payment.
11854 if let Err(crate::ln::channelmanager::InboundOnionErr { err_code, .. }) =
11855 node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
11856 sender_intended_amt_msat - extra_fee_msat - 1, 42, None, true, Some(extra_fee_msat))
11858 assert_eq!(err_code, 19);
11859 } else { panic!(); }
11861 // If amt_received + extra_fee is equal to the sender intended amount, we're fine.
11862 let hop_data = msgs::InboundOnionPayload::Receive { // This is the same payload as above, InboundOnionPayload doesn't implement Clone
11864 outgoing_cltv_value: 42,
11865 payment_metadata: None,
11866 keysend_preimage: None,
11867 payment_data: Some(msgs::FinalOnionHopData {
11868 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
11870 custom_tlvs: Vec::new(),
11872 assert!(node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
11873 sender_intended_amt_msat - extra_fee_msat, 42, None, true, Some(extra_fee_msat)).is_ok());
11877 fn test_final_incorrect_cltv(){
11878 let chanmon_cfg = create_chanmon_cfgs(1);
11879 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
11880 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
11881 let node = create_network(1, &node_cfg, &node_chanmgr);
11883 let result = node[0].node.construct_recv_pending_htlc_info(msgs::InboundOnionPayload::Receive {
11885 outgoing_cltv_value: 22,
11886 payment_metadata: None,
11887 keysend_preimage: None,
11888 payment_data: Some(msgs::FinalOnionHopData {
11889 payment_secret: PaymentSecret([0; 32]), total_msat: 100,
11891 custom_tlvs: Vec::new(),
11892 }, [0; 32], PaymentHash([0; 32]), 100, 23, None, true, None);
11894 // Should not return an error as this condition:
11895 // https://github.com/lightning/bolts/blob/4dcc377209509b13cf89a4b91fde7d478f5b46d8/04-onion-routing.md?plain=1#L334
11896 // is not satisfied.
11897 assert!(result.is_ok());
11901 fn test_inbound_anchors_manual_acceptance() {
11902 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
11903 // flag set and (sometimes) accept channels as 0conf.
11904 let mut anchors_cfg = test_default_channel_config();
11905 anchors_cfg.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
11907 let mut anchors_manual_accept_cfg = anchors_cfg.clone();
11908 anchors_manual_accept_cfg.manually_accept_inbound_channels = true;
11910 let chanmon_cfgs = create_chanmon_cfgs(3);
11911 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
11912 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs,
11913 &[Some(anchors_cfg.clone()), Some(anchors_cfg.clone()), Some(anchors_manual_accept_cfg.clone())]);
11914 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
11916 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
11917 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11919 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11920 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
11921 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
11922 match &msg_events[0] {
11923 MessageSendEvent::HandleError { node_id, action } => {
11924 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
11926 ErrorAction::SendErrorMessage { msg } =>
11927 assert_eq!(msg.data, "No channels with anchor outputs accepted".to_owned()),
11928 _ => panic!("Unexpected error action"),
11931 _ => panic!("Unexpected event"),
11934 nodes[2].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11935 let events = nodes[2].node.get_and_clear_pending_events();
11937 Event::OpenChannelRequest { temporary_channel_id, .. } =>
11938 nodes[2].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap(),
11939 _ => panic!("Unexpected event"),
11941 get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
11945 fn test_anchors_zero_fee_htlc_tx_fallback() {
11946 // Tests that if both nodes support anchors, but the remote node does not want to accept
11947 // anchor channels at the moment, an error it sent to the local node such that it can retry
11948 // the channel without the anchors feature.
11949 let chanmon_cfgs = create_chanmon_cfgs(2);
11950 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11951 let mut anchors_config = test_default_channel_config();
11952 anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
11953 anchors_config.manually_accept_inbound_channels = true;
11954 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config.clone()), Some(anchors_config.clone())]);
11955 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11957 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 0, None, None).unwrap();
11958 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11959 assert!(open_channel_msg.channel_type.as_ref().unwrap().supports_anchors_zero_fee_htlc_tx());
11961 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11962 let events = nodes[1].node.get_and_clear_pending_events();
11964 Event::OpenChannelRequest { temporary_channel_id, .. } => {
11965 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
11967 _ => panic!("Unexpected event"),
11970 let error_msg = get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id());
11971 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &error_msg);
11973 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11974 assert!(!open_channel_msg.channel_type.unwrap().supports_anchors_zero_fee_htlc_tx());
11976 // Since nodes[1] should not have accepted the channel, it should
11977 // not have generated any events.
11978 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
11982 fn test_update_channel_config() {
11983 let chanmon_cfg = create_chanmon_cfgs(2);
11984 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
11985 let mut user_config = test_default_channel_config();
11986 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
11987 let nodes = create_network(2, &node_cfg, &node_chanmgr);
11988 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
11989 let channel = &nodes[0].node.list_channels()[0];
11991 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
11992 let events = nodes[0].node.get_and_clear_pending_msg_events();
11993 assert_eq!(events.len(), 0);
11995 user_config.channel_config.forwarding_fee_base_msat += 10;
11996 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
11997 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_base_msat, user_config.channel_config.forwarding_fee_base_msat);
11998 let events = nodes[0].node.get_and_clear_pending_msg_events();
11999 assert_eq!(events.len(), 1);
12001 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
12002 _ => panic!("expected BroadcastChannelUpdate event"),
12005 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate::default()).unwrap();
12006 let events = nodes[0].node.get_and_clear_pending_msg_events();
12007 assert_eq!(events.len(), 0);
12009 let new_cltv_expiry_delta = user_config.channel_config.cltv_expiry_delta + 6;
12010 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
12011 cltv_expiry_delta: Some(new_cltv_expiry_delta),
12012 ..Default::default()
12014 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
12015 let events = nodes[0].node.get_and_clear_pending_msg_events();
12016 assert_eq!(events.len(), 1);
12018 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
12019 _ => panic!("expected BroadcastChannelUpdate event"),
12022 let new_fee = user_config.channel_config.forwarding_fee_proportional_millionths + 100;
12023 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
12024 forwarding_fee_proportional_millionths: Some(new_fee),
12025 ..Default::default()
12027 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
12028 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, new_fee);
12029 let events = nodes[0].node.get_and_clear_pending_msg_events();
12030 assert_eq!(events.len(), 1);
12032 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
12033 _ => panic!("expected BroadcastChannelUpdate event"),
12036 // If we provide a channel_id not associated with the peer, we should get an error and no updates
12037 // should be applied to ensure update atomicity as specified in the API docs.
12038 let bad_channel_id = ChannelId::v1_from_funding_txid(&[10; 32], 10);
12039 let current_fee = nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths;
12040 let new_fee = current_fee + 100;
12043 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id, bad_channel_id], &ChannelConfigUpdate {
12044 forwarding_fee_proportional_millionths: Some(new_fee),
12045 ..Default::default()
12047 Err(APIError::ChannelUnavailable { err: _ }),
12050 // Check that the fee hasn't changed for the channel that exists.
12051 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, current_fee);
12052 let events = nodes[0].node.get_and_clear_pending_msg_events();
12053 assert_eq!(events.len(), 0);
12057 fn test_payment_display() {
12058 let payment_id = PaymentId([42; 32]);
12059 assert_eq!(format!("{}", &payment_id), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
12060 let payment_hash = PaymentHash([42; 32]);
12061 assert_eq!(format!("{}", &payment_hash), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
12062 let payment_preimage = PaymentPreimage([42; 32]);
12063 assert_eq!(format!("{}", &payment_preimage), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
12067 fn test_trigger_lnd_force_close() {
12068 let chanmon_cfg = create_chanmon_cfgs(2);
12069 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
12070 let user_config = test_default_channel_config();
12071 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
12072 let nodes = create_network(2, &node_cfg, &node_chanmgr);
12074 // Open a channel, immediately disconnect each other, and broadcast Alice's latest state.
12075 let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
12076 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
12077 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
12078 nodes[0].node.force_close_broadcasting_latest_txn(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
12079 check_closed_broadcast(&nodes[0], 1, true);
12080 check_added_monitors(&nodes[0], 1);
12081 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
12083 let txn = nodes[0].tx_broadcaster.txn_broadcast();
12084 assert_eq!(txn.len(), 1);
12085 check_spends!(txn[0], funding_tx);
12088 // Since they're disconnected, Bob won't receive Alice's `Error` message. Reconnect them
12089 // such that Bob sends a `ChannelReestablish` to Alice since the channel is still open from
12091 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
12092 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
12094 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
12095 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
12096 }, false).unwrap();
12097 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
12098 let channel_reestablish = get_event_msg!(
12099 nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id()
12101 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &channel_reestablish);
12103 // Alice should respond with an error since the channel isn't known, but a bogus
12104 // `ChannelReestablish` should be sent first, such that we actually trigger Bob to force
12105 // close even if it was an lnd node.
12106 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
12107 assert_eq!(msg_events.len(), 2);
12108 if let MessageSendEvent::SendChannelReestablish { node_id, msg } = &msg_events[0] {
12109 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
12110 assert_eq!(msg.next_local_commitment_number, 0);
12111 assert_eq!(msg.next_remote_commitment_number, 0);
12112 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &msg);
12113 } else { panic!() };
12114 check_closed_broadcast(&nodes[1], 1, true);
12115 check_added_monitors(&nodes[1], 1);
12116 let expected_close_reason = ClosureReason::ProcessingError {
12117 err: "Peer sent an invalid channel_reestablish to force close in a non-standard way".to_string()
12119 check_closed_event!(nodes[1], 1, expected_close_reason, [nodes[0].node.get_our_node_id()], 100000);
12121 let txn = nodes[1].tx_broadcaster.txn_broadcast();
12122 assert_eq!(txn.len(), 1);
12123 check_spends!(txn[0], funding_tx);
12130 use crate::chain::Listen;
12131 use crate::chain::chainmonitor::{ChainMonitor, Persist};
12132 use crate::sign::{KeysManager, InMemorySigner};
12133 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider};
12134 use crate::ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId, RecipientOnionFields, Retry};
12135 use crate::ln::functional_test_utils::*;
12136 use crate::ln::msgs::{ChannelMessageHandler, Init};
12137 use crate::routing::gossip::NetworkGraph;
12138 use crate::routing::router::{PaymentParameters, RouteParameters};
12139 use crate::util::test_utils;
12140 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
12142 use bitcoin::hashes::Hash;
12143 use bitcoin::hashes::sha256::Hash as Sha256;
12144 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
12146 use crate::sync::{Arc, Mutex, RwLock};
12148 use criterion::Criterion;
12150 type Manager<'a, P> = ChannelManager<
12151 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
12152 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
12153 &'a test_utils::TestLogger, &'a P>,
12154 &'a test_utils::TestBroadcaster, &'a KeysManager, &'a KeysManager, &'a KeysManager,
12155 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
12156 &'a test_utils::TestLogger>;
12158 struct ANodeHolder<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> {
12159 node: &'node_cfg Manager<'chan_mon_cfg, P>,
12161 impl<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> NodeHolder for ANodeHolder<'node_cfg, 'chan_mon_cfg, P> {
12162 type CM = Manager<'chan_mon_cfg, P>;
12164 fn node(&self) -> &Manager<'chan_mon_cfg, P> { self.node }
12166 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { None }
12169 pub fn bench_sends(bench: &mut Criterion) {
12170 bench_two_sends(bench, "bench_sends", test_utils::TestPersister::new(), test_utils::TestPersister::new());
12173 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Criterion, bench_name: &str, persister_a: P, persister_b: P) {
12174 // Do a simple benchmark of sending a payment back and forth between two nodes.
12175 // Note that this is unrealistic as each payment send will require at least two fsync
12177 let network = bitcoin::Network::Testnet;
12178 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
12180 let tx_broadcaster = test_utils::TestBroadcaster::new(network);
12181 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
12182 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
12183 let scorer = RwLock::new(test_utils::TestScorer::new());
12184 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(network, &logger_a)), &scorer);
12186 let mut config: UserConfig = Default::default();
12187 config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
12188 config.channel_handshake_config.minimum_depth = 1;
12190 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
12191 let seed_a = [1u8; 32];
12192 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
12193 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 {
12195 best_block: BestBlock::from_network(network),
12196 }, genesis_block.header.time);
12197 let node_a_holder = ANodeHolder { node: &node_a };
12199 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
12200 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
12201 let seed_b = [2u8; 32];
12202 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
12203 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 {
12205 best_block: BestBlock::from_network(network),
12206 }, genesis_block.header.time);
12207 let node_b_holder = ANodeHolder { node: &node_b };
12209 node_a.peer_connected(&node_b.get_our_node_id(), &Init {
12210 features: node_b.init_features(), networks: None, remote_network_address: None
12212 node_b.peer_connected(&node_a.get_our_node_id(), &Init {
12213 features: node_a.init_features(), networks: None, remote_network_address: None
12214 }, false).unwrap();
12215 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None, None).unwrap();
12216 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()));
12217 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()));
12220 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
12221 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
12222 value: 8_000_000, script_pubkey: output_script,
12224 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
12225 } else { panic!(); }
12227 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()));
12228 let events_b = node_b.get_and_clear_pending_events();
12229 assert_eq!(events_b.len(), 1);
12230 match events_b[0] {
12231 Event::ChannelPending{ ref counterparty_node_id, .. } => {
12232 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
12234 _ => panic!("Unexpected event"),
12237 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()));
12238 let events_a = node_a.get_and_clear_pending_events();
12239 assert_eq!(events_a.len(), 1);
12240 match events_a[0] {
12241 Event::ChannelPending{ ref counterparty_node_id, .. } => {
12242 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
12244 _ => panic!("Unexpected event"),
12247 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
12249 let block = create_dummy_block(BestBlock::from_network(network).block_hash(), 42, vec![tx]);
12250 Listen::block_connected(&node_a, &block, 1);
12251 Listen::block_connected(&node_b, &block, 1);
12253 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()));
12254 let msg_events = node_a.get_and_clear_pending_msg_events();
12255 assert_eq!(msg_events.len(), 2);
12256 match msg_events[0] {
12257 MessageSendEvent::SendChannelReady { ref msg, .. } => {
12258 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
12259 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
12263 match msg_events[1] {
12264 MessageSendEvent::SendChannelUpdate { .. } => {},
12268 let events_a = node_a.get_and_clear_pending_events();
12269 assert_eq!(events_a.len(), 1);
12270 match events_a[0] {
12271 Event::ChannelReady{ ref counterparty_node_id, .. } => {
12272 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
12274 _ => panic!("Unexpected event"),
12277 let events_b = node_b.get_and_clear_pending_events();
12278 assert_eq!(events_b.len(), 1);
12279 match events_b[0] {
12280 Event::ChannelReady{ ref counterparty_node_id, .. } => {
12281 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
12283 _ => panic!("Unexpected event"),
12286 let mut payment_count: u64 = 0;
12287 macro_rules! send_payment {
12288 ($node_a: expr, $node_b: expr) => {
12289 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id(), TEST_FINAL_CLTV)
12290 .with_bolt11_features($node_b.bolt11_invoice_features()).unwrap();
12291 let mut payment_preimage = PaymentPreimage([0; 32]);
12292 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
12293 payment_count += 1;
12294 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
12295 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
12297 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
12298 PaymentId(payment_hash.0),
12299 RouteParameters::from_payment_params_and_value(payment_params, 10_000),
12300 Retry::Attempts(0)).unwrap();
12301 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
12302 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
12303 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
12304 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_b }, &$node_a.get_our_node_id());
12305 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
12306 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
12307 $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()));
12309 expect_pending_htlcs_forwardable!(ANodeHolder { node: &$node_b });
12310 expect_payment_claimable!(ANodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
12311 $node_b.claim_funds(payment_preimage);
12312 expect_payment_claimed!(ANodeHolder { node: &$node_b }, payment_hash, 10_000);
12314 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
12315 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
12316 assert_eq!(node_id, $node_a.get_our_node_id());
12317 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
12318 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
12320 _ => panic!("Failed to generate claim event"),
12323 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_a }, &$node_b.get_our_node_id());
12324 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
12325 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
12326 $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()));
12328 expect_payment_sent!(ANodeHolder { node: &$node_a }, payment_preimage);
12332 bench.bench_function(bench_name, |b| b.iter(|| {
12333 send_payment!(node_a, node_b);
12334 send_payment!(node_b, node_a);