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::{genesis_block, 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};
34 use crate::chain::{Confirm, ChannelMonitorUpdateStatus, Watch, BestBlock};
35 use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator};
36 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};
37 use crate::chain::transaction::{OutPoint, TransactionData};
39 use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination, PaymentFailureReason};
40 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
41 // construct one themselves.
42 use crate::ln::{inbound_payment, ChannelId, PaymentHash, PaymentPreimage, PaymentSecret};
43 use crate::ln::channel::{Channel, ChannelPhase, ChannelContext, ChannelError, ChannelUpdateStatus, ShutdownResult, UnfundedChannelContext, UpdateFulfillCommitFetch, OutboundV1Channel, InboundV1Channel};
44 use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
45 #[cfg(any(feature = "_test_utils", test))]
46 use crate::ln::features::Bolt11InvoiceFeatures;
47 use crate::routing::gossip::NetworkGraph;
48 use crate::routing::router::{BlindedTail, DefaultRouter, InFlightHtlcs, Path, Payee, PaymentParameters, Route, RouteParameters, Router};
49 use crate::routing::scoring::{ProbabilisticScorer, ProbabilisticScoringFeeParameters};
51 use crate::ln::onion_utils;
52 use crate::ln::onion_utils::HTLCFailReason;
53 use crate::ln::msgs::{ChannelMessageHandler, DecodeError, LightningError};
55 use crate::ln::outbound_payment;
56 use crate::ln::outbound_payment::{OutboundPayments, PaymentAttempts, PendingOutboundPayment, SendAlongPathArgs};
57 use crate::ln::wire::Encode;
58 use crate::sign::{EntropySource, KeysManager, NodeSigner, Recipient, SignerProvider, WriteableEcdsaChannelSigner};
59 use crate::util::config::{UserConfig, ChannelConfig, ChannelConfigUpdate};
60 use crate::util::wakers::{Future, Notifier};
61 use crate::util::scid_utils::fake_scid;
62 use crate::util::string::UntrustedString;
63 use crate::util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
64 use crate::util::logger::{Level, Logger};
65 use crate::util::errors::APIError;
67 use alloc::collections::{btree_map, BTreeMap};
70 use crate::prelude::*;
72 use core::cell::RefCell;
74 use crate::sync::{Arc, Mutex, RwLock, RwLockReadGuard, FairRwLock, LockTestExt, LockHeldState};
75 use core::sync::atomic::{AtomicUsize, AtomicBool, Ordering};
76 use core::time::Duration;
79 // Re-export this for use in the public API.
80 pub use crate::ln::outbound_payment::{PaymentSendFailure, ProbeSendFailure, Retry, RetryableSendFailure, RecipientOnionFields};
81 use crate::ln::script::ShutdownScript;
83 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
85 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
86 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
87 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
89 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
90 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
91 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
92 // before we forward it.
94 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
95 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
96 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
97 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
98 // our payment, which we can use to decode errors or inform the user that the payment was sent.
100 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
101 pub(super) enum PendingHTLCRouting {
103 onion_packet: msgs::OnionPacket,
104 /// The SCID from the onion that we should forward to. This could be a real SCID or a fake one
105 /// generated using `get_fake_scid` from the scid_utils::fake_scid module.
106 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
109 payment_data: msgs::FinalOnionHopData,
110 payment_metadata: Option<Vec<u8>>,
111 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
112 phantom_shared_secret: Option<[u8; 32]>,
113 /// See [`RecipientOnionFields::custom_tlvs`] for more info.
114 custom_tlvs: Vec<(u64, Vec<u8>)>,
117 /// This was added in 0.0.116 and will break deserialization on downgrades.
118 payment_data: Option<msgs::FinalOnionHopData>,
119 payment_preimage: PaymentPreimage,
120 payment_metadata: Option<Vec<u8>>,
121 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
122 /// See [`RecipientOnionFields::custom_tlvs`] for more info.
123 custom_tlvs: Vec<(u64, Vec<u8>)>,
127 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
128 pub(super) struct PendingHTLCInfo {
129 pub(super) routing: PendingHTLCRouting,
130 pub(super) incoming_shared_secret: [u8; 32],
131 payment_hash: PaymentHash,
133 pub(super) incoming_amt_msat: Option<u64>, // Added in 0.0.113
134 /// Sender intended amount to forward or receive (actual amount received
135 /// may overshoot this in either case)
136 pub(super) outgoing_amt_msat: u64,
137 pub(super) outgoing_cltv_value: u32,
138 /// The fee being skimmed off the top of this HTLC. If this is a forward, it'll be the fee we are
139 /// skimming. If we're receiving this HTLC, it's the fee that our counterparty skimmed.
140 pub(super) skimmed_fee_msat: Option<u64>,
143 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
144 pub(super) enum HTLCFailureMsg {
145 Relay(msgs::UpdateFailHTLC),
146 Malformed(msgs::UpdateFailMalformedHTLC),
149 /// Stores whether we can't forward an HTLC or relevant forwarding info
150 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
151 pub(super) enum PendingHTLCStatus {
152 Forward(PendingHTLCInfo),
153 Fail(HTLCFailureMsg),
156 pub(super) struct PendingAddHTLCInfo {
157 pub(super) forward_info: PendingHTLCInfo,
159 // These fields are produced in `forward_htlcs()` and consumed in
160 // `process_pending_htlc_forwards()` for constructing the
161 // `HTLCSource::PreviousHopData` for failed and forwarded
164 // Note that this may be an outbound SCID alias for the associated channel.
165 prev_short_channel_id: u64,
167 prev_funding_outpoint: OutPoint,
168 prev_user_channel_id: u128,
171 pub(super) enum HTLCForwardInfo {
172 AddHTLC(PendingAddHTLCInfo),
175 err_packet: msgs::OnionErrorPacket,
179 /// Tracks the inbound corresponding to an outbound HTLC
180 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
181 pub(crate) struct HTLCPreviousHopData {
182 // Note that this may be an outbound SCID alias for the associated channel.
183 short_channel_id: u64,
184 user_channel_id: Option<u128>,
186 incoming_packet_shared_secret: [u8; 32],
187 phantom_shared_secret: Option<[u8; 32]>,
189 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
190 // channel with a preimage provided by the forward channel.
195 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
197 /// This is only here for backwards-compatibility in serialization, in the future it can be
198 /// removed, breaking clients running 0.0.106 and earlier.
199 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
201 /// Contains the payer-provided preimage.
202 Spontaneous(PaymentPreimage),
205 /// HTLCs that are to us and can be failed/claimed by the user
206 struct ClaimableHTLC {
207 prev_hop: HTLCPreviousHopData,
209 /// The amount (in msats) of this MPP part
211 /// The amount (in msats) that the sender intended to be sent in this MPP
212 /// part (used for validating total MPP amount)
213 sender_intended_value: u64,
214 onion_payload: OnionPayload,
216 /// The total value received for a payment (sum of all MPP parts if the payment is a MPP).
217 /// Gets set to the amount reported when pushing [`Event::PaymentClaimable`].
218 total_value_received: Option<u64>,
219 /// The sender intended sum total of all MPP parts specified in the onion
221 /// The extra fee our counterparty skimmed off the top of this HTLC.
222 counterparty_skimmed_fee_msat: Option<u64>,
225 impl From<&ClaimableHTLC> for events::ClaimedHTLC {
226 fn from(val: &ClaimableHTLC) -> Self {
227 events::ClaimedHTLC {
228 channel_id: val.prev_hop.outpoint.to_channel_id(),
229 user_channel_id: val.prev_hop.user_channel_id.unwrap_or(0),
230 cltv_expiry: val.cltv_expiry,
231 value_msat: val.value,
236 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
237 /// a payment and ensure idempotency in LDK.
239 /// This is not exported to bindings users as we just use [u8; 32] directly
240 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
241 pub struct PaymentId(pub [u8; Self::LENGTH]);
244 /// Number of bytes in the id.
245 pub const LENGTH: usize = 32;
248 impl Writeable for PaymentId {
249 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
254 impl Readable for PaymentId {
255 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
256 let buf: [u8; 32] = Readable::read(r)?;
261 impl core::fmt::Display for PaymentId {
262 fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
263 crate::util::logger::DebugBytes(&self.0).fmt(f)
267 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
269 /// This is not exported to bindings users as we just use [u8; 32] directly
270 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
271 pub struct InterceptId(pub [u8; 32]);
273 impl Writeable for InterceptId {
274 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
279 impl Readable for InterceptId {
280 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
281 let buf: [u8; 32] = Readable::read(r)?;
286 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
287 /// Uniquely describes an HTLC by its source. Just the guaranteed-unique subset of [`HTLCSource`].
288 pub(crate) enum SentHTLCId {
289 PreviousHopData { short_channel_id: u64, htlc_id: u64 },
290 OutboundRoute { session_priv: SecretKey },
293 pub(crate) fn from_source(source: &HTLCSource) -> Self {
295 HTLCSource::PreviousHopData(hop_data) => Self::PreviousHopData {
296 short_channel_id: hop_data.short_channel_id,
297 htlc_id: hop_data.htlc_id,
299 HTLCSource::OutboundRoute { session_priv, .. } =>
300 Self::OutboundRoute { session_priv: *session_priv },
304 impl_writeable_tlv_based_enum!(SentHTLCId,
305 (0, PreviousHopData) => {
306 (0, short_channel_id, required),
307 (2, htlc_id, required),
309 (2, OutboundRoute) => {
310 (0, session_priv, required),
315 /// Tracks the inbound corresponding to an outbound HTLC
316 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
317 #[derive(Clone, Debug, PartialEq, Eq)]
318 pub(crate) enum HTLCSource {
319 PreviousHopData(HTLCPreviousHopData),
322 session_priv: SecretKey,
323 /// Technically we can recalculate this from the route, but we cache it here to avoid
324 /// doing a double-pass on route when we get a failure back
325 first_hop_htlc_msat: u64,
326 payment_id: PaymentId,
329 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
330 impl core::hash::Hash for HTLCSource {
331 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
333 HTLCSource::PreviousHopData(prev_hop_data) => {
335 prev_hop_data.hash(hasher);
337 HTLCSource::OutboundRoute { path, session_priv, payment_id, first_hop_htlc_msat } => {
340 session_priv[..].hash(hasher);
341 payment_id.hash(hasher);
342 first_hop_htlc_msat.hash(hasher);
348 #[cfg(all(feature = "_test_vectors", not(feature = "grind_signatures")))]
350 pub fn dummy() -> Self {
351 HTLCSource::OutboundRoute {
352 path: Path { hops: Vec::new(), blinded_tail: None },
353 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
354 first_hop_htlc_msat: 0,
355 payment_id: PaymentId([2; 32]),
359 #[cfg(debug_assertions)]
360 /// Checks whether this HTLCSource could possibly match the given HTLC output in a commitment
361 /// transaction. Useful to ensure different datastructures match up.
362 pub(crate) fn possibly_matches_output(&self, htlc: &super::chan_utils::HTLCOutputInCommitment) -> bool {
363 if let HTLCSource::OutboundRoute { first_hop_htlc_msat, .. } = self {
364 *first_hop_htlc_msat == htlc.amount_msat
366 // There's nothing we can check for forwarded HTLCs
372 struct InboundOnionErr {
378 /// This enum is used to specify which error data to send to peers when failing back an HTLC
379 /// using [`ChannelManager::fail_htlc_backwards_with_reason`].
381 /// For more info on failure codes, see <https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages>.
382 #[derive(Clone, Copy)]
383 pub enum FailureCode {
384 /// We had a temporary error processing the payment. Useful if no other error codes fit
385 /// and you want to indicate that the payer may want to retry.
386 TemporaryNodeFailure,
387 /// We have a required feature which was not in this onion. For example, you may require
388 /// some additional metadata that was not provided with this payment.
389 RequiredNodeFeatureMissing,
390 /// You may wish to use this when a `payment_preimage` is unknown, or the CLTV expiry of
391 /// the HTLC is too close to the current block height for safe handling.
392 /// Using this failure code in [`ChannelManager::fail_htlc_backwards_with_reason`] is
393 /// equivalent to calling [`ChannelManager::fail_htlc_backwards`].
394 IncorrectOrUnknownPaymentDetails,
395 /// We failed to process the payload after the onion was decrypted. You may wish to
396 /// use this when receiving custom HTLC TLVs with even type numbers that you don't recognize.
398 /// If available, the tuple data may include the type number and byte offset in the
399 /// decrypted byte stream where the failure occurred.
400 InvalidOnionPayload(Option<(u64, u16)>),
403 impl Into<u16> for FailureCode {
404 fn into(self) -> u16 {
406 FailureCode::TemporaryNodeFailure => 0x2000 | 2,
407 FailureCode::RequiredNodeFeatureMissing => 0x4000 | 0x2000 | 3,
408 FailureCode::IncorrectOrUnknownPaymentDetails => 0x4000 | 15,
409 FailureCode::InvalidOnionPayload(_) => 0x4000 | 22,
414 /// Error type returned across the peer_state mutex boundary. When an Err is generated for a
415 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
416 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
417 /// peer_state lock. We then return the set of things that need to be done outside the lock in
418 /// this struct and call handle_error!() on it.
420 struct MsgHandleErrInternal {
421 err: msgs::LightningError,
422 chan_id: Option<(ChannelId, u128)>, // If Some a channel of ours has been closed
423 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
424 channel_capacity: Option<u64>,
426 impl MsgHandleErrInternal {
428 fn send_err_msg_no_close(err: String, channel_id: ChannelId) -> Self {
430 err: LightningError {
432 action: msgs::ErrorAction::SendErrorMessage {
433 msg: msgs::ErrorMessage {
440 shutdown_finish: None,
441 channel_capacity: None,
445 fn from_no_close(err: msgs::LightningError) -> Self {
446 Self { err, chan_id: None, shutdown_finish: None, channel_capacity: None }
449 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 {
451 err: LightningError {
453 action: msgs::ErrorAction::SendErrorMessage {
454 msg: msgs::ErrorMessage {
460 chan_id: Some((channel_id, user_channel_id)),
461 shutdown_finish: Some((shutdown_res, channel_update)),
462 channel_capacity: Some(channel_capacity)
466 fn from_chan_no_close(err: ChannelError, channel_id: ChannelId) -> Self {
469 ChannelError::Warn(msg) => LightningError {
471 action: msgs::ErrorAction::SendWarningMessage {
472 msg: msgs::WarningMessage {
476 log_level: Level::Warn,
479 ChannelError::Ignore(msg) => LightningError {
481 action: msgs::ErrorAction::IgnoreError,
483 ChannelError::Close(msg) => LightningError {
485 action: msgs::ErrorAction::SendErrorMessage {
486 msg: msgs::ErrorMessage {
494 shutdown_finish: None,
495 channel_capacity: None,
499 fn closes_channel(&self) -> bool {
500 self.chan_id.is_some()
504 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
505 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
506 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
507 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
508 pub(super) const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
510 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
511 /// be sent in the order they appear in the return value, however sometimes the order needs to be
512 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
513 /// they were originally sent). In those cases, this enum is also returned.
514 #[derive(Clone, PartialEq)]
515 pub(super) enum RAACommitmentOrder {
516 /// Send the CommitmentUpdate messages first
518 /// Send the RevokeAndACK message first
522 /// Information about a payment which is currently being claimed.
523 struct ClaimingPayment {
525 payment_purpose: events::PaymentPurpose,
526 receiver_node_id: PublicKey,
527 htlcs: Vec<events::ClaimedHTLC>,
528 sender_intended_value: Option<u64>,
530 impl_writeable_tlv_based!(ClaimingPayment, {
531 (0, amount_msat, required),
532 (2, payment_purpose, required),
533 (4, receiver_node_id, required),
534 (5, htlcs, optional_vec),
535 (7, sender_intended_value, option),
538 struct ClaimablePayment {
539 purpose: events::PaymentPurpose,
540 onion_fields: Option<RecipientOnionFields>,
541 htlcs: Vec<ClaimableHTLC>,
544 /// Information about claimable or being-claimed payments
545 struct ClaimablePayments {
546 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
547 /// failed/claimed by the user.
549 /// Note that, no consistency guarantees are made about the channels given here actually
550 /// existing anymore by the time you go to read them!
552 /// When adding to the map, [`Self::pending_claiming_payments`] must also be checked to ensure
553 /// we don't get a duplicate payment.
554 claimable_payments: HashMap<PaymentHash, ClaimablePayment>,
556 /// Map from payment hash to the payment data for HTLCs which we have begun claiming, but which
557 /// are waiting on a [`ChannelMonitorUpdate`] to complete in order to be surfaced to the user
558 /// as an [`events::Event::PaymentClaimed`].
559 pending_claiming_payments: HashMap<PaymentHash, ClaimingPayment>,
562 /// Events which we process internally but cannot be processed immediately at the generation site
563 /// usually because we're running pre-full-init. They are handled immediately once we detect we are
564 /// running normally, and specifically must be processed before any other non-background
565 /// [`ChannelMonitorUpdate`]s are applied.
566 enum BackgroundEvent {
567 /// Handle a ChannelMonitorUpdate which closes the channel or for an already-closed channel.
568 /// This is only separated from [`Self::MonitorUpdateRegeneratedOnStartup`] as the
569 /// maybe-non-closing variant needs a public key to handle channel resumption, whereas if the
570 /// channel has been force-closed we do not need the counterparty node_id.
572 /// Note that any such events are lost on shutdown, so in general they must be updates which
573 /// are regenerated on startup.
574 ClosedMonitorUpdateRegeneratedOnStartup((OutPoint, ChannelMonitorUpdate)),
575 /// Handle a ChannelMonitorUpdate which may or may not close the channel and may unblock the
576 /// channel to continue normal operation.
578 /// In general this should be used rather than
579 /// [`Self::ClosedMonitorUpdateRegeneratedOnStartup`], however in cases where the
580 /// `counterparty_node_id` is not available as the channel has closed from a [`ChannelMonitor`]
581 /// error the other variant is acceptable.
583 /// Note that any such events are lost on shutdown, so in general they must be updates which
584 /// are regenerated on startup.
585 MonitorUpdateRegeneratedOnStartup {
586 counterparty_node_id: PublicKey,
587 funding_txo: OutPoint,
588 update: ChannelMonitorUpdate
590 /// Some [`ChannelMonitorUpdate`] (s) completed before we were serialized but we still have
591 /// them marked pending, thus we need to run any [`MonitorUpdateCompletionAction`] (s) pending
593 MonitorUpdatesComplete {
594 counterparty_node_id: PublicKey,
595 channel_id: ChannelId,
600 pub(crate) enum MonitorUpdateCompletionAction {
601 /// Indicates that a payment ultimately destined for us was claimed and we should emit an
602 /// [`events::Event::PaymentClaimed`] to the user if we haven't yet generated such an event for
603 /// this payment. Note that this is only best-effort. On restart it's possible such a duplicate
604 /// event can be generated.
605 PaymentClaimed { payment_hash: PaymentHash },
606 /// Indicates an [`events::Event`] should be surfaced to the user and possibly resume the
607 /// operation of another channel.
609 /// This is usually generated when we've forwarded an HTLC and want to block the outbound edge
610 /// from completing a monitor update which removes the payment preimage until the inbound edge
611 /// completes a monitor update containing the payment preimage. In that case, after the inbound
612 /// edge completes, we will surface an [`Event::PaymentForwarded`] as well as unblock the
614 EmitEventAndFreeOtherChannel {
615 event: events::Event,
616 downstream_counterparty_and_funding_outpoint: Option<(PublicKey, OutPoint, RAAMonitorUpdateBlockingAction)>,
620 impl_writeable_tlv_based_enum_upgradable!(MonitorUpdateCompletionAction,
621 (0, PaymentClaimed) => { (0, payment_hash, required) },
622 (2, EmitEventAndFreeOtherChannel) => {
623 (0, event, upgradable_required),
624 // LDK prior to 0.0.116 did not have this field as the monitor update application order was
625 // required by clients. If we downgrade to something prior to 0.0.116 this may result in
626 // monitor updates which aren't properly blocked or resumed, however that's fine - we don't
627 // support async monitor updates even in LDK 0.0.116 and once we do we'll require no
628 // downgrades to prior versions.
629 (1, downstream_counterparty_and_funding_outpoint, option),
633 #[derive(Clone, Debug, PartialEq, Eq)]
634 pub(crate) enum EventCompletionAction {
635 ReleaseRAAChannelMonitorUpdate {
636 counterparty_node_id: PublicKey,
637 channel_funding_outpoint: OutPoint,
640 impl_writeable_tlv_based_enum!(EventCompletionAction,
641 (0, ReleaseRAAChannelMonitorUpdate) => {
642 (0, channel_funding_outpoint, required),
643 (2, counterparty_node_id, required),
647 #[derive(Clone, PartialEq, Eq, Debug)]
648 /// If something is blocked on the completion of an RAA-generated [`ChannelMonitorUpdate`] we track
649 /// the blocked action here. See enum variants for more info.
650 pub(crate) enum RAAMonitorUpdateBlockingAction {
651 /// A forwarded payment was claimed. We block the downstream channel completing its monitor
652 /// update which removes the HTLC preimage until the upstream channel has gotten the preimage
654 ForwardedPaymentInboundClaim {
655 /// The upstream channel ID (i.e. the inbound edge).
656 channel_id: ChannelId,
657 /// The HTLC ID on the inbound edge.
662 impl RAAMonitorUpdateBlockingAction {
663 fn from_prev_hop_data(prev_hop: &HTLCPreviousHopData) -> Self {
664 Self::ForwardedPaymentInboundClaim {
665 channel_id: prev_hop.outpoint.to_channel_id(),
666 htlc_id: prev_hop.htlc_id,
671 impl_writeable_tlv_based_enum!(RAAMonitorUpdateBlockingAction,
672 (0, ForwardedPaymentInboundClaim) => { (0, channel_id, required), (2, htlc_id, required) }
676 /// State we hold per-peer.
677 pub(super) struct PeerState<SP: Deref> where SP::Target: SignerProvider {
678 /// `channel_id` -> `ChannelPhase`
680 /// Holds all channels within corresponding `ChannelPhase`s where the peer is the counterparty.
681 pub(super) channel_by_id: HashMap<ChannelId, ChannelPhase<SP>>,
682 /// `temporary_channel_id` -> `InboundChannelRequest`.
684 /// When manual channel acceptance is enabled, this holds all unaccepted inbound channels where
685 /// the peer is the counterparty. If the channel is accepted, then the entry in this table is
686 /// removed, and an InboundV1Channel is created and placed in the `inbound_v1_channel_by_id` table. If
687 /// the channel is rejected, then the entry is simply removed.
688 pub(super) inbound_channel_request_by_id: HashMap<ChannelId, InboundChannelRequest>,
689 /// The latest `InitFeatures` we heard from the peer.
690 latest_features: InitFeatures,
691 /// Messages to send to the peer - pushed to in the same lock that they are generated in (except
692 /// for broadcast messages, where ordering isn't as strict).
693 pub(super) pending_msg_events: Vec<MessageSendEvent>,
694 /// Map from Channel IDs to pending [`ChannelMonitorUpdate`]s which have been passed to the
695 /// user but which have not yet completed.
697 /// Note that the channel may no longer exist. For example if the channel was closed but we
698 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
699 /// for a missing channel.
700 in_flight_monitor_updates: BTreeMap<OutPoint, Vec<ChannelMonitorUpdate>>,
701 /// Map from a specific channel to some action(s) that should be taken when all pending
702 /// [`ChannelMonitorUpdate`]s for the channel complete updating.
704 /// Note that because we generally only have one entry here a HashMap is pretty overkill. A
705 /// BTreeMap currently stores more than ten elements per leaf node, so even up to a few
706 /// channels with a peer this will just be one allocation and will amount to a linear list of
707 /// channels to walk, avoiding the whole hashing rigmarole.
709 /// Note that the channel may no longer exist. For example, if a channel was closed but we
710 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
711 /// for a missing channel. While a malicious peer could construct a second channel with the
712 /// same `temporary_channel_id` (or final `channel_id` in the case of 0conf channels or prior
713 /// to funding appearing on-chain), the downstream `ChannelMonitor` set is required to ensure
714 /// duplicates do not occur, so such channels should fail without a monitor update completing.
715 monitor_update_blocked_actions: BTreeMap<ChannelId, Vec<MonitorUpdateCompletionAction>>,
716 /// If another channel's [`ChannelMonitorUpdate`] needs to complete before a channel we have
717 /// with this peer can complete an RAA [`ChannelMonitorUpdate`] (e.g. because the RAA update
718 /// will remove a preimage that needs to be durably in an upstream channel first), we put an
719 /// entry here to note that the channel with the key's ID is blocked on a set of actions.
720 actions_blocking_raa_monitor_updates: BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
721 /// The peer is currently connected (i.e. we've seen a
722 /// [`ChannelMessageHandler::peer_connected`] and no corresponding
723 /// [`ChannelMessageHandler::peer_disconnected`].
727 impl <SP: Deref> PeerState<SP> where SP::Target: SignerProvider {
728 /// Indicates that a peer meets the criteria where we're ok to remove it from our storage.
729 /// If true is passed for `require_disconnected`, the function will return false if we haven't
730 /// disconnected from the node already, ie. `PeerState::is_connected` is set to `true`.
731 fn ok_to_remove(&self, require_disconnected: bool) -> bool {
732 if require_disconnected && self.is_connected {
735 self.channel_by_id.iter().filter(|(_, phase)| matches!(phase, ChannelPhase::Funded(_))).count() == 0
736 && self.monitor_update_blocked_actions.is_empty()
737 && self.in_flight_monitor_updates.is_empty()
740 // Returns a count of all channels we have with this peer, including unfunded channels.
741 fn total_channel_count(&self) -> usize {
742 self.channel_by_id.len() + self.inbound_channel_request_by_id.len()
745 // Returns a bool indicating if the given `channel_id` matches a channel we have with this peer.
746 fn has_channel(&self, channel_id: &ChannelId) -> bool {
747 self.channel_by_id.contains_key(channel_id) ||
748 self.inbound_channel_request_by_id.contains_key(channel_id)
752 /// A not-yet-accepted inbound (from counterparty) channel. Once
753 /// accepted, the parameters will be used to construct a channel.
754 pub(super) struct InboundChannelRequest {
755 /// The original OpenChannel message.
756 pub open_channel_msg: msgs::OpenChannel,
757 /// The number of ticks remaining before the request expires.
758 pub ticks_remaining: i32,
761 /// The number of ticks that may elapse while we're waiting for an unaccepted inbound channel to be
762 /// accepted. An unaccepted channel that exceeds this limit will be abandoned.
763 const UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS: i32 = 2;
765 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
766 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
768 /// For users who don't want to bother doing their own payment preimage storage, we also store that
771 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
772 /// and instead encoding it in the payment secret.
773 struct PendingInboundPayment {
774 /// The payment secret that the sender must use for us to accept this payment
775 payment_secret: PaymentSecret,
776 /// Time at which this HTLC expires - blocks with a header time above this value will result in
777 /// this payment being removed.
779 /// Arbitrary identifier the user specifies (or not)
780 user_payment_id: u64,
781 // Other required attributes of the payment, optionally enforced:
782 payment_preimage: Option<PaymentPreimage>,
783 min_value_msat: Option<u64>,
786 /// [`SimpleArcChannelManager`] is useful when you need a [`ChannelManager`] with a static lifetime, e.g.
787 /// when you're using `lightning-net-tokio` (since `tokio::spawn` requires parameters with static
788 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
789 /// [`SimpleRefChannelManager`] is the more appropriate type. Defining these type aliases prevents
790 /// issues such as overly long function definitions. Note that the `ChannelManager` can take any type
791 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
792 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
793 /// of [`KeysManager`] and [`DefaultRouter`].
795 /// This is not exported to bindings users as Arcs don't make sense in bindings
796 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
804 Arc<NetworkGraph<Arc<L>>>,
806 Arc<Mutex<ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>>,
807 ProbabilisticScoringFeeParameters,
808 ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>,
813 /// [`SimpleRefChannelManager`] is a type alias for a ChannelManager reference, and is the reference
814 /// counterpart to the [`SimpleArcChannelManager`] type alias. Use this type by default when you don't
815 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
816 /// usage of lightning-net-tokio (since `tokio::spawn` requires parameters with static lifetimes).
817 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
818 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
819 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
820 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
821 /// of [`KeysManager`] and [`DefaultRouter`].
823 /// This is not exported to bindings users as Arcs don't make sense in bindings
824 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> =
833 &'f NetworkGraph<&'g L>,
835 &'h Mutex<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>,
836 ProbabilisticScoringFeeParameters,
837 ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>
842 /// A trivial trait which describes any [`ChannelManager`].
843 pub trait AChannelManager {
844 /// A type implementing [`chain::Watch`].
845 type Watch: chain::Watch<Self::Signer> + ?Sized;
846 /// A type that may be dereferenced to [`Self::Watch`].
847 type M: Deref<Target = Self::Watch>;
848 /// A type implementing [`BroadcasterInterface`].
849 type Broadcaster: BroadcasterInterface + ?Sized;
850 /// A type that may be dereferenced to [`Self::Broadcaster`].
851 type T: Deref<Target = Self::Broadcaster>;
852 /// A type implementing [`EntropySource`].
853 type EntropySource: EntropySource + ?Sized;
854 /// A type that may be dereferenced to [`Self::EntropySource`].
855 type ES: Deref<Target = Self::EntropySource>;
856 /// A type implementing [`NodeSigner`].
857 type NodeSigner: NodeSigner + ?Sized;
858 /// A type that may be dereferenced to [`Self::NodeSigner`].
859 type NS: Deref<Target = Self::NodeSigner>;
860 /// A type implementing [`WriteableEcdsaChannelSigner`].
861 type Signer: WriteableEcdsaChannelSigner + Sized;
862 /// A type implementing [`SignerProvider`] for [`Self::Signer`].
863 type SignerProvider: SignerProvider<Signer = Self::Signer> + ?Sized;
864 /// A type that may be dereferenced to [`Self::SignerProvider`].
865 type SP: Deref<Target = Self::SignerProvider>;
866 /// A type implementing [`FeeEstimator`].
867 type FeeEstimator: FeeEstimator + ?Sized;
868 /// A type that may be dereferenced to [`Self::FeeEstimator`].
869 type F: Deref<Target = Self::FeeEstimator>;
870 /// A type implementing [`Router`].
871 type Router: Router + ?Sized;
872 /// A type that may be dereferenced to [`Self::Router`].
873 type R: Deref<Target = Self::Router>;
874 /// A type implementing [`Logger`].
875 type Logger: Logger + ?Sized;
876 /// A type that may be dereferenced to [`Self::Logger`].
877 type L: Deref<Target = Self::Logger>;
878 /// Returns a reference to the actual [`ChannelManager`] object.
879 fn get_cm(&self) -> &ChannelManager<Self::M, Self::T, Self::ES, Self::NS, Self::SP, Self::F, Self::R, Self::L>;
882 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> AChannelManager
883 for ChannelManager<M, T, ES, NS, SP, F, R, L>
885 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
886 T::Target: BroadcasterInterface,
887 ES::Target: EntropySource,
888 NS::Target: NodeSigner,
889 SP::Target: SignerProvider,
890 F::Target: FeeEstimator,
894 type Watch = M::Target;
896 type Broadcaster = T::Target;
898 type EntropySource = ES::Target;
900 type NodeSigner = NS::Target;
902 type Signer = <SP::Target as SignerProvider>::Signer;
903 type SignerProvider = SP::Target;
905 type FeeEstimator = F::Target;
907 type Router = R::Target;
909 type Logger = L::Target;
911 fn get_cm(&self) -> &ChannelManager<M, T, ES, NS, SP, F, R, L> { self }
914 /// Manager which keeps track of a number of channels and sends messages to the appropriate
915 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
917 /// Implements [`ChannelMessageHandler`], handling the multi-channel parts and passing things through
918 /// to individual Channels.
920 /// Implements [`Writeable`] to write out all channel state to disk. Implies [`peer_disconnected`] for
921 /// all peers during write/read (though does not modify this instance, only the instance being
922 /// serialized). This will result in any channels which have not yet exchanged [`funding_created`] (i.e.,
923 /// called [`funding_transaction_generated`] for outbound channels) being closed.
925 /// Note that you can be a bit lazier about writing out `ChannelManager` than you can be with
926 /// [`ChannelMonitor`]. With [`ChannelMonitor`] you MUST durably write each
927 /// [`ChannelMonitorUpdate`] before returning from
928 /// [`chain::Watch::watch_channel`]/[`update_channel`] or before completing async writes. With
929 /// `ChannelManager`s, writing updates happens out-of-band (and will prevent any other
930 /// `ChannelManager` operations from occurring during the serialization process). If the
931 /// deserialized version is out-of-date compared to the [`ChannelMonitor`] passed by reference to
932 /// [`read`], those channels will be force-closed based on the `ChannelMonitor` state and no funds
933 /// will be lost (modulo on-chain transaction fees).
935 /// Note that the deserializer is only implemented for `(`[`BlockHash`]`, `[`ChannelManager`]`)`, which
936 /// tells you the last block hash which was connected. You should get the best block tip before using the manager.
937 /// See [`chain::Listen`] and [`chain::Confirm`] for more details.
939 /// Note that `ChannelManager` is responsible for tracking liveness of its channels and generating
940 /// [`ChannelUpdate`] messages informing peers that the channel is temporarily disabled. To avoid
941 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
942 /// offline for a full minute. In order to track this, you must call
943 /// [`timer_tick_occurred`] roughly once per minute, though it doesn't have to be perfect.
945 /// To avoid trivial DoS issues, `ChannelManager` limits the number of inbound connections and
946 /// inbound channels without confirmed funding transactions. This may result in nodes which we do
947 /// not have a channel with being unable to connect to us or open new channels with us if we have
948 /// many peers with unfunded channels.
950 /// Because it is an indication of trust, inbound channels which we've accepted as 0conf are
951 /// exempted from the count of unfunded channels. Similarly, outbound channels and connections are
952 /// never limited. Please ensure you limit the count of such channels yourself.
954 /// Rather than using a plain `ChannelManager`, it is preferable to use either a [`SimpleArcChannelManager`]
955 /// a [`SimpleRefChannelManager`], for conciseness. See their documentation for more details, but
956 /// essentially you should default to using a [`SimpleRefChannelManager`], and use a
957 /// [`SimpleArcChannelManager`] when you require a `ChannelManager` with a static lifetime, such as when
958 /// you're using lightning-net-tokio.
960 /// [`peer_disconnected`]: msgs::ChannelMessageHandler::peer_disconnected
961 /// [`funding_created`]: msgs::FundingCreated
962 /// [`funding_transaction_generated`]: Self::funding_transaction_generated
963 /// [`BlockHash`]: bitcoin::hash_types::BlockHash
964 /// [`update_channel`]: chain::Watch::update_channel
965 /// [`ChannelUpdate`]: msgs::ChannelUpdate
966 /// [`timer_tick_occurred`]: Self::timer_tick_occurred
967 /// [`read`]: ReadableArgs::read
970 // The tree structure below illustrates the lock order requirements for the different locks of the
971 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
972 // and should then be taken in the order of the lowest to the highest level in the tree.
973 // Note that locks on different branches shall not be taken at the same time, as doing so will
974 // create a new lock order for those specific locks in the order they were taken.
978 // `total_consistency_lock`
980 // |__`forward_htlcs`
982 // | |__`pending_intercepted_htlcs`
984 // |__`per_peer_state`
986 // | |__`pending_inbound_payments`
988 // | |__`claimable_payments`
990 // | |__`pending_outbound_payments` // This field's struct contains a map of pending outbounds
996 // | |__`short_to_chan_info`
998 // | |__`outbound_scid_aliases`
1000 // | |__`best_block`
1002 // | |__`pending_events`
1004 // | |__`pending_background_events`
1006 pub struct ChannelManager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
1008 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
1009 T::Target: BroadcasterInterface,
1010 ES::Target: EntropySource,
1011 NS::Target: NodeSigner,
1012 SP::Target: SignerProvider,
1013 F::Target: FeeEstimator,
1017 default_configuration: UserConfig,
1018 genesis_hash: BlockHash,
1019 fee_estimator: LowerBoundedFeeEstimator<F>,
1025 /// See `ChannelManager` struct-level documentation for lock order requirements.
1027 pub(super) best_block: RwLock<BestBlock>,
1029 best_block: RwLock<BestBlock>,
1030 secp_ctx: Secp256k1<secp256k1::All>,
1032 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
1033 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
1034 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
1035 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
1037 /// See `ChannelManager` struct-level documentation for lock order requirements.
1038 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
1040 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
1041 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
1042 /// (if the channel has been force-closed), however we track them here to prevent duplicative
1043 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
1044 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
1045 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
1046 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
1047 /// after reloading from disk while replaying blocks against ChannelMonitors.
1049 /// See `PendingOutboundPayment` documentation for more info.
1051 /// See `ChannelManager` struct-level documentation for lock order requirements.
1052 pending_outbound_payments: OutboundPayments,
1054 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
1056 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
1057 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
1058 /// and via the classic SCID.
1060 /// Note that no consistency guarantees are made about the existence of a channel with the
1061 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
1063 /// See `ChannelManager` struct-level documentation for lock order requirements.
1065 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1067 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1068 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
1069 /// until the user tells us what we should do with them.
1071 /// See `ChannelManager` struct-level documentation for lock order requirements.
1072 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
1074 /// The sets of payments which are claimable or currently being claimed. See
1075 /// [`ClaimablePayments`]' individual field docs for more info.
1077 /// See `ChannelManager` struct-level documentation for lock order requirements.
1078 claimable_payments: Mutex<ClaimablePayments>,
1080 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
1081 /// and some closed channels which reached a usable state prior to being closed. This is used
1082 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
1083 /// active channel list on load.
1085 /// See `ChannelManager` struct-level documentation for lock order requirements.
1086 outbound_scid_aliases: Mutex<HashSet<u64>>,
1088 /// `channel_id` -> `counterparty_node_id`.
1090 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
1091 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
1092 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
1094 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
1095 /// the corresponding channel for the event, as we only have access to the `channel_id` during
1096 /// the handling of the events.
1098 /// Note that no consistency guarantees are made about the existence of a peer with the
1099 /// `counterparty_node_id` in our other maps.
1102 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
1103 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
1104 /// would break backwards compatability.
1105 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
1106 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
1107 /// required to access the channel with the `counterparty_node_id`.
1109 /// See `ChannelManager` struct-level documentation for lock order requirements.
1110 id_to_peer: Mutex<HashMap<ChannelId, PublicKey>>,
1112 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
1114 /// Outbound SCID aliases are added here once the channel is available for normal use, with
1115 /// SCIDs being added once the funding transaction is confirmed at the channel's required
1116 /// confirmation depth.
1118 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
1119 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
1120 /// channel with the `channel_id` in our other maps.
1122 /// See `ChannelManager` struct-level documentation for lock order requirements.
1124 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1126 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1128 our_network_pubkey: PublicKey,
1130 inbound_payment_key: inbound_payment::ExpandedKey,
1132 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
1133 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
1134 /// we encrypt the namespace identifier using these bytes.
1136 /// [fake scids]: crate::util::scid_utils::fake_scid
1137 fake_scid_rand_bytes: [u8; 32],
1139 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
1140 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
1141 /// keeping additional state.
1142 probing_cookie_secret: [u8; 32],
1144 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
1145 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
1146 /// very far in the past, and can only ever be up to two hours in the future.
1147 highest_seen_timestamp: AtomicUsize,
1149 /// The bulk of our storage. Currently the `per_peer_state` stores our channels on a per-peer
1150 /// basis, as well as the peer's latest features.
1152 /// If we are connected to a peer we always at least have an entry here, even if no channels
1153 /// are currently open with that peer.
1155 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
1156 /// operate on the inner value freely. This opens up for parallel per-peer operation for
1159 /// Note that the same thread must never acquire two inner `PeerState` locks at the same time.
1161 /// See `ChannelManager` struct-level documentation for lock order requirements.
1162 #[cfg(not(any(test, feature = "_test_utils")))]
1163 per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1164 #[cfg(any(test, feature = "_test_utils"))]
1165 pub(super) per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1167 /// The set of events which we need to give to the user to handle. In some cases an event may
1168 /// require some further action after the user handles it (currently only blocking a monitor
1169 /// update from being handed to the user to ensure the included changes to the channel state
1170 /// are handled by the user before they're persisted durably to disk). In that case, the second
1171 /// element in the tuple is set to `Some` with further details of the action.
1173 /// Note that events MUST NOT be removed from pending_events after deserialization, as they
1174 /// could be in the middle of being processed without the direct mutex held.
1176 /// See `ChannelManager` struct-level documentation for lock order requirements.
1177 #[cfg(not(any(test, feature = "_test_utils")))]
1178 pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1179 #[cfg(any(test, feature = "_test_utils"))]
1180 pub(crate) pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1182 /// A simple atomic flag to ensure only one task at a time can be processing events asynchronously.
1183 pending_events_processor: AtomicBool,
1185 /// If we are running during init (either directly during the deserialization method or in
1186 /// block connection methods which run after deserialization but before normal operation) we
1187 /// cannot provide the user with [`ChannelMonitorUpdate`]s through the normal update flow -
1188 /// prior to normal operation the user may not have loaded the [`ChannelMonitor`]s into their
1189 /// [`ChainMonitor`] and thus attempting to update it will fail or panic.
1191 /// Thus, we place them here to be handled as soon as possible once we are running normally.
1193 /// See `ChannelManager` struct-level documentation for lock order requirements.
1195 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
1196 pending_background_events: Mutex<Vec<BackgroundEvent>>,
1197 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
1198 /// Essentially just when we're serializing ourselves out.
1199 /// Taken first everywhere where we are making changes before any other locks.
1200 /// When acquiring this lock in read mode, rather than acquiring it directly, call
1201 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
1202 /// Notifier the lock contains sends out a notification when the lock is released.
1203 total_consistency_lock: RwLock<()>,
1204 /// Tracks the progress of channels going through batch funding by whether funding_signed was
1205 /// received and the monitor has been persisted.
1207 /// This information does not need to be persisted as funding nodes can forget
1208 /// unfunded channels upon disconnection.
1209 funding_batch_states: Mutex<BTreeMap<Txid, Vec<(ChannelId, PublicKey, bool)>>>,
1211 background_events_processed_since_startup: AtomicBool,
1213 event_persist_notifier: Notifier,
1214 needs_persist_flag: AtomicBool,
1218 signer_provider: SP,
1223 /// Chain-related parameters used to construct a new `ChannelManager`.
1225 /// Typically, the block-specific parameters are derived from the best block hash for the network,
1226 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
1227 /// are not needed when deserializing a previously constructed `ChannelManager`.
1228 #[derive(Clone, Copy, PartialEq)]
1229 pub struct ChainParameters {
1230 /// The network for determining the `chain_hash` in Lightning messages.
1231 pub network: Network,
1233 /// The hash and height of the latest block successfully connected.
1235 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
1236 pub best_block: BestBlock,
1239 #[derive(Copy, Clone, PartialEq)]
1243 SkipPersistHandleEvents,
1244 SkipPersistNoEvents,
1247 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
1248 /// desirable to notify any listeners on `await_persistable_update_timeout`/
1249 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
1250 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
1251 /// sending the aforementioned notification (since the lock being released indicates that the
1252 /// updates are ready for persistence).
1254 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
1255 /// notify or not based on whether relevant changes have been made, providing a closure to
1256 /// `optionally_notify` which returns a `NotifyOption`.
1257 struct PersistenceNotifierGuard<'a, F: FnMut() -> NotifyOption> {
1258 event_persist_notifier: &'a Notifier,
1259 needs_persist_flag: &'a AtomicBool,
1261 // We hold onto this result so the lock doesn't get released immediately.
1262 _read_guard: RwLockReadGuard<'a, ()>,
1265 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
1266 /// Notifies any waiters and indicates that we need to persist, in addition to possibly having
1267 /// events to handle.
1269 /// This must always be called if the changes included a `ChannelMonitorUpdate`, as well as in
1270 /// other cases where losing the changes on restart may result in a force-close or otherwise
1272 fn notify_on_drop<C: AChannelManager>(cm: &'a C) -> PersistenceNotifierGuard<'a, impl FnMut() -> NotifyOption> {
1273 Self::optionally_notify(cm, || -> NotifyOption { NotifyOption::DoPersist })
1276 fn optionally_notify<F: FnMut() -> NotifyOption, C: AChannelManager>(cm: &'a C, mut persist_check: F)
1277 -> PersistenceNotifierGuard<'a, impl FnMut() -> NotifyOption> {
1278 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1279 let force_notify = cm.get_cm().process_background_events();
1281 PersistenceNotifierGuard {
1282 event_persist_notifier: &cm.get_cm().event_persist_notifier,
1283 needs_persist_flag: &cm.get_cm().needs_persist_flag,
1284 should_persist: move || {
1285 // Pick the "most" action between `persist_check` and the background events
1286 // processing and return that.
1287 let notify = persist_check();
1288 match (notify, force_notify) {
1289 (NotifyOption::DoPersist, _) => NotifyOption::DoPersist,
1290 (_, NotifyOption::DoPersist) => NotifyOption::DoPersist,
1291 (NotifyOption::SkipPersistHandleEvents, _) => NotifyOption::SkipPersistHandleEvents,
1292 (_, NotifyOption::SkipPersistHandleEvents) => NotifyOption::SkipPersistHandleEvents,
1293 _ => NotifyOption::SkipPersistNoEvents,
1296 _read_guard: read_guard,
1300 /// Note that if any [`ChannelMonitorUpdate`]s are possibly generated,
1301 /// [`ChannelManager::process_background_events`] MUST be called first (or
1302 /// [`Self::optionally_notify`] used).
1303 fn optionally_notify_skipping_background_events<F: Fn() -> NotifyOption, C: AChannelManager>
1304 (cm: &'a C, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
1305 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1307 PersistenceNotifierGuard {
1308 event_persist_notifier: &cm.get_cm().event_persist_notifier,
1309 needs_persist_flag: &cm.get_cm().needs_persist_flag,
1310 should_persist: persist_check,
1311 _read_guard: read_guard,
1316 impl<'a, F: FnMut() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
1317 fn drop(&mut self) {
1318 match (self.should_persist)() {
1319 NotifyOption::DoPersist => {
1320 self.needs_persist_flag.store(true, Ordering::Release);
1321 self.event_persist_notifier.notify()
1323 NotifyOption::SkipPersistHandleEvents =>
1324 self.event_persist_notifier.notify(),
1325 NotifyOption::SkipPersistNoEvents => {},
1330 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
1331 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
1333 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
1335 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
1336 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
1337 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
1338 /// the maximum required amount in lnd as of March 2021.
1339 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
1341 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
1342 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
1344 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
1346 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
1347 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
1348 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
1349 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
1350 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
1351 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
1352 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
1353 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
1354 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
1355 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
1356 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
1357 // routing failure for any HTLC sender picking up an LDK node among the first hops.
1358 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
1360 /// Minimum CLTV difference between the current block height and received inbound payments.
1361 /// Invoices generated for payment to us must set their `min_final_cltv_expiry_delta` field to at least
1363 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
1364 // any payments to succeed. Further, we don't want payments to fail if a block was found while
1365 // a payment was being routed, so we add an extra block to be safe.
1366 pub const MIN_FINAL_CLTV_EXPIRY_DELTA: u16 = HTLC_FAIL_BACK_BUFFER as u16 + 3;
1368 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
1369 // ie that if the next-hop peer fails the HTLC within
1370 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
1371 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
1372 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
1373 // LATENCY_GRACE_PERIOD_BLOCKS.
1376 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;
1378 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
1379 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
1382 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
1384 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
1385 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
1387 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is disconnected
1388 /// until we mark the channel disabled and gossip the update.
1389 pub(crate) const DISABLE_GOSSIP_TICKS: u8 = 10;
1391 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is connected until
1392 /// we mark the channel enabled and gossip the update.
1393 pub(crate) const ENABLE_GOSSIP_TICKS: u8 = 5;
1395 /// The maximum number of unfunded channels we can have per-peer before we start rejecting new
1396 /// (inbound) ones. The number of peers with unfunded channels is limited separately in
1397 /// [`MAX_UNFUNDED_CHANNEL_PEERS`].
1398 const MAX_UNFUNDED_CHANS_PER_PEER: usize = 4;
1400 /// The maximum number of peers from which we will allow pending unfunded channels. Once we reach
1401 /// this many peers we reject new (inbound) channels from peers with which we don't have a channel.
1402 const MAX_UNFUNDED_CHANNEL_PEERS: usize = 50;
1404 /// The maximum number of peers which we do not have a (funded) channel with. Once we reach this
1405 /// many peers we reject new (inbound) connections.
1406 const MAX_NO_CHANNEL_PEERS: usize = 250;
1408 /// Information needed for constructing an invoice route hint for this channel.
1409 #[derive(Clone, Debug, PartialEq)]
1410 pub struct CounterpartyForwardingInfo {
1411 /// Base routing fee in millisatoshis.
1412 pub fee_base_msat: u32,
1413 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
1414 pub fee_proportional_millionths: u32,
1415 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
1416 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
1417 /// `cltv_expiry_delta` for more details.
1418 pub cltv_expiry_delta: u16,
1421 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
1422 /// to better separate parameters.
1423 #[derive(Clone, Debug, PartialEq)]
1424 pub struct ChannelCounterparty {
1425 /// The node_id of our counterparty
1426 pub node_id: PublicKey,
1427 /// The Features the channel counterparty provided upon last connection.
1428 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
1429 /// many routing-relevant features are present in the init context.
1430 pub features: InitFeatures,
1431 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
1432 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
1433 /// claiming at least this value on chain.
1435 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
1437 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
1438 pub unspendable_punishment_reserve: u64,
1439 /// Information on the fees and requirements that the counterparty requires when forwarding
1440 /// payments to us through this channel.
1441 pub forwarding_info: Option<CounterpartyForwardingInfo>,
1442 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
1443 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
1444 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
1445 pub outbound_htlc_minimum_msat: Option<u64>,
1446 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
1447 pub outbound_htlc_maximum_msat: Option<u64>,
1450 /// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
1451 #[derive(Clone, Debug, PartialEq)]
1452 pub struct ChannelDetails {
1453 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
1454 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
1455 /// Note that this means this value is *not* persistent - it can change once during the
1456 /// lifetime of the channel.
1457 pub channel_id: ChannelId,
1458 /// Parameters which apply to our counterparty. See individual fields for more information.
1459 pub counterparty: ChannelCounterparty,
1460 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
1461 /// our counterparty already.
1463 /// Note that, if this has been set, `channel_id` will be equivalent to
1464 /// `funding_txo.unwrap().to_channel_id()`.
1465 pub funding_txo: Option<OutPoint>,
1466 /// The features which this channel operates with. See individual features for more info.
1468 /// `None` until negotiation completes and the channel type is finalized.
1469 pub channel_type: Option<ChannelTypeFeatures>,
1470 /// The position of the funding transaction in the chain. None if the funding transaction has
1471 /// not yet been confirmed and the channel fully opened.
1473 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1474 /// payments instead of this. See [`get_inbound_payment_scid`].
1476 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1477 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1479 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1480 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1481 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1482 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1483 /// [`confirmations_required`]: Self::confirmations_required
1484 pub short_channel_id: Option<u64>,
1485 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1486 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1487 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1490 /// This will be `None` as long as the channel is not available for routing outbound payments.
1492 /// [`short_channel_id`]: Self::short_channel_id
1493 /// [`confirmations_required`]: Self::confirmations_required
1494 pub outbound_scid_alias: Option<u64>,
1495 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1496 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1497 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1498 /// when they see a payment to be routed to us.
1500 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1501 /// previous values for inbound payment forwarding.
1503 /// [`short_channel_id`]: Self::short_channel_id
1504 pub inbound_scid_alias: Option<u64>,
1505 /// The value, in satoshis, of this channel as appears in the funding output
1506 pub channel_value_satoshis: u64,
1507 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1508 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1509 /// this value on chain.
1511 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1513 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1515 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1516 pub unspendable_punishment_reserve: Option<u64>,
1517 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
1518 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
1519 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
1520 /// `user_channel_id` will be randomized for an inbound channel. This may be zero for objects
1521 /// serialized with LDK versions prior to 0.0.113.
1523 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
1524 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
1525 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
1526 pub user_channel_id: u128,
1527 /// The currently negotiated fee rate denominated in satoshi per 1000 weight units,
1528 /// which is applied to commitment and HTLC transactions.
1530 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
1531 pub feerate_sat_per_1000_weight: Option<u32>,
1532 /// Our total balance. This is the amount we would get if we close the channel.
1533 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1534 /// amount is not likely to be recoverable on close.
1536 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1537 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1538 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1539 /// This does not consider any on-chain fees.
1541 /// See also [`ChannelDetails::outbound_capacity_msat`]
1542 pub balance_msat: u64,
1543 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1544 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1545 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1546 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1548 /// See also [`ChannelDetails::balance_msat`]
1550 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1551 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1552 /// should be able to spend nearly this amount.
1553 pub outbound_capacity_msat: u64,
1554 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1555 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1556 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1557 /// to use a limit as close as possible to the HTLC limit we can currently send.
1559 /// See also [`ChannelDetails::next_outbound_htlc_minimum_msat`],
1560 /// [`ChannelDetails::balance_msat`], and [`ChannelDetails::outbound_capacity_msat`].
1561 pub next_outbound_htlc_limit_msat: u64,
1562 /// The minimum value for sending a single HTLC to the remote peer. This is the equivalent of
1563 /// [`ChannelDetails::next_outbound_htlc_limit_msat`] but represents a lower-bound, rather than
1564 /// an upper-bound. This is intended for use when routing, allowing us to ensure we pick a
1565 /// route which is valid.
1566 pub next_outbound_htlc_minimum_msat: u64,
1567 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1568 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1569 /// available for inclusion in new inbound HTLCs).
1570 /// Note that there are some corner cases not fully handled here, so the actual available
1571 /// inbound capacity may be slightly higher than this.
1573 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1574 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1575 /// However, our counterparty should be able to spend nearly this amount.
1576 pub inbound_capacity_msat: u64,
1577 /// The number of required confirmations on the funding transaction before the funding will be
1578 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1579 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1580 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1581 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1583 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1585 /// [`is_outbound`]: ChannelDetails::is_outbound
1586 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1587 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1588 pub confirmations_required: Option<u32>,
1589 /// The current number of confirmations on the funding transaction.
1591 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1592 pub confirmations: Option<u32>,
1593 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1594 /// until we can claim our funds after we force-close the channel. During this time our
1595 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1596 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1597 /// time to claim our non-HTLC-encumbered funds.
1599 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1600 pub force_close_spend_delay: Option<u16>,
1601 /// True if the channel was initiated (and thus funded) by us.
1602 pub is_outbound: bool,
1603 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1604 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1605 /// required confirmation count has been reached (and we were connected to the peer at some
1606 /// point after the funding transaction received enough confirmations). The required
1607 /// confirmation count is provided in [`confirmations_required`].
1609 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1610 pub is_channel_ready: bool,
1611 /// The stage of the channel's shutdown.
1612 /// `None` for `ChannelDetails` serialized on LDK versions prior to 0.0.116.
1613 pub channel_shutdown_state: Option<ChannelShutdownState>,
1614 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1615 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1617 /// This is a strict superset of `is_channel_ready`.
1618 pub is_usable: bool,
1619 /// True if this channel is (or will be) publicly-announced.
1620 pub is_public: bool,
1621 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1622 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1623 pub inbound_htlc_minimum_msat: Option<u64>,
1624 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1625 pub inbound_htlc_maximum_msat: Option<u64>,
1626 /// Set of configurable parameters that affect channel operation.
1628 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1629 pub config: Option<ChannelConfig>,
1632 impl ChannelDetails {
1633 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1634 /// This should be used for providing invoice hints or in any other context where our
1635 /// counterparty will forward a payment to us.
1637 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1638 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1639 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1640 self.inbound_scid_alias.or(self.short_channel_id)
1643 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1644 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1645 /// we're sending or forwarding a payment outbound over this channel.
1647 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1648 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1649 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1650 self.short_channel_id.or(self.outbound_scid_alias)
1653 fn from_channel_context<SP: Deref, F: Deref>(
1654 context: &ChannelContext<SP>, best_block_height: u32, latest_features: InitFeatures,
1655 fee_estimator: &LowerBoundedFeeEstimator<F>
1658 SP::Target: SignerProvider,
1659 F::Target: FeeEstimator
1661 let balance = context.get_available_balances(fee_estimator);
1662 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1663 context.get_holder_counterparty_selected_channel_reserve_satoshis();
1665 channel_id: context.channel_id(),
1666 counterparty: ChannelCounterparty {
1667 node_id: context.get_counterparty_node_id(),
1668 features: latest_features,
1669 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1670 forwarding_info: context.counterparty_forwarding_info(),
1671 // Ensures that we have actually received the `htlc_minimum_msat` value
1672 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1673 // message (as they are always the first message from the counterparty).
1674 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1675 // default `0` value set by `Channel::new_outbound`.
1676 outbound_htlc_minimum_msat: if context.have_received_message() {
1677 Some(context.get_counterparty_htlc_minimum_msat()) } else { None },
1678 outbound_htlc_maximum_msat: context.get_counterparty_htlc_maximum_msat(),
1680 funding_txo: context.get_funding_txo(),
1681 // Note that accept_channel (or open_channel) is always the first message, so
1682 // `have_received_message` indicates that type negotiation has completed.
1683 channel_type: if context.have_received_message() { Some(context.get_channel_type().clone()) } else { None },
1684 short_channel_id: context.get_short_channel_id(),
1685 outbound_scid_alias: if context.is_usable() { Some(context.outbound_scid_alias()) } else { None },
1686 inbound_scid_alias: context.latest_inbound_scid_alias(),
1687 channel_value_satoshis: context.get_value_satoshis(),
1688 feerate_sat_per_1000_weight: Some(context.get_feerate_sat_per_1000_weight()),
1689 unspendable_punishment_reserve: to_self_reserve_satoshis,
1690 balance_msat: balance.balance_msat,
1691 inbound_capacity_msat: balance.inbound_capacity_msat,
1692 outbound_capacity_msat: balance.outbound_capacity_msat,
1693 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1694 next_outbound_htlc_minimum_msat: balance.next_outbound_htlc_minimum_msat,
1695 user_channel_id: context.get_user_id(),
1696 confirmations_required: context.minimum_depth(),
1697 confirmations: Some(context.get_funding_tx_confirmations(best_block_height)),
1698 force_close_spend_delay: context.get_counterparty_selected_contest_delay(),
1699 is_outbound: context.is_outbound(),
1700 is_channel_ready: context.is_usable(),
1701 is_usable: context.is_live(),
1702 is_public: context.should_announce(),
1703 inbound_htlc_minimum_msat: Some(context.get_holder_htlc_minimum_msat()),
1704 inbound_htlc_maximum_msat: context.get_holder_htlc_maximum_msat(),
1705 config: Some(context.config()),
1706 channel_shutdown_state: Some(context.shutdown_state()),
1711 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
1712 /// Further information on the details of the channel shutdown.
1713 /// Upon channels being forced closed (i.e. commitment transaction confirmation detected
1714 /// by `ChainMonitor`), ChannelShutdownState will be set to `ShutdownComplete` or
1715 /// the channel will be removed shortly.
1716 /// Also note, that in normal operation, peers could disconnect at any of these states
1717 /// and require peer re-connection before making progress onto other states
1718 pub enum ChannelShutdownState {
1719 /// Channel has not sent or received a shutdown message.
1721 /// Local node has sent a shutdown message for this channel.
1723 /// Shutdown message exchanges have concluded and the channels are in the midst of
1724 /// resolving all existing open HTLCs before closing can continue.
1726 /// All HTLCs have been resolved, nodes are currently negotiating channel close onchain fee rates.
1727 NegotiatingClosingFee,
1728 /// We've successfully negotiated a closing_signed dance. At this point `ChannelManager` is about
1729 /// to drop the channel.
1733 /// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
1734 /// These include payments that have yet to find a successful path, or have unresolved HTLCs.
1735 #[derive(Debug, PartialEq)]
1736 pub enum RecentPaymentDetails {
1737 /// When an invoice was requested and thus a payment has not yet been sent.
1739 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1740 /// a payment and ensure idempotency in LDK.
1741 payment_id: PaymentId,
1743 /// When a payment is still being sent and awaiting successful delivery.
1745 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1746 /// a payment and ensure idempotency in LDK.
1747 payment_id: PaymentId,
1748 /// Hash of the payment that is currently being sent but has yet to be fulfilled or
1750 payment_hash: PaymentHash,
1751 /// Total amount (in msat, excluding fees) across all paths for this payment,
1752 /// not just the amount currently inflight.
1755 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
1756 /// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
1757 /// payment is removed from tracking.
1759 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1760 /// a payment and ensure idempotency in LDK.
1761 payment_id: PaymentId,
1762 /// Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
1763 /// made before LDK version 0.0.104.
1764 payment_hash: Option<PaymentHash>,
1766 /// After a payment's retries are exhausted per the provided [`Retry`], or it is explicitly
1767 /// abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
1768 /// pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
1770 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1771 /// a payment and ensure idempotency in LDK.
1772 payment_id: PaymentId,
1773 /// Hash of the payment that we have given up trying to send.
1774 payment_hash: PaymentHash,
1778 /// Route hints used in constructing invoices for [phantom node payents].
1780 /// [phantom node payments]: crate::sign::PhantomKeysManager
1782 pub struct PhantomRouteHints {
1783 /// The list of channels to be included in the invoice route hints.
1784 pub channels: Vec<ChannelDetails>,
1785 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1787 pub phantom_scid: u64,
1788 /// The pubkey of the real backing node that would ultimately receive the payment.
1789 pub real_node_pubkey: PublicKey,
1792 macro_rules! handle_error {
1793 ($self: ident, $internal: expr, $counterparty_node_id: expr) => { {
1794 // In testing, ensure there are no deadlocks where the lock is already held upon
1795 // entering the macro.
1796 debug_assert_ne!($self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
1797 debug_assert_ne!($self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
1801 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish, channel_capacity }) => {
1802 let mut msg_events = Vec::with_capacity(2);
1804 if let Some((shutdown_res, update_option)) = shutdown_finish {
1805 $self.finish_close_channel(shutdown_res);
1806 if let Some(update) = update_option {
1807 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1811 if let Some((channel_id, user_channel_id)) = chan_id {
1812 $self.pending_events.lock().unwrap().push_back((events::Event::ChannelClosed {
1813 channel_id, user_channel_id,
1814 reason: ClosureReason::ProcessingError { err: err.err.clone() },
1815 counterparty_node_id: Some($counterparty_node_id),
1816 channel_capacity_sats: channel_capacity,
1821 log_error!($self.logger, "{}", err.err);
1822 if let msgs::ErrorAction::IgnoreError = err.action {
1824 msg_events.push(events::MessageSendEvent::HandleError {
1825 node_id: $counterparty_node_id,
1826 action: err.action.clone()
1830 if !msg_events.is_empty() {
1831 let per_peer_state = $self.per_peer_state.read().unwrap();
1832 if let Some(peer_state_mutex) = per_peer_state.get(&$counterparty_node_id) {
1833 let mut peer_state = peer_state_mutex.lock().unwrap();
1834 peer_state.pending_msg_events.append(&mut msg_events);
1838 // Return error in case higher-API need one
1843 ($self: ident, $internal: expr) => {
1846 Err((chan, msg_handle_err)) => {
1847 let counterparty_node_id = chan.get_counterparty_node_id();
1848 handle_error!($self, Err(msg_handle_err), counterparty_node_id).map_err(|err| (chan, err))
1854 macro_rules! update_maps_on_chan_removal {
1855 ($self: expr, $channel_context: expr) => {{
1856 $self.id_to_peer.lock().unwrap().remove(&$channel_context.channel_id());
1857 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1858 if let Some(short_id) = $channel_context.get_short_channel_id() {
1859 short_to_chan_info.remove(&short_id);
1861 // If the channel was never confirmed on-chain prior to its closure, remove the
1862 // outbound SCID alias we used for it from the collision-prevention set. While we
1863 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1864 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1865 // opening a million channels with us which are closed before we ever reach the funding
1867 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel_context.outbound_scid_alias());
1868 debug_assert!(alias_removed);
1870 short_to_chan_info.remove(&$channel_context.outbound_scid_alias());
1874 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1875 macro_rules! convert_chan_phase_err {
1876 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, MANUAL_CHANNEL_UPDATE, $channel_update: expr) => {
1878 ChannelError::Warn(msg) => {
1879 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), *$channel_id))
1881 ChannelError::Ignore(msg) => {
1882 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), *$channel_id))
1884 ChannelError::Close(msg) => {
1885 log_error!($self.logger, "Closing channel {} due to close-required error: {}", $channel_id, msg);
1886 update_maps_on_chan_removal!($self, $channel.context);
1887 let shutdown_res = $channel.context.force_shutdown(true);
1888 let user_id = $channel.context.get_user_id();
1889 let channel_capacity_satoshis = $channel.context.get_value_satoshis();
1891 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, user_id,
1892 shutdown_res, $channel_update, channel_capacity_satoshis))
1896 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, FUNDED_CHANNEL) => {
1897 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, { $self.get_channel_update_for_broadcast($channel).ok() })
1899 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, UNFUNDED_CHANNEL) => {
1900 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, None)
1902 ($self: ident, $err: expr, $channel_phase: expr, $channel_id: expr) => {
1903 match $channel_phase {
1904 ChannelPhase::Funded(channel) => {
1905 convert_chan_phase_err!($self, $err, channel, $channel_id, FUNDED_CHANNEL)
1907 ChannelPhase::UnfundedOutboundV1(channel) => {
1908 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
1910 ChannelPhase::UnfundedInboundV1(channel) => {
1911 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
1917 macro_rules! break_chan_phase_entry {
1918 ($self: ident, $res: expr, $entry: expr) => {
1922 let key = *$entry.key();
1923 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
1925 $entry.remove_entry();
1933 macro_rules! try_chan_phase_entry {
1934 ($self: ident, $res: expr, $entry: expr) => {
1938 let key = *$entry.key();
1939 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
1941 $entry.remove_entry();
1949 macro_rules! remove_channel_phase {
1950 ($self: expr, $entry: expr) => {
1952 let channel = $entry.remove_entry().1;
1953 update_maps_on_chan_removal!($self, &channel.context());
1959 macro_rules! send_channel_ready {
1960 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
1961 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1962 node_id: $channel.context.get_counterparty_node_id(),
1963 msg: $channel_ready_msg,
1965 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1966 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1967 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1968 let outbound_alias_insert = short_to_chan_info.insert($channel.context.outbound_scid_alias(), ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
1969 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
1970 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1971 if let Some(real_scid) = $channel.context.get_short_channel_id() {
1972 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
1973 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
1974 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1979 macro_rules! emit_channel_pending_event {
1980 ($locked_events: expr, $channel: expr) => {
1981 if $channel.context.should_emit_channel_pending_event() {
1982 $locked_events.push_back((events::Event::ChannelPending {
1983 channel_id: $channel.context.channel_id(),
1984 former_temporary_channel_id: $channel.context.temporary_channel_id(),
1985 counterparty_node_id: $channel.context.get_counterparty_node_id(),
1986 user_channel_id: $channel.context.get_user_id(),
1987 funding_txo: $channel.context.get_funding_txo().unwrap().into_bitcoin_outpoint(),
1989 $channel.context.set_channel_pending_event_emitted();
1994 macro_rules! emit_channel_ready_event {
1995 ($locked_events: expr, $channel: expr) => {
1996 if $channel.context.should_emit_channel_ready_event() {
1997 debug_assert!($channel.context.channel_pending_event_emitted());
1998 $locked_events.push_back((events::Event::ChannelReady {
1999 channel_id: $channel.context.channel_id(),
2000 user_channel_id: $channel.context.get_user_id(),
2001 counterparty_node_id: $channel.context.get_counterparty_node_id(),
2002 channel_type: $channel.context.get_channel_type().clone(),
2004 $channel.context.set_channel_ready_event_emitted();
2009 macro_rules! handle_monitor_update_completion {
2010 ($self: ident, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
2011 let mut updates = $chan.monitor_updating_restored(&$self.logger,
2012 &$self.node_signer, $self.genesis_hash, &$self.default_configuration,
2013 $self.best_block.read().unwrap().height());
2014 let counterparty_node_id = $chan.context.get_counterparty_node_id();
2015 let channel_update = if updates.channel_ready.is_some() && $chan.context.is_usable() {
2016 // We only send a channel_update in the case where we are just now sending a
2017 // channel_ready and the channel is in a usable state. We may re-send a
2018 // channel_update later through the announcement_signatures process for public
2019 // channels, but there's no reason not to just inform our counterparty of our fees
2021 if let Ok(msg) = $self.get_channel_update_for_unicast($chan) {
2022 Some(events::MessageSendEvent::SendChannelUpdate {
2023 node_id: counterparty_node_id,
2029 let update_actions = $peer_state.monitor_update_blocked_actions
2030 .remove(&$chan.context.channel_id()).unwrap_or(Vec::new());
2032 let htlc_forwards = $self.handle_channel_resumption(
2033 &mut $peer_state.pending_msg_events, $chan, updates.raa,
2034 updates.commitment_update, updates.order, updates.accepted_htlcs,
2035 updates.funding_broadcastable, updates.channel_ready,
2036 updates.announcement_sigs);
2037 if let Some(upd) = channel_update {
2038 $peer_state.pending_msg_events.push(upd);
2041 let channel_id = $chan.context.channel_id();
2042 let unbroadcasted_batch_funding_txid = $chan.context.unbroadcasted_batch_funding_txid();
2043 core::mem::drop($peer_state_lock);
2044 core::mem::drop($per_peer_state_lock);
2046 // If the channel belongs to a batch funding transaction, the progress of the batch
2047 // should be updated as we have received funding_signed and persisted the monitor.
2048 if let Some(txid) = unbroadcasted_batch_funding_txid {
2049 let mut funding_batch_states = $self.funding_batch_states.lock().unwrap();
2050 let mut batch_completed = false;
2051 if let Some(batch_state) = funding_batch_states.get_mut(&txid) {
2052 let channel_state = batch_state.iter_mut().find(|(chan_id, pubkey, _)| (
2053 *chan_id == channel_id &&
2054 *pubkey == counterparty_node_id
2056 if let Some(channel_state) = channel_state {
2057 channel_state.2 = true;
2059 debug_assert!(false, "Missing channel batch state for channel which completed initial monitor update");
2061 batch_completed = batch_state.iter().all(|(_, _, completed)| *completed);
2063 debug_assert!(false, "Missing batch state for channel which completed initial monitor update");
2066 // When all channels in a batched funding transaction have become ready, it is not necessary
2067 // to track the progress of the batch anymore and the state of the channels can be updated.
2068 if batch_completed {
2069 let removed_batch_state = funding_batch_states.remove(&txid).into_iter().flatten();
2070 let per_peer_state = $self.per_peer_state.read().unwrap();
2071 let mut batch_funding_tx = None;
2072 for (channel_id, counterparty_node_id, _) in removed_batch_state {
2073 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2074 let mut peer_state = peer_state_mutex.lock().unwrap();
2075 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
2076 batch_funding_tx = batch_funding_tx.or_else(|| chan.context.unbroadcasted_funding());
2077 chan.set_batch_ready();
2078 let mut pending_events = $self.pending_events.lock().unwrap();
2079 emit_channel_pending_event!(pending_events, chan);
2083 if let Some(tx) = batch_funding_tx {
2084 log_info!($self.logger, "Broadcasting batch funding transaction with txid {}", tx.txid());
2085 $self.tx_broadcaster.broadcast_transactions(&[&tx]);
2090 $self.handle_monitor_update_completion_actions(update_actions);
2092 if let Some(forwards) = htlc_forwards {
2093 $self.forward_htlcs(&mut [forwards][..]);
2095 $self.finalize_claims(updates.finalized_claimed_htlcs);
2096 for failure in updates.failed_htlcs.drain(..) {
2097 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2098 $self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
2103 macro_rules! handle_new_monitor_update {
2104 ($self: ident, $update_res: expr, $chan: expr, _internal, $completed: expr) => { {
2105 debug_assert!($self.background_events_processed_since_startup.load(Ordering::Acquire));
2107 ChannelMonitorUpdateStatus::UnrecoverableError => {
2108 let err_str = "ChannelMonitor[Update] persistence failed unrecoverably. This indicates we cannot continue normal operation and must shut down.";
2109 log_error!($self.logger, "{}", err_str);
2110 panic!("{}", err_str);
2112 ChannelMonitorUpdateStatus::InProgress => {
2113 log_debug!($self.logger, "ChannelMonitor update for {} in flight, holding messages until the update completes.",
2114 &$chan.context.channel_id());
2117 ChannelMonitorUpdateStatus::Completed => {
2123 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr, INITIAL_MONITOR) => {
2124 handle_new_monitor_update!($self, $update_res, $chan, _internal,
2125 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan))
2127 ($self: ident, $funding_txo: expr, $update: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
2128 let in_flight_updates = $peer_state.in_flight_monitor_updates.entry($funding_txo)
2129 .or_insert_with(Vec::new);
2130 // During startup, we push monitor updates as background events through to here in
2131 // order to replay updates that were in-flight when we shut down. Thus, we have to
2132 // filter for uniqueness here.
2133 let idx = in_flight_updates.iter().position(|upd| upd == &$update)
2134 .unwrap_or_else(|| {
2135 in_flight_updates.push($update);
2136 in_flight_updates.len() - 1
2138 let update_res = $self.chain_monitor.update_channel($funding_txo, &in_flight_updates[idx]);
2139 handle_new_monitor_update!($self, update_res, $chan, _internal,
2141 let _ = in_flight_updates.remove(idx);
2142 if in_flight_updates.is_empty() && $chan.blocked_monitor_updates_pending() == 0 {
2143 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan);
2149 macro_rules! process_events_body {
2150 ($self: expr, $event_to_handle: expr, $handle_event: expr) => {
2151 let mut processed_all_events = false;
2152 while !processed_all_events {
2153 if $self.pending_events_processor.compare_exchange(false, true, Ordering::Acquire, Ordering::Relaxed).is_err() {
2160 // We'll acquire our total consistency lock so that we can be sure no other
2161 // persists happen while processing monitor events.
2162 let _read_guard = $self.total_consistency_lock.read().unwrap();
2164 // Because `handle_post_event_actions` may send `ChannelMonitorUpdate`s to the user we must
2165 // ensure any startup-generated background events are handled first.
2166 result = $self.process_background_events();
2168 // TODO: This behavior should be documented. It's unintuitive that we query
2169 // ChannelMonitors when clearing other events.
2170 if $self.process_pending_monitor_events() {
2171 result = NotifyOption::DoPersist;
2175 let pending_events = $self.pending_events.lock().unwrap().clone();
2176 let num_events = pending_events.len();
2177 if !pending_events.is_empty() {
2178 result = NotifyOption::DoPersist;
2181 let mut post_event_actions = Vec::new();
2183 for (event, action_opt) in pending_events {
2184 $event_to_handle = event;
2186 if let Some(action) = action_opt {
2187 post_event_actions.push(action);
2192 let mut pending_events = $self.pending_events.lock().unwrap();
2193 pending_events.drain(..num_events);
2194 processed_all_events = pending_events.is_empty();
2195 // Note that `push_pending_forwards_ev` relies on `pending_events_processor` being
2196 // updated here with the `pending_events` lock acquired.
2197 $self.pending_events_processor.store(false, Ordering::Release);
2200 if !post_event_actions.is_empty() {
2201 $self.handle_post_event_actions(post_event_actions);
2202 // If we had some actions, go around again as we may have more events now
2203 processed_all_events = false;
2207 NotifyOption::DoPersist => {
2208 $self.needs_persist_flag.store(true, Ordering::Release);
2209 $self.event_persist_notifier.notify();
2211 NotifyOption::SkipPersistHandleEvents =>
2212 $self.event_persist_notifier.notify(),
2213 NotifyOption::SkipPersistNoEvents => {},
2219 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>
2221 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
2222 T::Target: BroadcasterInterface,
2223 ES::Target: EntropySource,
2224 NS::Target: NodeSigner,
2225 SP::Target: SignerProvider,
2226 F::Target: FeeEstimator,
2230 /// Constructs a new `ChannelManager` to hold several channels and route between them.
2232 /// The current time or latest block header time can be provided as the `current_timestamp`.
2234 /// This is the main "logic hub" for all channel-related actions, and implements
2235 /// [`ChannelMessageHandler`].
2237 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
2239 /// Users need to notify the new `ChannelManager` when a new block is connected or
2240 /// disconnected using its [`block_connected`] and [`block_disconnected`] methods, starting
2241 /// from after [`params.best_block.block_hash`]. See [`chain::Listen`] and [`chain::Confirm`] for
2244 /// [`block_connected`]: chain::Listen::block_connected
2245 /// [`block_disconnected`]: chain::Listen::block_disconnected
2246 /// [`params.best_block.block_hash`]: chain::BestBlock::block_hash
2248 fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, entropy_source: ES,
2249 node_signer: NS, signer_provider: SP, config: UserConfig, params: ChainParameters,
2250 current_timestamp: u32,
2252 let mut secp_ctx = Secp256k1::new();
2253 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
2254 let inbound_pmt_key_material = node_signer.get_inbound_payment_key_material();
2255 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
2257 default_configuration: config.clone(),
2258 genesis_hash: genesis_block(params.network).header.block_hash(),
2259 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
2264 best_block: RwLock::new(params.best_block),
2266 outbound_scid_aliases: Mutex::new(HashSet::new()),
2267 pending_inbound_payments: Mutex::new(HashMap::new()),
2268 pending_outbound_payments: OutboundPayments::new(),
2269 forward_htlcs: Mutex::new(HashMap::new()),
2270 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments: HashMap::new(), pending_claiming_payments: HashMap::new() }),
2271 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
2272 id_to_peer: Mutex::new(HashMap::new()),
2273 short_to_chan_info: FairRwLock::new(HashMap::new()),
2275 our_network_pubkey: node_signer.get_node_id(Recipient::Node).unwrap(),
2278 inbound_payment_key: expanded_inbound_key,
2279 fake_scid_rand_bytes: entropy_source.get_secure_random_bytes(),
2281 probing_cookie_secret: entropy_source.get_secure_random_bytes(),
2283 highest_seen_timestamp: AtomicUsize::new(current_timestamp as usize),
2285 per_peer_state: FairRwLock::new(HashMap::new()),
2287 pending_events: Mutex::new(VecDeque::new()),
2288 pending_events_processor: AtomicBool::new(false),
2289 pending_background_events: Mutex::new(Vec::new()),
2290 total_consistency_lock: RwLock::new(()),
2291 background_events_processed_since_startup: AtomicBool::new(false),
2292 event_persist_notifier: Notifier::new(),
2293 needs_persist_flag: AtomicBool::new(false),
2294 funding_batch_states: Mutex::new(BTreeMap::new()),
2304 /// Gets the current configuration applied to all new channels.
2305 pub fn get_current_default_configuration(&self) -> &UserConfig {
2306 &self.default_configuration
2309 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
2310 let height = self.best_block.read().unwrap().height();
2311 let mut outbound_scid_alias = 0;
2314 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
2315 outbound_scid_alias += 1;
2317 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
2319 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
2323 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"); }
2328 /// Creates a new outbound channel to the given remote node and with the given value.
2330 /// `user_channel_id` will be provided back as in
2331 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
2332 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
2333 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
2334 /// is simply copied to events and otherwise ignored.
2336 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
2337 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
2339 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be opened due to failing to
2340 /// generate a shutdown scriptpubkey or destination script set by
2341 /// [`SignerProvider::get_shutdown_scriptpubkey`] or [`SignerProvider::get_destination_script`].
2343 /// Note that we do not check if you are currently connected to the given peer. If no
2344 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
2345 /// the channel eventually being silently forgotten (dropped on reload).
2347 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
2348 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
2349 /// [`ChannelDetails::channel_id`] until after
2350 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
2351 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
2352 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
2354 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
2355 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
2356 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
2357 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_channel_id: u128, override_config: Option<UserConfig>) -> Result<ChannelId, APIError> {
2358 if channel_value_satoshis < 1000 {
2359 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
2362 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2363 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
2364 debug_assert!(&self.total_consistency_lock.try_write().is_err());
2366 let per_peer_state = self.per_peer_state.read().unwrap();
2368 let peer_state_mutex = per_peer_state.get(&their_network_key)
2369 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Not connected to node: {}", their_network_key) })?;
2371 let mut peer_state = peer_state_mutex.lock().unwrap();
2373 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
2374 let their_features = &peer_state.latest_features;
2375 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
2376 match OutboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider, their_network_key,
2377 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
2378 self.best_block.read().unwrap().height(), outbound_scid_alias)
2382 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
2387 let res = channel.get_open_channel(self.genesis_hash.clone());
2389 let temporary_channel_id = channel.context.channel_id();
2390 match peer_state.channel_by_id.entry(temporary_channel_id) {
2391 hash_map::Entry::Occupied(_) => {
2393 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
2395 panic!("RNG is bad???");
2398 hash_map::Entry::Vacant(entry) => { entry.insert(ChannelPhase::UnfundedOutboundV1(channel)); }
2401 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
2402 node_id: their_network_key,
2405 Ok(temporary_channel_id)
2408 fn list_funded_channels_with_filter<Fn: FnMut(&(&ChannelId, &Channel<SP>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
2409 // Allocate our best estimate of the number of channels we have in the `res`
2410 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2411 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2412 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2413 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2414 // the same channel.
2415 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2417 let best_block_height = self.best_block.read().unwrap().height();
2418 let per_peer_state = self.per_peer_state.read().unwrap();
2419 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2420 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2421 let peer_state = &mut *peer_state_lock;
2422 res.extend(peer_state.channel_by_id.iter()
2423 .filter_map(|(chan_id, phase)| match phase {
2424 // Only `Channels` in the `ChannelPhase::Funded` phase can be considered funded.
2425 ChannelPhase::Funded(chan) => Some((chan_id, chan)),
2429 .map(|(_channel_id, channel)| {
2430 ChannelDetails::from_channel_context(&channel.context, best_block_height,
2431 peer_state.latest_features.clone(), &self.fee_estimator)
2439 /// Gets the list of open channels, in random order. See [`ChannelDetails`] field documentation for
2440 /// more information.
2441 pub fn list_channels(&self) -> Vec<ChannelDetails> {
2442 // Allocate our best estimate of the number of channels we have in the `res`
2443 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2444 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2445 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2446 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2447 // the same channel.
2448 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2450 let best_block_height = self.best_block.read().unwrap().height();
2451 let per_peer_state = self.per_peer_state.read().unwrap();
2452 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2453 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2454 let peer_state = &mut *peer_state_lock;
2455 for context in peer_state.channel_by_id.iter().map(|(_, phase)| phase.context()) {
2456 let details = ChannelDetails::from_channel_context(context, best_block_height,
2457 peer_state.latest_features.clone(), &self.fee_estimator);
2465 /// Gets the list of usable channels, in random order. Useful as an argument to
2466 /// [`Router::find_route`] to ensure non-announced channels are used.
2468 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
2469 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
2471 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
2472 // Note we use is_live here instead of usable which leads to somewhat confused
2473 // internal/external nomenclature, but that's ok cause that's probably what the user
2474 // really wanted anyway.
2475 self.list_funded_channels_with_filter(|&(_, ref channel)| channel.context.is_live())
2478 /// Gets the list of channels we have with a given counterparty, in random order.
2479 pub fn list_channels_with_counterparty(&self, counterparty_node_id: &PublicKey) -> Vec<ChannelDetails> {
2480 let best_block_height = self.best_block.read().unwrap().height();
2481 let per_peer_state = self.per_peer_state.read().unwrap();
2483 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
2484 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2485 let peer_state = &mut *peer_state_lock;
2486 let features = &peer_state.latest_features;
2487 let context_to_details = |context| {
2488 ChannelDetails::from_channel_context(context, best_block_height, features.clone(), &self.fee_estimator)
2490 return peer_state.channel_by_id
2492 .map(|(_, phase)| phase.context())
2493 .map(context_to_details)
2499 /// Returns in an undefined order recent payments that -- if not fulfilled -- have yet to find a
2500 /// successful path, or have unresolved HTLCs.
2502 /// This can be useful for payments that may have been prepared, but ultimately not sent, as a
2503 /// result of a crash. If such a payment exists, is not listed here, and an
2504 /// [`Event::PaymentSent`] has not been received, you may consider resending the payment.
2506 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2507 pub fn list_recent_payments(&self) -> Vec<RecentPaymentDetails> {
2508 self.pending_outbound_payments.pending_outbound_payments.lock().unwrap().iter()
2509 .filter_map(|(payment_id, pending_outbound_payment)| match pending_outbound_payment {
2510 PendingOutboundPayment::AwaitingInvoice { .. } => {
2511 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2513 // InvoiceReceived is an intermediate state and doesn't need to be exposed
2514 PendingOutboundPayment::InvoiceReceived { .. } => {
2515 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2517 PendingOutboundPayment::Retryable { payment_hash, total_msat, .. } => {
2518 Some(RecentPaymentDetails::Pending {
2519 payment_id: *payment_id,
2520 payment_hash: *payment_hash,
2521 total_msat: *total_msat,
2524 PendingOutboundPayment::Abandoned { payment_hash, .. } => {
2525 Some(RecentPaymentDetails::Abandoned { payment_id: *payment_id, payment_hash: *payment_hash })
2527 PendingOutboundPayment::Fulfilled { payment_hash, .. } => {
2528 Some(RecentPaymentDetails::Fulfilled { payment_id: *payment_id, payment_hash: *payment_hash })
2530 PendingOutboundPayment::Legacy { .. } => None
2535 /// Helper function that issues the channel close events
2536 fn issue_channel_close_events(&self, context: &ChannelContext<SP>, closure_reason: ClosureReason) {
2537 let mut pending_events_lock = self.pending_events.lock().unwrap();
2538 match context.unbroadcasted_funding() {
2539 Some(transaction) => {
2540 pending_events_lock.push_back((events::Event::DiscardFunding {
2541 channel_id: context.channel_id(), transaction
2546 pending_events_lock.push_back((events::Event::ChannelClosed {
2547 channel_id: context.channel_id(),
2548 user_channel_id: context.get_user_id(),
2549 reason: closure_reason,
2550 counterparty_node_id: Some(context.get_counterparty_node_id()),
2551 channel_capacity_sats: Some(context.get_value_satoshis()),
2555 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> {
2556 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2558 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
2559 let mut shutdown_result = None;
2561 let per_peer_state = self.per_peer_state.read().unwrap();
2563 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2564 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2566 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2567 let peer_state = &mut *peer_state_lock;
2569 match peer_state.channel_by_id.entry(channel_id.clone()) {
2570 hash_map::Entry::Occupied(mut chan_phase_entry) => {
2571 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
2572 let funding_txo_opt = chan.context.get_funding_txo();
2573 let their_features = &peer_state.latest_features;
2574 let unbroadcasted_batch_funding_txid = chan.context.unbroadcasted_batch_funding_txid();
2575 let (shutdown_msg, mut monitor_update_opt, htlcs) =
2576 chan.get_shutdown(&self.signer_provider, their_features, target_feerate_sats_per_1000_weight, override_shutdown_script)?;
2577 failed_htlcs = htlcs;
2579 // We can send the `shutdown` message before updating the `ChannelMonitor`
2580 // here as we don't need the monitor update to complete until we send a
2581 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
2582 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2583 node_id: *counterparty_node_id,
2587 debug_assert!(monitor_update_opt.is_none() || !chan.is_shutdown(),
2588 "We can't both complete shutdown and generate a monitor update");
2590 // Update the monitor with the shutdown script if necessary.
2591 if let Some(monitor_update) = monitor_update_opt.take() {
2592 handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
2593 peer_state_lock, peer_state, per_peer_state, chan);
2597 if chan.is_shutdown() {
2598 if let ChannelPhase::Funded(chan) = remove_channel_phase!(self, chan_phase_entry) {
2599 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&chan) {
2600 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2604 self.issue_channel_close_events(&chan.context, ClosureReason::HolderForceClosed);
2605 shutdown_result = Some((None, Vec::new(), unbroadcasted_batch_funding_txid));
2611 hash_map::Entry::Vacant(_) => {
2612 // If we reach this point, it means that the channel_id either refers to an unfunded channel or
2613 // it does not exist for this peer. Either way, we can attempt to force-close it.
2615 // An appropriate error will be returned for non-existence of the channel if that's the case.
2616 return self.force_close_channel_with_peer(&channel_id, counterparty_node_id, None, false).map(|_| ())
2621 for htlc_source in failed_htlcs.drain(..) {
2622 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2623 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
2624 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
2627 if let Some(shutdown_result) = shutdown_result {
2628 self.finish_close_channel(shutdown_result);
2634 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2635 /// will be accepted on the given channel, and after additional timeout/the closing of all
2636 /// pending HTLCs, the channel will be closed on chain.
2638 /// * If we are the channel initiator, we will pay between our [`Background`] and
2639 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
2641 /// * If our counterparty is the channel initiator, we will require a channel closing
2642 /// transaction feerate of at least our [`Background`] feerate or the feerate which
2643 /// would appear on a force-closure transaction, whichever is lower. We will allow our
2644 /// counterparty to pay as much fee as they'd like, however.
2646 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2648 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2649 /// generate a shutdown scriptpubkey or destination script set by
2650 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2653 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2654 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
2655 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
2656 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2657 pub fn close_channel(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey) -> Result<(), APIError> {
2658 self.close_channel_internal(channel_id, counterparty_node_id, None, None)
2661 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2662 /// will be accepted on the given channel, and after additional timeout/the closing of all
2663 /// pending HTLCs, the channel will be closed on chain.
2665 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
2666 /// the channel being closed or not:
2667 /// * If we are the channel initiator, we will pay at least this feerate on the closing
2668 /// transaction. The upper-bound is set by
2669 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
2670 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
2671 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
2672 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
2673 /// will appear on a force-closure transaction, whichever is lower).
2675 /// The `shutdown_script` provided will be used as the `scriptPubKey` for the closing transaction.
2676 /// Will fail if a shutdown script has already been set for this channel by
2677 /// ['ChannelHandshakeConfig::commit_upfront_shutdown_pubkey`]. The given shutdown script must
2678 /// also be compatible with our and the counterparty's features.
2680 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2682 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2683 /// generate a shutdown scriptpubkey or destination script set by
2684 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2687 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2688 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
2689 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
2690 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2691 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> {
2692 self.close_channel_internal(channel_id, counterparty_node_id, target_feerate_sats_per_1000_weight, shutdown_script)
2695 fn finish_close_channel(&self, shutdown_res: ShutdownResult) {
2696 debug_assert_ne!(self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
2697 #[cfg(debug_assertions)]
2698 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
2699 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
2702 let (monitor_update_option, mut failed_htlcs, unbroadcasted_batch_funding_txid) = shutdown_res;
2703 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
2704 for htlc_source in failed_htlcs.drain(..) {
2705 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
2706 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2707 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2708 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
2710 if let Some((_, funding_txo, monitor_update)) = monitor_update_option {
2711 // There isn't anything we can do if we get an update failure - we're already
2712 // force-closing. The monitor update on the required in-memory copy should broadcast
2713 // the latest local state, which is the best we can do anyway. Thus, it is safe to
2714 // ignore the result here.
2715 let _ = self.chain_monitor.update_channel(funding_txo, &monitor_update);
2717 let mut shutdown_results = Vec::new();
2718 if let Some(txid) = unbroadcasted_batch_funding_txid {
2719 let mut funding_batch_states = self.funding_batch_states.lock().unwrap();
2720 let affected_channels = funding_batch_states.remove(&txid).into_iter().flatten();
2721 let per_peer_state = self.per_peer_state.read().unwrap();
2722 let mut has_uncompleted_channel = None;
2723 for (channel_id, counterparty_node_id, state) in affected_channels {
2724 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2725 let mut peer_state = peer_state_mutex.lock().unwrap();
2726 if let Some(mut chan) = peer_state.channel_by_id.remove(&channel_id) {
2727 update_maps_on_chan_removal!(self, &chan.context());
2728 self.issue_channel_close_events(&chan.context(), ClosureReason::FundingBatchClosure);
2729 shutdown_results.push(chan.context_mut().force_shutdown(false));
2732 has_uncompleted_channel = Some(has_uncompleted_channel.map_or(!state, |v| v || !state));
2735 has_uncompleted_channel.unwrap_or(true),
2736 "Closing a batch where all channels have completed initial monitor update",
2739 for shutdown_result in shutdown_results.drain(..) {
2740 self.finish_close_channel(shutdown_result);
2744 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
2745 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
2746 fn force_close_channel_with_peer(&self, channel_id: &ChannelId, peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
2747 -> Result<PublicKey, APIError> {
2748 let per_peer_state = self.per_peer_state.read().unwrap();
2749 let peer_state_mutex = per_peer_state.get(peer_node_id)
2750 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", peer_node_id) })?;
2751 let (update_opt, counterparty_node_id) = {
2752 let mut peer_state = peer_state_mutex.lock().unwrap();
2753 let closure_reason = if let Some(peer_msg) = peer_msg {
2754 ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(peer_msg.to_string()) }
2756 ClosureReason::HolderForceClosed
2758 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(channel_id.clone()) {
2759 log_error!(self.logger, "Force-closing channel {}", channel_id);
2760 self.issue_channel_close_events(&chan_phase_entry.get().context(), closure_reason);
2761 let mut chan_phase = remove_channel_phase!(self, chan_phase_entry);
2762 mem::drop(peer_state);
2763 mem::drop(per_peer_state);
2765 ChannelPhase::Funded(mut chan) => {
2766 self.finish_close_channel(chan.context.force_shutdown(broadcast));
2767 (self.get_channel_update_for_broadcast(&chan).ok(), chan.context.get_counterparty_node_id())
2769 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => {
2770 self.finish_close_channel(chan_phase.context_mut().force_shutdown(false));
2771 // Unfunded channel has no update
2772 (None, chan_phase.context().get_counterparty_node_id())
2775 } else if peer_state.inbound_channel_request_by_id.remove(channel_id).is_some() {
2776 log_error!(self.logger, "Force-closing channel {}", &channel_id);
2777 // N.B. that we don't send any channel close event here: we
2778 // don't have a user_channel_id, and we never sent any opening
2780 (None, *peer_node_id)
2782 return Err(APIError::ChannelUnavailable{ err: format!("Channel with id {} not found for the passed counterparty node_id {}", channel_id, peer_node_id) });
2785 if let Some(update) = update_opt {
2786 // Try to send the `BroadcastChannelUpdate` to the peer we just force-closed on, but if
2787 // not try to broadcast it via whatever peer we have.
2788 let per_peer_state = self.per_peer_state.read().unwrap();
2789 let a_peer_state_opt = per_peer_state.get(peer_node_id)
2790 .ok_or(per_peer_state.values().next());
2791 if let Ok(a_peer_state_mutex) = a_peer_state_opt {
2792 let mut a_peer_state = a_peer_state_mutex.lock().unwrap();
2793 a_peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2799 Ok(counterparty_node_id)
2802 fn force_close_sending_error(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
2803 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2804 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
2805 Ok(counterparty_node_id) => {
2806 let per_peer_state = self.per_peer_state.read().unwrap();
2807 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2808 let mut peer_state = peer_state_mutex.lock().unwrap();
2809 peer_state.pending_msg_events.push(
2810 events::MessageSendEvent::HandleError {
2811 node_id: counterparty_node_id,
2812 action: msgs::ErrorAction::SendErrorMessage {
2813 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
2824 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
2825 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
2826 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
2828 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
2829 -> Result<(), APIError> {
2830 self.force_close_sending_error(channel_id, counterparty_node_id, true)
2833 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
2834 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
2835 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
2837 /// You can always get the latest local transaction(s) to broadcast from
2838 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
2839 pub fn force_close_without_broadcasting_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
2840 -> Result<(), APIError> {
2841 self.force_close_sending_error(channel_id, counterparty_node_id, false)
2844 /// Force close all channels, immediately broadcasting the latest local commitment transaction
2845 /// for each to the chain and rejecting new HTLCs on each.
2846 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
2847 for chan in self.list_channels() {
2848 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
2852 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
2853 /// local transaction(s).
2854 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
2855 for chan in self.list_channels() {
2856 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
2860 fn construct_fwd_pending_htlc_info(
2861 &self, msg: &msgs::UpdateAddHTLC, hop_data: msgs::InboundOnionPayload, hop_hmac: [u8; 32],
2862 new_packet_bytes: [u8; onion_utils::ONION_DATA_LEN], shared_secret: [u8; 32],
2863 next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
2864 ) -> Result<PendingHTLCInfo, InboundOnionErr> {
2865 debug_assert!(next_packet_pubkey_opt.is_some());
2866 let outgoing_packet = msgs::OnionPacket {
2868 public_key: next_packet_pubkey_opt.unwrap_or(Err(secp256k1::Error::InvalidPublicKey)),
2869 hop_data: new_packet_bytes,
2873 let (short_channel_id, amt_to_forward, outgoing_cltv_value) = match hop_data {
2874 msgs::InboundOnionPayload::Forward { short_channel_id, amt_to_forward, outgoing_cltv_value } =>
2875 (short_channel_id, amt_to_forward, outgoing_cltv_value),
2876 msgs::InboundOnionPayload::Receive { .. } | msgs::InboundOnionPayload::BlindedReceive { .. } =>
2877 return Err(InboundOnionErr {
2878 msg: "Final Node OnionHopData provided for us as an intermediary node",
2879 err_code: 0x4000 | 22,
2880 err_data: Vec::new(),
2884 Ok(PendingHTLCInfo {
2885 routing: PendingHTLCRouting::Forward {
2886 onion_packet: outgoing_packet,
2889 payment_hash: msg.payment_hash,
2890 incoming_shared_secret: shared_secret,
2891 incoming_amt_msat: Some(msg.amount_msat),
2892 outgoing_amt_msat: amt_to_forward,
2893 outgoing_cltv_value,
2894 skimmed_fee_msat: None,
2898 fn construct_recv_pending_htlc_info(
2899 &self, hop_data: msgs::InboundOnionPayload, shared_secret: [u8; 32], payment_hash: PaymentHash,
2900 amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>, allow_underpay: bool,
2901 counterparty_skimmed_fee_msat: Option<u64>,
2902 ) -> Result<PendingHTLCInfo, InboundOnionErr> {
2903 let (payment_data, keysend_preimage, custom_tlvs, onion_amt_msat, outgoing_cltv_value, payment_metadata) = match hop_data {
2904 msgs::InboundOnionPayload::Receive {
2905 payment_data, keysend_preimage, custom_tlvs, amt_msat, outgoing_cltv_value, payment_metadata, ..
2907 (payment_data, keysend_preimage, custom_tlvs, amt_msat, outgoing_cltv_value, payment_metadata),
2908 msgs::InboundOnionPayload::BlindedReceive {
2909 amt_msat, total_msat, outgoing_cltv_value, payment_secret, ..
2911 let payment_data = msgs::FinalOnionHopData { payment_secret, total_msat };
2912 (Some(payment_data), None, Vec::new(), amt_msat, outgoing_cltv_value, None)
2914 msgs::InboundOnionPayload::Forward { .. } => {
2915 return Err(InboundOnionErr {
2916 err_code: 0x4000|22,
2917 err_data: Vec::new(),
2918 msg: "Got non final data with an HMAC of 0",
2922 // final_incorrect_cltv_expiry
2923 if outgoing_cltv_value > cltv_expiry {
2924 return Err(InboundOnionErr {
2925 msg: "Upstream node set CLTV to less than the CLTV set by the sender",
2927 err_data: cltv_expiry.to_be_bytes().to_vec()
2930 // final_expiry_too_soon
2931 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
2932 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
2934 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
2935 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
2936 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
2937 let current_height: u32 = self.best_block.read().unwrap().height();
2938 if (outgoing_cltv_value as u64) <= current_height as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
2939 let mut err_data = Vec::with_capacity(12);
2940 err_data.extend_from_slice(&amt_msat.to_be_bytes());
2941 err_data.extend_from_slice(¤t_height.to_be_bytes());
2942 return Err(InboundOnionErr {
2943 err_code: 0x4000 | 15, err_data,
2944 msg: "The final CLTV expiry is too soon to handle",
2947 if (!allow_underpay && onion_amt_msat > amt_msat) ||
2948 (allow_underpay && onion_amt_msat >
2949 amt_msat.saturating_add(counterparty_skimmed_fee_msat.unwrap_or(0)))
2951 return Err(InboundOnionErr {
2953 err_data: amt_msat.to_be_bytes().to_vec(),
2954 msg: "Upstream node sent less than we were supposed to receive in payment",
2958 let routing = if let Some(payment_preimage) = keysend_preimage {
2959 // We need to check that the sender knows the keysend preimage before processing this
2960 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
2961 // could discover the final destination of X, by probing the adjacent nodes on the route
2962 // with a keysend payment of identical payment hash to X and observing the processing
2963 // time discrepancies due to a hash collision with X.
2964 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2965 if hashed_preimage != payment_hash {
2966 return Err(InboundOnionErr {
2967 err_code: 0x4000|22,
2968 err_data: Vec::new(),
2969 msg: "Payment preimage didn't match payment hash",
2972 if !self.default_configuration.accept_mpp_keysend && payment_data.is_some() {
2973 return Err(InboundOnionErr {
2974 err_code: 0x4000|22,
2975 err_data: Vec::new(),
2976 msg: "We don't support MPP keysend payments",
2979 PendingHTLCRouting::ReceiveKeysend {
2983 incoming_cltv_expiry: outgoing_cltv_value,
2986 } else if let Some(data) = payment_data {
2987 PendingHTLCRouting::Receive {
2990 incoming_cltv_expiry: outgoing_cltv_value,
2991 phantom_shared_secret,
2995 return Err(InboundOnionErr {
2996 err_code: 0x4000|0x2000|3,
2997 err_data: Vec::new(),
2998 msg: "We require payment_secrets",
3001 Ok(PendingHTLCInfo {
3004 incoming_shared_secret: shared_secret,
3005 incoming_amt_msat: Some(amt_msat),
3006 outgoing_amt_msat: onion_amt_msat,
3007 outgoing_cltv_value,
3008 skimmed_fee_msat: counterparty_skimmed_fee_msat,
3012 fn decode_update_add_htlc_onion(
3013 &self, msg: &msgs::UpdateAddHTLC
3014 ) -> Result<(onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg> {
3015 macro_rules! return_malformed_err {
3016 ($msg: expr, $err_code: expr) => {
3018 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3019 return Err(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
3020 channel_id: msg.channel_id,
3021 htlc_id: msg.htlc_id,
3022 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
3023 failure_code: $err_code,
3029 if let Err(_) = msg.onion_routing_packet.public_key {
3030 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
3033 let shared_secret = self.node_signer.ecdh(
3034 Recipient::Node, &msg.onion_routing_packet.public_key.unwrap(), None
3035 ).unwrap().secret_bytes();
3037 if msg.onion_routing_packet.version != 0 {
3038 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
3039 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
3040 //the hash doesn't really serve any purpose - in the case of hashing all data, the
3041 //receiving node would have to brute force to figure out which version was put in the
3042 //packet by the node that send us the message, in the case of hashing the hop_data, the
3043 //node knows the HMAC matched, so they already know what is there...
3044 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
3046 macro_rules! return_err {
3047 ($msg: expr, $err_code: expr, $data: expr) => {
3049 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3050 return Err(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3051 channel_id: msg.channel_id,
3052 htlc_id: msg.htlc_id,
3053 reason: HTLCFailReason::reason($err_code, $data.to_vec())
3054 .get_encrypted_failure_packet(&shared_secret, &None),
3060 let next_hop = match onion_utils::decode_next_payment_hop(
3061 shared_secret, &msg.onion_routing_packet.hop_data[..], msg.onion_routing_packet.hmac,
3062 msg.payment_hash, &self.node_signer
3065 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
3066 return_malformed_err!(err_msg, err_code);
3068 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3069 return_err!(err_msg, err_code, &[0; 0]);
3072 let (outgoing_scid, outgoing_amt_msat, outgoing_cltv_value, next_packet_pk_opt) = match next_hop {
3073 onion_utils::Hop::Forward {
3074 next_hop_data: msgs::InboundOnionPayload::Forward {
3075 short_channel_id, amt_to_forward, outgoing_cltv_value
3078 let next_packet_pk = onion_utils::next_hop_pubkey(&self.secp_ctx,
3079 msg.onion_routing_packet.public_key.unwrap(), &shared_secret);
3080 (short_channel_id, amt_to_forward, outgoing_cltv_value, Some(next_packet_pk))
3082 // We'll do receive checks in [`Self::construct_pending_htlc_info`] so we have access to the
3083 // inbound channel's state.
3084 onion_utils::Hop::Receive { .. } => return Ok((next_hop, shared_secret, None)),
3085 onion_utils::Hop::Forward { next_hop_data: msgs::InboundOnionPayload::Receive { .. }, .. } |
3086 onion_utils::Hop::Forward { next_hop_data: msgs::InboundOnionPayload::BlindedReceive { .. }, .. } =>
3088 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0; 0]);
3092 // Perform outbound checks here instead of in [`Self::construct_pending_htlc_info`] because we
3093 // can't hold the outbound peer state lock at the same time as the inbound peer state lock.
3094 if let Some((err, mut code, chan_update)) = loop {
3095 let id_option = self.short_to_chan_info.read().unwrap().get(&outgoing_scid).cloned();
3096 let forwarding_chan_info_opt = match id_option {
3097 None => { // unknown_next_peer
3098 // Note that this is likely a timing oracle for detecting whether an scid is a
3099 // phantom or an intercept.
3100 if (self.default_configuration.accept_intercept_htlcs &&
3101 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, outgoing_scid, &self.genesis_hash)) ||
3102 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, outgoing_scid, &self.genesis_hash)
3106 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3109 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
3111 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
3112 let per_peer_state = self.per_peer_state.read().unwrap();
3113 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3114 if peer_state_mutex_opt.is_none() {
3115 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3117 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
3118 let peer_state = &mut *peer_state_lock;
3119 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id).map(
3120 |chan_phase| if let ChannelPhase::Funded(chan) = chan_phase { Some(chan) } else { None }
3123 // Channel was removed. The short_to_chan_info and channel_by_id maps
3124 // have no consistency guarantees.
3125 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3129 if !chan.context.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
3130 // Note that the behavior here should be identical to the above block - we
3131 // should NOT reveal the existence or non-existence of a private channel if
3132 // we don't allow forwards outbound over them.
3133 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
3135 if chan.context.get_channel_type().supports_scid_privacy() && outgoing_scid != chan.context.outbound_scid_alias() {
3136 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
3137 // "refuse to forward unless the SCID alias was used", so we pretend
3138 // we don't have the channel here.
3139 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
3141 let chan_update_opt = self.get_channel_update_for_onion(outgoing_scid, chan).ok();
3143 // Note that we could technically not return an error yet here and just hope
3144 // that the connection is reestablished or monitor updated by the time we get
3145 // around to doing the actual forward, but better to fail early if we can and
3146 // hopefully an attacker trying to path-trace payments cannot make this occur
3147 // on a small/per-node/per-channel scale.
3148 if !chan.context.is_live() { // channel_disabled
3149 // If the channel_update we're going to return is disabled (i.e. the
3150 // peer has been disabled for some time), return `channel_disabled`,
3151 // otherwise return `temporary_channel_failure`.
3152 if chan_update_opt.as_ref().map(|u| u.contents.flags & 2 == 2).unwrap_or(false) {
3153 break Some(("Forwarding channel has been disconnected for some time.", 0x1000 | 20, chan_update_opt));
3155 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 7, chan_update_opt));
3158 if outgoing_amt_msat < chan.context.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
3159 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
3161 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, outgoing_amt_msat, outgoing_cltv_value) {
3162 break Some((err, code, chan_update_opt));
3166 if (msg.cltv_expiry as u64) < (outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 {
3167 // We really should set `incorrect_cltv_expiry` here but as we're not
3168 // forwarding over a real channel we can't generate a channel_update
3169 // for it. Instead we just return a generic temporary_node_failure.
3171 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
3178 let cur_height = self.best_block.read().unwrap().height() + 1;
3179 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
3180 // but we want to be robust wrt to counterparty packet sanitization (see
3181 // HTLC_FAIL_BACK_BUFFER rationale).
3182 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
3183 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
3185 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
3186 break Some(("CLTV expiry is too far in the future", 21, None));
3188 // If the HTLC expires ~now, don't bother trying to forward it to our
3189 // counterparty. They should fail it anyway, but we don't want to bother with
3190 // the round-trips or risk them deciding they definitely want the HTLC and
3191 // force-closing to ensure they get it if we're offline.
3192 // We previously had a much more aggressive check here which tried to ensure
3193 // our counterparty receives an HTLC which has *our* risk threshold met on it,
3194 // but there is no need to do that, and since we're a bit conservative with our
3195 // risk threshold it just results in failing to forward payments.
3196 if (outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
3197 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
3203 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
3204 if let Some(chan_update) = chan_update {
3205 if code == 0x1000 | 11 || code == 0x1000 | 12 {
3206 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
3208 else if code == 0x1000 | 13 {
3209 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
3211 else if code == 0x1000 | 20 {
3212 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
3213 0u16.write(&mut res).expect("Writes cannot fail");
3215 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
3216 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
3217 chan_update.write(&mut res).expect("Writes cannot fail");
3218 } else if code & 0x1000 == 0x1000 {
3219 // If we're trying to return an error that requires a `channel_update` but
3220 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
3221 // generate an update), just use the generic "temporary_node_failure"
3225 return_err!(err, code, &res.0[..]);
3227 Ok((next_hop, shared_secret, next_packet_pk_opt))
3230 fn construct_pending_htlc_status<'a>(
3231 &self, msg: &msgs::UpdateAddHTLC, shared_secret: [u8; 32], decoded_hop: onion_utils::Hop,
3232 allow_underpay: bool, next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
3233 ) -> PendingHTLCStatus {
3234 macro_rules! return_err {
3235 ($msg: expr, $err_code: expr, $data: expr) => {
3237 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3238 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3239 channel_id: msg.channel_id,
3240 htlc_id: msg.htlc_id,
3241 reason: HTLCFailReason::reason($err_code, $data.to_vec())
3242 .get_encrypted_failure_packet(&shared_secret, &None),
3248 onion_utils::Hop::Receive(next_hop_data) => {
3250 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash,
3251 msg.amount_msat, msg.cltv_expiry, None, allow_underpay, msg.skimmed_fee_msat)
3254 // Note that we could obviously respond immediately with an update_fulfill_htlc
3255 // message, however that would leak that we are the recipient of this payment, so
3256 // instead we stay symmetric with the forwarding case, only responding (after a
3257 // delay) once they've send us a commitment_signed!
3258 PendingHTLCStatus::Forward(info)
3260 Err(InboundOnionErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3263 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
3264 match self.construct_fwd_pending_htlc_info(msg, next_hop_data, next_hop_hmac,
3265 new_packet_bytes, shared_secret, next_packet_pubkey_opt) {
3266 Ok(info) => PendingHTLCStatus::Forward(info),
3267 Err(InboundOnionErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3273 /// Gets the current [`channel_update`] for the given channel. This first checks if the channel is
3274 /// public, and thus should be called whenever the result is going to be passed out in a
3275 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
3277 /// Note that in [`internal_closing_signed`], this function is called without the `peer_state`
3278 /// corresponding to the channel's counterparty locked, as the channel been removed from the
3279 /// storage and the `peer_state` lock has been dropped.
3281 /// [`channel_update`]: msgs::ChannelUpdate
3282 /// [`internal_closing_signed`]: Self::internal_closing_signed
3283 fn get_channel_update_for_broadcast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3284 if !chan.context.should_announce() {
3285 return Err(LightningError {
3286 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
3287 action: msgs::ErrorAction::IgnoreError
3290 if chan.context.get_short_channel_id().is_none() {
3291 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
3293 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", &chan.context.channel_id());
3294 self.get_channel_update_for_unicast(chan)
3297 /// Gets the current [`channel_update`] for the given channel. This does not check if the channel
3298 /// is public (only returning an `Err` if the channel does not yet have an assigned SCID),
3299 /// and thus MUST NOT be called unless the recipient of the resulting message has already
3300 /// provided evidence that they know about the existence of the channel.
3302 /// Note that through [`internal_closing_signed`], this function is called without the
3303 /// `peer_state` corresponding to the channel's counterparty locked, as the channel been
3304 /// removed from the storage and the `peer_state` lock has been dropped.
3306 /// [`channel_update`]: msgs::ChannelUpdate
3307 /// [`internal_closing_signed`]: Self::internal_closing_signed
3308 fn get_channel_update_for_unicast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3309 log_trace!(self.logger, "Attempting to generate channel update for channel {}", &chan.context.channel_id());
3310 let short_channel_id = match chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias()) {
3311 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
3315 self.get_channel_update_for_onion(short_channel_id, chan)
3318 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3319 log_trace!(self.logger, "Generating channel update for channel {}", &chan.context.channel_id());
3320 let were_node_one = self.our_network_pubkey.serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
3322 let enabled = chan.context.is_usable() && match chan.channel_update_status() {
3323 ChannelUpdateStatus::Enabled => true,
3324 ChannelUpdateStatus::DisabledStaged(_) => true,
3325 ChannelUpdateStatus::Disabled => false,
3326 ChannelUpdateStatus::EnabledStaged(_) => false,
3329 let unsigned = msgs::UnsignedChannelUpdate {
3330 chain_hash: self.genesis_hash,
3332 timestamp: chan.context.get_update_time_counter(),
3333 flags: (!were_node_one) as u8 | ((!enabled as u8) << 1),
3334 cltv_expiry_delta: chan.context.get_cltv_expiry_delta(),
3335 htlc_minimum_msat: chan.context.get_counterparty_htlc_minimum_msat(),
3336 htlc_maximum_msat: chan.context.get_announced_htlc_max_msat(),
3337 fee_base_msat: chan.context.get_outbound_forwarding_fee_base_msat(),
3338 fee_proportional_millionths: chan.context.get_fee_proportional_millionths(),
3339 excess_data: Vec::new(),
3341 // Panic on failure to signal LDK should be restarted to retry signing the `ChannelUpdate`.
3342 // If we returned an error and the `node_signer` cannot provide a signature for whatever
3343 // reason`, we wouldn't be able to receive inbound payments through the corresponding
3345 let sig = self.node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelUpdate(&unsigned)).unwrap();
3347 Ok(msgs::ChannelUpdate {
3354 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> {
3355 let _lck = self.total_consistency_lock.read().unwrap();
3356 self.send_payment_along_path(SendAlongPathArgs {
3357 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3362 fn send_payment_along_path(&self, args: SendAlongPathArgs) -> Result<(), APIError> {
3363 let SendAlongPathArgs {
3364 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3367 // The top-level caller should hold the total_consistency_lock read lock.
3368 debug_assert!(self.total_consistency_lock.try_write().is_err());
3370 log_trace!(self.logger,
3371 "Attempting to send payment with payment hash {} along path with next hop {}",
3372 payment_hash, path.hops.first().unwrap().short_channel_id);
3373 let prng_seed = self.entropy_source.get_secure_random_bytes();
3374 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
3376 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
3377 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected".to_owned()})?;
3378 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, recipient_onion, cur_height, keysend_preimage)?;
3380 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash)
3381 .map_err(|_| APIError::InvalidRoute { err: "Route size too large considering onion data".to_owned()})?;
3383 let err: Result<(), _> = loop {
3384 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
3385 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
3386 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3389 let per_peer_state = self.per_peer_state.read().unwrap();
3390 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
3391 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
3392 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3393 let peer_state = &mut *peer_state_lock;
3394 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(id) {
3395 match chan_phase_entry.get_mut() {
3396 ChannelPhase::Funded(chan) => {
3397 if !chan.context.is_live() {
3398 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected".to_owned()});
3400 let funding_txo = chan.context.get_funding_txo().unwrap();
3401 let send_res = chan.send_htlc_and_commit(htlc_msat, payment_hash.clone(),
3402 htlc_cltv, HTLCSource::OutboundRoute {
3404 session_priv: session_priv.clone(),
3405 first_hop_htlc_msat: htlc_msat,
3407 }, onion_packet, None, &self.fee_estimator, &self.logger);
3408 match break_chan_phase_entry!(self, send_res, chan_phase_entry) {
3409 Some(monitor_update) => {
3410 match handle_new_monitor_update!(self, funding_txo, monitor_update, peer_state_lock, peer_state, per_peer_state, chan) {
3412 // Note that MonitorUpdateInProgress here indicates (per function
3413 // docs) that we will resend the commitment update once monitor
3414 // updating completes. Therefore, we must return an error
3415 // indicating that it is unsafe to retry the payment wholesale,
3416 // which we do in the send_payment check for
3417 // MonitorUpdateInProgress, below.
3418 return Err(APIError::MonitorUpdateInProgress);
3426 _ => return Err(APIError::ChannelUnavailable{err: "Channel to first hop is unfunded".to_owned()}),
3429 // The channel was likely removed after we fetched the id from the
3430 // `short_to_chan_info` map, but before we successfully locked the
3431 // `channel_by_id` map.
3432 // This can occur as no consistency guarantees exists between the two maps.
3433 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
3438 match handle_error!(self, err, path.hops.first().unwrap().pubkey) {
3439 Ok(_) => unreachable!(),
3441 Err(APIError::ChannelUnavailable { err: e.err })
3446 /// Sends a payment along a given route.
3448 /// Value parameters are provided via the last hop in route, see documentation for [`RouteHop`]
3449 /// fields for more info.
3451 /// May generate [`UpdateHTLCs`] message(s) event on success, which should be relayed (e.g. via
3452 /// [`PeerManager::process_events`]).
3454 /// # Avoiding Duplicate Payments
3456 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
3457 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
3458 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
3459 /// [`Event::PaymentSent`] or [`Event::PaymentFailed`]) LDK will not stop you from sending a
3460 /// second payment with the same [`PaymentId`].
3462 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
3463 /// tracking of payments, including state to indicate once a payment has completed. Because you
3464 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
3465 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
3466 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
3468 /// Additionally, in the scenario where we begin the process of sending a payment, but crash
3469 /// before `send_payment` returns (or prior to [`ChannelMonitorUpdate`] persistence if you're
3470 /// using [`ChannelMonitorUpdateStatus::InProgress`]), the payment may be lost on restart. See
3471 /// [`ChannelManager::list_recent_payments`] for more information.
3473 /// # Possible Error States on [`PaymentSendFailure`]
3475 /// Each path may have a different return value, and [`PaymentSendFailure`] may return a `Vec` with
3476 /// each entry matching the corresponding-index entry in the route paths, see
3477 /// [`PaymentSendFailure`] for more info.
3479 /// In general, a path may raise:
3480 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
3481 /// node public key) is specified.
3482 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available as it has been
3483 /// closed, doesn't exist, or the peer is currently disconnected.
3484 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
3485 /// relevant updates.
3487 /// Note that depending on the type of the [`PaymentSendFailure`] the HTLC may have been
3488 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
3489 /// different route unless you intend to pay twice!
3491 /// [`RouteHop`]: crate::routing::router::RouteHop
3492 /// [`Event::PaymentSent`]: events::Event::PaymentSent
3493 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
3494 /// [`UpdateHTLCs`]: events::MessageSendEvent::UpdateHTLCs
3495 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
3496 /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
3497 pub fn send_payment_with_route(&self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
3498 let best_block_height = self.best_block.read().unwrap().height();
3499 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3500 self.pending_outbound_payments
3501 .send_payment_with_route(route, payment_hash, recipient_onion, payment_id,
3502 &self.entropy_source, &self.node_signer, best_block_height,
3503 |args| self.send_payment_along_path(args))
3506 /// Similar to [`ChannelManager::send_payment_with_route`], but will automatically find a route based on
3507 /// `route_params` and retry failed payment paths based on `retry_strategy`.
3508 pub fn send_payment(&self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<(), RetryableSendFailure> {
3509 let best_block_height = self.best_block.read().unwrap().height();
3510 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3511 self.pending_outbound_payments
3512 .send_payment(payment_hash, recipient_onion, payment_id, retry_strategy, route_params,
3513 &self.router, self.list_usable_channels(), || self.compute_inflight_htlcs(),
3514 &self.entropy_source, &self.node_signer, best_block_height, &self.logger,
3515 &self.pending_events, |args| self.send_payment_along_path(args))
3519 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> {
3520 let best_block_height = self.best_block.read().unwrap().height();
3521 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3522 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, recipient_onion,
3523 keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.node_signer,
3524 best_block_height, |args| self.send_payment_along_path(args))
3528 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> {
3529 let best_block_height = self.best_block.read().unwrap().height();
3530 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, recipient_onion, payment_id, route, None, &self.entropy_source, best_block_height)
3534 pub(crate) fn test_set_payment_metadata(&self, payment_id: PaymentId, new_payment_metadata: Option<Vec<u8>>) {
3535 self.pending_outbound_payments.test_set_payment_metadata(payment_id, new_payment_metadata);
3539 /// Signals that no further attempts for the given payment should occur. Useful if you have a
3540 /// pending outbound payment with retries remaining, but wish to stop retrying the payment before
3541 /// retries are exhausted.
3543 /// # Event Generation
3545 /// If no [`Event::PaymentFailed`] event had been generated before, one will be generated as soon
3546 /// as there are no remaining pending HTLCs for this payment.
3548 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
3549 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
3550 /// determine the ultimate status of a payment.
3552 /// # Requested Invoices
3554 /// In the case of paying a [`Bolt12Invoice`], abandoning the payment prior to receiving the
3555 /// invoice will result in an [`Event::InvoiceRequestFailed`] and prevent any attempts at paying
3556 /// it once received. The other events may only be generated once the invoice has been received.
3558 /// # Restart Behavior
3560 /// If an [`Event::PaymentFailed`] is generated and we restart without first persisting the
3561 /// [`ChannelManager`], another [`Event::PaymentFailed`] may be generated; likewise for
3562 /// [`Event::InvoiceRequestFailed`].
3564 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
3565 pub fn abandon_payment(&self, payment_id: PaymentId) {
3566 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3567 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
3570 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
3571 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
3572 /// the preimage, it must be a cryptographically secure random value that no intermediate node
3573 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
3574 /// never reach the recipient.
3576 /// See [`send_payment`] documentation for more details on the return value of this function
3577 /// and idempotency guarantees provided by the [`PaymentId`] key.
3579 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
3580 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
3582 /// [`send_payment`]: Self::send_payment
3583 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
3584 let best_block_height = self.best_block.read().unwrap().height();
3585 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3586 self.pending_outbound_payments.send_spontaneous_payment_with_route(
3587 route, payment_preimage, recipient_onion, payment_id, &self.entropy_source,
3588 &self.node_signer, best_block_height, |args| self.send_payment_along_path(args))
3591 /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
3592 /// based on `route_params` and retry failed payment paths based on `retry_strategy`.
3594 /// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous
3597 /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
3598 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> {
3599 let best_block_height = self.best_block.read().unwrap().height();
3600 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3601 self.pending_outbound_payments.send_spontaneous_payment(payment_preimage, recipient_onion,
3602 payment_id, retry_strategy, route_params, &self.router, self.list_usable_channels(),
3603 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
3604 &self.logger, &self.pending_events, |args| self.send_payment_along_path(args))
3607 /// Send a payment that is probing the given route for liquidity. We calculate the
3608 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
3609 /// us to easily discern them from real payments.
3610 pub fn send_probe(&self, path: Path) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
3611 let best_block_height = self.best_block.read().unwrap().height();
3612 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3613 self.pending_outbound_payments.send_probe(path, self.probing_cookie_secret,
3614 &self.entropy_source, &self.node_signer, best_block_height,
3615 |args| self.send_payment_along_path(args))
3618 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
3621 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
3622 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
3625 /// Sends payment probes over all paths of a route that would be used to pay the given
3626 /// amount to the given `node_id`.
3628 /// See [`ChannelManager::send_preflight_probes`] for more information.
3629 pub fn send_spontaneous_preflight_probes(
3630 &self, node_id: PublicKey, amount_msat: u64, final_cltv_expiry_delta: u32,
3631 liquidity_limit_multiplier: Option<u64>,
3632 ) -> Result<Vec<(PaymentHash, PaymentId)>, ProbeSendFailure> {
3633 let payment_params =
3634 PaymentParameters::from_node_id(node_id, final_cltv_expiry_delta);
3636 let route_params = RouteParameters::from_payment_params_and_value(payment_params, amount_msat);
3638 self.send_preflight_probes(route_params, liquidity_limit_multiplier)
3641 /// Sends payment probes over all paths of a route that would be used to pay a route found
3642 /// according to the given [`RouteParameters`].
3644 /// This may be used to send "pre-flight" probes, i.e., to train our scorer before conducting
3645 /// the actual payment. Note this is only useful if there likely is sufficient time for the
3646 /// probe to settle before sending out the actual payment, e.g., when waiting for user
3647 /// confirmation in a wallet UI.
3649 /// Otherwise, there is a chance the probe could take up some liquidity needed to complete the
3650 /// actual payment. Users should therefore be cautious and might avoid sending probes if
3651 /// liquidity is scarce and/or they don't expect the probe to return before they send the
3652 /// payment. To mitigate this issue, channels with available liquidity less than the required
3653 /// amount times the given `liquidity_limit_multiplier` won't be used to send pre-flight
3654 /// probes. If `None` is given as `liquidity_limit_multiplier`, it defaults to `3`.
3655 pub fn send_preflight_probes(
3656 &self, route_params: RouteParameters, liquidity_limit_multiplier: Option<u64>,
3657 ) -> Result<Vec<(PaymentHash, PaymentId)>, ProbeSendFailure> {
3658 let liquidity_limit_multiplier = liquidity_limit_multiplier.unwrap_or(3);
3660 let payer = self.get_our_node_id();
3661 let usable_channels = self.list_usable_channels();
3662 let first_hops = usable_channels.iter().collect::<Vec<_>>();
3663 let inflight_htlcs = self.compute_inflight_htlcs();
3667 .find_route(&payer, &route_params, Some(&first_hops), inflight_htlcs)
3669 log_error!(self.logger, "Failed to find path for payment probe: {:?}", e);
3670 ProbeSendFailure::RouteNotFound
3673 let mut used_liquidity_map = HashMap::with_capacity(first_hops.len());
3675 let mut res = Vec::new();
3677 for mut path in route.paths {
3678 // If the last hop is probably an unannounced channel we refrain from probing all the
3679 // way through to the end and instead probe up to the second-to-last channel.
3680 while let Some(last_path_hop) = path.hops.last() {
3681 if last_path_hop.maybe_announced_channel {
3682 // We found a potentially announced last hop.
3685 // Drop the last hop, as it's likely unannounced.
3688 "Avoided sending payment probe all the way to last hop {} as it is likely unannounced.",
3689 last_path_hop.short_channel_id
3691 let final_value_msat = path.final_value_msat();
3693 if let Some(new_last) = path.hops.last_mut() {
3694 new_last.fee_msat += final_value_msat;
3699 if path.hops.len() < 2 {
3702 "Skipped sending payment probe over path with less than two hops."
3707 if let Some(first_path_hop) = path.hops.first() {
3708 if let Some(first_hop) = first_hops.iter().find(|h| {
3709 h.get_outbound_payment_scid() == Some(first_path_hop.short_channel_id)
3711 let path_value = path.final_value_msat() + path.fee_msat();
3712 let used_liquidity =
3713 used_liquidity_map.entry(first_path_hop.short_channel_id).or_insert(0);
3715 if first_hop.next_outbound_htlc_limit_msat
3716 < (*used_liquidity + path_value) * liquidity_limit_multiplier
3718 log_debug!(self.logger, "Skipped sending payment probe to avoid putting channel {} under the liquidity limit.", first_path_hop.short_channel_id);
3721 *used_liquidity += path_value;
3726 res.push(self.send_probe(path).map_err(|e| {
3727 log_error!(self.logger, "Failed to send pre-flight probe: {:?}", e);
3728 ProbeSendFailure::SendingFailed(e)
3735 /// Handles the generation of a funding transaction, optionally (for tests) with a function
3736 /// which checks the correctness of the funding transaction given the associated channel.
3737 fn funding_transaction_generated_intern<FundingOutput: FnMut(&OutboundV1Channel<SP>, &Transaction) -> Result<OutPoint, APIError>>(
3738 &self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, is_batch_funding: bool,
3739 mut find_funding_output: FundingOutput,
3740 ) -> Result<(), APIError> {
3741 let per_peer_state = self.per_peer_state.read().unwrap();
3742 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3743 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3745 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3746 let peer_state = &mut *peer_state_lock;
3747 let (chan, msg) = match peer_state.channel_by_id.remove(temporary_channel_id) {
3748 Some(ChannelPhase::UnfundedOutboundV1(chan)) => {
3749 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
3751 let funding_res = chan.get_funding_created(funding_transaction, funding_txo, is_batch_funding, &self.logger)
3752 .map_err(|(mut chan, e)| if let ChannelError::Close(msg) = e {
3753 let channel_id = chan.context.channel_id();
3754 let user_id = chan.context.get_user_id();
3755 let shutdown_res = chan.context.force_shutdown(false);
3756 let channel_capacity = chan.context.get_value_satoshis();
3757 (chan, MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, user_id, shutdown_res, None, channel_capacity))
3758 } else { unreachable!(); });
3760 Ok((chan, funding_msg)) => (chan, funding_msg),
3761 Err((chan, err)) => {
3762 mem::drop(peer_state_lock);
3763 mem::drop(per_peer_state);
3765 let _: Result<(), _> = handle_error!(self, Err(err), chan.context.get_counterparty_node_id());
3766 return Err(APIError::ChannelUnavailable {
3767 err: "Signer refused to sign the initial commitment transaction".to_owned()
3773 peer_state.channel_by_id.insert(*temporary_channel_id, phase);
3774 return Err(APIError::APIMisuseError {
3776 "Channel with id {} for the passed counterparty node_id {} is not an unfunded, outbound V1 channel",
3777 temporary_channel_id, counterparty_node_id),
3780 None => return Err(APIError::ChannelUnavailable {err: format!(
3781 "Channel with id {} not found for the passed counterparty node_id {}",
3782 temporary_channel_id, counterparty_node_id),
3786 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
3787 node_id: chan.context.get_counterparty_node_id(),
3790 match peer_state.channel_by_id.entry(chan.context.channel_id()) {
3791 hash_map::Entry::Occupied(_) => {
3792 panic!("Generated duplicate funding txid?");
3794 hash_map::Entry::Vacant(e) => {
3795 let mut id_to_peer = self.id_to_peer.lock().unwrap();
3796 if id_to_peer.insert(chan.context.channel_id(), chan.context.get_counterparty_node_id()).is_some() {
3797 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
3799 e.insert(ChannelPhase::Funded(chan));
3806 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
3807 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, false, |_, tx| {
3808 Ok(OutPoint { txid: tx.txid(), index: output_index })
3812 /// Call this upon creation of a funding transaction for the given channel.
3814 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
3815 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
3817 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
3818 /// across the p2p network.
3820 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
3821 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
3823 /// May panic if the output found in the funding transaction is duplicative with some other
3824 /// channel (note that this should be trivially prevented by using unique funding transaction
3825 /// keys per-channel).
3827 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
3828 /// counterparty's signature the funding transaction will automatically be broadcast via the
3829 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
3831 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
3832 /// not currently support replacing a funding transaction on an existing channel. Instead,
3833 /// create a new channel with a conflicting funding transaction.
3835 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
3836 /// the wallet software generating the funding transaction to apply anti-fee sniping as
3837 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
3838 /// for more details.
3840 /// [`Event::FundingGenerationReady`]: crate::events::Event::FundingGenerationReady
3841 /// [`Event::ChannelClosed`]: crate::events::Event::ChannelClosed
3842 pub fn funding_transaction_generated(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
3843 self.batch_funding_transaction_generated(&[(temporary_channel_id, counterparty_node_id)], funding_transaction)
3846 /// Call this upon creation of a batch funding transaction for the given channels.
3848 /// Return values are identical to [`Self::funding_transaction_generated`], respective to
3849 /// each individual channel and transaction output.
3851 /// Do NOT broadcast the funding transaction yourself. This batch funding transcaction
3852 /// will only be broadcast when we have safely received and persisted the counterparty's
3853 /// signature for each channel.
3855 /// If there is an error, all channels in the batch are to be considered closed.
3856 pub fn batch_funding_transaction_generated(&self, temporary_channels: &[(&ChannelId, &PublicKey)], funding_transaction: Transaction) -> Result<(), APIError> {
3857 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3858 let mut result = Ok(());
3860 if !funding_transaction.is_coin_base() {
3861 for inp in funding_transaction.input.iter() {
3862 if inp.witness.is_empty() {
3863 result = result.and(Err(APIError::APIMisuseError {
3864 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
3869 if funding_transaction.output.len() > u16::max_value() as usize {
3870 result = result.and(Err(APIError::APIMisuseError {
3871 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
3875 let height = self.best_block.read().unwrap().height();
3876 // Transactions are evaluated as final by network mempools if their locktime is strictly
3877 // lower than the next block height. However, the modules constituting our Lightning
3878 // node might not have perfect sync about their blockchain views. Thus, if the wallet
3879 // module is ahead of LDK, only allow one more block of headroom.
3880 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 {
3881 result = result.and(Err(APIError::APIMisuseError {
3882 err: "Funding transaction absolute timelock is non-final".to_owned()
3887 let txid = funding_transaction.txid();
3888 let is_batch_funding = temporary_channels.len() > 1;
3889 let mut funding_batch_states = if is_batch_funding {
3890 Some(self.funding_batch_states.lock().unwrap())
3894 let mut funding_batch_state = funding_batch_states.as_mut().and_then(|states| {
3895 match states.entry(txid) {
3896 btree_map::Entry::Occupied(_) => {
3897 result = result.clone().and(Err(APIError::APIMisuseError {
3898 err: "Batch funding transaction with the same txid already exists".to_owned()
3902 btree_map::Entry::Vacant(vacant) => Some(vacant.insert(Vec::new())),
3905 for (channel_idx, &(temporary_channel_id, counterparty_node_id)) in temporary_channels.iter().enumerate() {
3906 result = result.and_then(|_| self.funding_transaction_generated_intern(
3907 temporary_channel_id,
3908 counterparty_node_id,
3909 funding_transaction.clone(),
3912 let mut output_index = None;
3913 let expected_spk = chan.context.get_funding_redeemscript().to_v0_p2wsh();
3914 for (idx, outp) in tx.output.iter().enumerate() {
3915 if outp.script_pubkey == expected_spk && outp.value == chan.context.get_value_satoshis() {
3916 if output_index.is_some() {
3917 return Err(APIError::APIMisuseError {
3918 err: "Multiple outputs matched the expected script and value".to_owned()
3921 output_index = Some(idx as u16);
3924 if output_index.is_none() {
3925 return Err(APIError::APIMisuseError {
3926 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
3929 let outpoint = OutPoint { txid: tx.txid(), index: output_index.unwrap() };
3930 if let Some(funding_batch_state) = funding_batch_state.as_mut() {
3931 funding_batch_state.push((outpoint.to_channel_id(), *counterparty_node_id, false));
3937 if let Err(ref e) = result {
3938 // Remaining channels need to be removed on any error.
3939 let e = format!("Error in transaction funding: {:?}", e);
3940 let mut channels_to_remove = Vec::new();
3941 channels_to_remove.extend(funding_batch_states.as_mut()
3942 .and_then(|states| states.remove(&txid))
3943 .into_iter().flatten()
3944 .map(|(chan_id, node_id, _state)| (chan_id, node_id))
3946 channels_to_remove.extend(temporary_channels.iter()
3947 .map(|(&chan_id, &node_id)| (chan_id, node_id))
3949 let mut shutdown_results = Vec::new();
3951 let per_peer_state = self.per_peer_state.read().unwrap();
3952 for (channel_id, counterparty_node_id) in channels_to_remove {
3953 per_peer_state.get(&counterparty_node_id)
3954 .map(|peer_state_mutex| peer_state_mutex.lock().unwrap())
3955 .and_then(|mut peer_state| peer_state.channel_by_id.remove(&channel_id))
3957 update_maps_on_chan_removal!(self, &chan.context());
3958 self.issue_channel_close_events(&chan.context(), ClosureReason::ProcessingError { err: e.clone() });
3959 shutdown_results.push(chan.context_mut().force_shutdown(false));
3963 for shutdown_result in shutdown_results.drain(..) {
3964 self.finish_close_channel(shutdown_result);
3970 /// Atomically applies partial updates to the [`ChannelConfig`] of the given channels.
3972 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3973 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3974 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3975 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3977 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3978 /// `counterparty_node_id` is provided.
3980 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3981 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3983 /// If an error is returned, none of the updates should be considered applied.
3985 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3986 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3987 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3988 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3989 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3990 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3991 /// [`APIMisuseError`]: APIError::APIMisuseError
3992 pub fn update_partial_channel_config(
3993 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config_update: &ChannelConfigUpdate,
3994 ) -> Result<(), APIError> {
3995 if config_update.cltv_expiry_delta.map(|delta| delta < MIN_CLTV_EXPIRY_DELTA).unwrap_or(false) {
3996 return Err(APIError::APIMisuseError {
3997 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
4001 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4002 let per_peer_state = self.per_peer_state.read().unwrap();
4003 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4004 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
4005 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4006 let peer_state = &mut *peer_state_lock;
4007 for channel_id in channel_ids {
4008 if !peer_state.has_channel(channel_id) {
4009 return Err(APIError::ChannelUnavailable {
4010 err: format!("Channel with ID {} was not found for the passed counterparty_node_id {}", channel_id, counterparty_node_id),
4014 for channel_id in channel_ids {
4015 if let Some(channel_phase) = peer_state.channel_by_id.get_mut(channel_id) {
4016 let mut config = channel_phase.context().config();
4017 config.apply(config_update);
4018 if !channel_phase.context_mut().update_config(&config) {
4021 if let ChannelPhase::Funded(channel) = channel_phase {
4022 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
4023 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
4024 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
4025 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4026 node_id: channel.context.get_counterparty_node_id(),
4033 // This should not be reachable as we've already checked for non-existence in the previous channel_id loop.
4034 debug_assert!(false);
4035 return Err(APIError::ChannelUnavailable {
4037 "Channel with ID {} for passed counterparty_node_id {} disappeared after we confirmed its existence - this should not be reachable!",
4038 channel_id, counterparty_node_id),
4045 /// Atomically updates the [`ChannelConfig`] for the given channels.
4047 /// Once the updates are applied, each eligible channel (advertised with a known short channel
4048 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
4049 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
4050 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
4052 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
4053 /// `counterparty_node_id` is provided.
4055 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
4056 /// below [`MIN_CLTV_EXPIRY_DELTA`].
4058 /// If an error is returned, none of the updates should be considered applied.
4060 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
4061 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
4062 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
4063 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
4064 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4065 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
4066 /// [`APIMisuseError`]: APIError::APIMisuseError
4067 pub fn update_channel_config(
4068 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config: &ChannelConfig,
4069 ) -> Result<(), APIError> {
4070 return self.update_partial_channel_config(counterparty_node_id, channel_ids, &(*config).into());
4073 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
4074 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
4076 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
4077 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
4079 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
4080 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
4081 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
4082 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
4083 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
4085 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
4086 /// you from forwarding more than you received. See
4087 /// [`HTLCIntercepted::expected_outbound_amount_msat`] for more on forwarding a different amount
4090 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
4093 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
4094 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
4095 /// [`HTLCIntercepted::expected_outbound_amount_msat`]: events::Event::HTLCIntercepted::expected_outbound_amount_msat
4096 // TODO: when we move to deciding the best outbound channel at forward time, only take
4097 // `next_node_id` and not `next_hop_channel_id`
4098 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> {
4099 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4101 let next_hop_scid = {
4102 let peer_state_lock = self.per_peer_state.read().unwrap();
4103 let peer_state_mutex = peer_state_lock.get(&next_node_id)
4104 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) })?;
4105 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4106 let peer_state = &mut *peer_state_lock;
4107 match peer_state.channel_by_id.get(next_hop_channel_id) {
4108 Some(ChannelPhase::Funded(chan)) => {
4109 if !chan.context.is_usable() {
4110 return Err(APIError::ChannelUnavailable {
4111 err: format!("Channel with id {} not fully established", next_hop_channel_id)
4114 chan.context.get_short_channel_id().unwrap_or(chan.context.outbound_scid_alias())
4116 Some(_) => return Err(APIError::ChannelUnavailable {
4117 err: format!("Channel with id {} for the passed counterparty node_id {} is still opening.",
4118 next_hop_channel_id, next_node_id)
4120 None => return Err(APIError::ChannelUnavailable {
4121 err: format!("Channel with id {} not found for the passed counterparty node_id {}.",
4122 next_hop_channel_id, next_node_id)
4127 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
4128 .ok_or_else(|| APIError::APIMisuseError {
4129 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
4132 let routing = match payment.forward_info.routing {
4133 PendingHTLCRouting::Forward { onion_packet, .. } => {
4134 PendingHTLCRouting::Forward { onion_packet, short_channel_id: next_hop_scid }
4136 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
4138 let skimmed_fee_msat =
4139 payment.forward_info.outgoing_amt_msat.saturating_sub(amt_to_forward_msat);
4140 let pending_htlc_info = PendingHTLCInfo {
4141 skimmed_fee_msat: if skimmed_fee_msat == 0 { None } else { Some(skimmed_fee_msat) },
4142 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
4145 let mut per_source_pending_forward = [(
4146 payment.prev_short_channel_id,
4147 payment.prev_funding_outpoint,
4148 payment.prev_user_channel_id,
4149 vec![(pending_htlc_info, payment.prev_htlc_id)]
4151 self.forward_htlcs(&mut per_source_pending_forward);
4155 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
4156 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
4158 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
4161 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
4162 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
4163 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4165 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
4166 .ok_or_else(|| APIError::APIMisuseError {
4167 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
4170 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
4171 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4172 short_channel_id: payment.prev_short_channel_id,
4173 user_channel_id: Some(payment.prev_user_channel_id),
4174 outpoint: payment.prev_funding_outpoint,
4175 htlc_id: payment.prev_htlc_id,
4176 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
4177 phantom_shared_secret: None,
4180 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
4181 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
4182 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
4183 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
4188 /// Processes HTLCs which are pending waiting on random forward delay.
4190 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
4191 /// Will likely generate further events.
4192 pub fn process_pending_htlc_forwards(&self) {
4193 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4195 let mut new_events = VecDeque::new();
4196 let mut failed_forwards = Vec::new();
4197 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
4199 let mut forward_htlcs = HashMap::new();
4200 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
4202 for (short_chan_id, mut pending_forwards) in forward_htlcs {
4203 if short_chan_id != 0 {
4204 macro_rules! forwarding_channel_not_found {
4206 for forward_info in pending_forwards.drain(..) {
4207 match forward_info {
4208 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4209 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4210 forward_info: PendingHTLCInfo {
4211 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
4212 outgoing_cltv_value, ..
4215 macro_rules! failure_handler {
4216 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
4217 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
4219 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4220 short_channel_id: prev_short_channel_id,
4221 user_channel_id: Some(prev_user_channel_id),
4222 outpoint: prev_funding_outpoint,
4223 htlc_id: prev_htlc_id,
4224 incoming_packet_shared_secret: incoming_shared_secret,
4225 phantom_shared_secret: $phantom_ss,
4228 let reason = if $next_hop_unknown {
4229 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
4231 HTLCDestination::FailedPayment{ payment_hash }
4234 failed_forwards.push((htlc_source, payment_hash,
4235 HTLCFailReason::reason($err_code, $err_data),
4241 macro_rules! fail_forward {
4242 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
4244 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
4248 macro_rules! failed_payment {
4249 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
4251 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
4255 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
4256 let phantom_pubkey_res = self.node_signer.get_node_id(Recipient::PhantomNode);
4257 if phantom_pubkey_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.genesis_hash) {
4258 let phantom_shared_secret = self.node_signer.ecdh(Recipient::PhantomNode, &onion_packet.public_key.unwrap(), None).unwrap().secret_bytes();
4259 let next_hop = match onion_utils::decode_next_payment_hop(
4260 phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac,
4261 payment_hash, &self.node_signer
4264 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
4265 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
4266 // In this scenario, the phantom would have sent us an
4267 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
4268 // if it came from us (the second-to-last hop) but contains the sha256
4270 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
4272 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
4273 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
4277 onion_utils::Hop::Receive(hop_data) => {
4278 match self.construct_recv_pending_htlc_info(hop_data,
4279 incoming_shared_secret, payment_hash, outgoing_amt_msat,
4280 outgoing_cltv_value, Some(phantom_shared_secret), false, None)
4282 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
4283 Err(InboundOnionErr { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
4289 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
4292 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
4295 HTLCForwardInfo::FailHTLC { .. } => {
4296 // Channel went away before we could fail it. This implies
4297 // the channel is now on chain and our counterparty is
4298 // trying to broadcast the HTLC-Timeout, but that's their
4299 // problem, not ours.
4305 let (counterparty_node_id, forward_chan_id) = match self.short_to_chan_info.read().unwrap().get(&short_chan_id) {
4306 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
4308 forwarding_channel_not_found!();
4312 let per_peer_state = self.per_peer_state.read().unwrap();
4313 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
4314 if peer_state_mutex_opt.is_none() {
4315 forwarding_channel_not_found!();
4318 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4319 let peer_state = &mut *peer_state_lock;
4320 if let Some(ChannelPhase::Funded(ref mut chan)) = peer_state.channel_by_id.get_mut(&forward_chan_id) {
4321 for forward_info in pending_forwards.drain(..) {
4322 match forward_info {
4323 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4324 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4325 forward_info: PendingHTLCInfo {
4326 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
4327 routing: PendingHTLCRouting::Forward { onion_packet, .. }, skimmed_fee_msat, ..
4330 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);
4331 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4332 short_channel_id: prev_short_channel_id,
4333 user_channel_id: Some(prev_user_channel_id),
4334 outpoint: prev_funding_outpoint,
4335 htlc_id: prev_htlc_id,
4336 incoming_packet_shared_secret: incoming_shared_secret,
4337 // Phantom payments are only PendingHTLCRouting::Receive.
4338 phantom_shared_secret: None,
4340 if let Err(e) = chan.queue_add_htlc(outgoing_amt_msat,
4341 payment_hash, outgoing_cltv_value, htlc_source.clone(),
4342 onion_packet, skimmed_fee_msat, &self.fee_estimator,
4345 if let ChannelError::Ignore(msg) = e {
4346 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", &payment_hash, msg);
4348 panic!("Stated return value requirements in send_htlc() were not met");
4350 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan);
4351 failed_forwards.push((htlc_source, payment_hash,
4352 HTLCFailReason::reason(failure_code, data),
4353 HTLCDestination::NextHopChannel { node_id: Some(chan.context.get_counterparty_node_id()), channel_id: forward_chan_id }
4358 HTLCForwardInfo::AddHTLC { .. } => {
4359 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
4361 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
4362 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
4363 if let Err(e) = chan.queue_fail_htlc(
4364 htlc_id, err_packet, &self.logger
4366 if let ChannelError::Ignore(msg) = e {
4367 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
4369 panic!("Stated return value requirements in queue_fail_htlc() were not met");
4371 // fail-backs are best-effort, we probably already have one
4372 // pending, and if not that's OK, if not, the channel is on
4373 // the chain and sending the HTLC-Timeout is their problem.
4380 forwarding_channel_not_found!();
4384 'next_forwardable_htlc: for forward_info in pending_forwards.drain(..) {
4385 match forward_info {
4386 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4387 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4388 forward_info: PendingHTLCInfo {
4389 routing, incoming_shared_secret, payment_hash, incoming_amt_msat, outgoing_amt_msat,
4390 skimmed_fee_msat, ..
4393 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret, mut onion_fields) = match routing {
4394 PendingHTLCRouting::Receive { payment_data, payment_metadata, incoming_cltv_expiry, phantom_shared_secret, custom_tlvs } => {
4395 let _legacy_hop_data = Some(payment_data.clone());
4396 let onion_fields = RecipientOnionFields { payment_secret: Some(payment_data.payment_secret),
4397 payment_metadata, custom_tlvs };
4398 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data },
4399 Some(payment_data), phantom_shared_secret, onion_fields)
4401 PendingHTLCRouting::ReceiveKeysend { payment_data, payment_preimage, payment_metadata, incoming_cltv_expiry, custom_tlvs } => {
4402 let onion_fields = RecipientOnionFields {
4403 payment_secret: payment_data.as_ref().map(|data| data.payment_secret),
4407 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage),
4408 payment_data, None, onion_fields)
4411 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
4414 let claimable_htlc = ClaimableHTLC {
4415 prev_hop: HTLCPreviousHopData {
4416 short_channel_id: prev_short_channel_id,
4417 user_channel_id: Some(prev_user_channel_id),
4418 outpoint: prev_funding_outpoint,
4419 htlc_id: prev_htlc_id,
4420 incoming_packet_shared_secret: incoming_shared_secret,
4421 phantom_shared_secret,
4423 // We differentiate the received value from the sender intended value
4424 // if possible so that we don't prematurely mark MPP payments complete
4425 // if routing nodes overpay
4426 value: incoming_amt_msat.unwrap_or(outgoing_amt_msat),
4427 sender_intended_value: outgoing_amt_msat,
4429 total_value_received: None,
4430 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
4433 counterparty_skimmed_fee_msat: skimmed_fee_msat,
4436 let mut committed_to_claimable = false;
4438 macro_rules! fail_htlc {
4439 ($htlc: expr, $payment_hash: expr) => {
4440 debug_assert!(!committed_to_claimable);
4441 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
4442 htlc_msat_height_data.extend_from_slice(
4443 &self.best_block.read().unwrap().height().to_be_bytes(),
4445 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
4446 short_channel_id: $htlc.prev_hop.short_channel_id,
4447 user_channel_id: $htlc.prev_hop.user_channel_id,
4448 outpoint: prev_funding_outpoint,
4449 htlc_id: $htlc.prev_hop.htlc_id,
4450 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
4451 phantom_shared_secret,
4453 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
4454 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
4456 continue 'next_forwardable_htlc;
4459 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
4460 let mut receiver_node_id = self.our_network_pubkey;
4461 if phantom_shared_secret.is_some() {
4462 receiver_node_id = self.node_signer.get_node_id(Recipient::PhantomNode)
4463 .expect("Failed to get node_id for phantom node recipient");
4466 macro_rules! check_total_value {
4467 ($purpose: expr) => {{
4468 let mut payment_claimable_generated = false;
4469 let is_keysend = match $purpose {
4470 events::PaymentPurpose::SpontaneousPayment(_) => true,
4471 events::PaymentPurpose::InvoicePayment { .. } => false,
4473 let mut claimable_payments = self.claimable_payments.lock().unwrap();
4474 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
4475 fail_htlc!(claimable_htlc, payment_hash);
4477 let ref mut claimable_payment = claimable_payments.claimable_payments
4478 .entry(payment_hash)
4479 // Note that if we insert here we MUST NOT fail_htlc!()
4480 .or_insert_with(|| {
4481 committed_to_claimable = true;
4483 purpose: $purpose.clone(), htlcs: Vec::new(), onion_fields: None,
4486 if $purpose != claimable_payment.purpose {
4487 let log_keysend = |keysend| if keysend { "keysend" } else { "non-keysend" };
4488 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));
4489 fail_htlc!(claimable_htlc, payment_hash);
4491 if !self.default_configuration.accept_mpp_keysend && is_keysend && !claimable_payment.htlcs.is_empty() {
4492 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);
4493 fail_htlc!(claimable_htlc, payment_hash);
4495 if let Some(earlier_fields) = &mut claimable_payment.onion_fields {
4496 if earlier_fields.check_merge(&mut onion_fields).is_err() {
4497 fail_htlc!(claimable_htlc, payment_hash);
4500 claimable_payment.onion_fields = Some(onion_fields);
4502 let ref mut htlcs = &mut claimable_payment.htlcs;
4503 let mut total_value = claimable_htlc.sender_intended_value;
4504 let mut earliest_expiry = claimable_htlc.cltv_expiry;
4505 for htlc in htlcs.iter() {
4506 total_value += htlc.sender_intended_value;
4507 earliest_expiry = cmp::min(earliest_expiry, htlc.cltv_expiry);
4508 if htlc.total_msat != claimable_htlc.total_msat {
4509 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
4510 &payment_hash, claimable_htlc.total_msat, htlc.total_msat);
4511 total_value = msgs::MAX_VALUE_MSAT;
4513 if total_value >= msgs::MAX_VALUE_MSAT { break; }
4515 // The condition determining whether an MPP is complete must
4516 // match exactly the condition used in `timer_tick_occurred`
4517 if total_value >= msgs::MAX_VALUE_MSAT {
4518 fail_htlc!(claimable_htlc, payment_hash);
4519 } else if total_value - claimable_htlc.sender_intended_value >= claimable_htlc.total_msat {
4520 log_trace!(self.logger, "Failing HTLC with payment_hash {} as payment is already claimable",
4522 fail_htlc!(claimable_htlc, payment_hash);
4523 } else if total_value >= claimable_htlc.total_msat {
4524 #[allow(unused_assignments)] {
4525 committed_to_claimable = true;
4527 let prev_channel_id = prev_funding_outpoint.to_channel_id();
4528 htlcs.push(claimable_htlc);
4529 let amount_msat = htlcs.iter().map(|htlc| htlc.value).sum();
4530 htlcs.iter_mut().for_each(|htlc| htlc.total_value_received = Some(amount_msat));
4531 let counterparty_skimmed_fee_msat = htlcs.iter()
4532 .map(|htlc| htlc.counterparty_skimmed_fee_msat.unwrap_or(0)).sum();
4533 debug_assert!(total_value.saturating_sub(amount_msat) <=
4534 counterparty_skimmed_fee_msat);
4535 new_events.push_back((events::Event::PaymentClaimable {
4536 receiver_node_id: Some(receiver_node_id),
4540 counterparty_skimmed_fee_msat,
4541 via_channel_id: Some(prev_channel_id),
4542 via_user_channel_id: Some(prev_user_channel_id),
4543 claim_deadline: Some(earliest_expiry - HTLC_FAIL_BACK_BUFFER),
4544 onion_fields: claimable_payment.onion_fields.clone(),
4546 payment_claimable_generated = true;
4548 // Nothing to do - we haven't reached the total
4549 // payment value yet, wait until we receive more
4551 htlcs.push(claimable_htlc);
4552 #[allow(unused_assignments)] {
4553 committed_to_claimable = true;
4556 payment_claimable_generated
4560 // Check that the payment hash and secret are known. Note that we
4561 // MUST take care to handle the "unknown payment hash" and
4562 // "incorrect payment secret" cases here identically or we'd expose
4563 // that we are the ultimate recipient of the given payment hash.
4564 // Further, we must not expose whether we have any other HTLCs
4565 // associated with the same payment_hash pending or not.
4566 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4567 match payment_secrets.entry(payment_hash) {
4568 hash_map::Entry::Vacant(_) => {
4569 match claimable_htlc.onion_payload {
4570 OnionPayload::Invoice { .. } => {
4571 let payment_data = payment_data.unwrap();
4572 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) {
4573 Ok(result) => result,
4575 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as payment verification failed", &payment_hash);
4576 fail_htlc!(claimable_htlc, payment_hash);
4579 if let Some(min_final_cltv_expiry_delta) = min_final_cltv_expiry_delta {
4580 let expected_min_expiry_height = (self.current_best_block().height() + min_final_cltv_expiry_delta as u32) as u64;
4581 if (cltv_expiry as u64) < expected_min_expiry_height {
4582 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as its CLTV expiry was too soon (had {}, earliest expected {})",
4583 &payment_hash, cltv_expiry, expected_min_expiry_height);
4584 fail_htlc!(claimable_htlc, payment_hash);
4587 let purpose = events::PaymentPurpose::InvoicePayment {
4588 payment_preimage: payment_preimage.clone(),
4589 payment_secret: payment_data.payment_secret,
4591 check_total_value!(purpose);
4593 OnionPayload::Spontaneous(preimage) => {
4594 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
4595 check_total_value!(purpose);
4599 hash_map::Entry::Occupied(inbound_payment) => {
4600 if let OnionPayload::Spontaneous(_) = claimable_htlc.onion_payload {
4601 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);
4602 fail_htlc!(claimable_htlc, payment_hash);
4604 let payment_data = payment_data.unwrap();
4605 if inbound_payment.get().payment_secret != payment_data.payment_secret {
4606 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", &payment_hash);
4607 fail_htlc!(claimable_htlc, payment_hash);
4608 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
4609 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
4610 &payment_hash, payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
4611 fail_htlc!(claimable_htlc, payment_hash);
4613 let purpose = events::PaymentPurpose::InvoicePayment {
4614 payment_preimage: inbound_payment.get().payment_preimage,
4615 payment_secret: payment_data.payment_secret,
4617 let payment_claimable_generated = check_total_value!(purpose);
4618 if payment_claimable_generated {
4619 inbound_payment.remove_entry();
4625 HTLCForwardInfo::FailHTLC { .. } => {
4626 panic!("Got pending fail of our own HTLC");
4634 let best_block_height = self.best_block.read().unwrap().height();
4635 self.pending_outbound_payments.check_retry_payments(&self.router, || self.list_usable_channels(),
4636 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
4637 &self.pending_events, &self.logger, |args| self.send_payment_along_path(args));
4639 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
4640 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4642 self.forward_htlcs(&mut phantom_receives);
4644 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
4645 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
4646 // nice to do the work now if we can rather than while we're trying to get messages in the
4648 self.check_free_holding_cells();
4650 if new_events.is_empty() { return }
4651 let mut events = self.pending_events.lock().unwrap();
4652 events.append(&mut new_events);
4655 /// Free the background events, generally called from [`PersistenceNotifierGuard`] constructors.
4657 /// Expects the caller to have a total_consistency_lock read lock.
4658 fn process_background_events(&self) -> NotifyOption {
4659 debug_assert_ne!(self.total_consistency_lock.held_by_thread(), LockHeldState::NotHeldByThread);
4661 self.background_events_processed_since_startup.store(true, Ordering::Release);
4663 let mut background_events = Vec::new();
4664 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
4665 if background_events.is_empty() {
4666 return NotifyOption::SkipPersistNoEvents;
4669 for event in background_events.drain(..) {
4671 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((funding_txo, update)) => {
4672 // The channel has already been closed, so no use bothering to care about the
4673 // monitor updating completing.
4674 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4676 BackgroundEvent::MonitorUpdateRegeneratedOnStartup { counterparty_node_id, funding_txo, update } => {
4677 let mut updated_chan = false;
4679 let per_peer_state = self.per_peer_state.read().unwrap();
4680 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4681 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4682 let peer_state = &mut *peer_state_lock;
4683 match peer_state.channel_by_id.entry(funding_txo.to_channel_id()) {
4684 hash_map::Entry::Occupied(mut chan_phase) => {
4685 if let ChannelPhase::Funded(chan) = chan_phase.get_mut() {
4686 updated_chan = true;
4687 handle_new_monitor_update!(self, funding_txo, update.clone(),
4688 peer_state_lock, peer_state, per_peer_state, chan);
4690 debug_assert!(false, "We shouldn't have an update for a non-funded channel");
4693 hash_map::Entry::Vacant(_) => {},
4698 // TODO: Track this as in-flight even though the channel is closed.
4699 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4702 BackgroundEvent::MonitorUpdatesComplete { counterparty_node_id, channel_id } => {
4703 let per_peer_state = self.per_peer_state.read().unwrap();
4704 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4705 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4706 let peer_state = &mut *peer_state_lock;
4707 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
4708 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, chan);
4710 let update_actions = peer_state.monitor_update_blocked_actions
4711 .remove(&channel_id).unwrap_or(Vec::new());
4712 mem::drop(peer_state_lock);
4713 mem::drop(per_peer_state);
4714 self.handle_monitor_update_completion_actions(update_actions);
4720 NotifyOption::DoPersist
4723 #[cfg(any(test, feature = "_test_utils"))]
4724 /// Process background events, for functional testing
4725 pub fn test_process_background_events(&self) {
4726 let _lck = self.total_consistency_lock.read().unwrap();
4727 let _ = self.process_background_events();
4730 fn update_channel_fee(&self, chan_id: &ChannelId, chan: &mut Channel<SP>, new_feerate: u32) -> NotifyOption {
4731 if !chan.context.is_outbound() { return NotifyOption::SkipPersistNoEvents; }
4732 // If the feerate has decreased by less than half, don't bother
4733 if new_feerate <= chan.context.get_feerate_sat_per_1000_weight() && new_feerate * 2 > chan.context.get_feerate_sat_per_1000_weight() {
4734 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
4735 chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4736 return NotifyOption::SkipPersistNoEvents;
4738 if !chan.context.is_live() {
4739 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).",
4740 chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4741 return NotifyOption::SkipPersistNoEvents;
4743 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
4744 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4746 chan.queue_update_fee(new_feerate, &self.fee_estimator, &self.logger);
4747 NotifyOption::DoPersist
4751 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
4752 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
4753 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
4754 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
4755 pub fn maybe_update_chan_fees(&self) {
4756 PersistenceNotifierGuard::optionally_notify(self, || {
4757 let mut should_persist = NotifyOption::SkipPersistNoEvents;
4759 let normal_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4760 let min_mempool_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::MempoolMinimum);
4762 let per_peer_state = self.per_peer_state.read().unwrap();
4763 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
4764 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4765 let peer_state = &mut *peer_state_lock;
4766 for (chan_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
4767 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
4769 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4774 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4775 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4783 /// Performs actions which should happen on startup and roughly once per minute thereafter.
4785 /// This currently includes:
4786 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
4787 /// * Broadcasting [`ChannelUpdate`] messages if we've been disconnected from our peer for more
4788 /// than a minute, informing the network that they should no longer attempt to route over
4790 /// * Expiring a channel's previous [`ChannelConfig`] if necessary to only allow forwarding HTLCs
4791 /// with the current [`ChannelConfig`].
4792 /// * Removing peers which have disconnected but and no longer have any channels.
4793 /// * Force-closing and removing channels which have not completed establishment in a timely manner.
4795 /// Note that this may cause reentrancy through [`chain::Watch::update_channel`] calls or feerate
4796 /// estimate fetches.
4798 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4799 /// [`ChannelConfig`]: crate::util::config::ChannelConfig
4800 pub fn timer_tick_occurred(&self) {
4801 PersistenceNotifierGuard::optionally_notify(self, || {
4802 let mut should_persist = NotifyOption::SkipPersistNoEvents;
4804 let normal_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4805 let min_mempool_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::MempoolMinimum);
4807 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
4808 let mut timed_out_mpp_htlcs = Vec::new();
4809 let mut pending_peers_awaiting_removal = Vec::new();
4810 let mut shutdown_channels = Vec::new();
4812 let mut process_unfunded_channel_tick = |
4813 chan_id: &ChannelId,
4814 context: &mut ChannelContext<SP>,
4815 unfunded_context: &mut UnfundedChannelContext,
4816 pending_msg_events: &mut Vec<MessageSendEvent>,
4817 counterparty_node_id: PublicKey,
4819 context.maybe_expire_prev_config();
4820 if unfunded_context.should_expire_unfunded_channel() {
4821 log_error!(self.logger,
4822 "Force-closing pending channel with ID {} for not establishing in a timely manner", chan_id);
4823 update_maps_on_chan_removal!(self, &context);
4824 self.issue_channel_close_events(&context, ClosureReason::HolderForceClosed);
4825 shutdown_channels.push(context.force_shutdown(false));
4826 pending_msg_events.push(MessageSendEvent::HandleError {
4827 node_id: counterparty_node_id,
4828 action: msgs::ErrorAction::SendErrorMessage {
4829 msg: msgs::ErrorMessage {
4830 channel_id: *chan_id,
4831 data: "Force-closing pending channel due to timeout awaiting establishment handshake".to_owned(),
4842 let per_peer_state = self.per_peer_state.read().unwrap();
4843 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
4844 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4845 let peer_state = &mut *peer_state_lock;
4846 let pending_msg_events = &mut peer_state.pending_msg_events;
4847 let counterparty_node_id = *counterparty_node_id;
4848 peer_state.channel_by_id.retain(|chan_id, phase| {
4850 ChannelPhase::Funded(chan) => {
4851 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4856 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4857 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4859 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
4860 let (needs_close, err) = convert_chan_phase_err!(self, e, chan, chan_id, FUNDED_CHANNEL);
4861 handle_errors.push((Err(err), counterparty_node_id));
4862 if needs_close { return false; }
4865 match chan.channel_update_status() {
4866 ChannelUpdateStatus::Enabled if !chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(0)),
4867 ChannelUpdateStatus::Disabled if chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(0)),
4868 ChannelUpdateStatus::DisabledStaged(_) if chan.context.is_live()
4869 => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
4870 ChannelUpdateStatus::EnabledStaged(_) if !chan.context.is_live()
4871 => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
4872 ChannelUpdateStatus::DisabledStaged(mut n) if !chan.context.is_live() => {
4874 if n >= DISABLE_GOSSIP_TICKS {
4875 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
4876 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4877 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4881 should_persist = NotifyOption::DoPersist;
4883 chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(n));
4886 ChannelUpdateStatus::EnabledStaged(mut n) if chan.context.is_live() => {
4888 if n >= ENABLE_GOSSIP_TICKS {
4889 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
4890 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4891 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4895 should_persist = NotifyOption::DoPersist;
4897 chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(n));
4903 chan.context.maybe_expire_prev_config();
4905 if chan.should_disconnect_peer_awaiting_response() {
4906 log_debug!(self.logger, "Disconnecting peer {} due to not making any progress on channel {}",
4907 counterparty_node_id, chan_id);
4908 pending_msg_events.push(MessageSendEvent::HandleError {
4909 node_id: counterparty_node_id,
4910 action: msgs::ErrorAction::DisconnectPeerWithWarning {
4911 msg: msgs::WarningMessage {
4912 channel_id: *chan_id,
4913 data: "Disconnecting due to timeout awaiting response".to_owned(),
4921 ChannelPhase::UnfundedInboundV1(chan) => {
4922 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
4923 pending_msg_events, counterparty_node_id)
4925 ChannelPhase::UnfundedOutboundV1(chan) => {
4926 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
4927 pending_msg_events, counterparty_node_id)
4932 for (chan_id, req) in peer_state.inbound_channel_request_by_id.iter_mut() {
4933 if { req.ticks_remaining -= 1 ; req.ticks_remaining } <= 0 {
4934 log_error!(self.logger, "Force-closing unaccepted inbound channel {} for not accepting in a timely manner", &chan_id);
4935 peer_state.pending_msg_events.push(
4936 events::MessageSendEvent::HandleError {
4937 node_id: counterparty_node_id,
4938 action: msgs::ErrorAction::SendErrorMessage {
4939 msg: msgs::ErrorMessage { channel_id: chan_id.clone(), data: "Channel force-closed".to_owned() }
4945 peer_state.inbound_channel_request_by_id.retain(|_, req| req.ticks_remaining > 0);
4947 if peer_state.ok_to_remove(true) {
4948 pending_peers_awaiting_removal.push(counterparty_node_id);
4953 // When a peer disconnects but still has channels, the peer's `peer_state` entry in the
4954 // `per_peer_state` is not removed by the `peer_disconnected` function. If the channels
4955 // of to that peer is later closed while still being disconnected (i.e. force closed),
4956 // we therefore need to remove the peer from `peer_state` separately.
4957 // To avoid having to take the `per_peer_state` `write` lock once the channels are
4958 // closed, we instead remove such peers awaiting removal here on a timer, to limit the
4959 // negative effects on parallelism as much as possible.
4960 if pending_peers_awaiting_removal.len() > 0 {
4961 let mut per_peer_state = self.per_peer_state.write().unwrap();
4962 for counterparty_node_id in pending_peers_awaiting_removal {
4963 match per_peer_state.entry(counterparty_node_id) {
4964 hash_map::Entry::Occupied(entry) => {
4965 // Remove the entry if the peer is still disconnected and we still
4966 // have no channels to the peer.
4967 let remove_entry = {
4968 let peer_state = entry.get().lock().unwrap();
4969 peer_state.ok_to_remove(true)
4972 entry.remove_entry();
4975 hash_map::Entry::Vacant(_) => { /* The PeerState has already been removed */ }
4980 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
4981 if payment.htlcs.is_empty() {
4982 // This should be unreachable
4983 debug_assert!(false);
4986 if let OnionPayload::Invoice { .. } = payment.htlcs[0].onion_payload {
4987 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
4988 // In this case we're not going to handle any timeouts of the parts here.
4989 // This condition determining whether the MPP is complete here must match
4990 // exactly the condition used in `process_pending_htlc_forwards`.
4991 if payment.htlcs[0].total_msat <= payment.htlcs.iter()
4992 .fold(0, |total, htlc| total + htlc.sender_intended_value)
4995 } else if payment.htlcs.iter_mut().any(|htlc| {
4996 htlc.timer_ticks += 1;
4997 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
4999 timed_out_mpp_htlcs.extend(payment.htlcs.drain(..)
5000 .map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
5007 for htlc_source in timed_out_mpp_htlcs.drain(..) {
5008 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
5009 let reason = HTLCFailReason::from_failure_code(23);
5010 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
5011 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
5014 for (err, counterparty_node_id) in handle_errors.drain(..) {
5015 let _ = handle_error!(self, err, counterparty_node_id);
5018 for shutdown_res in shutdown_channels {
5019 self.finish_close_channel(shutdown_res);
5022 self.pending_outbound_payments.remove_stale_payments(&self.pending_events);
5024 // Technically we don't need to do this here, but if we have holding cell entries in a
5025 // channel that need freeing, it's better to do that here and block a background task
5026 // than block the message queueing pipeline.
5027 if self.check_free_holding_cells() {
5028 should_persist = NotifyOption::DoPersist;
5035 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
5036 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
5037 /// along the path (including in our own channel on which we received it).
5039 /// Note that in some cases around unclean shutdown, it is possible the payment may have
5040 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
5041 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
5042 /// may have already been failed automatically by LDK if it was nearing its expiration time.
5044 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
5045 /// [`ChannelManager::claim_funds`]), you should still monitor for
5046 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
5047 /// startup during which time claims that were in-progress at shutdown may be replayed.
5048 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
5049 self.fail_htlc_backwards_with_reason(payment_hash, FailureCode::IncorrectOrUnknownPaymentDetails);
5052 /// This is a variant of [`ChannelManager::fail_htlc_backwards`] that allows you to specify the
5053 /// reason for the failure.
5055 /// See [`FailureCode`] for valid failure codes.
5056 pub fn fail_htlc_backwards_with_reason(&self, payment_hash: &PaymentHash, failure_code: FailureCode) {
5057 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5059 let removed_source = self.claimable_payments.lock().unwrap().claimable_payments.remove(payment_hash);
5060 if let Some(payment) = removed_source {
5061 for htlc in payment.htlcs {
5062 let reason = self.get_htlc_fail_reason_from_failure_code(failure_code, &htlc);
5063 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5064 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
5065 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5070 /// Gets error data to form an [`HTLCFailReason`] given a [`FailureCode`] and [`ClaimableHTLC`].
5071 fn get_htlc_fail_reason_from_failure_code(&self, failure_code: FailureCode, htlc: &ClaimableHTLC) -> HTLCFailReason {
5072 match failure_code {
5073 FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(failure_code.into()),
5074 FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(failure_code.into()),
5075 FailureCode::IncorrectOrUnknownPaymentDetails => {
5076 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5077 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5078 HTLCFailReason::reason(failure_code.into(), htlc_msat_height_data)
5080 FailureCode::InvalidOnionPayload(data) => {
5081 let fail_data = match data {
5082 Some((typ, offset)) => [BigSize(typ).encode(), offset.encode()].concat(),
5085 HTLCFailReason::reason(failure_code.into(), fail_data)
5090 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
5091 /// that we want to return and a channel.
5093 /// This is for failures on the channel on which the HTLC was *received*, not failures
5095 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<SP>) -> (u16, Vec<u8>) {
5096 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
5097 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
5098 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
5099 // an inbound SCID alias before the real SCID.
5100 let scid_pref = if chan.context.should_announce() {
5101 chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias())
5103 chan.context.latest_inbound_scid_alias().or(chan.context.get_short_channel_id())
5105 if let Some(scid) = scid_pref {
5106 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
5108 (0x4000|10, Vec::new())
5113 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
5114 /// that we want to return and a channel.
5115 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<SP>) -> (u16, Vec<u8>) {
5116 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
5117 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
5118 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
5119 if desired_err_code == 0x1000 | 20 {
5120 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
5121 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
5122 0u16.write(&mut enc).expect("Writes cannot fail");
5124 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
5125 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
5126 upd.write(&mut enc).expect("Writes cannot fail");
5127 (desired_err_code, enc.0)
5129 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
5130 // which means we really shouldn't have gotten a payment to be forwarded over this
5131 // channel yet, or if we did it's from a route hint. Either way, returning an error of
5132 // PERM|no_such_channel should be fine.
5133 (0x4000|10, Vec::new())
5137 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
5138 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
5139 // be surfaced to the user.
5140 fn fail_holding_cell_htlcs(
5141 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: ChannelId,
5142 counterparty_node_id: &PublicKey
5144 let (failure_code, onion_failure_data) = {
5145 let per_peer_state = self.per_peer_state.read().unwrap();
5146 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
5147 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5148 let peer_state = &mut *peer_state_lock;
5149 match peer_state.channel_by_id.entry(channel_id) {
5150 hash_map::Entry::Occupied(chan_phase_entry) => {
5151 if let ChannelPhase::Funded(chan) = chan_phase_entry.get() {
5152 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan)
5154 // We shouldn't be trying to fail holding cell HTLCs on an unfunded channel.
5155 debug_assert!(false);
5156 (0x4000|10, Vec::new())
5159 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
5161 } else { (0x4000|10, Vec::new()) }
5164 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
5165 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
5166 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
5167 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
5171 /// Fails an HTLC backwards to the sender of it to us.
5172 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
5173 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
5174 // Ensure that no peer state channel storage lock is held when calling this function.
5175 // This ensures that future code doesn't introduce a lock-order requirement for
5176 // `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
5177 // this function with any `per_peer_state` peer lock acquired would.
5178 #[cfg(debug_assertions)]
5179 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
5180 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
5183 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
5184 //identify whether we sent it or not based on the (I presume) very different runtime
5185 //between the branches here. We should make this async and move it into the forward HTLCs
5188 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5189 // from block_connected which may run during initialization prior to the chain_monitor
5190 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
5192 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, .. } => {
5193 if self.pending_outbound_payments.fail_htlc(source, payment_hash, onion_error, path,
5194 session_priv, payment_id, self.probing_cookie_secret, &self.secp_ctx,
5195 &self.pending_events, &self.logger)
5196 { self.push_pending_forwards_ev(); }
5198 HTLCSource::PreviousHopData(HTLCPreviousHopData { ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret, ref phantom_shared_secret, ref outpoint, .. }) => {
5199 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with {:?}", &payment_hash, onion_error);
5200 let err_packet = onion_error.get_encrypted_failure_packet(incoming_packet_shared_secret, phantom_shared_secret);
5202 let mut push_forward_ev = false;
5203 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
5204 if forward_htlcs.is_empty() {
5205 push_forward_ev = true;
5207 match forward_htlcs.entry(*short_channel_id) {
5208 hash_map::Entry::Occupied(mut entry) => {
5209 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet });
5211 hash_map::Entry::Vacant(entry) => {
5212 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }));
5215 mem::drop(forward_htlcs);
5216 if push_forward_ev { self.push_pending_forwards_ev(); }
5217 let mut pending_events = self.pending_events.lock().unwrap();
5218 pending_events.push_back((events::Event::HTLCHandlingFailed {
5219 prev_channel_id: outpoint.to_channel_id(),
5220 failed_next_destination: destination,
5226 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
5227 /// [`MessageSendEvent`]s needed to claim the payment.
5229 /// This method is guaranteed to ensure the payment has been claimed but only if the current
5230 /// height is strictly below [`Event::PaymentClaimable::claim_deadline`]. To avoid race
5231 /// conditions, you should wait for an [`Event::PaymentClaimed`] before considering the payment
5232 /// successful. It will generally be available in the next [`process_pending_events`] call.
5234 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
5235 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
5236 /// event matches your expectation. If you fail to do so and call this method, you may provide
5237 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
5239 /// This function will fail the payment if it has custom TLVs with even type numbers, as we
5240 /// will assume they are unknown. If you intend to accept even custom TLVs, you should use
5241 /// [`claim_funds_with_known_custom_tlvs`].
5243 /// [`Event::PaymentClaimable`]: crate::events::Event::PaymentClaimable
5244 /// [`Event::PaymentClaimable::claim_deadline`]: crate::events::Event::PaymentClaimable::claim_deadline
5245 /// [`Event::PaymentClaimed`]: crate::events::Event::PaymentClaimed
5246 /// [`process_pending_events`]: EventsProvider::process_pending_events
5247 /// [`create_inbound_payment`]: Self::create_inbound_payment
5248 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5249 /// [`claim_funds_with_known_custom_tlvs`]: Self::claim_funds_with_known_custom_tlvs
5250 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
5251 self.claim_payment_internal(payment_preimage, false);
5254 /// This is a variant of [`claim_funds`] that allows accepting a payment with custom TLVs with
5255 /// even type numbers.
5259 /// You MUST check you've understood all even TLVs before using this to
5260 /// claim, otherwise you may unintentionally agree to some protocol you do not understand.
5262 /// [`claim_funds`]: Self::claim_funds
5263 pub fn claim_funds_with_known_custom_tlvs(&self, payment_preimage: PaymentPreimage) {
5264 self.claim_payment_internal(payment_preimage, true);
5267 fn claim_payment_internal(&self, payment_preimage: PaymentPreimage, custom_tlvs_known: bool) {
5268 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
5270 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5273 let mut claimable_payments = self.claimable_payments.lock().unwrap();
5274 if let Some(payment) = claimable_payments.claimable_payments.remove(&payment_hash) {
5275 let mut receiver_node_id = self.our_network_pubkey;
5276 for htlc in payment.htlcs.iter() {
5277 if htlc.prev_hop.phantom_shared_secret.is_some() {
5278 let phantom_pubkey = self.node_signer.get_node_id(Recipient::PhantomNode)
5279 .expect("Failed to get node_id for phantom node recipient");
5280 receiver_node_id = phantom_pubkey;
5285 let htlcs = payment.htlcs.iter().map(events::ClaimedHTLC::from).collect();
5286 let sender_intended_value = payment.htlcs.first().map(|htlc| htlc.total_msat);
5287 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
5288 ClaimingPayment { amount_msat: payment.htlcs.iter().map(|source| source.value).sum(),
5289 payment_purpose: payment.purpose, receiver_node_id, htlcs, sender_intended_value
5291 if dup_purpose.is_some() {
5292 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
5293 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
5297 if let Some(RecipientOnionFields { ref custom_tlvs, .. }) = payment.onion_fields {
5298 if !custom_tlvs_known && custom_tlvs.iter().any(|(typ, _)| typ % 2 == 0) {
5299 log_info!(self.logger, "Rejecting payment with payment hash {} as we cannot accept payment with unknown even TLVs: {}",
5300 &payment_hash, log_iter!(custom_tlvs.iter().map(|(typ, _)| typ).filter(|typ| *typ % 2 == 0)));
5301 claimable_payments.pending_claiming_payments.remove(&payment_hash);
5302 mem::drop(claimable_payments);
5303 for htlc in payment.htlcs {
5304 let reason = self.get_htlc_fail_reason_from_failure_code(FailureCode::InvalidOnionPayload(None), &htlc);
5305 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5306 let receiver = HTLCDestination::FailedPayment { payment_hash };
5307 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5316 debug_assert!(!sources.is_empty());
5318 // Just in case one HTLC has been failed between when we generated the `PaymentClaimable`
5319 // and when we got here we need to check that the amount we're about to claim matches the
5320 // amount we told the user in the last `PaymentClaimable`. We also do a sanity-check that
5321 // the MPP parts all have the same `total_msat`.
5322 let mut claimable_amt_msat = 0;
5323 let mut prev_total_msat = None;
5324 let mut expected_amt_msat = None;
5325 let mut valid_mpp = true;
5326 let mut errs = Vec::new();
5327 let per_peer_state = self.per_peer_state.read().unwrap();
5328 for htlc in sources.iter() {
5329 if prev_total_msat.is_some() && prev_total_msat != Some(htlc.total_msat) {
5330 log_error!(self.logger, "Somehow ended up with an MPP payment with different expected total amounts - this should not be reachable!");
5331 debug_assert!(false);
5335 prev_total_msat = Some(htlc.total_msat);
5337 if expected_amt_msat.is_some() && expected_amt_msat != htlc.total_value_received {
5338 log_error!(self.logger, "Somehow ended up with an MPP payment with different received total amounts - this should not be reachable!");
5339 debug_assert!(false);
5343 expected_amt_msat = htlc.total_value_received;
5344 claimable_amt_msat += htlc.value;
5346 mem::drop(per_peer_state);
5347 if sources.is_empty() || expected_amt_msat.is_none() {
5348 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5349 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
5352 if claimable_amt_msat != expected_amt_msat.unwrap() {
5353 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5354 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
5355 expected_amt_msat.unwrap(), claimable_amt_msat);
5359 for htlc in sources.drain(..) {
5360 if let Err((pk, err)) = self.claim_funds_from_hop(
5361 htlc.prev_hop, payment_preimage,
5362 |_| Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash }))
5364 if let msgs::ErrorAction::IgnoreError = err.err.action {
5365 // We got a temporary failure updating monitor, but will claim the
5366 // HTLC when the monitor updating is restored (or on chain).
5367 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
5368 } else { errs.push((pk, err)); }
5373 for htlc in sources.drain(..) {
5374 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5375 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5376 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5377 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
5378 let receiver = HTLCDestination::FailedPayment { payment_hash };
5379 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5381 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5384 // Now we can handle any errors which were generated.
5385 for (counterparty_node_id, err) in errs.drain(..) {
5386 let res: Result<(), _> = Err(err);
5387 let _ = handle_error!(self, res, counterparty_node_id);
5391 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>) -> Option<MonitorUpdateCompletionAction>>(&self,
5392 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
5393 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
5394 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
5396 // If we haven't yet run background events assume we're still deserializing and shouldn't
5397 // actually pass `ChannelMonitorUpdate`s to users yet. Instead, queue them up as
5398 // `BackgroundEvent`s.
5399 let during_init = !self.background_events_processed_since_startup.load(Ordering::Acquire);
5402 let per_peer_state = self.per_peer_state.read().unwrap();
5403 let chan_id = prev_hop.outpoint.to_channel_id();
5404 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
5405 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
5409 let peer_state_opt = counterparty_node_id_opt.as_ref().map(
5410 |counterparty_node_id| per_peer_state.get(counterparty_node_id)
5411 .map(|peer_mutex| peer_mutex.lock().unwrap())
5414 if peer_state_opt.is_some() {
5415 let mut peer_state_lock = peer_state_opt.unwrap();
5416 let peer_state = &mut *peer_state_lock;
5417 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(chan_id) {
5418 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
5419 let counterparty_node_id = chan.context.get_counterparty_node_id();
5420 let fulfill_res = chan.get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger);
5422 if let UpdateFulfillCommitFetch::NewClaim { htlc_value_msat, monitor_update } = fulfill_res {
5423 if let Some(action) = completion_action(Some(htlc_value_msat)) {
5424 log_trace!(self.logger, "Tracking monitor update completion action for channel {}: {:?}",
5426 peer_state.monitor_update_blocked_actions.entry(chan_id).or_insert(Vec::new()).push(action);
5429 handle_new_monitor_update!(self, prev_hop.outpoint, monitor_update, peer_state_lock,
5430 peer_state, per_peer_state, chan);
5432 // If we're running during init we cannot update a monitor directly -
5433 // they probably haven't actually been loaded yet. Instead, push the
5434 // monitor update as a background event.
5435 self.pending_background_events.lock().unwrap().push(
5436 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
5437 counterparty_node_id,
5438 funding_txo: prev_hop.outpoint,
5439 update: monitor_update.clone(),
5448 let preimage_update = ChannelMonitorUpdate {
5449 update_id: CLOSED_CHANNEL_UPDATE_ID,
5450 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
5456 // We update the ChannelMonitor on the backward link, after
5457 // receiving an `update_fulfill_htlc` from the forward link.
5458 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, &preimage_update);
5459 if update_res != ChannelMonitorUpdateStatus::Completed {
5460 // TODO: This needs to be handled somehow - if we receive a monitor update
5461 // with a preimage we *must* somehow manage to propagate it to the upstream
5462 // channel, or we must have an ability to receive the same event and try
5463 // again on restart.
5464 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
5465 payment_preimage, update_res);
5468 // If we're running during init we cannot update a monitor directly - they probably
5469 // haven't actually been loaded yet. Instead, push the monitor update as a background
5471 // Note that while it's safe to use `ClosedMonitorUpdateRegeneratedOnStartup` here (the
5472 // channel is already closed) we need to ultimately handle the monitor update
5473 // completion action only after we've completed the monitor update. This is the only
5474 // way to guarantee this update *will* be regenerated on startup (otherwise if this was
5475 // from a forwarded HTLC the downstream preimage may be deleted before we claim
5476 // upstream). Thus, we need to transition to some new `BackgroundEvent` type which will
5477 // complete the monitor update completion action from `completion_action`.
5478 self.pending_background_events.lock().unwrap().push(
5479 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((
5480 prev_hop.outpoint, preimage_update,
5483 // Note that we do process the completion action here. This totally could be a
5484 // duplicate claim, but we have no way of knowing without interrogating the
5485 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
5486 // generally always allowed to be duplicative (and it's specifically noted in
5487 // `PaymentForwarded`).
5488 self.handle_monitor_update_completion_actions(completion_action(None));
5492 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
5493 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
5496 fn claim_funds_internal(&self, source: HTLCSource, payment_preimage: PaymentPreimage,
5497 forwarded_htlc_value_msat: Option<u64>, from_onchain: bool,
5498 next_channel_counterparty_node_id: Option<PublicKey>, next_channel_outpoint: OutPoint
5501 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
5502 debug_assert!(self.background_events_processed_since_startup.load(Ordering::Acquire),
5503 "We don't support claim_htlc claims during startup - monitors may not be available yet");
5504 if let Some(pubkey) = next_channel_counterparty_node_id {
5505 debug_assert_eq!(pubkey, path.hops[0].pubkey);
5507 let ev_completion_action = EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
5508 channel_funding_outpoint: next_channel_outpoint,
5509 counterparty_node_id: path.hops[0].pubkey,
5511 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage,
5512 session_priv, path, from_onchain, ev_completion_action, &self.pending_events,
5515 HTLCSource::PreviousHopData(hop_data) => {
5516 let prev_outpoint = hop_data.outpoint;
5517 let completed_blocker = RAAMonitorUpdateBlockingAction::from_prev_hop_data(&hop_data);
5518 let res = self.claim_funds_from_hop(hop_data, payment_preimage,
5519 |htlc_claim_value_msat| {
5520 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
5521 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
5522 Some(claimed_htlc_value - forwarded_htlc_value)
5525 Some(MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5526 event: events::Event::PaymentForwarded {
5528 claim_from_onchain_tx: from_onchain,
5529 prev_channel_id: Some(prev_outpoint.to_channel_id()),
5530 next_channel_id: Some(next_channel_outpoint.to_channel_id()),
5531 outbound_amount_forwarded_msat: forwarded_htlc_value_msat,
5533 downstream_counterparty_and_funding_outpoint:
5534 if let Some(node_id) = next_channel_counterparty_node_id {
5535 Some((node_id, next_channel_outpoint, completed_blocker))
5537 // We can only get `None` here if we are processing a
5538 // `ChannelMonitor`-originated event, in which case we
5539 // don't care about ensuring we wake the downstream
5540 // channel's monitor updating - the channel is already
5547 if let Err((pk, err)) = res {
5548 let result: Result<(), _> = Err(err);
5549 let _ = handle_error!(self, result, pk);
5555 /// Gets the node_id held by this ChannelManager
5556 pub fn get_our_node_id(&self) -> PublicKey {
5557 self.our_network_pubkey.clone()
5560 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
5561 for action in actions.into_iter() {
5563 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
5564 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5565 if let Some(ClaimingPayment {
5567 payment_purpose: purpose,
5570 sender_intended_value: sender_intended_total_msat,
5572 self.pending_events.lock().unwrap().push_back((events::Event::PaymentClaimed {
5576 receiver_node_id: Some(receiver_node_id),
5578 sender_intended_total_msat,
5582 MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5583 event, downstream_counterparty_and_funding_outpoint
5585 self.pending_events.lock().unwrap().push_back((event, None));
5586 if let Some((node_id, funding_outpoint, blocker)) = downstream_counterparty_and_funding_outpoint {
5587 self.handle_monitor_update_release(node_id, funding_outpoint, Some(blocker));
5594 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
5595 /// update completion.
5596 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
5597 channel: &mut Channel<SP>, raa: Option<msgs::RevokeAndACK>,
5598 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
5599 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
5600 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
5601 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
5602 log_trace!(self.logger, "Handling channel resumption for channel {} with {} RAA, {} commitment update, {} pending forwards, {}broadcasting funding, {} channel ready, {} announcement",
5603 &channel.context.channel_id(),
5604 if raa.is_some() { "an" } else { "no" },
5605 if commitment_update.is_some() { "a" } else { "no" }, pending_forwards.len(),
5606 if funding_broadcastable.is_some() { "" } else { "not " },
5607 if channel_ready.is_some() { "sending" } else { "without" },
5608 if announcement_sigs.is_some() { "sending" } else { "without" });
5610 let mut htlc_forwards = None;
5612 let counterparty_node_id = channel.context.get_counterparty_node_id();
5613 if !pending_forwards.is_empty() {
5614 htlc_forwards = Some((channel.context.get_short_channel_id().unwrap_or(channel.context.outbound_scid_alias()),
5615 channel.context.get_funding_txo().unwrap(), channel.context.get_user_id(), pending_forwards));
5618 if let Some(msg) = channel_ready {
5619 send_channel_ready!(self, pending_msg_events, channel, msg);
5621 if let Some(msg) = announcement_sigs {
5622 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5623 node_id: counterparty_node_id,
5628 macro_rules! handle_cs { () => {
5629 if let Some(update) = commitment_update {
5630 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5631 node_id: counterparty_node_id,
5636 macro_rules! handle_raa { () => {
5637 if let Some(revoke_and_ack) = raa {
5638 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
5639 node_id: counterparty_node_id,
5640 msg: revoke_and_ack,
5645 RAACommitmentOrder::CommitmentFirst => {
5649 RAACommitmentOrder::RevokeAndACKFirst => {
5655 if let Some(tx) = funding_broadcastable {
5656 log_info!(self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
5657 self.tx_broadcaster.broadcast_transactions(&[&tx]);
5661 let mut pending_events = self.pending_events.lock().unwrap();
5662 emit_channel_pending_event!(pending_events, channel);
5663 emit_channel_ready_event!(pending_events, channel);
5669 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
5670 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
5672 let counterparty_node_id = match counterparty_node_id {
5673 Some(cp_id) => cp_id.clone(),
5675 // TODO: Once we can rely on the counterparty_node_id from the
5676 // monitor event, this and the id_to_peer map should be removed.
5677 let id_to_peer = self.id_to_peer.lock().unwrap();
5678 match id_to_peer.get(&funding_txo.to_channel_id()) {
5679 Some(cp_id) => cp_id.clone(),
5684 let per_peer_state = self.per_peer_state.read().unwrap();
5685 let mut peer_state_lock;
5686 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
5687 if peer_state_mutex_opt.is_none() { return }
5688 peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5689 let peer_state = &mut *peer_state_lock;
5691 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&funding_txo.to_channel_id()) {
5694 let update_actions = peer_state.monitor_update_blocked_actions
5695 .remove(&funding_txo.to_channel_id()).unwrap_or(Vec::new());
5696 mem::drop(peer_state_lock);
5697 mem::drop(per_peer_state);
5698 self.handle_monitor_update_completion_actions(update_actions);
5701 let remaining_in_flight =
5702 if let Some(pending) = peer_state.in_flight_monitor_updates.get_mut(funding_txo) {
5703 pending.retain(|upd| upd.update_id > highest_applied_update_id);
5706 log_trace!(self.logger, "ChannelMonitor updated to {}. Current highest is {}. {} pending in-flight updates.",
5707 highest_applied_update_id, channel.context.get_latest_monitor_update_id(),
5708 remaining_in_flight);
5709 if !channel.is_awaiting_monitor_update() || channel.context.get_latest_monitor_update_id() != highest_applied_update_id {
5712 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, channel);
5715 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
5717 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
5718 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
5721 /// The `user_channel_id` parameter will be provided back in
5722 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5723 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5725 /// Note that this method will return an error and reject the channel, if it requires support
5726 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
5727 /// used to accept such channels.
5729 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5730 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5731 pub fn accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5732 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
5735 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
5736 /// it as confirmed immediately.
5738 /// The `user_channel_id` parameter will be provided back in
5739 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5740 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5742 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
5743 /// and (if the counterparty agrees), enables forwarding of payments immediately.
5745 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
5746 /// transaction and blindly assumes that it will eventually confirm.
5748 /// If it does not confirm before we decide to close the channel, or if the funding transaction
5749 /// does not pay to the correct script the correct amount, *you will lose funds*.
5751 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5752 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5753 pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5754 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
5757 fn do_accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
5758 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5760 let peers_without_funded_channels =
5761 self.peers_without_funded_channels(|peer| { peer.total_channel_count() > 0 });
5762 let per_peer_state = self.per_peer_state.read().unwrap();
5763 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5764 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
5765 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5766 let peer_state = &mut *peer_state_lock;
5767 let is_only_peer_channel = peer_state.total_channel_count() == 1;
5769 // Find (and remove) the channel in the unaccepted table. If it's not there, something weird is
5770 // happening and return an error. N.B. that we create channel with an outbound SCID of zero so
5771 // that we can delay allocating the SCID until after we're sure that the checks below will
5773 let mut channel = match peer_state.inbound_channel_request_by_id.remove(temporary_channel_id) {
5774 Some(unaccepted_channel) => {
5775 let best_block_height = self.best_block.read().unwrap().height();
5776 InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
5777 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features,
5778 &unaccepted_channel.open_channel_msg, user_channel_id, &self.default_configuration, best_block_height,
5779 &self.logger, accept_0conf).map_err(|e| APIError::ChannelUnavailable { err: e.to_string() })
5781 _ => Err(APIError::APIMisuseError { err: "No such channel awaiting to be accepted.".to_owned() })
5785 // This should have been correctly configured by the call to InboundV1Channel::new.
5786 debug_assert!(channel.context.minimum_depth().unwrap() == 0);
5787 } else if channel.context.get_channel_type().requires_zero_conf() {
5788 let send_msg_err_event = events::MessageSendEvent::HandleError {
5789 node_id: channel.context.get_counterparty_node_id(),
5790 action: msgs::ErrorAction::SendErrorMessage{
5791 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
5794 peer_state.pending_msg_events.push(send_msg_err_event);
5795 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
5797 // If this peer already has some channels, a new channel won't increase our number of peers
5798 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
5799 // channels per-peer we can accept channels from a peer with existing ones.
5800 if is_only_peer_channel && peers_without_funded_channels >= MAX_UNFUNDED_CHANNEL_PEERS {
5801 let send_msg_err_event = events::MessageSendEvent::HandleError {
5802 node_id: channel.context.get_counterparty_node_id(),
5803 action: msgs::ErrorAction::SendErrorMessage{
5804 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "Have too many peers with unfunded channels, not accepting new ones".to_owned(), }
5807 peer_state.pending_msg_events.push(send_msg_err_event);
5808 return Err(APIError::APIMisuseError { err: "Too many peers with unfunded channels, refusing to accept new ones".to_owned() });
5812 // Now that we know we have a channel, assign an outbound SCID alias.
5813 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
5814 channel.context.set_outbound_scid_alias(outbound_scid_alias);
5816 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
5817 node_id: channel.context.get_counterparty_node_id(),
5818 msg: channel.accept_inbound_channel(),
5821 peer_state.channel_by_id.insert(temporary_channel_id.clone(), ChannelPhase::UnfundedInboundV1(channel));
5826 /// Gets the number of peers which match the given filter and do not have any funded, outbound,
5827 /// or 0-conf channels.
5829 /// The filter is called for each peer and provided with the number of unfunded, inbound, and
5830 /// non-0-conf channels we have with the peer.
5831 fn peers_without_funded_channels<Filter>(&self, maybe_count_peer: Filter) -> usize
5832 where Filter: Fn(&PeerState<SP>) -> bool {
5833 let mut peers_without_funded_channels = 0;
5834 let best_block_height = self.best_block.read().unwrap().height();
5836 let peer_state_lock = self.per_peer_state.read().unwrap();
5837 for (_, peer_mtx) in peer_state_lock.iter() {
5838 let peer = peer_mtx.lock().unwrap();
5839 if !maybe_count_peer(&*peer) { continue; }
5840 let num_unfunded_channels = Self::unfunded_channel_count(&peer, best_block_height);
5841 if num_unfunded_channels == peer.total_channel_count() {
5842 peers_without_funded_channels += 1;
5846 return peers_without_funded_channels;
5849 fn unfunded_channel_count(
5850 peer: &PeerState<SP>, best_block_height: u32
5852 let mut num_unfunded_channels = 0;
5853 for (_, phase) in peer.channel_by_id.iter() {
5855 ChannelPhase::Funded(chan) => {
5856 // This covers non-zero-conf inbound `Channel`s that we are currently monitoring, but those
5857 // which have not yet had any confirmations on-chain.
5858 if !chan.context.is_outbound() && chan.context.minimum_depth().unwrap_or(1) != 0 &&
5859 chan.context.get_funding_tx_confirmations(best_block_height) == 0
5861 num_unfunded_channels += 1;
5864 ChannelPhase::UnfundedInboundV1(chan) => {
5865 if chan.context.minimum_depth().unwrap_or(1) != 0 {
5866 num_unfunded_channels += 1;
5869 ChannelPhase::UnfundedOutboundV1(_) => {
5870 // Outbound channels don't contribute to the unfunded count in the DoS context.
5875 num_unfunded_channels + peer.inbound_channel_request_by_id.len()
5878 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
5879 // Note that the ChannelManager is NOT re-persisted on disk after this, so any changes are
5880 // likely to be lost on restart!
5881 if msg.chain_hash != self.genesis_hash {
5882 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
5885 if !self.default_configuration.accept_inbound_channels {
5886 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
5889 // Get the number of peers with channels, but without funded ones. We don't care too much
5890 // about peers that never open a channel, so we filter by peers that have at least one
5891 // channel, and then limit the number of those with unfunded channels.
5892 let channeled_peers_without_funding =
5893 self.peers_without_funded_channels(|node| node.total_channel_count() > 0);
5895 let per_peer_state = self.per_peer_state.read().unwrap();
5896 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5898 debug_assert!(false);
5899 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())
5901 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5902 let peer_state = &mut *peer_state_lock;
5904 // If this peer already has some channels, a new channel won't increase our number of peers
5905 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
5906 // channels per-peer we can accept channels from a peer with existing ones.
5907 if peer_state.total_channel_count() == 0 &&
5908 channeled_peers_without_funding >= MAX_UNFUNDED_CHANNEL_PEERS &&
5909 !self.default_configuration.manually_accept_inbound_channels
5911 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5912 "Have too many peers with unfunded channels, not accepting new ones".to_owned(),
5913 msg.temporary_channel_id.clone()));
5916 let best_block_height = self.best_block.read().unwrap().height();
5917 if Self::unfunded_channel_count(peer_state, best_block_height) >= MAX_UNFUNDED_CHANS_PER_PEER {
5918 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5919 format!("Refusing more than {} unfunded channels.", MAX_UNFUNDED_CHANS_PER_PEER),
5920 msg.temporary_channel_id.clone()));
5923 let channel_id = msg.temporary_channel_id;
5924 let channel_exists = peer_state.has_channel(&channel_id);
5926 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision for the same peer!".to_owned(), msg.temporary_channel_id.clone()));
5929 // If we're doing manual acceptance checks on the channel, then defer creation until we're sure we want to accept.
5930 if self.default_configuration.manually_accept_inbound_channels {
5931 let mut pending_events = self.pending_events.lock().unwrap();
5932 pending_events.push_back((events::Event::OpenChannelRequest {
5933 temporary_channel_id: msg.temporary_channel_id.clone(),
5934 counterparty_node_id: counterparty_node_id.clone(),
5935 funding_satoshis: msg.funding_satoshis,
5936 push_msat: msg.push_msat,
5937 channel_type: msg.channel_type.clone().unwrap(),
5939 peer_state.inbound_channel_request_by_id.insert(channel_id, InboundChannelRequest {
5940 open_channel_msg: msg.clone(),
5941 ticks_remaining: UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS,
5946 // Otherwise create the channel right now.
5947 let mut random_bytes = [0u8; 16];
5948 random_bytes.copy_from_slice(&self.entropy_source.get_secure_random_bytes()[..16]);
5949 let user_channel_id = u128::from_be_bytes(random_bytes);
5950 let mut channel = match InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
5951 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id,
5952 &self.default_configuration, best_block_height, &self.logger, /*is_0conf=*/false)
5955 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
5960 let channel_type = channel.context.get_channel_type();
5961 if channel_type.requires_zero_conf() {
5962 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
5964 if channel_type.requires_anchors_zero_fee_htlc_tx() {
5965 return Err(MsgHandleErrInternal::send_err_msg_no_close("No channels with anchor outputs accepted".to_owned(), msg.temporary_channel_id.clone()));
5968 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
5969 channel.context.set_outbound_scid_alias(outbound_scid_alias);
5971 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
5972 node_id: counterparty_node_id.clone(),
5973 msg: channel.accept_inbound_channel(),
5975 peer_state.channel_by_id.insert(channel_id, ChannelPhase::UnfundedInboundV1(channel));
5979 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
5980 // Note that the ChannelManager is NOT re-persisted on disk after this, so any changes are
5981 // likely to be lost on restart!
5982 let (value, output_script, user_id) = {
5983 let per_peer_state = self.per_peer_state.read().unwrap();
5984 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5986 debug_assert!(false);
5987 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)
5989 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5990 let peer_state = &mut *peer_state_lock;
5991 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
5992 hash_map::Entry::Occupied(mut phase) => {
5993 match phase.get_mut() {
5994 ChannelPhase::UnfundedOutboundV1(chan) => {
5995 try_chan_phase_entry!(self, chan.accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &peer_state.latest_features), phase);
5996 (chan.context.get_value_satoshis(), chan.context.get_funding_redeemscript().to_v0_p2wsh(), chan.context.get_user_id())
5999 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));
6003 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))
6006 let mut pending_events = self.pending_events.lock().unwrap();
6007 pending_events.push_back((events::Event::FundingGenerationReady {
6008 temporary_channel_id: msg.temporary_channel_id,
6009 counterparty_node_id: *counterparty_node_id,
6010 channel_value_satoshis: value,
6012 user_channel_id: user_id,
6017 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
6018 let best_block = *self.best_block.read().unwrap();
6020 let per_peer_state = self.per_peer_state.read().unwrap();
6021 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6023 debug_assert!(false);
6024 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)
6027 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6028 let peer_state = &mut *peer_state_lock;
6029 let (chan, funding_msg, monitor) =
6030 match peer_state.channel_by_id.remove(&msg.temporary_channel_id) {
6031 Some(ChannelPhase::UnfundedInboundV1(inbound_chan)) => {
6032 match inbound_chan.funding_created(msg, best_block, &self.signer_provider, &self.logger) {
6034 Err((mut inbound_chan, err)) => {
6035 // We've already removed this inbound channel from the map in `PeerState`
6036 // above so at this point we just need to clean up any lingering entries
6037 // concerning this channel as it is safe to do so.
6038 update_maps_on_chan_removal!(self, &inbound_chan.context);
6039 let user_id = inbound_chan.context.get_user_id();
6040 let shutdown_res = inbound_chan.context.force_shutdown(false);
6041 return Err(MsgHandleErrInternal::from_finish_shutdown(format!("{}", err),
6042 msg.temporary_channel_id, user_id, shutdown_res, None, inbound_chan.context.get_value_satoshis()));
6046 Some(ChannelPhase::Funded(_)) | Some(ChannelPhase::UnfundedOutboundV1(_)) => {
6047 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));
6049 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))
6052 match peer_state.channel_by_id.entry(funding_msg.channel_id) {
6053 hash_map::Entry::Occupied(_) => {
6054 Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
6056 hash_map::Entry::Vacant(e) => {
6057 let mut id_to_peer_lock = self.id_to_peer.lock().unwrap();
6058 match id_to_peer_lock.entry(chan.context.channel_id()) {
6059 hash_map::Entry::Occupied(_) => {
6060 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6061 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
6062 funding_msg.channel_id))
6064 hash_map::Entry::Vacant(i_e) => {
6065 let monitor_res = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
6066 if let Ok(persist_state) = monitor_res {
6067 i_e.insert(chan.context.get_counterparty_node_id());
6068 mem::drop(id_to_peer_lock);
6070 // There's no problem signing a counterparty's funding transaction if our monitor
6071 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
6072 // accepted payment from yet. We do, however, need to wait to send our channel_ready
6073 // until we have persisted our monitor.
6074 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
6075 node_id: counterparty_node_id.clone(),
6079 if let ChannelPhase::Funded(chan) = e.insert(ChannelPhase::Funded(chan)) {
6080 handle_new_monitor_update!(self, persist_state, peer_state_lock, peer_state,
6081 per_peer_state, chan, INITIAL_MONITOR);
6083 unreachable!("This must be a funded channel as we just inserted it.");
6087 log_error!(self.logger, "Persisting initial ChannelMonitor failed, implying the funding outpoint was duplicated");
6088 return Err(MsgHandleErrInternal::send_err_msg_no_close(
6089 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
6090 funding_msg.channel_id));
6098 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
6099 let best_block = *self.best_block.read().unwrap();
6100 let per_peer_state = self.per_peer_state.read().unwrap();
6101 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6103 debug_assert!(false);
6104 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6107 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6108 let peer_state = &mut *peer_state_lock;
6109 match peer_state.channel_by_id.entry(msg.channel_id) {
6110 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6111 match chan_phase_entry.get_mut() {
6112 ChannelPhase::Funded(ref mut chan) => {
6113 let monitor = try_chan_phase_entry!(self,
6114 chan.funding_signed(&msg, best_block, &self.signer_provider, &self.logger), chan_phase_entry);
6115 if let Ok(persist_status) = self.chain_monitor.watch_channel(chan.context.get_funding_txo().unwrap(), monitor) {
6116 handle_new_monitor_update!(self, persist_status, peer_state_lock, peer_state, per_peer_state, chan, INITIAL_MONITOR);
6119 try_chan_phase_entry!(self, Err(ChannelError::Close("Channel funding outpoint was a duplicate".to_owned())), chan_phase_entry)
6123 return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id));
6127 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
6131 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
6132 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6133 // closing a channel), so any changes are likely to be lost on restart!
6134 let per_peer_state = self.per_peer_state.read().unwrap();
6135 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6137 debug_assert!(false);
6138 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6140 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6141 let peer_state = &mut *peer_state_lock;
6142 match peer_state.channel_by_id.entry(msg.channel_id) {
6143 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6144 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6145 let announcement_sigs_opt = try_chan_phase_entry!(self, chan.channel_ready(&msg, &self.node_signer,
6146 self.genesis_hash.clone(), &self.default_configuration, &self.best_block.read().unwrap(), &self.logger), chan_phase_entry);
6147 if let Some(announcement_sigs) = announcement_sigs_opt {
6148 log_trace!(self.logger, "Sending announcement_signatures for channel {}", chan.context.channel_id());
6149 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
6150 node_id: counterparty_node_id.clone(),
6151 msg: announcement_sigs,
6153 } else if chan.context.is_usable() {
6154 // If we're sending an announcement_signatures, we'll send the (public)
6155 // channel_update after sending a channel_announcement when we receive our
6156 // counterparty's announcement_signatures. Thus, we only bother to send a
6157 // channel_update here if the channel is not public, i.e. we're not sending an
6158 // announcement_signatures.
6159 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", chan.context.channel_id());
6160 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
6161 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
6162 node_id: counterparty_node_id.clone(),
6169 let mut pending_events = self.pending_events.lock().unwrap();
6170 emit_channel_ready_event!(pending_events, chan);
6175 try_chan_phase_entry!(self, Err(ChannelError::Close(
6176 "Got a channel_ready message for an unfunded channel!".into())), chan_phase_entry)
6179 hash_map::Entry::Vacant(_) => {
6180 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))
6185 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
6186 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)> = Vec::new();
6187 let mut finish_shutdown = None;
6189 let per_peer_state = self.per_peer_state.read().unwrap();
6190 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6192 debug_assert!(false);
6193 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6195 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6196 let peer_state = &mut *peer_state_lock;
6197 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(msg.channel_id.clone()) {
6198 let phase = chan_phase_entry.get_mut();
6200 ChannelPhase::Funded(chan) => {
6201 if !chan.received_shutdown() {
6202 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
6204 if chan.sent_shutdown() { " after we initiated shutdown" } else { "" });
6207 let funding_txo_opt = chan.context.get_funding_txo();
6208 let (shutdown, monitor_update_opt, htlcs) = try_chan_phase_entry!(self,
6209 chan.shutdown(&self.signer_provider, &peer_state.latest_features, &msg), chan_phase_entry);
6210 dropped_htlcs = htlcs;
6212 if let Some(msg) = shutdown {
6213 // We can send the `shutdown` message before updating the `ChannelMonitor`
6214 // here as we don't need the monitor update to complete until we send a
6215 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
6216 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
6217 node_id: *counterparty_node_id,
6221 // Update the monitor with the shutdown script if necessary.
6222 if let Some(monitor_update) = monitor_update_opt {
6223 handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
6224 peer_state_lock, peer_state, per_peer_state, chan);
6227 ChannelPhase::UnfundedInboundV1(_) | ChannelPhase::UnfundedOutboundV1(_) => {
6228 let context = phase.context_mut();
6229 log_error!(self.logger, "Immediately closing unfunded channel {} as peer asked to cooperatively shut it down (which is unnecessary)", &msg.channel_id);
6230 self.issue_channel_close_events(&context, ClosureReason::CounterpartyCoopClosedUnfundedChannel);
6231 let mut chan = remove_channel_phase!(self, chan_phase_entry);
6232 finish_shutdown = Some(chan.context_mut().force_shutdown(false));
6236 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))
6239 for htlc_source in dropped_htlcs.drain(..) {
6240 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
6241 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
6242 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
6244 if let Some(shutdown_res) = finish_shutdown {
6245 self.finish_close_channel(shutdown_res);
6251 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
6252 let mut shutdown_result = None;
6253 let unbroadcasted_batch_funding_txid;
6254 let per_peer_state = self.per_peer_state.read().unwrap();
6255 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6257 debug_assert!(false);
6258 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6260 let (tx, chan_option) = {
6261 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6262 let peer_state = &mut *peer_state_lock;
6263 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
6264 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6265 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6266 unbroadcasted_batch_funding_txid = chan.context.unbroadcasted_batch_funding_txid();
6267 let (closing_signed, tx) = try_chan_phase_entry!(self, chan.closing_signed(&self.fee_estimator, &msg), chan_phase_entry);
6268 if let Some(msg) = closing_signed {
6269 peer_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
6270 node_id: counterparty_node_id.clone(),
6275 // We're done with this channel, we've got a signed closing transaction and
6276 // will send the closing_signed back to the remote peer upon return. This
6277 // also implies there are no pending HTLCs left on the channel, so we can
6278 // fully delete it from tracking (the channel monitor is still around to
6279 // watch for old state broadcasts)!
6280 (tx, Some(remove_channel_phase!(self, chan_phase_entry)))
6281 } else { (tx, None) }
6283 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6284 "Got a closing_signed message for an unfunded channel!".into())), chan_phase_entry);
6287 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))
6290 if let Some(broadcast_tx) = tx {
6291 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
6292 self.tx_broadcaster.broadcast_transactions(&[&broadcast_tx]);
6294 if let Some(ChannelPhase::Funded(chan)) = chan_option {
6295 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6296 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6297 let peer_state = &mut *peer_state_lock;
6298 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6302 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
6303 shutdown_result = Some((None, Vec::new(), unbroadcasted_batch_funding_txid));
6305 mem::drop(per_peer_state);
6306 if let Some(shutdown_result) = shutdown_result {
6307 self.finish_close_channel(shutdown_result);
6312 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
6313 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
6314 //determine the state of the payment based on our response/if we forward anything/the time
6315 //we take to respond. We should take care to avoid allowing such an attack.
6317 //TODO: There exists a further attack where a node may garble the onion data, forward it to
6318 //us repeatedly garbled in different ways, and compare our error messages, which are
6319 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
6320 //but we should prevent it anyway.
6322 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6323 // closing a channel), so any changes are likely to be lost on restart!
6325 let decoded_hop_res = self.decode_update_add_htlc_onion(msg);
6326 let per_peer_state = self.per_peer_state.read().unwrap();
6327 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6329 debug_assert!(false);
6330 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6332 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6333 let peer_state = &mut *peer_state_lock;
6334 match peer_state.channel_by_id.entry(msg.channel_id) {
6335 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6336 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6337 let pending_forward_info = match decoded_hop_res {
6338 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
6339 self.construct_pending_htlc_status(msg, shared_secret, next_hop,
6340 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt),
6341 Err(e) => PendingHTLCStatus::Fail(e)
6343 let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
6344 // If the update_add is completely bogus, the call will Err and we will close,
6345 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
6346 // want to reject the new HTLC and fail it backwards instead of forwarding.
6347 match pending_forward_info {
6348 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
6349 let reason = if (error_code & 0x1000) != 0 {
6350 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
6351 HTLCFailReason::reason(real_code, error_data)
6353 HTLCFailReason::from_failure_code(error_code)
6354 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
6355 let msg = msgs::UpdateFailHTLC {
6356 channel_id: msg.channel_id,
6357 htlc_id: msg.htlc_id,
6360 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
6362 _ => pending_forward_info
6365 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);
6367 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6368 "Got an update_add_htlc message for an unfunded channel!".into())), chan_phase_entry);
6371 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))
6376 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
6378 let (htlc_source, forwarded_htlc_value) = {
6379 let per_peer_state = self.per_peer_state.read().unwrap();
6380 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6382 debug_assert!(false);
6383 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6385 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6386 let peer_state = &mut *peer_state_lock;
6387 match peer_state.channel_by_id.entry(msg.channel_id) {
6388 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6389 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6390 let res = try_chan_phase_entry!(self, chan.update_fulfill_htlc(&msg), chan_phase_entry);
6391 if let HTLCSource::PreviousHopData(prev_hop) = &res.0 {
6392 peer_state.actions_blocking_raa_monitor_updates.entry(msg.channel_id)
6393 .or_insert_with(Vec::new)
6394 .push(RAAMonitorUpdateBlockingAction::from_prev_hop_data(&prev_hop));
6396 // Note that we do not need to push an `actions_blocking_raa_monitor_updates`
6397 // entry here, even though we *do* need to block the next RAA monitor update.
6398 // We do this instead in the `claim_funds_internal` by attaching a
6399 // `ReleaseRAAChannelMonitorUpdate` action to the event generated when the
6400 // outbound HTLC is claimed. This is guaranteed to all complete before we
6401 // process the RAA as messages are processed from single peers serially.
6402 funding_txo = chan.context.get_funding_txo().expect("We won't accept a fulfill until funded");
6405 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6406 "Got an update_fulfill_htlc message for an unfunded channel!".into())), chan_phase_entry);
6409 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))
6412 self.claim_funds_internal(htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, Some(*counterparty_node_id), funding_txo);
6416 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
6417 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6418 // closing a channel), so any changes are likely to be lost on restart!
6419 let per_peer_state = self.per_peer_state.read().unwrap();
6420 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6422 debug_assert!(false);
6423 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6425 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6426 let peer_state = &mut *peer_state_lock;
6427 match peer_state.channel_by_id.entry(msg.channel_id) {
6428 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6429 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6430 try_chan_phase_entry!(self, chan.update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan_phase_entry);
6432 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6433 "Got an update_fail_htlc message for an unfunded channel!".into())), chan_phase_entry);
6436 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))
6441 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
6442 // Note that the ChannelManager is NOT re-persisted on disk after this (unless we error
6443 // closing a channel), so any changes are likely to be lost on restart!
6444 let per_peer_state = self.per_peer_state.read().unwrap();
6445 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6447 debug_assert!(false);
6448 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6450 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6451 let peer_state = &mut *peer_state_lock;
6452 match peer_state.channel_by_id.entry(msg.channel_id) {
6453 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6454 if (msg.failure_code & 0x8000) == 0 {
6455 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
6456 try_chan_phase_entry!(self, Err(chan_err), chan_phase_entry);
6458 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6459 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);
6461 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6462 "Got an update_fail_malformed_htlc message for an unfunded channel!".into())), chan_phase_entry);
6466 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))
6470 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
6471 let per_peer_state = self.per_peer_state.read().unwrap();
6472 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6474 debug_assert!(false);
6475 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6477 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6478 let peer_state = &mut *peer_state_lock;
6479 match peer_state.channel_by_id.entry(msg.channel_id) {
6480 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6481 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6482 let funding_txo = chan.context.get_funding_txo();
6483 let monitor_update_opt = try_chan_phase_entry!(self, chan.commitment_signed(&msg, &self.logger), chan_phase_entry);
6484 if let Some(monitor_update) = monitor_update_opt {
6485 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update, peer_state_lock,
6486 peer_state, per_peer_state, chan);
6490 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6491 "Got a commitment_signed message for an unfunded channel!".into())), chan_phase_entry);
6494 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))
6499 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
6500 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
6501 let mut push_forward_event = false;
6502 let mut new_intercept_events = VecDeque::new();
6503 let mut failed_intercept_forwards = Vec::new();
6504 if !pending_forwards.is_empty() {
6505 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
6506 let scid = match forward_info.routing {
6507 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
6508 PendingHTLCRouting::Receive { .. } => 0,
6509 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
6511 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
6512 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
6514 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
6515 let forward_htlcs_empty = forward_htlcs.is_empty();
6516 match forward_htlcs.entry(scid) {
6517 hash_map::Entry::Occupied(mut entry) => {
6518 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6519 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
6521 hash_map::Entry::Vacant(entry) => {
6522 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
6523 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.genesis_hash)
6525 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).into_inner());
6526 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
6527 match pending_intercepts.entry(intercept_id) {
6528 hash_map::Entry::Vacant(entry) => {
6529 new_intercept_events.push_back((events::Event::HTLCIntercepted {
6530 requested_next_hop_scid: scid,
6531 payment_hash: forward_info.payment_hash,
6532 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
6533 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
6536 entry.insert(PendingAddHTLCInfo {
6537 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
6539 hash_map::Entry::Occupied(_) => {
6540 log_info!(self.logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
6541 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
6542 short_channel_id: prev_short_channel_id,
6543 user_channel_id: Some(prev_user_channel_id),
6544 outpoint: prev_funding_outpoint,
6545 htlc_id: prev_htlc_id,
6546 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
6547 phantom_shared_secret: None,
6550 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
6551 HTLCFailReason::from_failure_code(0x4000 | 10),
6552 HTLCDestination::InvalidForward { requested_forward_scid: scid },
6557 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
6558 // payments are being processed.
6559 if forward_htlcs_empty {
6560 push_forward_event = true;
6562 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6563 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
6570 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
6571 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
6574 if !new_intercept_events.is_empty() {
6575 let mut events = self.pending_events.lock().unwrap();
6576 events.append(&mut new_intercept_events);
6578 if push_forward_event { self.push_pending_forwards_ev() }
6582 fn push_pending_forwards_ev(&self) {
6583 let mut pending_events = self.pending_events.lock().unwrap();
6584 let is_processing_events = self.pending_events_processor.load(Ordering::Acquire);
6585 let num_forward_events = pending_events.iter().filter(|(ev, _)|
6586 if let events::Event::PendingHTLCsForwardable { .. } = ev { true } else { false }
6588 // We only want to push a PendingHTLCsForwardable event if no others are queued. Processing
6589 // events is done in batches and they are not removed until we're done processing each
6590 // batch. Since handling a `PendingHTLCsForwardable` event will call back into the
6591 // `ChannelManager`, we'll still see the original forwarding event not removed. Phantom
6592 // payments will need an additional forwarding event before being claimed to make them look
6593 // real by taking more time.
6594 if (is_processing_events && num_forward_events <= 1) || num_forward_events < 1 {
6595 pending_events.push_back((Event::PendingHTLCsForwardable {
6596 time_forwardable: Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
6601 /// Checks whether [`ChannelMonitorUpdate`]s generated by the receipt of a remote
6602 /// [`msgs::RevokeAndACK`] should be held for the given channel until some other action
6603 /// completes. Note that this needs to happen in the same [`PeerState`] mutex as any release of
6604 /// the [`ChannelMonitorUpdate`] in question.
6605 fn raa_monitor_updates_held(&self,
6606 actions_blocking_raa_monitor_updates: &BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
6607 channel_funding_outpoint: OutPoint, counterparty_node_id: PublicKey
6609 actions_blocking_raa_monitor_updates
6610 .get(&channel_funding_outpoint.to_channel_id()).map(|v| !v.is_empty()).unwrap_or(false)
6611 || self.pending_events.lock().unwrap().iter().any(|(_, action)| {
6612 action == &Some(EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
6613 channel_funding_outpoint,
6614 counterparty_node_id,
6619 #[cfg(any(test, feature = "_test_utils"))]
6620 pub(crate) fn test_raa_monitor_updates_held(&self,
6621 counterparty_node_id: PublicKey, channel_id: ChannelId
6623 let per_peer_state = self.per_peer_state.read().unwrap();
6624 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
6625 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
6626 let peer_state = &mut *peer_state_lck;
6628 if let Some(chan) = peer_state.channel_by_id.get(&channel_id) {
6629 return self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
6630 chan.context().get_funding_txo().unwrap(), counterparty_node_id);
6636 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
6637 let htlcs_to_fail = {
6638 let per_peer_state = self.per_peer_state.read().unwrap();
6639 let mut peer_state_lock = per_peer_state.get(counterparty_node_id)
6641 debug_assert!(false);
6642 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6643 }).map(|mtx| mtx.lock().unwrap())?;
6644 let peer_state = &mut *peer_state_lock;
6645 match peer_state.channel_by_id.entry(msg.channel_id) {
6646 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6647 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6648 let funding_txo_opt = chan.context.get_funding_txo();
6649 let mon_update_blocked = if let Some(funding_txo) = funding_txo_opt {
6650 self.raa_monitor_updates_held(
6651 &peer_state.actions_blocking_raa_monitor_updates, funding_txo,
6652 *counterparty_node_id)
6654 let (htlcs_to_fail, monitor_update_opt) = try_chan_phase_entry!(self,
6655 chan.revoke_and_ack(&msg, &self.fee_estimator, &self.logger, mon_update_blocked), chan_phase_entry);
6656 if let Some(monitor_update) = monitor_update_opt {
6657 let funding_txo = funding_txo_opt
6658 .expect("Funding outpoint must have been set for RAA handling to succeed");
6659 handle_new_monitor_update!(self, funding_txo, monitor_update,
6660 peer_state_lock, peer_state, per_peer_state, chan);
6664 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6665 "Got a revoke_and_ack message for an unfunded channel!".into())), chan_phase_entry);
6668 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))
6671 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
6675 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
6676 let per_peer_state = self.per_peer_state.read().unwrap();
6677 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6679 debug_assert!(false);
6680 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6682 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6683 let peer_state = &mut *peer_state_lock;
6684 match peer_state.channel_by_id.entry(msg.channel_id) {
6685 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6686 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6687 try_chan_phase_entry!(self, chan.update_fee(&self.fee_estimator, &msg, &self.logger), chan_phase_entry);
6689 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6690 "Got an update_fee message for an unfunded channel!".into())), chan_phase_entry);
6693 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))
6698 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
6699 let per_peer_state = self.per_peer_state.read().unwrap();
6700 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6702 debug_assert!(false);
6703 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6705 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6706 let peer_state = &mut *peer_state_lock;
6707 match peer_state.channel_by_id.entry(msg.channel_id) {
6708 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6709 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6710 if !chan.context.is_usable() {
6711 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
6714 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
6715 msg: try_chan_phase_entry!(self, chan.announcement_signatures(
6716 &self.node_signer, self.genesis_hash.clone(), self.best_block.read().unwrap().height(),
6717 msg, &self.default_configuration
6718 ), chan_phase_entry),
6719 // Note that announcement_signatures fails if the channel cannot be announced,
6720 // so get_channel_update_for_broadcast will never fail by the time we get here.
6721 update_msg: Some(self.get_channel_update_for_broadcast(chan).unwrap()),
6724 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6725 "Got an announcement_signatures message for an unfunded channel!".into())), chan_phase_entry);
6728 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))
6733 /// Returns DoPersist if anything changed, otherwise either SkipPersistNoEvents or an Err.
6734 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
6735 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
6736 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
6738 // It's not a local channel
6739 return Ok(NotifyOption::SkipPersistNoEvents)
6742 let per_peer_state = self.per_peer_state.read().unwrap();
6743 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
6744 if peer_state_mutex_opt.is_none() {
6745 return Ok(NotifyOption::SkipPersistNoEvents)
6747 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
6748 let peer_state = &mut *peer_state_lock;
6749 match peer_state.channel_by_id.entry(chan_id) {
6750 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6751 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6752 if chan.context.get_counterparty_node_id() != *counterparty_node_id {
6753 if chan.context.should_announce() {
6754 // If the announcement is about a channel of ours which is public, some
6755 // other peer may simply be forwarding all its gossip to us. Don't provide
6756 // a scary-looking error message and return Ok instead.
6757 return Ok(NotifyOption::SkipPersistNoEvents);
6759 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));
6761 let were_node_one = self.get_our_node_id().serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
6762 let msg_from_node_one = msg.contents.flags & 1 == 0;
6763 if were_node_one == msg_from_node_one {
6764 return Ok(NotifyOption::SkipPersistNoEvents);
6766 log_debug!(self.logger, "Received channel_update {:?} for channel {}.", msg, chan_id);
6767 let did_change = try_chan_phase_entry!(self, chan.channel_update(&msg), chan_phase_entry);
6768 // If nothing changed after applying their update, we don't need to bother
6771 return Ok(NotifyOption::SkipPersistNoEvents);
6775 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6776 "Got a channel_update for an unfunded channel!".into())), chan_phase_entry);
6779 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersistNoEvents)
6781 Ok(NotifyOption::DoPersist)
6784 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<NotifyOption, MsgHandleErrInternal> {
6786 let need_lnd_workaround = {
6787 let per_peer_state = self.per_peer_state.read().unwrap();
6789 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6791 debug_assert!(false);
6792 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6794 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6795 let peer_state = &mut *peer_state_lock;
6796 match peer_state.channel_by_id.entry(msg.channel_id) {
6797 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6798 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6799 // Currently, we expect all holding cell update_adds to be dropped on peer
6800 // disconnect, so Channel's reestablish will never hand us any holding cell
6801 // freed HTLCs to fail backwards. If in the future we no longer drop pending
6802 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
6803 let responses = try_chan_phase_entry!(self, chan.channel_reestablish(
6804 msg, &self.logger, &self.node_signer, self.genesis_hash,
6805 &self.default_configuration, &*self.best_block.read().unwrap()), chan_phase_entry);
6806 let mut channel_update = None;
6807 if let Some(msg) = responses.shutdown_msg {
6808 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
6809 node_id: counterparty_node_id.clone(),
6812 } else if chan.context.is_usable() {
6813 // If the channel is in a usable state (ie the channel is not being shut
6814 // down), send a unicast channel_update to our counterparty to make sure
6815 // they have the latest channel parameters.
6816 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
6817 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
6818 node_id: chan.context.get_counterparty_node_id(),
6823 let need_lnd_workaround = chan.context.workaround_lnd_bug_4006.take();
6824 htlc_forwards = self.handle_channel_resumption(
6825 &mut peer_state.pending_msg_events, chan, responses.raa, responses.commitment_update, responses.order,
6826 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
6827 if let Some(upd) = channel_update {
6828 peer_state.pending_msg_events.push(upd);
6832 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6833 "Got a channel_reestablish message for an unfunded channel!".into())), chan_phase_entry);
6836 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))
6840 let mut persist = NotifyOption::SkipPersistHandleEvents;
6841 if let Some(forwards) = htlc_forwards {
6842 self.forward_htlcs(&mut [forwards][..]);
6843 persist = NotifyOption::DoPersist;
6846 if let Some(channel_ready_msg) = need_lnd_workaround {
6847 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
6852 /// Process pending events from the [`chain::Watch`], returning whether any events were processed.
6853 fn process_pending_monitor_events(&self) -> bool {
6854 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
6856 let mut failed_channels = Vec::new();
6857 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
6858 let has_pending_monitor_events = !pending_monitor_events.is_empty();
6859 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
6860 for monitor_event in monitor_events.drain(..) {
6861 match monitor_event {
6862 MonitorEvent::HTLCEvent(htlc_update) => {
6863 if let Some(preimage) = htlc_update.payment_preimage {
6864 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", preimage);
6865 self.claim_funds_internal(htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, counterparty_node_id, funding_outpoint);
6867 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", &htlc_update.payment_hash);
6868 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
6869 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
6870 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
6873 MonitorEvent::HolderForceClosed(funding_outpoint) => {
6874 let counterparty_node_id_opt = match counterparty_node_id {
6875 Some(cp_id) => Some(cp_id),
6877 // TODO: Once we can rely on the counterparty_node_id from the
6878 // monitor event, this and the id_to_peer map should be removed.
6879 let id_to_peer = self.id_to_peer.lock().unwrap();
6880 id_to_peer.get(&funding_outpoint.to_channel_id()).cloned()
6883 if let Some(counterparty_node_id) = counterparty_node_id_opt {
6884 let per_peer_state = self.per_peer_state.read().unwrap();
6885 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
6886 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6887 let peer_state = &mut *peer_state_lock;
6888 let pending_msg_events = &mut peer_state.pending_msg_events;
6889 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(funding_outpoint.to_channel_id()) {
6890 if let ChannelPhase::Funded(mut chan) = remove_channel_phase!(self, chan_phase_entry) {
6891 failed_channels.push(chan.context.force_shutdown(false));
6892 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6893 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6897 self.issue_channel_close_events(&chan.context, ClosureReason::HolderForceClosed);
6898 pending_msg_events.push(events::MessageSendEvent::HandleError {
6899 node_id: chan.context.get_counterparty_node_id(),
6900 action: msgs::ErrorAction::SendErrorMessage {
6901 msg: msgs::ErrorMessage { channel_id: chan.context.channel_id(), data: "Channel force-closed".to_owned() }
6909 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
6910 self.channel_monitor_updated(&funding_txo, monitor_update_id, counterparty_node_id.as_ref());
6916 for failure in failed_channels.drain(..) {
6917 self.finish_close_channel(failure);
6920 has_pending_monitor_events
6923 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
6924 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
6925 /// update events as a separate process method here.
6927 pub fn process_monitor_events(&self) {
6928 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6929 self.process_pending_monitor_events();
6932 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
6933 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
6934 /// update was applied.
6935 fn check_free_holding_cells(&self) -> bool {
6936 let mut has_monitor_update = false;
6937 let mut failed_htlcs = Vec::new();
6939 // Walk our list of channels and find any that need to update. Note that when we do find an
6940 // update, if it includes actions that must be taken afterwards, we have to drop the
6941 // per-peer state lock as well as the top level per_peer_state lock. Thus, we loop until we
6942 // manage to go through all our peers without finding a single channel to update.
6944 let per_peer_state = self.per_peer_state.read().unwrap();
6945 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6947 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6948 let peer_state: &mut PeerState<_> = &mut *peer_state_lock;
6949 for (channel_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
6950 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
6952 let counterparty_node_id = chan.context.get_counterparty_node_id();
6953 let funding_txo = chan.context.get_funding_txo();
6954 let (monitor_opt, holding_cell_failed_htlcs) =
6955 chan.maybe_free_holding_cell_htlcs(&self.fee_estimator, &self.logger);
6956 if !holding_cell_failed_htlcs.is_empty() {
6957 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id, counterparty_node_id));
6959 if let Some(monitor_update) = monitor_opt {
6960 has_monitor_update = true;
6962 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update,
6963 peer_state_lock, peer_state, per_peer_state, chan);
6964 continue 'peer_loop;
6973 let has_update = has_monitor_update || !failed_htlcs.is_empty();
6974 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
6975 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
6981 /// Check whether any channels have finished removing all pending updates after a shutdown
6982 /// exchange and can now send a closing_signed.
6983 /// Returns whether any closing_signed messages were generated.
6984 fn maybe_generate_initial_closing_signed(&self) -> bool {
6985 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
6986 let mut has_update = false;
6987 let mut shutdown_result = None;
6988 let mut unbroadcasted_batch_funding_txid = None;
6990 let per_peer_state = self.per_peer_state.read().unwrap();
6992 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6993 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6994 let peer_state = &mut *peer_state_lock;
6995 let pending_msg_events = &mut peer_state.pending_msg_events;
6996 peer_state.channel_by_id.retain(|channel_id, phase| {
6998 ChannelPhase::Funded(chan) => {
6999 unbroadcasted_batch_funding_txid = chan.context.unbroadcasted_batch_funding_txid();
7000 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
7001 Ok((msg_opt, tx_opt)) => {
7002 if let Some(msg) = msg_opt {
7004 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
7005 node_id: chan.context.get_counterparty_node_id(), msg,
7008 if let Some(tx) = tx_opt {
7009 // We're done with this channel. We got a closing_signed and sent back
7010 // a closing_signed with a closing transaction to broadcast.
7011 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
7012 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7017 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
7019 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
7020 self.tx_broadcaster.broadcast_transactions(&[&tx]);
7021 update_maps_on_chan_removal!(self, &chan.context);
7022 shutdown_result = Some((None, Vec::new(), unbroadcasted_batch_funding_txid));
7028 let (close_channel, res) = convert_chan_phase_err!(self, e, chan, channel_id, FUNDED_CHANNEL);
7029 handle_errors.push((chan.context.get_counterparty_node_id(), Err(res)));
7034 _ => true, // Retain unfunded channels if present.
7040 for (counterparty_node_id, err) in handle_errors.drain(..) {
7041 let _ = handle_error!(self, err, counterparty_node_id);
7044 if let Some(shutdown_result) = shutdown_result {
7045 self.finish_close_channel(shutdown_result);
7051 /// Handle a list of channel failures during a block_connected or block_disconnected call,
7052 /// pushing the channel monitor update (if any) to the background events queue and removing the
7054 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
7055 for mut failure in failed_channels.drain(..) {
7056 // Either a commitment transactions has been confirmed on-chain or
7057 // Channel::block_disconnected detected that the funding transaction has been
7058 // reorganized out of the main chain.
7059 // We cannot broadcast our latest local state via monitor update (as
7060 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
7061 // so we track the update internally and handle it when the user next calls
7062 // timer_tick_occurred, guaranteeing we're running normally.
7063 if let Some((counterparty_node_id, funding_txo, update)) = failure.0.take() {
7064 assert_eq!(update.updates.len(), 1);
7065 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
7066 assert!(should_broadcast);
7067 } else { unreachable!(); }
7068 self.pending_background_events.lock().unwrap().push(
7069 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
7070 counterparty_node_id, funding_txo, update
7073 self.finish_close_channel(failure);
7077 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
7080 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
7081 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
7083 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
7084 /// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
7085 /// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
7086 /// passed directly to [`claim_funds`].
7088 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
7090 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
7091 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
7095 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
7096 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
7098 /// Errors if `min_value_msat` is greater than total bitcoin supply.
7100 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
7101 /// on versions of LDK prior to 0.0.114.
7103 /// [`claim_funds`]: Self::claim_funds
7104 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
7105 /// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
7106 /// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
7107 /// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
7108 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
7109 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
7110 min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
7111 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs,
7112 &self.entropy_source, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
7113 min_final_cltv_expiry_delta)
7116 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
7117 /// stored external to LDK.
7119 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
7120 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
7121 /// the `min_value_msat` provided here, if one is provided.
7123 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
7124 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
7127 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
7128 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
7129 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
7130 /// sender "proof-of-payment" unless they have paid the required amount.
7132 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
7133 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
7134 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
7135 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
7136 /// invoices when no timeout is set.
7138 /// Note that we use block header time to time-out pending inbound payments (with some margin
7139 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
7140 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
7141 /// If you need exact expiry semantics, you should enforce them upon receipt of
7142 /// [`PaymentClaimable`].
7144 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
7145 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
7147 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
7148 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
7152 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
7153 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
7155 /// Errors if `min_value_msat` is greater than total bitcoin supply.
7157 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
7158 /// on versions of LDK prior to 0.0.114.
7160 /// [`create_inbound_payment`]: Self::create_inbound_payment
7161 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
7162 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>,
7163 invoice_expiry_delta_secs: u32, min_final_cltv_expiry: Option<u16>) -> Result<PaymentSecret, ()> {
7164 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash,
7165 invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
7166 min_final_cltv_expiry)
7169 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
7170 /// previously returned from [`create_inbound_payment`].
7172 /// [`create_inbound_payment`]: Self::create_inbound_payment
7173 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
7174 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
7177 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
7178 /// are used when constructing the phantom invoice's route hints.
7180 /// [phantom node payments]: crate::sign::PhantomKeysManager
7181 pub fn get_phantom_scid(&self) -> u64 {
7182 let best_block_height = self.best_block.read().unwrap().height();
7183 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
7185 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
7186 // Ensure the generated scid doesn't conflict with a real channel.
7187 match short_to_chan_info.get(&scid_candidate) {
7188 Some(_) => continue,
7189 None => return scid_candidate
7194 /// Gets route hints for use in receiving [phantom node payments].
7196 /// [phantom node payments]: crate::sign::PhantomKeysManager
7197 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
7199 channels: self.list_usable_channels(),
7200 phantom_scid: self.get_phantom_scid(),
7201 real_node_pubkey: self.get_our_node_id(),
7205 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
7206 /// used when constructing the route hints for HTLCs intended to be intercepted. See
7207 /// [`ChannelManager::forward_intercepted_htlc`].
7209 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
7210 /// times to get a unique scid.
7211 pub fn get_intercept_scid(&self) -> u64 {
7212 let best_block_height = self.best_block.read().unwrap().height();
7213 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
7215 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
7216 // Ensure the generated scid doesn't conflict with a real channel.
7217 if short_to_chan_info.contains_key(&scid_candidate) { continue }
7218 return scid_candidate
7222 /// Gets inflight HTLC information by processing pending outbound payments that are in
7223 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
7224 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
7225 let mut inflight_htlcs = InFlightHtlcs::new();
7227 let per_peer_state = self.per_peer_state.read().unwrap();
7228 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7229 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7230 let peer_state = &mut *peer_state_lock;
7231 for chan in peer_state.channel_by_id.values().filter_map(
7232 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
7234 for (htlc_source, _) in chan.inflight_htlc_sources() {
7235 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
7236 inflight_htlcs.process_path(path, self.get_our_node_id());
7245 #[cfg(any(test, feature = "_test_utils"))]
7246 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
7247 let events = core::cell::RefCell::new(Vec::new());
7248 let event_handler = |event: events::Event| events.borrow_mut().push(event);
7249 self.process_pending_events(&event_handler);
7253 #[cfg(feature = "_test_utils")]
7254 pub fn push_pending_event(&self, event: events::Event) {
7255 let mut events = self.pending_events.lock().unwrap();
7256 events.push_back((event, None));
7260 pub fn pop_pending_event(&self) -> Option<events::Event> {
7261 let mut events = self.pending_events.lock().unwrap();
7262 events.pop_front().map(|(e, _)| e)
7266 pub fn has_pending_payments(&self) -> bool {
7267 self.pending_outbound_payments.has_pending_payments()
7271 pub fn clear_pending_payments(&self) {
7272 self.pending_outbound_payments.clear_pending_payments()
7275 /// When something which was blocking a channel from updating its [`ChannelMonitor`] (e.g. an
7276 /// [`Event`] being handled) completes, this should be called to restore the channel to normal
7277 /// operation. It will double-check that nothing *else* is also blocking the same channel from
7278 /// making progress and then let any blocked [`ChannelMonitorUpdate`]s fly.
7279 fn handle_monitor_update_release(&self, counterparty_node_id: PublicKey, channel_funding_outpoint: OutPoint, mut completed_blocker: Option<RAAMonitorUpdateBlockingAction>) {
7281 let per_peer_state = self.per_peer_state.read().unwrap();
7282 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
7283 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
7284 let peer_state = &mut *peer_state_lck;
7286 if let Some(blocker) = completed_blocker.take() {
7287 // Only do this on the first iteration of the loop.
7288 if let Some(blockers) = peer_state.actions_blocking_raa_monitor_updates
7289 .get_mut(&channel_funding_outpoint.to_channel_id())
7291 blockers.retain(|iter| iter != &blocker);
7295 if self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
7296 channel_funding_outpoint, counterparty_node_id) {
7297 // Check that, while holding the peer lock, we don't have anything else
7298 // blocking monitor updates for this channel. If we do, release the monitor
7299 // update(s) when those blockers complete.
7300 log_trace!(self.logger, "Delaying monitor unlock for channel {} as another channel's mon update needs to complete first",
7301 &channel_funding_outpoint.to_channel_id());
7305 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(channel_funding_outpoint.to_channel_id()) {
7306 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7307 debug_assert_eq!(chan.context.get_funding_txo().unwrap(), channel_funding_outpoint);
7308 if let Some((monitor_update, further_update_exists)) = chan.unblock_next_blocked_monitor_update() {
7309 log_debug!(self.logger, "Unlocking monitor updating for channel {} and updating monitor",
7310 channel_funding_outpoint.to_channel_id());
7311 handle_new_monitor_update!(self, channel_funding_outpoint, monitor_update,
7312 peer_state_lck, peer_state, per_peer_state, chan);
7313 if further_update_exists {
7314 // If there are more `ChannelMonitorUpdate`s to process, restart at the
7319 log_trace!(self.logger, "Unlocked monitor updating for channel {} without monitors to update",
7320 channel_funding_outpoint.to_channel_id());
7325 log_debug!(self.logger,
7326 "Got a release post-RAA monitor update for peer {} but the channel is gone",
7327 log_pubkey!(counterparty_node_id));
7333 fn handle_post_event_actions(&self, actions: Vec<EventCompletionAction>) {
7334 for action in actions {
7336 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
7337 channel_funding_outpoint, counterparty_node_id
7339 self.handle_monitor_update_release(counterparty_node_id, channel_funding_outpoint, None);
7345 /// Processes any events asynchronously in the order they were generated since the last call
7346 /// using the given event handler.
7348 /// See the trait-level documentation of [`EventsProvider`] for requirements.
7349 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
7353 process_events_body!(self, ev, { handler(ev).await });
7357 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>
7359 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7360 T::Target: BroadcasterInterface,
7361 ES::Target: EntropySource,
7362 NS::Target: NodeSigner,
7363 SP::Target: SignerProvider,
7364 F::Target: FeeEstimator,
7368 /// Returns `MessageSendEvent`s strictly ordered per-peer, in the order they were generated.
7369 /// The returned array will contain `MessageSendEvent`s for different peers if
7370 /// `MessageSendEvent`s to more than one peer exists, but `MessageSendEvent`s to the same peer
7371 /// is always placed next to each other.
7373 /// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
7374 /// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
7375 /// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
7376 /// will randomly be placed first or last in the returned array.
7378 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
7379 /// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
7380 /// the `MessageSendEvent`s to the specific peer they were generated under.
7381 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
7382 let events = RefCell::new(Vec::new());
7383 PersistenceNotifierGuard::optionally_notify(self, || {
7384 let mut result = NotifyOption::SkipPersistNoEvents;
7386 // TODO: This behavior should be documented. It's unintuitive that we query
7387 // ChannelMonitors when clearing other events.
7388 if self.process_pending_monitor_events() {
7389 result = NotifyOption::DoPersist;
7392 if self.check_free_holding_cells() {
7393 result = NotifyOption::DoPersist;
7395 if self.maybe_generate_initial_closing_signed() {
7396 result = NotifyOption::DoPersist;
7399 let mut pending_events = Vec::new();
7400 let per_peer_state = self.per_peer_state.read().unwrap();
7401 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7402 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7403 let peer_state = &mut *peer_state_lock;
7404 if peer_state.pending_msg_events.len() > 0 {
7405 pending_events.append(&mut peer_state.pending_msg_events);
7409 if !pending_events.is_empty() {
7410 events.replace(pending_events);
7419 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>
7421 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7422 T::Target: BroadcasterInterface,
7423 ES::Target: EntropySource,
7424 NS::Target: NodeSigner,
7425 SP::Target: SignerProvider,
7426 F::Target: FeeEstimator,
7430 /// Processes events that must be periodically handled.
7432 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
7433 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
7434 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
7436 process_events_body!(self, ev, handler.handle_event(ev));
7440 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>
7442 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7443 T::Target: BroadcasterInterface,
7444 ES::Target: EntropySource,
7445 NS::Target: NodeSigner,
7446 SP::Target: SignerProvider,
7447 F::Target: FeeEstimator,
7451 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
7453 let best_block = self.best_block.read().unwrap();
7454 assert_eq!(best_block.block_hash(), header.prev_blockhash,
7455 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
7456 assert_eq!(best_block.height(), height - 1,
7457 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
7460 self.transactions_confirmed(header, txdata, height);
7461 self.best_block_updated(header, height);
7464 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
7465 let _persistence_guard =
7466 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
7467 self, || -> NotifyOption { NotifyOption::DoPersist });
7468 let new_height = height - 1;
7470 let mut best_block = self.best_block.write().unwrap();
7471 assert_eq!(best_block.block_hash(), header.block_hash(),
7472 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
7473 assert_eq!(best_block.height(), height,
7474 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
7475 *best_block = BestBlock::new(header.prev_blockhash, new_height)
7478 self.do_chain_event(Some(new_height), |channel| channel.best_block_updated(new_height, header.time, self.genesis_hash.clone(), &self.node_signer, &self.default_configuration, &self.logger));
7482 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>
7484 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7485 T::Target: BroadcasterInterface,
7486 ES::Target: EntropySource,
7487 NS::Target: NodeSigner,
7488 SP::Target: SignerProvider,
7489 F::Target: FeeEstimator,
7493 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
7494 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
7495 // during initialization prior to the chain_monitor being fully configured in some cases.
7496 // See the docs for `ChannelManagerReadArgs` for more.
7498 let block_hash = header.block_hash();
7499 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
7501 let _persistence_guard =
7502 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
7503 self, || -> NotifyOption { NotifyOption::DoPersist });
7504 self.do_chain_event(Some(height), |channel| channel.transactions_confirmed(&block_hash, height, txdata, self.genesis_hash.clone(), &self.node_signer, &self.default_configuration, &self.logger)
7505 .map(|(a, b)| (a, Vec::new(), b)));
7507 let last_best_block_height = self.best_block.read().unwrap().height();
7508 if height < last_best_block_height {
7509 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
7510 self.do_chain_event(Some(last_best_block_height), |channel| channel.best_block_updated(last_best_block_height, timestamp as u32, self.genesis_hash.clone(), &self.node_signer, &self.default_configuration, &self.logger));
7514 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
7515 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
7516 // during initialization prior to the chain_monitor being fully configured in some cases.
7517 // See the docs for `ChannelManagerReadArgs` for more.
7519 let block_hash = header.block_hash();
7520 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
7522 let _persistence_guard =
7523 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
7524 self, || -> NotifyOption { NotifyOption::DoPersist });
7525 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
7527 self.do_chain_event(Some(height), |channel| channel.best_block_updated(height, header.time, self.genesis_hash.clone(), &self.node_signer, &self.default_configuration, &self.logger));
7529 macro_rules! max_time {
7530 ($timestamp: expr) => {
7532 // Update $timestamp to be the max of its current value and the block
7533 // timestamp. This should keep us close to the current time without relying on
7534 // having an explicit local time source.
7535 // Just in case we end up in a race, we loop until we either successfully
7536 // update $timestamp or decide we don't need to.
7537 let old_serial = $timestamp.load(Ordering::Acquire);
7538 if old_serial >= header.time as usize { break; }
7539 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
7545 max_time!(self.highest_seen_timestamp);
7546 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
7547 payment_secrets.retain(|_, inbound_payment| {
7548 inbound_payment.expiry_time > header.time as u64
7552 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
7553 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
7554 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
7555 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7556 let peer_state = &mut *peer_state_lock;
7557 for chan in peer_state.channel_by_id.values().filter_map(|phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }) {
7558 if let (Some(funding_txo), Some(block_hash)) = (chan.context.get_funding_txo(), chan.context.get_funding_tx_confirmed_in()) {
7559 res.push((funding_txo.txid, Some(block_hash)));
7566 fn transaction_unconfirmed(&self, txid: &Txid) {
7567 let _persistence_guard =
7568 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
7569 self, || -> NotifyOption { NotifyOption::DoPersist });
7570 self.do_chain_event(None, |channel| {
7571 if let Some(funding_txo) = channel.context.get_funding_txo() {
7572 if funding_txo.txid == *txid {
7573 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
7574 } else { Ok((None, Vec::new(), None)) }
7575 } else { Ok((None, Vec::new(), None)) }
7580 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>
7582 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7583 T::Target: BroadcasterInterface,
7584 ES::Target: EntropySource,
7585 NS::Target: NodeSigner,
7586 SP::Target: SignerProvider,
7587 F::Target: FeeEstimator,
7591 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
7592 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
7594 fn do_chain_event<FN: Fn(&mut Channel<SP>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
7595 (&self, height_opt: Option<u32>, f: FN) {
7596 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
7597 // during initialization prior to the chain_monitor being fully configured in some cases.
7598 // See the docs for `ChannelManagerReadArgs` for more.
7600 let mut failed_channels = Vec::new();
7601 let mut timed_out_htlcs = Vec::new();
7603 let per_peer_state = self.per_peer_state.read().unwrap();
7604 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7605 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7606 let peer_state = &mut *peer_state_lock;
7607 let pending_msg_events = &mut peer_state.pending_msg_events;
7608 peer_state.channel_by_id.retain(|_, phase| {
7610 // Retain unfunded channels.
7611 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => true,
7612 ChannelPhase::Funded(channel) => {
7613 let res = f(channel);
7614 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
7615 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
7616 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
7617 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
7618 HTLCDestination::NextHopChannel { node_id: Some(channel.context.get_counterparty_node_id()), channel_id: channel.context.channel_id() }));
7620 if let Some(channel_ready) = channel_ready_opt {
7621 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
7622 if channel.context.is_usable() {
7623 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", channel.context.channel_id());
7624 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
7625 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
7626 node_id: channel.context.get_counterparty_node_id(),
7631 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", channel.context.channel_id());
7636 let mut pending_events = self.pending_events.lock().unwrap();
7637 emit_channel_ready_event!(pending_events, channel);
7640 if let Some(announcement_sigs) = announcement_sigs {
7641 log_trace!(self.logger, "Sending announcement_signatures for channel {}", channel.context.channel_id());
7642 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
7643 node_id: channel.context.get_counterparty_node_id(),
7644 msg: announcement_sigs,
7646 if let Some(height) = height_opt {
7647 if let Some(announcement) = channel.get_signed_channel_announcement(&self.node_signer, self.genesis_hash, height, &self.default_configuration) {
7648 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
7650 // Note that announcement_signatures fails if the channel cannot be announced,
7651 // so get_channel_update_for_broadcast will never fail by the time we get here.
7652 update_msg: Some(self.get_channel_update_for_broadcast(channel).unwrap()),
7657 if channel.is_our_channel_ready() {
7658 if let Some(real_scid) = channel.context.get_short_channel_id() {
7659 // If we sent a 0conf channel_ready, and now have an SCID, we add it
7660 // to the short_to_chan_info map here. Note that we check whether we
7661 // can relay using the real SCID at relay-time (i.e.
7662 // enforce option_scid_alias then), and if the funding tx is ever
7663 // un-confirmed we force-close the channel, ensuring short_to_chan_info
7664 // is always consistent.
7665 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
7666 let scid_insert = short_to_chan_info.insert(real_scid, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
7667 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.context.get_counterparty_node_id(), channel.context.channel_id()),
7668 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
7669 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
7672 } else if let Err(reason) = res {
7673 update_maps_on_chan_removal!(self, &channel.context);
7674 // It looks like our counterparty went on-chain or funding transaction was
7675 // reorged out of the main chain. Close the channel.
7676 failed_channels.push(channel.context.force_shutdown(true));
7677 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
7678 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7682 let reason_message = format!("{}", reason);
7683 self.issue_channel_close_events(&channel.context, reason);
7684 pending_msg_events.push(events::MessageSendEvent::HandleError {
7685 node_id: channel.context.get_counterparty_node_id(),
7686 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
7687 channel_id: channel.context.channel_id(),
7688 data: reason_message,
7700 if let Some(height) = height_opt {
7701 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
7702 payment.htlcs.retain(|htlc| {
7703 // If height is approaching the number of blocks we think it takes us to get
7704 // our commitment transaction confirmed before the HTLC expires, plus the
7705 // number of blocks we generally consider it to take to do a commitment update,
7706 // just give up on it and fail the HTLC.
7707 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
7708 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
7709 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
7711 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
7712 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
7713 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
7717 !payment.htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
7720 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
7721 intercepted_htlcs.retain(|_, htlc| {
7722 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
7723 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
7724 short_channel_id: htlc.prev_short_channel_id,
7725 user_channel_id: Some(htlc.prev_user_channel_id),
7726 htlc_id: htlc.prev_htlc_id,
7727 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
7728 phantom_shared_secret: None,
7729 outpoint: htlc.prev_funding_outpoint,
7732 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
7733 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
7734 _ => unreachable!(),
7736 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
7737 HTLCFailReason::from_failure_code(0x2000 | 2),
7738 HTLCDestination::InvalidForward { requested_forward_scid }));
7739 log_trace!(self.logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
7745 self.handle_init_event_channel_failures(failed_channels);
7747 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
7748 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
7752 /// Gets a [`Future`] that completes when this [`ChannelManager`] may need to be persisted or
7753 /// may have events that need processing.
7755 /// In order to check if this [`ChannelManager`] needs persisting, call
7756 /// [`Self::get_and_clear_needs_persistence`].
7758 /// Note that callbacks registered on the [`Future`] MUST NOT call back into this
7759 /// [`ChannelManager`] and should instead register actions to be taken later.
7760 pub fn get_event_or_persistence_needed_future(&self) -> Future {
7761 self.event_persist_notifier.get_future()
7764 /// Returns true if this [`ChannelManager`] needs to be persisted.
7765 pub fn get_and_clear_needs_persistence(&self) -> bool {
7766 self.needs_persist_flag.swap(false, Ordering::AcqRel)
7769 #[cfg(any(test, feature = "_test_utils"))]
7770 pub fn get_event_or_persist_condvar_value(&self) -> bool {
7771 self.event_persist_notifier.notify_pending()
7774 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
7775 /// [`chain::Confirm`] interfaces.
7776 pub fn current_best_block(&self) -> BestBlock {
7777 self.best_block.read().unwrap().clone()
7780 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
7781 /// [`ChannelManager`].
7782 pub fn node_features(&self) -> NodeFeatures {
7783 provided_node_features(&self.default_configuration)
7786 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags which are provided by or required by
7787 /// [`ChannelManager`].
7789 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
7790 /// or not. Thus, this method is not public.
7791 #[cfg(any(feature = "_test_utils", test))]
7792 pub fn invoice_features(&self) -> Bolt11InvoiceFeatures {
7793 provided_invoice_features(&self.default_configuration)
7796 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
7797 /// [`ChannelManager`].
7798 pub fn channel_features(&self) -> ChannelFeatures {
7799 provided_channel_features(&self.default_configuration)
7802 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
7803 /// [`ChannelManager`].
7804 pub fn channel_type_features(&self) -> ChannelTypeFeatures {
7805 provided_channel_type_features(&self.default_configuration)
7808 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
7809 /// [`ChannelManager`].
7810 pub fn init_features(&self) -> InitFeatures {
7811 provided_init_features(&self.default_configuration)
7815 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7816 ChannelMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
7818 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7819 T::Target: BroadcasterInterface,
7820 ES::Target: EntropySource,
7821 NS::Target: NodeSigner,
7822 SP::Target: SignerProvider,
7823 F::Target: FeeEstimator,
7827 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) {
7828 // Note that we never need to persist the updated ChannelManager for an inbound
7829 // open_channel message - pre-funded channels are never written so there should be no
7830 // change to the contents.
7831 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
7832 let res = self.internal_open_channel(counterparty_node_id, msg);
7833 let persist = match &res {
7834 Err(e) if e.closes_channel() => {
7835 debug_assert!(false, "We shouldn't close a new channel");
7836 NotifyOption::DoPersist
7838 _ => NotifyOption::SkipPersistHandleEvents,
7840 let _ = handle_error!(self, res, *counterparty_node_id);
7845 fn handle_open_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
7846 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7847 "Dual-funded channels not supported".to_owned(),
7848 msg.temporary_channel_id.clone())), *counterparty_node_id);
7851 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
7852 // Note that we never need to persist the updated ChannelManager for an inbound
7853 // accept_channel message - pre-funded channels are never written so there should be no
7854 // change to the contents.
7855 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
7856 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, msg), *counterparty_node_id);
7857 NotifyOption::SkipPersistHandleEvents
7861 fn handle_accept_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
7862 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7863 "Dual-funded channels not supported".to_owned(),
7864 msg.temporary_channel_id.clone())), *counterparty_node_id);
7867 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
7868 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7869 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
7872 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
7873 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7874 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
7877 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
7878 // Note that we never need to persist the updated ChannelManager for an inbound
7879 // channel_ready message - while the channel's state will change, any channel_ready message
7880 // will ultimately be re-sent on startup and the `ChannelMonitor` won't be updated so we
7881 // will not force-close the channel on startup.
7882 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
7883 let res = self.internal_channel_ready(counterparty_node_id, msg);
7884 let persist = match &res {
7885 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
7886 _ => NotifyOption::SkipPersistHandleEvents,
7888 let _ = handle_error!(self, res, *counterparty_node_id);
7893 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
7894 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7895 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
7898 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
7899 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7900 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
7903 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
7904 // Note that we never need to persist the updated ChannelManager for an inbound
7905 // update_add_htlc message - the message itself doesn't change our channel state only the
7906 // `commitment_signed` message afterwards will.
7907 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
7908 let res = self.internal_update_add_htlc(counterparty_node_id, msg);
7909 let persist = match &res {
7910 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
7911 Err(_) => NotifyOption::SkipPersistHandleEvents,
7912 Ok(()) => NotifyOption::SkipPersistNoEvents,
7914 let _ = handle_error!(self, res, *counterparty_node_id);
7919 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
7920 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7921 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
7924 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
7925 // Note that we never need to persist the updated ChannelManager for an inbound
7926 // update_fail_htlc message - the message itself doesn't change our channel state only the
7927 // `commitment_signed` message afterwards will.
7928 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
7929 let res = self.internal_update_fail_htlc(counterparty_node_id, msg);
7930 let persist = match &res {
7931 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
7932 Err(_) => NotifyOption::SkipPersistHandleEvents,
7933 Ok(()) => NotifyOption::SkipPersistNoEvents,
7935 let _ = handle_error!(self, res, *counterparty_node_id);
7940 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
7941 // Note that we never need to persist the updated ChannelManager for an inbound
7942 // update_fail_malformed_htlc message - the message itself doesn't change our channel state
7943 // only the `commitment_signed` message afterwards will.
7944 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
7945 let res = self.internal_update_fail_malformed_htlc(counterparty_node_id, msg);
7946 let persist = match &res {
7947 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
7948 Err(_) => NotifyOption::SkipPersistHandleEvents,
7949 Ok(()) => NotifyOption::SkipPersistNoEvents,
7951 let _ = handle_error!(self, res, *counterparty_node_id);
7956 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
7957 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7958 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
7961 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
7962 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7963 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
7966 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
7967 // Note that we never need to persist the updated ChannelManager for an inbound
7968 // update_fee message - the message itself doesn't change our channel state only the
7969 // `commitment_signed` message afterwards will.
7970 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
7971 let res = self.internal_update_fee(counterparty_node_id, msg);
7972 let persist = match &res {
7973 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
7974 Err(_) => NotifyOption::SkipPersistHandleEvents,
7975 Ok(()) => NotifyOption::SkipPersistNoEvents,
7977 let _ = handle_error!(self, res, *counterparty_node_id);
7982 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
7983 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7984 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
7987 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
7988 PersistenceNotifierGuard::optionally_notify(self, || {
7989 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
7992 NotifyOption::DoPersist
7997 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
7998 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(self, || {
7999 let res = self.internal_channel_reestablish(counterparty_node_id, msg);
8000 let persist = match &res {
8001 Err(e) if e.closes_channel() => NotifyOption::DoPersist,
8002 Err(_) => NotifyOption::SkipPersistHandleEvents,
8003 Ok(persist) => *persist,
8005 let _ = handle_error!(self, res, *counterparty_node_id);
8010 fn peer_disconnected(&self, counterparty_node_id: &PublicKey) {
8011 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(
8012 self, || NotifyOption::SkipPersistHandleEvents);
8013 let mut failed_channels = Vec::new();
8014 let mut per_peer_state = self.per_peer_state.write().unwrap();
8016 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates.",
8017 log_pubkey!(counterparty_node_id));
8018 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
8019 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8020 let peer_state = &mut *peer_state_lock;
8021 let pending_msg_events = &mut peer_state.pending_msg_events;
8022 peer_state.channel_by_id.retain(|_, phase| {
8023 let context = match phase {
8024 ChannelPhase::Funded(chan) => {
8025 if chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger).is_ok() {
8026 // We only retain funded channels that are not shutdown.
8031 // Unfunded channels will always be removed.
8032 ChannelPhase::UnfundedOutboundV1(chan) => {
8035 ChannelPhase::UnfundedInboundV1(chan) => {
8039 // Clean up for removal.
8040 update_maps_on_chan_removal!(self, &context);
8041 self.issue_channel_close_events(&context, ClosureReason::DisconnectedPeer);
8042 failed_channels.push(context.force_shutdown(false));
8045 // Note that we don't bother generating any events for pre-accept channels -
8046 // they're not considered "channels" yet from the PoV of our events interface.
8047 peer_state.inbound_channel_request_by_id.clear();
8048 pending_msg_events.retain(|msg| {
8050 // V1 Channel Establishment
8051 &events::MessageSendEvent::SendAcceptChannel { .. } => false,
8052 &events::MessageSendEvent::SendOpenChannel { .. } => false,
8053 &events::MessageSendEvent::SendFundingCreated { .. } => false,
8054 &events::MessageSendEvent::SendFundingSigned { .. } => false,
8055 // V2 Channel Establishment
8056 &events::MessageSendEvent::SendAcceptChannelV2 { .. } => false,
8057 &events::MessageSendEvent::SendOpenChannelV2 { .. } => false,
8058 // Common Channel Establishment
8059 &events::MessageSendEvent::SendChannelReady { .. } => false,
8060 &events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
8061 // Interactive Transaction Construction
8062 &events::MessageSendEvent::SendTxAddInput { .. } => false,
8063 &events::MessageSendEvent::SendTxAddOutput { .. } => false,
8064 &events::MessageSendEvent::SendTxRemoveInput { .. } => false,
8065 &events::MessageSendEvent::SendTxRemoveOutput { .. } => false,
8066 &events::MessageSendEvent::SendTxComplete { .. } => false,
8067 &events::MessageSendEvent::SendTxSignatures { .. } => false,
8068 &events::MessageSendEvent::SendTxInitRbf { .. } => false,
8069 &events::MessageSendEvent::SendTxAckRbf { .. } => false,
8070 &events::MessageSendEvent::SendTxAbort { .. } => false,
8071 // Channel Operations
8072 &events::MessageSendEvent::UpdateHTLCs { .. } => false,
8073 &events::MessageSendEvent::SendRevokeAndACK { .. } => false,
8074 &events::MessageSendEvent::SendClosingSigned { .. } => false,
8075 &events::MessageSendEvent::SendShutdown { .. } => false,
8076 &events::MessageSendEvent::SendChannelReestablish { .. } => false,
8077 &events::MessageSendEvent::HandleError { .. } => false,
8079 &events::MessageSendEvent::SendChannelAnnouncement { .. } => false,
8080 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
8081 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
8082 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
8083 &events::MessageSendEvent::SendChannelUpdate { .. } => false,
8084 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
8085 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
8086 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
8087 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
8090 debug_assert!(peer_state.is_connected, "A disconnected peer cannot disconnect");
8091 peer_state.is_connected = false;
8092 peer_state.ok_to_remove(true)
8093 } else { debug_assert!(false, "Unconnected peer disconnected"); true }
8096 per_peer_state.remove(counterparty_node_id);
8098 mem::drop(per_peer_state);
8100 for failure in failed_channels.drain(..) {
8101 self.finish_close_channel(failure);
8105 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init, inbound: bool) -> Result<(), ()> {
8106 if !init_msg.features.supports_static_remote_key() {
8107 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting", log_pubkey!(counterparty_node_id));
8111 let mut res = Ok(());
8113 PersistenceNotifierGuard::optionally_notify(self, || {
8114 // If we have too many peers connected which don't have funded channels, disconnect the
8115 // peer immediately (as long as it doesn't have funded channels). If we have a bunch of
8116 // unfunded channels taking up space in memory for disconnected peers, we still let new
8117 // peers connect, but we'll reject new channels from them.
8118 let connected_peers_without_funded_channels = self.peers_without_funded_channels(|node| node.is_connected);
8119 let inbound_peer_limited = inbound && connected_peers_without_funded_channels >= MAX_NO_CHANNEL_PEERS;
8122 let mut peer_state_lock = self.per_peer_state.write().unwrap();
8123 match peer_state_lock.entry(counterparty_node_id.clone()) {
8124 hash_map::Entry::Vacant(e) => {
8125 if inbound_peer_limited {
8127 return NotifyOption::SkipPersistNoEvents;
8129 e.insert(Mutex::new(PeerState {
8130 channel_by_id: HashMap::new(),
8131 inbound_channel_request_by_id: HashMap::new(),
8132 latest_features: init_msg.features.clone(),
8133 pending_msg_events: Vec::new(),
8134 in_flight_monitor_updates: BTreeMap::new(),
8135 monitor_update_blocked_actions: BTreeMap::new(),
8136 actions_blocking_raa_monitor_updates: BTreeMap::new(),
8140 hash_map::Entry::Occupied(e) => {
8141 let mut peer_state = e.get().lock().unwrap();
8142 peer_state.latest_features = init_msg.features.clone();
8144 let best_block_height = self.best_block.read().unwrap().height();
8145 if inbound_peer_limited &&
8146 Self::unfunded_channel_count(&*peer_state, best_block_height) ==
8147 peer_state.channel_by_id.len()
8150 return NotifyOption::SkipPersistNoEvents;
8153 debug_assert!(!peer_state.is_connected, "A peer shouldn't be connected twice");
8154 peer_state.is_connected = true;
8159 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
8161 let per_peer_state = self.per_peer_state.read().unwrap();
8162 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
8163 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8164 let peer_state = &mut *peer_state_lock;
8165 let pending_msg_events = &mut peer_state.pending_msg_events;
8167 peer_state.channel_by_id.iter_mut().filter_map(|(_, phase)|
8168 if let ChannelPhase::Funded(chan) = phase { Some(chan) } else {
8169 // Since unfunded channel maps are cleared upon disconnecting a peer, and they're not persisted
8170 // (so won't be recovered after a crash), they shouldn't exist here and we would never need to
8171 // worry about closing and removing them.
8172 debug_assert!(false);
8176 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
8177 node_id: chan.context.get_counterparty_node_id(),
8178 msg: chan.get_channel_reestablish(&self.logger),
8183 return NotifyOption::SkipPersistHandleEvents;
8184 //TODO: Also re-broadcast announcement_signatures
8189 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
8190 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
8192 match &msg.data as &str {
8193 "cannot co-op close channel w/ active htlcs"|
8194 "link failed to shutdown" =>
8196 // LND hasn't properly handled shutdown messages ever, and force-closes any time we
8197 // send one while HTLCs are still present. The issue is tracked at
8198 // https://github.com/lightningnetwork/lnd/issues/6039 and has had multiple patches
8199 // to fix it but none so far have managed to land upstream. The issue appears to be
8200 // very low priority for the LND team despite being marked "P1".
8201 // We're not going to bother handling this in a sensible way, instead simply
8202 // repeating the Shutdown message on repeat until morale improves.
8203 if !msg.channel_id.is_zero() {
8204 let per_peer_state = self.per_peer_state.read().unwrap();
8205 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
8206 if peer_state_mutex_opt.is_none() { return; }
8207 let mut peer_state = peer_state_mutex_opt.unwrap().lock().unwrap();
8208 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get(&msg.channel_id) {
8209 if let Some(msg) = chan.get_outbound_shutdown() {
8210 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
8211 node_id: *counterparty_node_id,
8215 peer_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
8216 node_id: *counterparty_node_id,
8217 action: msgs::ErrorAction::SendWarningMessage {
8218 msg: msgs::WarningMessage {
8219 channel_id: msg.channel_id,
8220 data: "You appear to be exhibiting LND bug 6039, we'll keep sending you shutdown messages until you handle them correctly".to_owned()
8222 log_level: Level::Trace,
8232 if msg.channel_id.is_zero() {
8233 let channel_ids: Vec<ChannelId> = {
8234 let per_peer_state = self.per_peer_state.read().unwrap();
8235 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
8236 if peer_state_mutex_opt.is_none() { return; }
8237 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
8238 let peer_state = &mut *peer_state_lock;
8239 // Note that we don't bother generating any events for pre-accept channels -
8240 // they're not considered "channels" yet from the PoV of our events interface.
8241 peer_state.inbound_channel_request_by_id.clear();
8242 peer_state.channel_by_id.keys().cloned().collect()
8244 for channel_id in channel_ids {
8245 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
8246 let _ = self.force_close_channel_with_peer(&channel_id, counterparty_node_id, Some(&msg.data), true);
8250 // First check if we can advance the channel type and try again.
8251 let per_peer_state = self.per_peer_state.read().unwrap();
8252 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
8253 if peer_state_mutex_opt.is_none() { return; }
8254 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
8255 let peer_state = &mut *peer_state_lock;
8256 if let Some(ChannelPhase::UnfundedOutboundV1(chan)) = peer_state.channel_by_id.get_mut(&msg.channel_id) {
8257 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash, &self.fee_estimator) {
8258 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
8259 node_id: *counterparty_node_id,
8267 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
8268 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
8272 fn provided_node_features(&self) -> NodeFeatures {
8273 provided_node_features(&self.default_configuration)
8276 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
8277 provided_init_features(&self.default_configuration)
8280 fn get_genesis_hashes(&self) -> Option<Vec<ChainHash>> {
8281 Some(vec![ChainHash::from(&self.genesis_hash[..])])
8284 fn handle_tx_add_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddInput) {
8285 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8286 "Dual-funded channels not supported".to_owned(),
8287 msg.channel_id.clone())), *counterparty_node_id);
8290 fn handle_tx_add_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
8291 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8292 "Dual-funded channels not supported".to_owned(),
8293 msg.channel_id.clone())), *counterparty_node_id);
8296 fn handle_tx_remove_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
8297 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8298 "Dual-funded channels not supported".to_owned(),
8299 msg.channel_id.clone())), *counterparty_node_id);
8302 fn handle_tx_remove_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
8303 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8304 "Dual-funded channels not supported".to_owned(),
8305 msg.channel_id.clone())), *counterparty_node_id);
8308 fn handle_tx_complete(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxComplete) {
8309 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8310 "Dual-funded channels not supported".to_owned(),
8311 msg.channel_id.clone())), *counterparty_node_id);
8314 fn handle_tx_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxSignatures) {
8315 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8316 "Dual-funded channels not supported".to_owned(),
8317 msg.channel_id.clone())), *counterparty_node_id);
8320 fn handle_tx_init_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
8321 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8322 "Dual-funded channels not supported".to_owned(),
8323 msg.channel_id.clone())), *counterparty_node_id);
8326 fn handle_tx_ack_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
8327 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8328 "Dual-funded channels not supported".to_owned(),
8329 msg.channel_id.clone())), *counterparty_node_id);
8332 fn handle_tx_abort(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAbort) {
8333 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
8334 "Dual-funded channels not supported".to_owned(),
8335 msg.channel_id.clone())), *counterparty_node_id);
8339 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
8340 /// [`ChannelManager`].
8341 pub(crate) fn provided_node_features(config: &UserConfig) -> NodeFeatures {
8342 let mut node_features = provided_init_features(config).to_context();
8343 node_features.set_keysend_optional();
8347 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags which are provided by or required by
8348 /// [`ChannelManager`].
8350 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
8351 /// or not. Thus, this method is not public.
8352 #[cfg(any(feature = "_test_utils", test))]
8353 pub(crate) fn provided_invoice_features(config: &UserConfig) -> Bolt11InvoiceFeatures {
8354 provided_init_features(config).to_context()
8357 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
8358 /// [`ChannelManager`].
8359 pub(crate) fn provided_channel_features(config: &UserConfig) -> ChannelFeatures {
8360 provided_init_features(config).to_context()
8363 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
8364 /// [`ChannelManager`].
8365 pub(crate) fn provided_channel_type_features(config: &UserConfig) -> ChannelTypeFeatures {
8366 ChannelTypeFeatures::from_init(&provided_init_features(config))
8369 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
8370 /// [`ChannelManager`].
8371 pub fn provided_init_features(config: &UserConfig) -> InitFeatures {
8372 // Note that if new features are added here which other peers may (eventually) require, we
8373 // should also add the corresponding (optional) bit to the [`ChannelMessageHandler`] impl for
8374 // [`ErroringMessageHandler`].
8375 let mut features = InitFeatures::empty();
8376 features.set_data_loss_protect_required();
8377 features.set_upfront_shutdown_script_optional();
8378 features.set_variable_length_onion_required();
8379 features.set_static_remote_key_required();
8380 features.set_payment_secret_required();
8381 features.set_basic_mpp_optional();
8382 features.set_wumbo_optional();
8383 features.set_shutdown_any_segwit_optional();
8384 features.set_channel_type_optional();
8385 features.set_scid_privacy_optional();
8386 features.set_zero_conf_optional();
8387 if config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx {
8388 features.set_anchors_zero_fee_htlc_tx_optional();
8393 const SERIALIZATION_VERSION: u8 = 1;
8394 const MIN_SERIALIZATION_VERSION: u8 = 1;
8396 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
8397 (2, fee_base_msat, required),
8398 (4, fee_proportional_millionths, required),
8399 (6, cltv_expiry_delta, required),
8402 impl_writeable_tlv_based!(ChannelCounterparty, {
8403 (2, node_id, required),
8404 (4, features, required),
8405 (6, unspendable_punishment_reserve, required),
8406 (8, forwarding_info, option),
8407 (9, outbound_htlc_minimum_msat, option),
8408 (11, outbound_htlc_maximum_msat, option),
8411 impl Writeable for ChannelDetails {
8412 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8413 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
8414 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
8415 let user_channel_id_low = self.user_channel_id as u64;
8416 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
8417 write_tlv_fields!(writer, {
8418 (1, self.inbound_scid_alias, option),
8419 (2, self.channel_id, required),
8420 (3, self.channel_type, option),
8421 (4, self.counterparty, required),
8422 (5, self.outbound_scid_alias, option),
8423 (6, self.funding_txo, option),
8424 (7, self.config, option),
8425 (8, self.short_channel_id, option),
8426 (9, self.confirmations, option),
8427 (10, self.channel_value_satoshis, required),
8428 (12, self.unspendable_punishment_reserve, option),
8429 (14, user_channel_id_low, required),
8430 (16, self.balance_msat, required),
8431 (18, self.outbound_capacity_msat, required),
8432 (19, self.next_outbound_htlc_limit_msat, required),
8433 (20, self.inbound_capacity_msat, required),
8434 (21, self.next_outbound_htlc_minimum_msat, required),
8435 (22, self.confirmations_required, option),
8436 (24, self.force_close_spend_delay, option),
8437 (26, self.is_outbound, required),
8438 (28, self.is_channel_ready, required),
8439 (30, self.is_usable, required),
8440 (32, self.is_public, required),
8441 (33, self.inbound_htlc_minimum_msat, option),
8442 (35, self.inbound_htlc_maximum_msat, option),
8443 (37, user_channel_id_high_opt, option),
8444 (39, self.feerate_sat_per_1000_weight, option),
8445 (41, self.channel_shutdown_state, option),
8451 impl Readable for ChannelDetails {
8452 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8453 _init_and_read_len_prefixed_tlv_fields!(reader, {
8454 (1, inbound_scid_alias, option),
8455 (2, channel_id, required),
8456 (3, channel_type, option),
8457 (4, counterparty, required),
8458 (5, outbound_scid_alias, option),
8459 (6, funding_txo, option),
8460 (7, config, option),
8461 (8, short_channel_id, option),
8462 (9, confirmations, option),
8463 (10, channel_value_satoshis, required),
8464 (12, unspendable_punishment_reserve, option),
8465 (14, user_channel_id_low, required),
8466 (16, balance_msat, required),
8467 (18, outbound_capacity_msat, required),
8468 // Note that by the time we get past the required read above, outbound_capacity_msat will be
8469 // filled in, so we can safely unwrap it here.
8470 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
8471 (20, inbound_capacity_msat, required),
8472 (21, next_outbound_htlc_minimum_msat, (default_value, 0)),
8473 (22, confirmations_required, option),
8474 (24, force_close_spend_delay, option),
8475 (26, is_outbound, required),
8476 (28, is_channel_ready, required),
8477 (30, is_usable, required),
8478 (32, is_public, required),
8479 (33, inbound_htlc_minimum_msat, option),
8480 (35, inbound_htlc_maximum_msat, option),
8481 (37, user_channel_id_high_opt, option),
8482 (39, feerate_sat_per_1000_weight, option),
8483 (41, channel_shutdown_state, option),
8486 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
8487 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
8488 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
8489 let user_channel_id = user_channel_id_low as u128 +
8490 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
8494 channel_id: channel_id.0.unwrap(),
8496 counterparty: counterparty.0.unwrap(),
8497 outbound_scid_alias,
8501 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
8502 unspendable_punishment_reserve,
8504 balance_msat: balance_msat.0.unwrap(),
8505 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
8506 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
8507 next_outbound_htlc_minimum_msat: next_outbound_htlc_minimum_msat.0.unwrap(),
8508 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
8509 confirmations_required,
8511 force_close_spend_delay,
8512 is_outbound: is_outbound.0.unwrap(),
8513 is_channel_ready: is_channel_ready.0.unwrap(),
8514 is_usable: is_usable.0.unwrap(),
8515 is_public: is_public.0.unwrap(),
8516 inbound_htlc_minimum_msat,
8517 inbound_htlc_maximum_msat,
8518 feerate_sat_per_1000_weight,
8519 channel_shutdown_state,
8524 impl_writeable_tlv_based!(PhantomRouteHints, {
8525 (2, channels, required_vec),
8526 (4, phantom_scid, required),
8527 (6, real_node_pubkey, required),
8530 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
8532 (0, onion_packet, required),
8533 (2, short_channel_id, required),
8536 (0, payment_data, required),
8537 (1, phantom_shared_secret, option),
8538 (2, incoming_cltv_expiry, required),
8539 (3, payment_metadata, option),
8540 (5, custom_tlvs, optional_vec),
8542 (2, ReceiveKeysend) => {
8543 (0, payment_preimage, required),
8544 (2, incoming_cltv_expiry, required),
8545 (3, payment_metadata, option),
8546 (4, payment_data, option), // Added in 0.0.116
8547 (5, custom_tlvs, optional_vec),
8551 impl_writeable_tlv_based!(PendingHTLCInfo, {
8552 (0, routing, required),
8553 (2, incoming_shared_secret, required),
8554 (4, payment_hash, required),
8555 (6, outgoing_amt_msat, required),
8556 (8, outgoing_cltv_value, required),
8557 (9, incoming_amt_msat, option),
8558 (10, skimmed_fee_msat, option),
8562 impl Writeable for HTLCFailureMsg {
8563 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8565 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
8567 channel_id.write(writer)?;
8568 htlc_id.write(writer)?;
8569 reason.write(writer)?;
8571 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
8572 channel_id, htlc_id, sha256_of_onion, failure_code
8575 channel_id.write(writer)?;
8576 htlc_id.write(writer)?;
8577 sha256_of_onion.write(writer)?;
8578 failure_code.write(writer)?;
8585 impl Readable for HTLCFailureMsg {
8586 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8587 let id: u8 = Readable::read(reader)?;
8590 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
8591 channel_id: Readable::read(reader)?,
8592 htlc_id: Readable::read(reader)?,
8593 reason: Readable::read(reader)?,
8597 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
8598 channel_id: Readable::read(reader)?,
8599 htlc_id: Readable::read(reader)?,
8600 sha256_of_onion: Readable::read(reader)?,
8601 failure_code: Readable::read(reader)?,
8604 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
8605 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
8606 // messages contained in the variants.
8607 // In version 0.0.101, support for reading the variants with these types was added, and
8608 // we should migrate to writing these variants when UpdateFailHTLC or
8609 // UpdateFailMalformedHTLC get TLV fields.
8611 let length: BigSize = Readable::read(reader)?;
8612 let mut s = FixedLengthReader::new(reader, length.0);
8613 let res = Readable::read(&mut s)?;
8614 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
8615 Ok(HTLCFailureMsg::Relay(res))
8618 let length: BigSize = Readable::read(reader)?;
8619 let mut s = FixedLengthReader::new(reader, length.0);
8620 let res = Readable::read(&mut s)?;
8621 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
8622 Ok(HTLCFailureMsg::Malformed(res))
8624 _ => Err(DecodeError::UnknownRequiredFeature),
8629 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
8634 impl_writeable_tlv_based!(HTLCPreviousHopData, {
8635 (0, short_channel_id, required),
8636 (1, phantom_shared_secret, option),
8637 (2, outpoint, required),
8638 (4, htlc_id, required),
8639 (6, incoming_packet_shared_secret, required),
8640 (7, user_channel_id, option),
8643 impl Writeable for ClaimableHTLC {
8644 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8645 let (payment_data, keysend_preimage) = match &self.onion_payload {
8646 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
8647 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
8649 write_tlv_fields!(writer, {
8650 (0, self.prev_hop, required),
8651 (1, self.total_msat, required),
8652 (2, self.value, required),
8653 (3, self.sender_intended_value, required),
8654 (4, payment_data, option),
8655 (5, self.total_value_received, option),
8656 (6, self.cltv_expiry, required),
8657 (8, keysend_preimage, option),
8658 (10, self.counterparty_skimmed_fee_msat, option),
8664 impl Readable for ClaimableHTLC {
8665 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8666 _init_and_read_len_prefixed_tlv_fields!(reader, {
8667 (0, prev_hop, required),
8668 (1, total_msat, option),
8669 (2, value_ser, required),
8670 (3, sender_intended_value, option),
8671 (4, payment_data_opt, option),
8672 (5, total_value_received, option),
8673 (6, cltv_expiry, required),
8674 (8, keysend_preimage, option),
8675 (10, counterparty_skimmed_fee_msat, option),
8677 let payment_data: Option<msgs::FinalOnionHopData> = payment_data_opt;
8678 let value = value_ser.0.unwrap();
8679 let onion_payload = match keysend_preimage {
8681 if payment_data.is_some() {
8682 return Err(DecodeError::InvalidValue)
8684 if total_msat.is_none() {
8685 total_msat = Some(value);
8687 OnionPayload::Spontaneous(p)
8690 if total_msat.is_none() {
8691 if payment_data.is_none() {
8692 return Err(DecodeError::InvalidValue)
8694 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
8696 OnionPayload::Invoice { _legacy_hop_data: payment_data }
8700 prev_hop: prev_hop.0.unwrap(),
8703 sender_intended_value: sender_intended_value.unwrap_or(value),
8704 total_value_received,
8705 total_msat: total_msat.unwrap(),
8707 cltv_expiry: cltv_expiry.0.unwrap(),
8708 counterparty_skimmed_fee_msat,
8713 impl Readable for HTLCSource {
8714 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8715 let id: u8 = Readable::read(reader)?;
8718 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
8719 let mut first_hop_htlc_msat: u64 = 0;
8720 let mut path_hops = Vec::new();
8721 let mut payment_id = None;
8722 let mut payment_params: Option<PaymentParameters> = None;
8723 let mut blinded_tail: Option<BlindedTail> = None;
8724 read_tlv_fields!(reader, {
8725 (0, session_priv, required),
8726 (1, payment_id, option),
8727 (2, first_hop_htlc_msat, required),
8728 (4, path_hops, required_vec),
8729 (5, payment_params, (option: ReadableArgs, 0)),
8730 (6, blinded_tail, option),
8732 if payment_id.is_none() {
8733 // For backwards compat, if there was no payment_id written, use the session_priv bytes
8735 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
8737 let path = Path { hops: path_hops, blinded_tail };
8738 if path.hops.len() == 0 {
8739 return Err(DecodeError::InvalidValue);
8741 if let Some(params) = payment_params.as_mut() {
8742 if let Payee::Clear { ref mut final_cltv_expiry_delta, .. } = params.payee {
8743 if final_cltv_expiry_delta == &0 {
8744 *final_cltv_expiry_delta = path.final_cltv_expiry_delta().ok_or(DecodeError::InvalidValue)?;
8748 Ok(HTLCSource::OutboundRoute {
8749 session_priv: session_priv.0.unwrap(),
8750 first_hop_htlc_msat,
8752 payment_id: payment_id.unwrap(),
8755 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
8756 _ => Err(DecodeError::UnknownRequiredFeature),
8761 impl Writeable for HTLCSource {
8762 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
8764 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id } => {
8766 let payment_id_opt = Some(payment_id);
8767 write_tlv_fields!(writer, {
8768 (0, session_priv, required),
8769 (1, payment_id_opt, option),
8770 (2, first_hop_htlc_msat, required),
8771 // 3 was previously used to write a PaymentSecret for the payment.
8772 (4, path.hops, required_vec),
8773 (5, None::<PaymentParameters>, option), // payment_params in LDK versions prior to 0.0.115
8774 (6, path.blinded_tail, option),
8777 HTLCSource::PreviousHopData(ref field) => {
8779 field.write(writer)?;
8786 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
8787 (0, forward_info, required),
8788 (1, prev_user_channel_id, (default_value, 0)),
8789 (2, prev_short_channel_id, required),
8790 (4, prev_htlc_id, required),
8791 (6, prev_funding_outpoint, required),
8794 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
8796 (0, htlc_id, required),
8797 (2, err_packet, required),
8802 impl_writeable_tlv_based!(PendingInboundPayment, {
8803 (0, payment_secret, required),
8804 (2, expiry_time, required),
8805 (4, user_payment_id, required),
8806 (6, payment_preimage, required),
8807 (8, min_value_msat, required),
8810 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>
8812 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8813 T::Target: BroadcasterInterface,
8814 ES::Target: EntropySource,
8815 NS::Target: NodeSigner,
8816 SP::Target: SignerProvider,
8817 F::Target: FeeEstimator,
8821 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8822 let _consistency_lock = self.total_consistency_lock.write().unwrap();
8824 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
8826 self.genesis_hash.write(writer)?;
8828 let best_block = self.best_block.read().unwrap();
8829 best_block.height().write(writer)?;
8830 best_block.block_hash().write(writer)?;
8833 let mut serializable_peer_count: u64 = 0;
8835 let per_peer_state = self.per_peer_state.read().unwrap();
8836 let mut number_of_funded_channels = 0;
8837 for (_, peer_state_mutex) in per_peer_state.iter() {
8838 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8839 let peer_state = &mut *peer_state_lock;
8840 if !peer_state.ok_to_remove(false) {
8841 serializable_peer_count += 1;
8844 number_of_funded_channels += peer_state.channel_by_id.iter().filter(
8845 |(_, phase)| if let ChannelPhase::Funded(chan) = phase { chan.context.is_funding_broadcast() } else { false }
8849 (number_of_funded_channels as u64).write(writer)?;
8851 for (_, peer_state_mutex) in per_peer_state.iter() {
8852 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8853 let peer_state = &mut *peer_state_lock;
8854 for channel in peer_state.channel_by_id.iter().filter_map(
8855 |(_, phase)| if let ChannelPhase::Funded(channel) = phase {
8856 if channel.context.is_funding_broadcast() { Some(channel) } else { None }
8859 channel.write(writer)?;
8865 let forward_htlcs = self.forward_htlcs.lock().unwrap();
8866 (forward_htlcs.len() as u64).write(writer)?;
8867 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
8868 short_channel_id.write(writer)?;
8869 (pending_forwards.len() as u64).write(writer)?;
8870 for forward in pending_forwards {
8871 forward.write(writer)?;
8876 let per_peer_state = self.per_peer_state.write().unwrap();
8878 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
8879 let claimable_payments = self.claimable_payments.lock().unwrap();
8880 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
8882 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
8883 let mut htlc_onion_fields: Vec<&_> = Vec::new();
8884 (claimable_payments.claimable_payments.len() as u64).write(writer)?;
8885 for (payment_hash, payment) in claimable_payments.claimable_payments.iter() {
8886 payment_hash.write(writer)?;
8887 (payment.htlcs.len() as u64).write(writer)?;
8888 for htlc in payment.htlcs.iter() {
8889 htlc.write(writer)?;
8891 htlc_purposes.push(&payment.purpose);
8892 htlc_onion_fields.push(&payment.onion_fields);
8895 let mut monitor_update_blocked_actions_per_peer = None;
8896 let mut peer_states = Vec::new();
8897 for (_, peer_state_mutex) in per_peer_state.iter() {
8898 // Because we're holding the owning `per_peer_state` write lock here there's no chance
8899 // of a lockorder violation deadlock - no other thread can be holding any
8900 // per_peer_state lock at all.
8901 peer_states.push(peer_state_mutex.unsafe_well_ordered_double_lock_self());
8904 (serializable_peer_count).write(writer)?;
8905 for ((peer_pubkey, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
8906 // Peers which we have no channels to should be dropped once disconnected. As we
8907 // disconnect all peers when shutting down and serializing the ChannelManager, we
8908 // consider all peers as disconnected here. There's therefore no need write peers with
8910 if !peer_state.ok_to_remove(false) {
8911 peer_pubkey.write(writer)?;
8912 peer_state.latest_features.write(writer)?;
8913 if !peer_state.monitor_update_blocked_actions.is_empty() {
8914 monitor_update_blocked_actions_per_peer
8915 .get_or_insert_with(Vec::new)
8916 .push((*peer_pubkey, &peer_state.monitor_update_blocked_actions));
8921 let events = self.pending_events.lock().unwrap();
8922 // LDK versions prior to 0.0.115 don't support post-event actions, thus if there's no
8923 // actions at all, skip writing the required TLV. Otherwise, pre-0.0.115 versions will
8924 // refuse to read the new ChannelManager.
8925 let events_not_backwards_compatible = events.iter().any(|(_, action)| action.is_some());
8926 if events_not_backwards_compatible {
8927 // If we're gonna write a even TLV that will overwrite our events anyway we might as
8928 // well save the space and not write any events here.
8929 0u64.write(writer)?;
8931 (events.len() as u64).write(writer)?;
8932 for (event, _) in events.iter() {
8933 event.write(writer)?;
8937 // LDK versions prior to 0.0.116 wrote the `pending_background_events`
8938 // `MonitorUpdateRegeneratedOnStartup`s here, however there was never a reason to do so -
8939 // the closing monitor updates were always effectively replayed on startup (either directly
8940 // by calling `broadcast_latest_holder_commitment_txn` on a `ChannelMonitor` during
8941 // deserialization or, in 0.0.115, by regenerating the monitor update itself).
8942 0u64.write(writer)?;
8944 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
8945 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
8946 // likely to be identical.
8947 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
8948 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
8950 (pending_inbound_payments.len() as u64).write(writer)?;
8951 for (hash, pending_payment) in pending_inbound_payments.iter() {
8952 hash.write(writer)?;
8953 pending_payment.write(writer)?;
8956 // For backwards compat, write the session privs and their total length.
8957 let mut num_pending_outbounds_compat: u64 = 0;
8958 for (_, outbound) in pending_outbound_payments.iter() {
8959 if !outbound.is_fulfilled() && !outbound.abandoned() {
8960 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
8963 num_pending_outbounds_compat.write(writer)?;
8964 for (_, outbound) in pending_outbound_payments.iter() {
8966 PendingOutboundPayment::Legacy { session_privs } |
8967 PendingOutboundPayment::Retryable { session_privs, .. } => {
8968 for session_priv in session_privs.iter() {
8969 session_priv.write(writer)?;
8972 PendingOutboundPayment::AwaitingInvoice { .. } => {},
8973 PendingOutboundPayment::InvoiceReceived { .. } => {},
8974 PendingOutboundPayment::Fulfilled { .. } => {},
8975 PendingOutboundPayment::Abandoned { .. } => {},
8979 // Encode without retry info for 0.0.101 compatibility.
8980 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
8981 for (id, outbound) in pending_outbound_payments.iter() {
8983 PendingOutboundPayment::Legacy { session_privs } |
8984 PendingOutboundPayment::Retryable { session_privs, .. } => {
8985 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
8991 let mut pending_intercepted_htlcs = None;
8992 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
8993 if our_pending_intercepts.len() != 0 {
8994 pending_intercepted_htlcs = Some(our_pending_intercepts);
8997 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
8998 if pending_claiming_payments.as_ref().unwrap().is_empty() {
8999 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
9000 // map. Thus, if there are no entries we skip writing a TLV for it.
9001 pending_claiming_payments = None;
9004 let mut in_flight_monitor_updates: Option<HashMap<(&PublicKey, &OutPoint), &Vec<ChannelMonitorUpdate>>> = None;
9005 for ((counterparty_id, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
9006 for (funding_outpoint, updates) in peer_state.in_flight_monitor_updates.iter() {
9007 if !updates.is_empty() {
9008 if in_flight_monitor_updates.is_none() { in_flight_monitor_updates = Some(HashMap::new()); }
9009 in_flight_monitor_updates.as_mut().unwrap().insert((counterparty_id, funding_outpoint), updates);
9014 write_tlv_fields!(writer, {
9015 (1, pending_outbound_payments_no_retry, required),
9016 (2, pending_intercepted_htlcs, option),
9017 (3, pending_outbound_payments, required),
9018 (4, pending_claiming_payments, option),
9019 (5, self.our_network_pubkey, required),
9020 (6, monitor_update_blocked_actions_per_peer, option),
9021 (7, self.fake_scid_rand_bytes, required),
9022 (8, if events_not_backwards_compatible { Some(&*events) } else { None }, option),
9023 (9, htlc_purposes, required_vec),
9024 (10, in_flight_monitor_updates, option),
9025 (11, self.probing_cookie_secret, required),
9026 (13, htlc_onion_fields, optional_vec),
9033 impl Writeable for VecDeque<(Event, Option<EventCompletionAction>)> {
9034 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
9035 (self.len() as u64).write(w)?;
9036 for (event, action) in self.iter() {
9039 #[cfg(debug_assertions)] {
9040 // Events are MaybeReadable, in some cases indicating that they shouldn't actually
9041 // be persisted and are regenerated on restart. However, if such an event has a
9042 // post-event-handling action we'll write nothing for the event and would have to
9043 // either forget the action or fail on deserialization (which we do below). Thus,
9044 // check that the event is sane here.
9045 let event_encoded = event.encode();
9046 let event_read: Option<Event> =
9047 MaybeReadable::read(&mut &event_encoded[..]).unwrap();
9048 if action.is_some() { assert!(event_read.is_some()); }
9054 impl Readable for VecDeque<(Event, Option<EventCompletionAction>)> {
9055 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
9056 let len: u64 = Readable::read(reader)?;
9057 const MAX_ALLOC_SIZE: u64 = 1024 * 16;
9058 let mut events: Self = VecDeque::with_capacity(cmp::min(
9059 MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>() as u64,
9062 let ev_opt = MaybeReadable::read(reader)?;
9063 let action = Readable::read(reader)?;
9064 if let Some(ev) = ev_opt {
9065 events.push_back((ev, action));
9066 } else if action.is_some() {
9067 return Err(DecodeError::InvalidValue);
9074 impl_writeable_tlv_based_enum!(ChannelShutdownState,
9075 (0, NotShuttingDown) => {},
9076 (2, ShutdownInitiated) => {},
9077 (4, ResolvingHTLCs) => {},
9078 (6, NegotiatingClosingFee) => {},
9079 (8, ShutdownComplete) => {}, ;
9082 /// Arguments for the creation of a ChannelManager that are not deserialized.
9084 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
9086 /// 1) Deserialize all stored [`ChannelMonitor`]s.
9087 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
9088 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
9089 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
9090 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
9091 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
9092 /// same way you would handle a [`chain::Filter`] call using
9093 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
9094 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
9095 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
9096 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
9097 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
9098 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
9100 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
9101 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
9103 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
9104 /// call any other methods on the newly-deserialized [`ChannelManager`].
9106 /// Note that because some channels may be closed during deserialization, it is critical that you
9107 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
9108 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
9109 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
9110 /// not force-close the same channels but consider them live), you may end up revoking a state for
9111 /// which you've already broadcasted the transaction.
9113 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
9114 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
9116 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
9117 T::Target: BroadcasterInterface,
9118 ES::Target: EntropySource,
9119 NS::Target: NodeSigner,
9120 SP::Target: SignerProvider,
9121 F::Target: FeeEstimator,
9125 /// A cryptographically secure source of entropy.
9126 pub entropy_source: ES,
9128 /// A signer that is able to perform node-scoped cryptographic operations.
9129 pub node_signer: NS,
9131 /// The keys provider which will give us relevant keys. Some keys will be loaded during
9132 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
9134 pub signer_provider: SP,
9136 /// The fee_estimator for use in the ChannelManager in the future.
9138 /// No calls to the FeeEstimator will be made during deserialization.
9139 pub fee_estimator: F,
9140 /// The chain::Watch for use in the ChannelManager in the future.
9142 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
9143 /// you have deserialized ChannelMonitors separately and will add them to your
9144 /// chain::Watch after deserializing this ChannelManager.
9145 pub chain_monitor: M,
9147 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
9148 /// used to broadcast the latest local commitment transactions of channels which must be
9149 /// force-closed during deserialization.
9150 pub tx_broadcaster: T,
9151 /// The router which will be used in the ChannelManager in the future for finding routes
9152 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
9154 /// No calls to the router will be made during deserialization.
9156 /// The Logger for use in the ChannelManager and which may be used to log information during
9157 /// deserialization.
9159 /// Default settings used for new channels. Any existing channels will continue to use the
9160 /// runtime settings which were stored when the ChannelManager was serialized.
9161 pub default_config: UserConfig,
9163 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
9164 /// value.context.get_funding_txo() should be the key).
9166 /// If a monitor is inconsistent with the channel state during deserialization the channel will
9167 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
9168 /// is true for missing channels as well. If there is a monitor missing for which we find
9169 /// channel data Err(DecodeError::InvalidValue) will be returned.
9171 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
9174 /// This is not exported to bindings users because we have no HashMap bindings
9175 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>,
9178 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
9179 ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>
9181 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
9182 T::Target: BroadcasterInterface,
9183 ES::Target: EntropySource,
9184 NS::Target: NodeSigner,
9185 SP::Target: SignerProvider,
9186 F::Target: FeeEstimator,
9190 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
9191 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
9192 /// populate a HashMap directly from C.
9193 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,
9194 mut channel_monitors: Vec<&'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>) -> Self {
9196 entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
9197 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
9202 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
9203 // SipmleArcChannelManager type:
9204 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
9205 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, ES, NS, SP, F, R, L>>)
9207 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
9208 T::Target: BroadcasterInterface,
9209 ES::Target: EntropySource,
9210 NS::Target: NodeSigner,
9211 SP::Target: SignerProvider,
9212 F::Target: FeeEstimator,
9216 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
9217 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)>::read(reader, args)?;
9218 Ok((blockhash, Arc::new(chan_manager)))
9222 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
9223 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)
9225 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
9226 T::Target: BroadcasterInterface,
9227 ES::Target: EntropySource,
9228 NS::Target: NodeSigner,
9229 SP::Target: SignerProvider,
9230 F::Target: FeeEstimator,
9234 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
9235 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
9237 let genesis_hash: BlockHash = Readable::read(reader)?;
9238 let best_block_height: u32 = Readable::read(reader)?;
9239 let best_block_hash: BlockHash = Readable::read(reader)?;
9241 let mut failed_htlcs = Vec::new();
9243 let channel_count: u64 = Readable::read(reader)?;
9244 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
9245 let mut funded_peer_channels: HashMap<PublicKey, HashMap<ChannelId, ChannelPhase<SP>>> = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
9246 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
9247 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
9248 let mut channel_closures = VecDeque::new();
9249 let mut close_background_events = Vec::new();
9250 for _ in 0..channel_count {
9251 let mut channel: Channel<SP> = Channel::read(reader, (
9252 &args.entropy_source, &args.signer_provider, best_block_height, &provided_channel_type_features(&args.default_config)
9254 let funding_txo = channel.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
9255 funding_txo_set.insert(funding_txo.clone());
9256 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
9257 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
9258 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
9259 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
9260 channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
9261 // But if the channel is behind of the monitor, close the channel:
9262 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
9263 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
9264 if channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
9265 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
9266 &channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
9268 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() {
9269 log_error!(args.logger, " The ChannelMonitor for channel {} is at holder commitment number {} but the ChannelManager is at holder commitment number {}.",
9270 &channel.context.channel_id(), monitor.get_cur_holder_commitment_number(), channel.get_cur_holder_commitment_transaction_number());
9272 if channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() {
9273 log_error!(args.logger, " The ChannelMonitor for channel {} is at revoked counterparty transaction number {} but the ChannelManager is at revoked counterparty transaction number {}.",
9274 &channel.context.channel_id(), monitor.get_min_seen_secret(), channel.get_revoked_counterparty_commitment_transaction_number());
9276 if channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() {
9277 log_error!(args.logger, " The ChannelMonitor for channel {} is at counterparty commitment transaction number {} but the ChannelManager is at counterparty commitment transaction number {}.",
9278 &channel.context.channel_id(), monitor.get_cur_counterparty_commitment_number(), channel.get_cur_counterparty_commitment_transaction_number());
9280 let (monitor_update, mut new_failed_htlcs, batch_funding_txid) = channel.context.force_shutdown(true);
9281 if batch_funding_txid.is_some() {
9282 return Err(DecodeError::InvalidValue);
9284 if let Some((counterparty_node_id, funding_txo, update)) = monitor_update {
9285 close_background_events.push(BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
9286 counterparty_node_id, funding_txo, update
9289 failed_htlcs.append(&mut new_failed_htlcs);
9290 channel_closures.push_back((events::Event::ChannelClosed {
9291 channel_id: channel.context.channel_id(),
9292 user_channel_id: channel.context.get_user_id(),
9293 reason: ClosureReason::OutdatedChannelManager,
9294 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
9295 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
9297 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
9298 let mut found_htlc = false;
9299 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
9300 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
9303 // If we have some HTLCs in the channel which are not present in the newer
9304 // ChannelMonitor, they have been removed and should be failed back to
9305 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
9306 // were actually claimed we'd have generated and ensured the previous-hop
9307 // claim update ChannelMonitor updates were persisted prior to persising
9308 // the ChannelMonitor update for the forward leg, so attempting to fail the
9309 // backwards leg of the HTLC will simply be rejected.
9310 log_info!(args.logger,
9311 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
9312 &channel.context.channel_id(), &payment_hash);
9313 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.context.get_counterparty_node_id(), channel.context.channel_id()));
9317 log_info!(args.logger, "Successfully loaded channel {} at update_id {} against monitor at update id {}",
9318 &channel.context.channel_id(), channel.context.get_latest_monitor_update_id(),
9319 monitor.get_latest_update_id());
9320 if let Some(short_channel_id) = channel.context.get_short_channel_id() {
9321 short_to_chan_info.insert(short_channel_id, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
9323 if channel.context.is_funding_broadcast() {
9324 id_to_peer.insert(channel.context.channel_id(), channel.context.get_counterparty_node_id());
9326 match funded_peer_channels.entry(channel.context.get_counterparty_node_id()) {
9327 hash_map::Entry::Occupied(mut entry) => {
9328 let by_id_map = entry.get_mut();
9329 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
9331 hash_map::Entry::Vacant(entry) => {
9332 let mut by_id_map = HashMap::new();
9333 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
9334 entry.insert(by_id_map);
9338 } else if channel.is_awaiting_initial_mon_persist() {
9339 // If we were persisted and shut down while the initial ChannelMonitor persistence
9340 // was in-progress, we never broadcasted the funding transaction and can still
9341 // safely discard the channel.
9342 let _ = channel.context.force_shutdown(false);
9343 channel_closures.push_back((events::Event::ChannelClosed {
9344 channel_id: channel.context.channel_id(),
9345 user_channel_id: channel.context.get_user_id(),
9346 reason: ClosureReason::DisconnectedPeer,
9347 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
9348 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
9351 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
9352 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
9353 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
9354 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
9355 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");
9356 return Err(DecodeError::InvalidValue);
9360 for (funding_txo, _) in args.channel_monitors.iter() {
9361 if !funding_txo_set.contains(funding_txo) {
9362 log_info!(args.logger, "Queueing monitor update to ensure missing channel {} is force closed",
9363 &funding_txo.to_channel_id());
9364 let monitor_update = ChannelMonitorUpdate {
9365 update_id: CLOSED_CHANNEL_UPDATE_ID,
9366 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast: true }],
9368 close_background_events.push(BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((*funding_txo, monitor_update)));
9372 const MAX_ALLOC_SIZE: usize = 1024 * 64;
9373 let forward_htlcs_count: u64 = Readable::read(reader)?;
9374 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
9375 for _ in 0..forward_htlcs_count {
9376 let short_channel_id = Readable::read(reader)?;
9377 let pending_forwards_count: u64 = Readable::read(reader)?;
9378 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
9379 for _ in 0..pending_forwards_count {
9380 pending_forwards.push(Readable::read(reader)?);
9382 forward_htlcs.insert(short_channel_id, pending_forwards);
9385 let claimable_htlcs_count: u64 = Readable::read(reader)?;
9386 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
9387 for _ in 0..claimable_htlcs_count {
9388 let payment_hash = Readable::read(reader)?;
9389 let previous_hops_len: u64 = Readable::read(reader)?;
9390 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
9391 for _ in 0..previous_hops_len {
9392 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
9394 claimable_htlcs_list.push((payment_hash, previous_hops));
9397 let peer_state_from_chans = |channel_by_id| {
9400 inbound_channel_request_by_id: HashMap::new(),
9401 latest_features: InitFeatures::empty(),
9402 pending_msg_events: Vec::new(),
9403 in_flight_monitor_updates: BTreeMap::new(),
9404 monitor_update_blocked_actions: BTreeMap::new(),
9405 actions_blocking_raa_monitor_updates: BTreeMap::new(),
9406 is_connected: false,
9410 let peer_count: u64 = Readable::read(reader)?;
9411 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<SP>>)>()));
9412 for _ in 0..peer_count {
9413 let peer_pubkey = Readable::read(reader)?;
9414 let peer_chans = funded_peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new());
9415 let mut peer_state = peer_state_from_chans(peer_chans);
9416 peer_state.latest_features = Readable::read(reader)?;
9417 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
9420 let event_count: u64 = Readable::read(reader)?;
9421 let mut pending_events_read: VecDeque<(events::Event, Option<EventCompletionAction>)> =
9422 VecDeque::with_capacity(cmp::min(event_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>()));
9423 for _ in 0..event_count {
9424 match MaybeReadable::read(reader)? {
9425 Some(event) => pending_events_read.push_back((event, None)),
9430 let background_event_count: u64 = Readable::read(reader)?;
9431 for _ in 0..background_event_count {
9432 match <u8 as Readable>::read(reader)? {
9434 // LDK versions prior to 0.0.116 wrote pending `MonitorUpdateRegeneratedOnStartup`s here,
9435 // however we really don't (and never did) need them - we regenerate all
9436 // on-startup monitor updates.
9437 let _: OutPoint = Readable::read(reader)?;
9438 let _: ChannelMonitorUpdate = Readable::read(reader)?;
9440 _ => return Err(DecodeError::InvalidValue),
9444 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
9445 let highest_seen_timestamp: u32 = Readable::read(reader)?;
9447 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
9448 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
9449 for _ in 0..pending_inbound_payment_count {
9450 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
9451 return Err(DecodeError::InvalidValue);
9455 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
9456 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
9457 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
9458 for _ in 0..pending_outbound_payments_count_compat {
9459 let session_priv = Readable::read(reader)?;
9460 let payment = PendingOutboundPayment::Legacy {
9461 session_privs: [session_priv].iter().cloned().collect()
9463 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
9464 return Err(DecodeError::InvalidValue)
9468 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
9469 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
9470 let mut pending_outbound_payments = None;
9471 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
9472 let mut received_network_pubkey: Option<PublicKey> = None;
9473 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
9474 let mut probing_cookie_secret: Option<[u8; 32]> = None;
9475 let mut claimable_htlc_purposes = None;
9476 let mut claimable_htlc_onion_fields = None;
9477 let mut pending_claiming_payments = Some(HashMap::new());
9478 let mut monitor_update_blocked_actions_per_peer: Option<Vec<(_, BTreeMap<_, Vec<_>>)>> = Some(Vec::new());
9479 let mut events_override = None;
9480 let mut in_flight_monitor_updates: Option<HashMap<(PublicKey, OutPoint), Vec<ChannelMonitorUpdate>>> = None;
9481 read_tlv_fields!(reader, {
9482 (1, pending_outbound_payments_no_retry, option),
9483 (2, pending_intercepted_htlcs, option),
9484 (3, pending_outbound_payments, option),
9485 (4, pending_claiming_payments, option),
9486 (5, received_network_pubkey, option),
9487 (6, monitor_update_blocked_actions_per_peer, option),
9488 (7, fake_scid_rand_bytes, option),
9489 (8, events_override, option),
9490 (9, claimable_htlc_purposes, optional_vec),
9491 (10, in_flight_monitor_updates, option),
9492 (11, probing_cookie_secret, option),
9493 (13, claimable_htlc_onion_fields, optional_vec),
9495 if fake_scid_rand_bytes.is_none() {
9496 fake_scid_rand_bytes = Some(args.entropy_source.get_secure_random_bytes());
9499 if probing_cookie_secret.is_none() {
9500 probing_cookie_secret = Some(args.entropy_source.get_secure_random_bytes());
9503 if let Some(events) = events_override {
9504 pending_events_read = events;
9507 if !channel_closures.is_empty() {
9508 pending_events_read.append(&mut channel_closures);
9511 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
9512 pending_outbound_payments = Some(pending_outbound_payments_compat);
9513 } else if pending_outbound_payments.is_none() {
9514 let mut outbounds = HashMap::new();
9515 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
9516 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
9518 pending_outbound_payments = Some(outbounds);
9520 let pending_outbounds = OutboundPayments {
9521 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
9522 retry_lock: Mutex::new(())
9525 // We have to replay (or skip, if they were completed after we wrote the `ChannelManager`)
9526 // each `ChannelMonitorUpdate` in `in_flight_monitor_updates`. After doing so, we have to
9527 // check that each channel we have isn't newer than the latest `ChannelMonitorUpdate`(s) we
9528 // replayed, and for each monitor update we have to replay we have to ensure there's a
9529 // `ChannelMonitor` for it.
9531 // In order to do so we first walk all of our live channels (so that we can check their
9532 // state immediately after doing the update replays, when we have the `update_id`s
9533 // available) and then walk any remaining in-flight updates.
9535 // Because the actual handling of the in-flight updates is the same, it's macro'ized here:
9536 let mut pending_background_events = Vec::new();
9537 macro_rules! handle_in_flight_updates {
9538 ($counterparty_node_id: expr, $chan_in_flight_upds: expr, $funding_txo: expr,
9539 $monitor: expr, $peer_state: expr, $channel_info_log: expr
9541 let mut max_in_flight_update_id = 0;
9542 $chan_in_flight_upds.retain(|upd| upd.update_id > $monitor.get_latest_update_id());
9543 for update in $chan_in_flight_upds.iter() {
9544 log_trace!(args.logger, "Replaying ChannelMonitorUpdate {} for {}channel {}",
9545 update.update_id, $channel_info_log, &$funding_txo.to_channel_id());
9546 max_in_flight_update_id = cmp::max(max_in_flight_update_id, update.update_id);
9547 pending_background_events.push(
9548 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
9549 counterparty_node_id: $counterparty_node_id,
9550 funding_txo: $funding_txo,
9551 update: update.clone(),
9554 if $chan_in_flight_upds.is_empty() {
9555 // We had some updates to apply, but it turns out they had completed before we
9556 // were serialized, we just weren't notified of that. Thus, we may have to run
9557 // the completion actions for any monitor updates, but otherwise are done.
9558 pending_background_events.push(
9559 BackgroundEvent::MonitorUpdatesComplete {
9560 counterparty_node_id: $counterparty_node_id,
9561 channel_id: $funding_txo.to_channel_id(),
9564 if $peer_state.in_flight_monitor_updates.insert($funding_txo, $chan_in_flight_upds).is_some() {
9565 log_error!(args.logger, "Duplicate in-flight monitor update set for the same channel!");
9566 return Err(DecodeError::InvalidValue);
9568 max_in_flight_update_id
9572 for (counterparty_id, peer_state_mtx) in per_peer_state.iter_mut() {
9573 let mut peer_state_lock = peer_state_mtx.lock().unwrap();
9574 let peer_state = &mut *peer_state_lock;
9575 for phase in peer_state.channel_by_id.values() {
9576 if let ChannelPhase::Funded(chan) = phase {
9577 // Channels that were persisted have to be funded, otherwise they should have been
9579 let funding_txo = chan.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
9580 let monitor = args.channel_monitors.get(&funding_txo)
9581 .expect("We already checked for monitor presence when loading channels");
9582 let mut max_in_flight_update_id = monitor.get_latest_update_id();
9583 if let Some(in_flight_upds) = &mut in_flight_monitor_updates {
9584 if let Some(mut chan_in_flight_upds) = in_flight_upds.remove(&(*counterparty_id, funding_txo)) {
9585 max_in_flight_update_id = cmp::max(max_in_flight_update_id,
9586 handle_in_flight_updates!(*counterparty_id, chan_in_flight_upds,
9587 funding_txo, monitor, peer_state, ""));
9590 if chan.get_latest_unblocked_monitor_update_id() > max_in_flight_update_id {
9591 // If the channel is ahead of the monitor, return InvalidValue:
9592 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
9593 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} with update_id through {} in-flight",
9594 chan.context.channel_id(), monitor.get_latest_update_id(), max_in_flight_update_id);
9595 log_error!(args.logger, " but the ChannelManager is at update_id {}.", chan.get_latest_unblocked_monitor_update_id());
9596 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
9597 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
9598 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
9599 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");
9600 return Err(DecodeError::InvalidValue);
9603 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
9604 // created in this `channel_by_id` map.
9605 debug_assert!(false);
9606 return Err(DecodeError::InvalidValue);
9611 if let Some(in_flight_upds) = in_flight_monitor_updates {
9612 for ((counterparty_id, funding_txo), mut chan_in_flight_updates) in in_flight_upds {
9613 if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
9614 // Now that we've removed all the in-flight monitor updates for channels that are
9615 // still open, we need to replay any monitor updates that are for closed channels,
9616 // creating the neccessary peer_state entries as we go.
9617 let peer_state_mutex = per_peer_state.entry(counterparty_id).or_insert_with(|| {
9618 Mutex::new(peer_state_from_chans(HashMap::new()))
9620 let mut peer_state = peer_state_mutex.lock().unwrap();
9621 handle_in_flight_updates!(counterparty_id, chan_in_flight_updates,
9622 funding_txo, monitor, peer_state, "closed ");
9624 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!");
9625 log_error!(args.logger, " The ChannelMonitor for channel {} is missing.",
9626 &funding_txo.to_channel_id());
9627 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
9628 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
9629 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
9630 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");
9631 return Err(DecodeError::InvalidValue);
9636 // Note that we have to do the above replays before we push new monitor updates.
9637 pending_background_events.append(&mut close_background_events);
9639 // If there's any preimages for forwarded HTLCs hanging around in ChannelMonitors we
9640 // should ensure we try them again on the inbound edge. We put them here and do so after we
9641 // have a fully-constructed `ChannelManager` at the end.
9642 let mut pending_claims_to_replay = Vec::new();
9645 // If we're tracking pending payments, ensure we haven't lost any by looking at the
9646 // ChannelMonitor data for any channels for which we do not have authorative state
9647 // (i.e. those for which we just force-closed above or we otherwise don't have a
9648 // corresponding `Channel` at all).
9649 // This avoids several edge-cases where we would otherwise "forget" about pending
9650 // payments which are still in-flight via their on-chain state.
9651 // We only rebuild the pending payments map if we were most recently serialized by
9653 for (_, monitor) in args.channel_monitors.iter() {
9654 let counterparty_opt = id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id());
9655 if counterparty_opt.is_none() {
9656 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
9657 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
9658 if path.hops.is_empty() {
9659 log_error!(args.logger, "Got an empty path for a pending payment");
9660 return Err(DecodeError::InvalidValue);
9663 let path_amt = path.final_value_msat();
9664 let mut session_priv_bytes = [0; 32];
9665 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
9666 match pending_outbounds.pending_outbound_payments.lock().unwrap().entry(payment_id) {
9667 hash_map::Entry::Occupied(mut entry) => {
9668 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
9669 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
9670 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), &htlc.payment_hash);
9672 hash_map::Entry::Vacant(entry) => {
9673 let path_fee = path.fee_msat();
9674 entry.insert(PendingOutboundPayment::Retryable {
9675 retry_strategy: None,
9676 attempts: PaymentAttempts::new(),
9677 payment_params: None,
9678 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
9679 payment_hash: htlc.payment_hash,
9680 payment_secret: None, // only used for retries, and we'll never retry on startup
9681 payment_metadata: None, // only used for retries, and we'll never retry on startup
9682 keysend_preimage: None, // only used for retries, and we'll never retry on startup
9683 custom_tlvs: Vec::new(), // only used for retries, and we'll never retry on startup
9684 pending_amt_msat: path_amt,
9685 pending_fee_msat: Some(path_fee),
9686 total_msat: path_amt,
9687 starting_block_height: best_block_height,
9688 remaining_max_total_routing_fee_msat: None, // only used for retries, and we'll never retry on startup
9690 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
9691 path_amt, &htlc.payment_hash, log_bytes!(session_priv_bytes));
9696 for (htlc_source, (htlc, preimage_opt)) in monitor.get_all_current_outbound_htlcs() {
9698 HTLCSource::PreviousHopData(prev_hop_data) => {
9699 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
9700 info.prev_funding_outpoint == prev_hop_data.outpoint &&
9701 info.prev_htlc_id == prev_hop_data.htlc_id
9703 // The ChannelMonitor is now responsible for this HTLC's
9704 // failure/success and will let us know what its outcome is. If we
9705 // still have an entry for this HTLC in `forward_htlcs` or
9706 // `pending_intercepted_htlcs`, we were apparently not persisted after
9707 // the monitor was when forwarding the payment.
9708 forward_htlcs.retain(|_, forwards| {
9709 forwards.retain(|forward| {
9710 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
9711 if pending_forward_matches_htlc(&htlc_info) {
9712 log_info!(args.logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
9713 &htlc.payment_hash, &monitor.get_funding_txo().0.to_channel_id());
9718 !forwards.is_empty()
9720 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
9721 if pending_forward_matches_htlc(&htlc_info) {
9722 log_info!(args.logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
9723 &htlc.payment_hash, &monitor.get_funding_txo().0.to_channel_id());
9724 pending_events_read.retain(|(event, _)| {
9725 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
9726 intercepted_id != ev_id
9733 HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } => {
9734 if let Some(preimage) = preimage_opt {
9735 let pending_events = Mutex::new(pending_events_read);
9736 // Note that we set `from_onchain` to "false" here,
9737 // deliberately keeping the pending payment around forever.
9738 // Given it should only occur when we have a channel we're
9739 // force-closing for being stale that's okay.
9740 // The alternative would be to wipe the state when claiming,
9741 // generating a `PaymentPathSuccessful` event but regenerating
9742 // it and the `PaymentSent` on every restart until the
9743 // `ChannelMonitor` is removed.
9745 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
9746 channel_funding_outpoint: monitor.get_funding_txo().0,
9747 counterparty_node_id: path.hops[0].pubkey,
9749 pending_outbounds.claim_htlc(payment_id, preimage, session_priv,
9750 path, false, compl_action, &pending_events, &args.logger);
9751 pending_events_read = pending_events.into_inner().unwrap();
9758 // Whether the downstream channel was closed or not, try to re-apply any payment
9759 // preimages from it which may be needed in upstream channels for forwarded
9761 let outbound_claimed_htlcs_iter = monitor.get_all_current_outbound_htlcs()
9763 .filter_map(|(htlc_source, (htlc, preimage_opt))| {
9764 if let HTLCSource::PreviousHopData(_) = htlc_source {
9765 if let Some(payment_preimage) = preimage_opt {
9766 Some((htlc_source, payment_preimage, htlc.amount_msat,
9767 // Check if `counterparty_opt.is_none()` to see if the
9768 // downstream chan is closed (because we don't have a
9769 // channel_id -> peer map entry).
9770 counterparty_opt.is_none(),
9771 counterparty_opt.cloned().or(monitor.get_counterparty_node_id()),
9772 monitor.get_funding_txo().0))
9775 // If it was an outbound payment, we've handled it above - if a preimage
9776 // came in and we persisted the `ChannelManager` we either handled it and
9777 // are good to go or the channel force-closed - we don't have to handle the
9778 // channel still live case here.
9782 for tuple in outbound_claimed_htlcs_iter {
9783 pending_claims_to_replay.push(tuple);
9788 if !forward_htlcs.is_empty() || pending_outbounds.needs_abandon() {
9789 // If we have pending HTLCs to forward, assume we either dropped a
9790 // `PendingHTLCsForwardable` or the user received it but never processed it as they
9791 // shut down before the timer hit. Either way, set the time_forwardable to a small
9792 // constant as enough time has likely passed that we should simply handle the forwards
9793 // now, or at least after the user gets a chance to reconnect to our peers.
9794 pending_events_read.push_back((events::Event::PendingHTLCsForwardable {
9795 time_forwardable: Duration::from_secs(2),
9799 let inbound_pmt_key_material = args.node_signer.get_inbound_payment_key_material();
9800 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
9802 let mut claimable_payments = HashMap::with_capacity(claimable_htlcs_list.len());
9803 if let Some(purposes) = claimable_htlc_purposes {
9804 if purposes.len() != claimable_htlcs_list.len() {
9805 return Err(DecodeError::InvalidValue);
9807 if let Some(onion_fields) = claimable_htlc_onion_fields {
9808 if onion_fields.len() != claimable_htlcs_list.len() {
9809 return Err(DecodeError::InvalidValue);
9811 for (purpose, (onion, (payment_hash, htlcs))) in
9812 purposes.into_iter().zip(onion_fields.into_iter().zip(claimable_htlcs_list.into_iter()))
9814 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
9815 purpose, htlcs, onion_fields: onion,
9817 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
9820 for (purpose, (payment_hash, htlcs)) in purposes.into_iter().zip(claimable_htlcs_list.into_iter()) {
9821 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
9822 purpose, htlcs, onion_fields: None,
9824 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
9828 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
9829 // include a `_legacy_hop_data` in the `OnionPayload`.
9830 for (payment_hash, htlcs) in claimable_htlcs_list.drain(..) {
9831 if htlcs.is_empty() {
9832 return Err(DecodeError::InvalidValue);
9834 let purpose = match &htlcs[0].onion_payload {
9835 OnionPayload::Invoice { _legacy_hop_data } => {
9836 if let Some(hop_data) = _legacy_hop_data {
9837 events::PaymentPurpose::InvoicePayment {
9838 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
9839 Some(inbound_payment) => inbound_payment.payment_preimage,
9840 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
9841 Ok((payment_preimage, _)) => payment_preimage,
9843 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);
9844 return Err(DecodeError::InvalidValue);
9848 payment_secret: hop_data.payment_secret,
9850 } else { return Err(DecodeError::InvalidValue); }
9852 OnionPayload::Spontaneous(payment_preimage) =>
9853 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
9855 claimable_payments.insert(payment_hash, ClaimablePayment {
9856 purpose, htlcs, onion_fields: None,
9861 let mut secp_ctx = Secp256k1::new();
9862 secp_ctx.seeded_randomize(&args.entropy_source.get_secure_random_bytes());
9864 let our_network_pubkey = match args.node_signer.get_node_id(Recipient::Node) {
9866 Err(()) => return Err(DecodeError::InvalidValue)
9868 if let Some(network_pubkey) = received_network_pubkey {
9869 if network_pubkey != our_network_pubkey {
9870 log_error!(args.logger, "Key that was generated does not match the existing key.");
9871 return Err(DecodeError::InvalidValue);
9875 let mut outbound_scid_aliases = HashSet::new();
9876 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
9877 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9878 let peer_state = &mut *peer_state_lock;
9879 for (chan_id, phase) in peer_state.channel_by_id.iter_mut() {
9880 if let ChannelPhase::Funded(chan) = phase {
9881 if chan.context.outbound_scid_alias() == 0 {
9882 let mut outbound_scid_alias;
9884 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
9885 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.entropy_source);
9886 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
9888 chan.context.set_outbound_scid_alias(outbound_scid_alias);
9889 } else if !outbound_scid_aliases.insert(chan.context.outbound_scid_alias()) {
9890 // Note that in rare cases its possible to hit this while reading an older
9891 // channel if we just happened to pick a colliding outbound alias above.
9892 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
9893 return Err(DecodeError::InvalidValue);
9895 if chan.context.is_usable() {
9896 if short_to_chan_info.insert(chan.context.outbound_scid_alias(), (chan.context.get_counterparty_node_id(), *chan_id)).is_some() {
9897 // Note that in rare cases its possible to hit this while reading an older
9898 // channel if we just happened to pick a colliding outbound alias above.
9899 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
9900 return Err(DecodeError::InvalidValue);
9904 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
9905 // created in this `channel_by_id` map.
9906 debug_assert!(false);
9907 return Err(DecodeError::InvalidValue);
9912 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
9914 for (_, monitor) in args.channel_monitors.iter() {
9915 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
9916 if let Some(payment) = claimable_payments.remove(&payment_hash) {
9917 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", &payment_hash);
9918 let mut claimable_amt_msat = 0;
9919 let mut receiver_node_id = Some(our_network_pubkey);
9920 let phantom_shared_secret = payment.htlcs[0].prev_hop.phantom_shared_secret;
9921 if phantom_shared_secret.is_some() {
9922 let phantom_pubkey = args.node_signer.get_node_id(Recipient::PhantomNode)
9923 .expect("Failed to get node_id for phantom node recipient");
9924 receiver_node_id = Some(phantom_pubkey)
9926 for claimable_htlc in &payment.htlcs {
9927 claimable_amt_msat += claimable_htlc.value;
9929 // Add a holding-cell claim of the payment to the Channel, which should be
9930 // applied ~immediately on peer reconnection. Because it won't generate a
9931 // new commitment transaction we can just provide the payment preimage to
9932 // the corresponding ChannelMonitor and nothing else.
9934 // We do so directly instead of via the normal ChannelMonitor update
9935 // procedure as the ChainMonitor hasn't yet been initialized, implying
9936 // we're not allowed to call it directly yet. Further, we do the update
9937 // without incrementing the ChannelMonitor update ID as there isn't any
9939 // If we were to generate a new ChannelMonitor update ID here and then
9940 // crash before the user finishes block connect we'd end up force-closing
9941 // this channel as well. On the flip side, there's no harm in restarting
9942 // without the new monitor persisted - we'll end up right back here on
9944 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
9945 if let Some(peer_node_id) = id_to_peer.get(&previous_channel_id){
9946 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
9947 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9948 let peer_state = &mut *peer_state_lock;
9949 if let Some(ChannelPhase::Funded(channel)) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
9950 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
9953 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
9954 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
9957 pending_events_read.push_back((events::Event::PaymentClaimed {
9960 purpose: payment.purpose,
9961 amount_msat: claimable_amt_msat,
9962 htlcs: payment.htlcs.iter().map(events::ClaimedHTLC::from).collect(),
9963 sender_intended_total_msat: payment.htlcs.first().map(|htlc| htlc.total_msat),
9969 for (node_id, monitor_update_blocked_actions) in monitor_update_blocked_actions_per_peer.unwrap() {
9970 if let Some(peer_state) = per_peer_state.get(&node_id) {
9971 for (_, actions) in monitor_update_blocked_actions.iter() {
9972 for action in actions.iter() {
9973 if let MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
9974 downstream_counterparty_and_funding_outpoint:
9975 Some((blocked_node_id, blocked_channel_outpoint, blocking_action)), ..
9977 if let Some(blocked_peer_state) = per_peer_state.get(&blocked_node_id) {
9978 blocked_peer_state.lock().unwrap().actions_blocking_raa_monitor_updates
9979 .entry(blocked_channel_outpoint.to_channel_id())
9980 .or_insert_with(Vec::new).push(blocking_action.clone());
9982 // If the channel we were blocking has closed, we don't need to
9983 // worry about it - the blocked monitor update should never have
9984 // been released from the `Channel` object so it can't have
9985 // completed, and if the channel closed there's no reason to bother
9991 peer_state.lock().unwrap().monitor_update_blocked_actions = monitor_update_blocked_actions;
9993 log_error!(args.logger, "Got blocked actions without a per-peer-state for {}", node_id);
9994 return Err(DecodeError::InvalidValue);
9998 let channel_manager = ChannelManager {
10000 fee_estimator: bounded_fee_estimator,
10001 chain_monitor: args.chain_monitor,
10002 tx_broadcaster: args.tx_broadcaster,
10003 router: args.router,
10005 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
10007 inbound_payment_key: expanded_inbound_key,
10008 pending_inbound_payments: Mutex::new(pending_inbound_payments),
10009 pending_outbound_payments: pending_outbounds,
10010 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
10012 forward_htlcs: Mutex::new(forward_htlcs),
10013 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments, pending_claiming_payments: pending_claiming_payments.unwrap() }),
10014 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
10015 id_to_peer: Mutex::new(id_to_peer),
10016 short_to_chan_info: FairRwLock::new(short_to_chan_info),
10017 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
10019 probing_cookie_secret: probing_cookie_secret.unwrap(),
10021 our_network_pubkey,
10024 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
10026 per_peer_state: FairRwLock::new(per_peer_state),
10028 pending_events: Mutex::new(pending_events_read),
10029 pending_events_processor: AtomicBool::new(false),
10030 pending_background_events: Mutex::new(pending_background_events),
10031 total_consistency_lock: RwLock::new(()),
10032 background_events_processed_since_startup: AtomicBool::new(false),
10034 event_persist_notifier: Notifier::new(),
10035 needs_persist_flag: AtomicBool::new(false),
10037 funding_batch_states: Mutex::new(BTreeMap::new()),
10039 entropy_source: args.entropy_source,
10040 node_signer: args.node_signer,
10041 signer_provider: args.signer_provider,
10043 logger: args.logger,
10044 default_configuration: args.default_config,
10047 for htlc_source in failed_htlcs.drain(..) {
10048 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
10049 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
10050 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
10051 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
10054 for (source, preimage, downstream_value, downstream_closed, downstream_node_id, downstream_funding) in pending_claims_to_replay {
10055 // We use `downstream_closed` in place of `from_onchain` here just as a guess - we
10056 // don't remember in the `ChannelMonitor` where we got a preimage from, but if the
10057 // channel is closed we just assume that it probably came from an on-chain claim.
10058 channel_manager.claim_funds_internal(source, preimage, Some(downstream_value),
10059 downstream_closed, downstream_node_id, downstream_funding);
10062 //TODO: Broadcast channel update for closed channels, but only after we've made a
10063 //connection or two.
10065 Ok((best_block_hash.clone(), channel_manager))
10071 use bitcoin::hashes::Hash;
10072 use bitcoin::hashes::sha256::Hash as Sha256;
10073 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
10074 use core::sync::atomic::Ordering;
10075 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
10076 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
10077 use crate::ln::ChannelId;
10078 use crate::ln::channelmanager::{inbound_payment, PaymentId, PaymentSendFailure, RecipientOnionFields, InterceptId};
10079 use crate::ln::functional_test_utils::*;
10080 use crate::ln::msgs::{self, ErrorAction};
10081 use crate::ln::msgs::ChannelMessageHandler;
10082 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
10083 use crate::util::errors::APIError;
10084 use crate::util::test_utils;
10085 use crate::util::config::{ChannelConfig, ChannelConfigUpdate};
10086 use crate::sign::EntropySource;
10089 fn test_notify_limits() {
10090 // Check that a few cases which don't require the persistence of a new ChannelManager,
10091 // indeed, do not cause the persistence of a new ChannelManager.
10092 let chanmon_cfgs = create_chanmon_cfgs(3);
10093 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
10094 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
10095 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
10097 // All nodes start with a persistable update pending as `create_network` connects each node
10098 // with all other nodes to make most tests simpler.
10099 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
10100 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
10101 assert!(nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
10103 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1);
10105 // We check that the channel info nodes have doesn't change too early, even though we try
10106 // to connect messages with new values
10107 chan.0.contents.fee_base_msat *= 2;
10108 chan.1.contents.fee_base_msat *= 2;
10109 let node_a_chan_info = nodes[0].node.list_channels_with_counterparty(
10110 &nodes[1].node.get_our_node_id()).pop().unwrap();
10111 let node_b_chan_info = nodes[1].node.list_channels_with_counterparty(
10112 &nodes[0].node.get_our_node_id()).pop().unwrap();
10114 // The first two nodes (which opened a channel) should now require fresh persistence
10115 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
10116 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
10117 // ... but the last node should not.
10118 assert!(!nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
10119 // After persisting the first two nodes they should no longer need fresh persistence.
10120 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
10121 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
10123 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
10124 // about the channel.
10125 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
10126 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
10127 assert!(!nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
10129 // The nodes which are a party to the channel should also ignore messages from unrelated
10131 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
10132 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
10133 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
10134 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
10135 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
10136 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
10138 // At this point the channel info given by peers should still be the same.
10139 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
10140 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
10142 // An earlier version of handle_channel_update didn't check the directionality of the
10143 // update message and would always update the local fee info, even if our peer was
10144 // (spuriously) forwarding us our own channel_update.
10145 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
10146 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
10147 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
10149 // First deliver each peers' own message, checking that the node doesn't need to be
10150 // persisted and that its channel info remains the same.
10151 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
10152 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
10153 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
10154 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
10155 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
10156 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
10158 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
10159 // the channel info has updated.
10160 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
10161 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
10162 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
10163 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
10164 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
10165 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
10169 fn test_keysend_dup_hash_partial_mpp() {
10170 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
10172 let chanmon_cfgs = create_chanmon_cfgs(2);
10173 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10174 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10175 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10176 create_announced_chan_between_nodes(&nodes, 0, 1);
10178 // First, send a partial MPP payment.
10179 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
10180 let mut mpp_route = route.clone();
10181 mpp_route.paths.push(mpp_route.paths[0].clone());
10183 let payment_id = PaymentId([42; 32]);
10184 // Use the utility function send_payment_along_path to send the payment with MPP data which
10185 // indicates there are more HTLCs coming.
10186 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.
10187 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
10188 RecipientOnionFields::secret_only(payment_secret), payment_id, &mpp_route).unwrap();
10189 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[0], &our_payment_hash,
10190 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
10191 check_added_monitors!(nodes[0], 1);
10192 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10193 assert_eq!(events.len(), 1);
10194 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
10196 // Next, send a keysend payment with the same payment_hash and make sure it fails.
10197 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
10198 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
10199 check_added_monitors!(nodes[0], 1);
10200 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10201 assert_eq!(events.len(), 1);
10202 let ev = events.drain(..).next().unwrap();
10203 let payment_event = SendEvent::from_event(ev);
10204 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
10205 check_added_monitors!(nodes[1], 0);
10206 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
10207 expect_pending_htlcs_forwardable!(nodes[1]);
10208 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
10209 check_added_monitors!(nodes[1], 1);
10210 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
10211 assert!(updates.update_add_htlcs.is_empty());
10212 assert!(updates.update_fulfill_htlcs.is_empty());
10213 assert_eq!(updates.update_fail_htlcs.len(), 1);
10214 assert!(updates.update_fail_malformed_htlcs.is_empty());
10215 assert!(updates.update_fee.is_none());
10216 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
10217 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
10218 expect_payment_failed!(nodes[0], our_payment_hash, true);
10220 // Send the second half of the original MPP payment.
10221 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[1], &our_payment_hash,
10222 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
10223 check_added_monitors!(nodes[0], 1);
10224 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10225 assert_eq!(events.len(), 1);
10226 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
10228 // Claim the full MPP payment. Note that we can't use a test utility like
10229 // claim_funds_along_route because the ordering of the messages causes the second half of the
10230 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
10231 // lightning messages manually.
10232 nodes[1].node.claim_funds(payment_preimage);
10233 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
10234 check_added_monitors!(nodes[1], 2);
10236 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
10237 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
10238 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
10239 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
10240 check_added_monitors!(nodes[0], 1);
10241 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
10242 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
10243 check_added_monitors!(nodes[1], 1);
10244 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
10245 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
10246 check_added_monitors!(nodes[1], 1);
10247 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
10248 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
10249 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
10250 check_added_monitors!(nodes[0], 1);
10251 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
10252 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
10253 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
10254 check_added_monitors!(nodes[0], 1);
10255 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
10256 check_added_monitors!(nodes[1], 1);
10257 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
10258 check_added_monitors!(nodes[1], 1);
10259 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
10260 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
10261 check_added_monitors!(nodes[0], 1);
10263 // Note that successful MPP payments will generate a single PaymentSent event upon the first
10264 // path's success and a PaymentPathSuccessful event for each path's success.
10265 let events = nodes[0].node.get_and_clear_pending_events();
10266 assert_eq!(events.len(), 2);
10268 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
10269 assert_eq!(payment_id, *actual_payment_id);
10270 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
10271 assert_eq!(route.paths[0], *path);
10273 _ => panic!("Unexpected event"),
10276 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
10277 assert_eq!(payment_id, *actual_payment_id);
10278 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
10279 assert_eq!(route.paths[0], *path);
10281 _ => panic!("Unexpected event"),
10286 fn test_keysend_dup_payment_hash() {
10287 do_test_keysend_dup_payment_hash(false);
10288 do_test_keysend_dup_payment_hash(true);
10291 fn do_test_keysend_dup_payment_hash(accept_mpp_keysend: bool) {
10292 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
10293 // outbound regular payment fails as expected.
10294 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
10295 // fails as expected.
10296 // (3): Test that a keysend payment with a duplicate payment hash to an existing keysend
10297 // payment fails as expected. When `accept_mpp_keysend` is false, this tests that we
10298 // reject MPP keysend payments, since in this case where the payment has no payment
10299 // secret, a keysend payment with a duplicate hash is basically an MPP keysend. If
10300 // `accept_mpp_keysend` is true, this tests that we only accept MPP keysends with
10301 // payment secrets and reject otherwise.
10302 let chanmon_cfgs = create_chanmon_cfgs(2);
10303 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10304 let mut mpp_keysend_cfg = test_default_channel_config();
10305 mpp_keysend_cfg.accept_mpp_keysend = accept_mpp_keysend;
10306 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(mpp_keysend_cfg)]);
10307 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10308 create_announced_chan_between_nodes(&nodes, 0, 1);
10309 let scorer = test_utils::TestScorer::new();
10310 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
10312 // To start (1), send a regular payment but don't claim it.
10313 let expected_route = [&nodes[1]];
10314 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &expected_route, 100_000);
10316 // Next, attempt a keysend payment and make sure it fails.
10317 let route_params = RouteParameters::from_payment_params_and_value(
10318 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(),
10319 TEST_FINAL_CLTV, false), 100_000);
10320 let route = find_route(
10321 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
10322 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
10324 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
10325 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
10326 check_added_monitors!(nodes[0], 1);
10327 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10328 assert_eq!(events.len(), 1);
10329 let ev = events.drain(..).next().unwrap();
10330 let payment_event = SendEvent::from_event(ev);
10331 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
10332 check_added_monitors!(nodes[1], 0);
10333 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
10334 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
10335 // fails), the second will process the resulting failure and fail the HTLC backward
10336 expect_pending_htlcs_forwardable!(nodes[1]);
10337 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
10338 check_added_monitors!(nodes[1], 1);
10339 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
10340 assert!(updates.update_add_htlcs.is_empty());
10341 assert!(updates.update_fulfill_htlcs.is_empty());
10342 assert_eq!(updates.update_fail_htlcs.len(), 1);
10343 assert!(updates.update_fail_malformed_htlcs.is_empty());
10344 assert!(updates.update_fee.is_none());
10345 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
10346 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
10347 expect_payment_failed!(nodes[0], payment_hash, true);
10349 // Finally, claim the original payment.
10350 claim_payment(&nodes[0], &expected_route, payment_preimage);
10352 // To start (2), send a keysend payment but don't claim it.
10353 let payment_preimage = PaymentPreimage([42; 32]);
10354 let route = find_route(
10355 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
10356 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
10358 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
10359 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
10360 check_added_monitors!(nodes[0], 1);
10361 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10362 assert_eq!(events.len(), 1);
10363 let event = events.pop().unwrap();
10364 let path = vec![&nodes[1]];
10365 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
10367 // Next, attempt a regular payment and make sure it fails.
10368 let payment_secret = PaymentSecret([43; 32]);
10369 nodes[0].node.send_payment_with_route(&route, payment_hash,
10370 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
10371 check_added_monitors!(nodes[0], 1);
10372 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10373 assert_eq!(events.len(), 1);
10374 let ev = events.drain(..).next().unwrap();
10375 let payment_event = SendEvent::from_event(ev);
10376 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
10377 check_added_monitors!(nodes[1], 0);
10378 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
10379 expect_pending_htlcs_forwardable!(nodes[1]);
10380 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
10381 check_added_monitors!(nodes[1], 1);
10382 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
10383 assert!(updates.update_add_htlcs.is_empty());
10384 assert!(updates.update_fulfill_htlcs.is_empty());
10385 assert_eq!(updates.update_fail_htlcs.len(), 1);
10386 assert!(updates.update_fail_malformed_htlcs.is_empty());
10387 assert!(updates.update_fee.is_none());
10388 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
10389 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
10390 expect_payment_failed!(nodes[0], payment_hash, true);
10392 // Finally, succeed the keysend payment.
10393 claim_payment(&nodes[0], &expected_route, payment_preimage);
10395 // To start (3), send a keysend payment but don't claim it.
10396 let payment_id_1 = PaymentId([44; 32]);
10397 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
10398 RecipientOnionFields::spontaneous_empty(), payment_id_1).unwrap();
10399 check_added_monitors!(nodes[0], 1);
10400 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10401 assert_eq!(events.len(), 1);
10402 let event = events.pop().unwrap();
10403 let path = vec![&nodes[1]];
10404 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
10406 // Next, attempt a keysend payment and make sure it fails.
10407 let route_params = RouteParameters::from_payment_params_and_value(
10408 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
10411 let route = find_route(
10412 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
10413 None, nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
10415 let payment_id_2 = PaymentId([45; 32]);
10416 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
10417 RecipientOnionFields::spontaneous_empty(), payment_id_2).unwrap();
10418 check_added_monitors!(nodes[0], 1);
10419 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10420 assert_eq!(events.len(), 1);
10421 let ev = events.drain(..).next().unwrap();
10422 let payment_event = SendEvent::from_event(ev);
10423 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
10424 check_added_monitors!(nodes[1], 0);
10425 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
10426 expect_pending_htlcs_forwardable!(nodes[1]);
10427 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
10428 check_added_monitors!(nodes[1], 1);
10429 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
10430 assert!(updates.update_add_htlcs.is_empty());
10431 assert!(updates.update_fulfill_htlcs.is_empty());
10432 assert_eq!(updates.update_fail_htlcs.len(), 1);
10433 assert!(updates.update_fail_malformed_htlcs.is_empty());
10434 assert!(updates.update_fee.is_none());
10435 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
10436 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
10437 expect_payment_failed!(nodes[0], payment_hash, true);
10439 // Finally, claim the original payment.
10440 claim_payment(&nodes[0], &expected_route, payment_preimage);
10444 fn test_keysend_hash_mismatch() {
10445 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
10446 // preimage doesn't match the msg's payment hash.
10447 let chanmon_cfgs = create_chanmon_cfgs(2);
10448 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10449 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10450 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10452 let payer_pubkey = nodes[0].node.get_our_node_id();
10453 let payee_pubkey = nodes[1].node.get_our_node_id();
10455 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
10456 let route_params = RouteParameters::from_payment_params_and_value(
10457 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
10458 let network_graph = nodes[0].network_graph.clone();
10459 let first_hops = nodes[0].node.list_usable_channels();
10460 let scorer = test_utils::TestScorer::new();
10461 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
10462 let route = find_route(
10463 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
10464 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
10467 let test_preimage = PaymentPreimage([42; 32]);
10468 let mismatch_payment_hash = PaymentHash([43; 32]);
10469 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash,
10470 RecipientOnionFields::spontaneous_empty(), PaymentId(mismatch_payment_hash.0), &route).unwrap();
10471 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash,
10472 RecipientOnionFields::spontaneous_empty(), Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
10473 check_added_monitors!(nodes[0], 1);
10475 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
10476 assert_eq!(updates.update_add_htlcs.len(), 1);
10477 assert!(updates.update_fulfill_htlcs.is_empty());
10478 assert!(updates.update_fail_htlcs.is_empty());
10479 assert!(updates.update_fail_malformed_htlcs.is_empty());
10480 assert!(updates.update_fee.is_none());
10481 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
10483 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "Payment preimage didn't match payment hash", 1);
10487 fn test_keysend_msg_with_secret_err() {
10488 // Test that we error as expected if we receive a keysend payment that includes a payment
10489 // secret when we don't support MPP keysend.
10490 let mut reject_mpp_keysend_cfg = test_default_channel_config();
10491 reject_mpp_keysend_cfg.accept_mpp_keysend = false;
10492 let chanmon_cfgs = create_chanmon_cfgs(2);
10493 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10494 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(reject_mpp_keysend_cfg)]);
10495 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10497 let payer_pubkey = nodes[0].node.get_our_node_id();
10498 let payee_pubkey = nodes[1].node.get_our_node_id();
10500 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
10501 let route_params = RouteParameters::from_payment_params_and_value(
10502 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
10503 let network_graph = nodes[0].network_graph.clone();
10504 let first_hops = nodes[0].node.list_usable_channels();
10505 let scorer = test_utils::TestScorer::new();
10506 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
10507 let route = find_route(
10508 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
10509 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
10512 let test_preimage = PaymentPreimage([42; 32]);
10513 let test_secret = PaymentSecret([43; 32]);
10514 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
10515 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash,
10516 RecipientOnionFields::secret_only(test_secret), PaymentId(payment_hash.0), &route).unwrap();
10517 nodes[0].node.test_send_payment_internal(&route, payment_hash,
10518 RecipientOnionFields::secret_only(test_secret), Some(test_preimage),
10519 PaymentId(payment_hash.0), None, session_privs).unwrap();
10520 check_added_monitors!(nodes[0], 1);
10522 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
10523 assert_eq!(updates.update_add_htlcs.len(), 1);
10524 assert!(updates.update_fulfill_htlcs.is_empty());
10525 assert!(updates.update_fail_htlcs.is_empty());
10526 assert!(updates.update_fail_malformed_htlcs.is_empty());
10527 assert!(updates.update_fee.is_none());
10528 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
10530 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "We don't support MPP keysend payments", 1);
10534 fn test_multi_hop_missing_secret() {
10535 let chanmon_cfgs = create_chanmon_cfgs(4);
10536 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
10537 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
10538 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
10540 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
10541 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
10542 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
10543 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
10545 // Marshall an MPP route.
10546 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
10547 let path = route.paths[0].clone();
10548 route.paths.push(path);
10549 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
10550 route.paths[0].hops[0].short_channel_id = chan_1_id;
10551 route.paths[0].hops[1].short_channel_id = chan_3_id;
10552 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
10553 route.paths[1].hops[0].short_channel_id = chan_2_id;
10554 route.paths[1].hops[1].short_channel_id = chan_4_id;
10556 match nodes[0].node.send_payment_with_route(&route, payment_hash,
10557 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0))
10559 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
10560 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err))
10562 _ => panic!("unexpected error")
10567 fn test_drop_disconnected_peers_when_removing_channels() {
10568 let chanmon_cfgs = create_chanmon_cfgs(2);
10569 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10570 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10571 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10573 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
10575 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
10576 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10578 nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
10579 check_closed_broadcast!(nodes[0], true);
10580 check_added_monitors!(nodes[0], 1);
10581 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
10584 // Assert that nodes[1] is awaiting removal for nodes[0] once nodes[1] has been
10585 // disconnected and the channel between has been force closed.
10586 let nodes_0_per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
10587 // Assert that nodes[1] isn't removed before `timer_tick_occurred` has been executed.
10588 assert_eq!(nodes_0_per_peer_state.len(), 1);
10589 assert!(nodes_0_per_peer_state.get(&nodes[1].node.get_our_node_id()).is_some());
10592 nodes[0].node.timer_tick_occurred();
10595 // Assert that nodes[1] has now been removed.
10596 assert_eq!(nodes[0].node.per_peer_state.read().unwrap().len(), 0);
10601 fn bad_inbound_payment_hash() {
10602 // Add coverage for checking that a user-provided payment hash matches the payment secret.
10603 let chanmon_cfgs = create_chanmon_cfgs(2);
10604 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10605 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10606 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10608 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
10609 let payment_data = msgs::FinalOnionHopData {
10611 total_msat: 100_000,
10614 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
10615 // payment verification fails as expected.
10616 let mut bad_payment_hash = payment_hash.clone();
10617 bad_payment_hash.0[0] += 1;
10618 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) {
10619 Ok(_) => panic!("Unexpected ok"),
10621 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment", "Failing HTLC with user-generated payment_hash", 1);
10625 // Check that using the original payment hash succeeds.
10626 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());
10630 fn test_id_to_peer_coverage() {
10631 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
10632 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
10633 // the channel is successfully closed.
10634 let chanmon_cfgs = create_chanmon_cfgs(2);
10635 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10636 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10637 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10639 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
10640 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10641 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
10642 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10643 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
10645 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
10646 let channel_id = ChannelId::from_bytes(tx.txid().into_inner());
10648 // Ensure that the `id_to_peer` map is empty until either party has received the
10649 // funding transaction, and have the real `channel_id`.
10650 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
10651 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
10654 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
10656 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
10657 // as it has the funding transaction.
10658 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
10659 assert_eq!(nodes_0_lock.len(), 1);
10660 assert!(nodes_0_lock.contains_key(&channel_id));
10663 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
10665 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
10667 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
10669 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
10670 assert_eq!(nodes_0_lock.len(), 1);
10671 assert!(nodes_0_lock.contains_key(&channel_id));
10673 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
10676 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
10677 // as it has the funding transaction.
10678 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
10679 assert_eq!(nodes_1_lock.len(), 1);
10680 assert!(nodes_1_lock.contains_key(&channel_id));
10682 check_added_monitors!(nodes[1], 1);
10683 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
10684 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
10685 check_added_monitors!(nodes[0], 1);
10686 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
10687 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
10688 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
10689 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
10691 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
10692 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()));
10693 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
10694 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &nodes_1_shutdown);
10696 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
10697 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
10699 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
10700 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
10701 // fee for the closing transaction has been negotiated and the parties has the other
10702 // party's signature for the fee negotiated closing transaction.)
10703 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
10704 assert_eq!(nodes_0_lock.len(), 1);
10705 assert!(nodes_0_lock.contains_key(&channel_id));
10709 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
10710 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
10711 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
10712 // kept in the `nodes[1]`'s `id_to_peer` map.
10713 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
10714 assert_eq!(nodes_1_lock.len(), 1);
10715 assert!(nodes_1_lock.contains_key(&channel_id));
10718 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()));
10720 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
10721 // therefore has all it needs to fully close the channel (both signatures for the
10722 // closing transaction).
10723 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
10724 // fully closed by `nodes[0]`.
10725 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
10727 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
10728 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
10729 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
10730 assert_eq!(nodes_1_lock.len(), 1);
10731 assert!(nodes_1_lock.contains_key(&channel_id));
10734 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
10736 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
10738 // Assert that the channel has now been removed from both parties `id_to_peer` map once
10739 // they both have everything required to fully close the channel.
10740 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
10742 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
10744 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
10745 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
10748 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
10749 let expected_message = format!("Not connected to node: {}", expected_public_key);
10750 check_api_error_message(expected_message, res_err)
10753 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
10754 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
10755 check_api_error_message(expected_message, res_err)
10758 fn check_api_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
10760 Err(APIError::APIMisuseError { err }) => {
10761 assert_eq!(err, expected_err_message);
10763 Err(APIError::ChannelUnavailable { err }) => {
10764 assert_eq!(err, expected_err_message);
10766 Ok(_) => panic!("Unexpected Ok"),
10767 Err(_) => panic!("Unexpected Error"),
10772 fn test_api_calls_with_unkown_counterparty_node() {
10773 // Tests that our API functions that expects a `counterparty_node_id` as input, behaves as
10774 // expected if the `counterparty_node_id` is an unkown peer in the
10775 // `ChannelManager::per_peer_state` map.
10776 let chanmon_cfg = create_chanmon_cfgs(2);
10777 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
10778 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
10779 let nodes = create_network(2, &node_cfg, &node_chanmgr);
10782 let channel_id = ChannelId::from_bytes([4; 32]);
10783 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
10784 let intercept_id = InterceptId([0; 32]);
10786 // Test the API functions.
10787 check_not_connected_to_peer_error(nodes[0].node.create_channel(unkown_public_key, 1_000_000, 500_000_000, 42, None), unkown_public_key);
10789 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&channel_id, &unkown_public_key, 42), unkown_public_key);
10791 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
10793 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
10795 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
10797 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
10799 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
10803 fn test_connection_limiting() {
10804 // Test that we limit un-channel'd peers and un-funded channels properly.
10805 let chanmon_cfgs = create_chanmon_cfgs(2);
10806 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10807 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10808 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10810 // Note that create_network connects the nodes together for us
10812 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10813 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10815 let mut funding_tx = None;
10816 for idx in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
10817 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10818 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10821 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
10822 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
10823 funding_tx = Some(tx.clone());
10824 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx).unwrap();
10825 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
10827 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
10828 check_added_monitors!(nodes[1], 1);
10829 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
10831 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
10833 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
10834 check_added_monitors!(nodes[0], 1);
10835 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
10837 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10840 // A MAX_UNFUNDED_CHANS_PER_PEER + 1 channel will be summarily rejected
10841 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10842 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10843 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
10844 open_channel_msg.temporary_channel_id);
10846 // Further, because all of our channels with nodes[0] are inbound, and none of them funded,
10847 // it doesn't count as a "protected" peer, i.e. it counts towards the MAX_NO_CHANNEL_PEERS
10849 let mut peer_pks = Vec::with_capacity(super::MAX_NO_CHANNEL_PEERS);
10850 for _ in 1..super::MAX_NO_CHANNEL_PEERS {
10851 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10852 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10853 peer_pks.push(random_pk);
10854 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
10855 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10858 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10859 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10860 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10861 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10862 }, true).unwrap_err();
10864 // Also importantly, because nodes[0] isn't "protected", we will refuse a reconnection from
10865 // them if we have too many un-channel'd peers.
10866 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10867 let chan_closed_events = nodes[1].node.get_and_clear_pending_events();
10868 assert_eq!(chan_closed_events.len(), super::MAX_UNFUNDED_CHANS_PER_PEER - 1);
10869 for ev in chan_closed_events {
10870 if let Event::ChannelClosed { .. } = ev { } else { panic!(); }
10872 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10873 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10875 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10876 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10877 }, true).unwrap_err();
10879 // but of course if the connection is outbound its allowed...
10880 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10881 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10882 }, false).unwrap();
10883 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10885 // Now nodes[0] is disconnected but still has a pending, un-funded channel lying around.
10886 // Even though we accept one more connection from new peers, we won't actually let them
10888 assert!(peer_pks.len() > super::MAX_UNFUNDED_CHANNEL_PEERS - 1);
10889 for i in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
10890 nodes[1].node.handle_open_channel(&peer_pks[i], &open_channel_msg);
10891 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, peer_pks[i]);
10892 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10894 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10895 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
10896 open_channel_msg.temporary_channel_id);
10898 // Of course, however, outbound channels are always allowed
10899 nodes[1].node.create_channel(last_random_pk, 100_000, 0, 42, None).unwrap();
10900 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, last_random_pk);
10902 // If we fund the first channel, nodes[0] has a live on-chain channel with us, it is now
10903 // "protected" and can connect again.
10904 mine_transaction(&nodes[1], funding_tx.as_ref().unwrap());
10905 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10906 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10908 get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
10910 // Further, because the first channel was funded, we can open another channel with
10912 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10913 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
10917 fn test_outbound_chans_unlimited() {
10918 // Test that we never refuse an outbound channel even if a peer is unfuned-channel-limited
10919 let chanmon_cfgs = create_chanmon_cfgs(2);
10920 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10921 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10922 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10924 // Note that create_network connects the nodes together for us
10926 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10927 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10929 for _ in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
10930 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10931 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10932 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10935 // Once we have MAX_UNFUNDED_CHANS_PER_PEER unfunded channels, new inbound channels will be
10937 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10938 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
10939 open_channel_msg.temporary_channel_id);
10941 // but we can still open an outbound channel.
10942 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10943 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
10945 // but even with such an outbound channel, additional inbound channels will still fail.
10946 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10947 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
10948 open_channel_msg.temporary_channel_id);
10952 fn test_0conf_limiting() {
10953 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
10954 // flag set and (sometimes) accept channels as 0conf.
10955 let chanmon_cfgs = create_chanmon_cfgs(2);
10956 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10957 let mut settings = test_default_channel_config();
10958 settings.manually_accept_inbound_channels = true;
10959 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(settings)]);
10960 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10962 // Note that create_network connects the nodes together for us
10964 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10965 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10967 // First, get us up to MAX_UNFUNDED_CHANNEL_PEERS so we can test at the edge
10968 for _ in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
10969 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10970 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10971 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
10972 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10975 nodes[1].node.handle_open_channel(&random_pk, &open_channel_msg);
10976 let events = nodes[1].node.get_and_clear_pending_events();
10978 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10979 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23).unwrap();
10981 _ => panic!("Unexpected event"),
10983 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, random_pk);
10984 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10987 // If we try to accept a channel from another peer non-0conf it will fail.
10988 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10989 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10990 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10991 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10993 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10994 let events = nodes[1].node.get_and_clear_pending_events();
10996 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10997 match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23) {
10998 Err(APIError::APIMisuseError { err }) =>
10999 assert_eq!(err, "Too many peers with unfunded channels, refusing to accept new ones"),
11003 _ => panic!("Unexpected event"),
11005 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
11006 open_channel_msg.temporary_channel_id);
11008 // ...however if we accept the same channel 0conf it should work just fine.
11009 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
11010 let events = nodes[1].node.get_and_clear_pending_events();
11012 Event::OpenChannelRequest { temporary_channel_id, .. } => {
11013 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23).unwrap();
11015 _ => panic!("Unexpected event"),
11017 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
11021 fn reject_excessively_underpaying_htlcs() {
11022 let chanmon_cfg = create_chanmon_cfgs(1);
11023 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
11024 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
11025 let node = create_network(1, &node_cfg, &node_chanmgr);
11026 let sender_intended_amt_msat = 100;
11027 let extra_fee_msat = 10;
11028 let hop_data = msgs::InboundOnionPayload::Receive {
11030 outgoing_cltv_value: 42,
11031 payment_metadata: None,
11032 keysend_preimage: None,
11033 payment_data: Some(msgs::FinalOnionHopData {
11034 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
11036 custom_tlvs: Vec::new(),
11038 // Check that if the amount we received + the penultimate hop extra fee is less than the sender
11039 // intended amount, we fail the payment.
11040 if let Err(crate::ln::channelmanager::InboundOnionErr { err_code, .. }) =
11041 node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
11042 sender_intended_amt_msat - extra_fee_msat - 1, 42, None, true, Some(extra_fee_msat))
11044 assert_eq!(err_code, 19);
11045 } else { panic!(); }
11047 // If amt_received + extra_fee is equal to the sender intended amount, we're fine.
11048 let hop_data = msgs::InboundOnionPayload::Receive { // This is the same payload as above, InboundOnionPayload doesn't implement Clone
11050 outgoing_cltv_value: 42,
11051 payment_metadata: None,
11052 keysend_preimage: None,
11053 payment_data: Some(msgs::FinalOnionHopData {
11054 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
11056 custom_tlvs: Vec::new(),
11058 assert!(node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
11059 sender_intended_amt_msat - extra_fee_msat, 42, None, true, Some(extra_fee_msat)).is_ok());
11063 fn test_inbound_anchors_manual_acceptance() {
11064 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
11065 // flag set and (sometimes) accept channels as 0conf.
11066 let mut anchors_cfg = test_default_channel_config();
11067 anchors_cfg.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
11069 let mut anchors_manual_accept_cfg = anchors_cfg.clone();
11070 anchors_manual_accept_cfg.manually_accept_inbound_channels = true;
11072 let chanmon_cfgs = create_chanmon_cfgs(3);
11073 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
11074 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs,
11075 &[Some(anchors_cfg.clone()), Some(anchors_cfg.clone()), Some(anchors_manual_accept_cfg.clone())]);
11076 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
11078 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
11079 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11081 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11082 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
11083 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
11084 match &msg_events[0] {
11085 MessageSendEvent::HandleError { node_id, action } => {
11086 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
11088 ErrorAction::SendErrorMessage { msg } =>
11089 assert_eq!(msg.data, "No channels with anchor outputs accepted".to_owned()),
11090 _ => panic!("Unexpected error action"),
11093 _ => panic!("Unexpected event"),
11096 nodes[2].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11097 let events = nodes[2].node.get_and_clear_pending_events();
11099 Event::OpenChannelRequest { temporary_channel_id, .. } =>
11100 nodes[2].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap(),
11101 _ => panic!("Unexpected event"),
11103 get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
11107 fn test_anchors_zero_fee_htlc_tx_fallback() {
11108 // Tests that if both nodes support anchors, but the remote node does not want to accept
11109 // anchor channels at the moment, an error it sent to the local node such that it can retry
11110 // the channel without the anchors feature.
11111 let chanmon_cfgs = create_chanmon_cfgs(2);
11112 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
11113 let mut anchors_config = test_default_channel_config();
11114 anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
11115 anchors_config.manually_accept_inbound_channels = true;
11116 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config.clone()), Some(anchors_config.clone())]);
11117 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
11119 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 0, None).unwrap();
11120 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11121 assert!(open_channel_msg.channel_type.as_ref().unwrap().supports_anchors_zero_fee_htlc_tx());
11123 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
11124 let events = nodes[1].node.get_and_clear_pending_events();
11126 Event::OpenChannelRequest { temporary_channel_id, .. } => {
11127 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
11129 _ => panic!("Unexpected event"),
11132 let error_msg = get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id());
11133 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &error_msg);
11135 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
11136 assert!(!open_channel_msg.channel_type.unwrap().supports_anchors_zero_fee_htlc_tx());
11138 // Since nodes[1] should not have accepted the channel, it should
11139 // not have generated any events.
11140 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
11144 fn test_update_channel_config() {
11145 let chanmon_cfg = create_chanmon_cfgs(2);
11146 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
11147 let mut user_config = test_default_channel_config();
11148 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
11149 let nodes = create_network(2, &node_cfg, &node_chanmgr);
11150 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
11151 let channel = &nodes[0].node.list_channels()[0];
11153 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
11154 let events = nodes[0].node.get_and_clear_pending_msg_events();
11155 assert_eq!(events.len(), 0);
11157 user_config.channel_config.forwarding_fee_base_msat += 10;
11158 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
11159 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_base_msat, user_config.channel_config.forwarding_fee_base_msat);
11160 let events = nodes[0].node.get_and_clear_pending_msg_events();
11161 assert_eq!(events.len(), 1);
11163 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
11164 _ => panic!("expected BroadcastChannelUpdate event"),
11167 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate::default()).unwrap();
11168 let events = nodes[0].node.get_and_clear_pending_msg_events();
11169 assert_eq!(events.len(), 0);
11171 let new_cltv_expiry_delta = user_config.channel_config.cltv_expiry_delta + 6;
11172 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
11173 cltv_expiry_delta: Some(new_cltv_expiry_delta),
11174 ..Default::default()
11176 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
11177 let events = nodes[0].node.get_and_clear_pending_msg_events();
11178 assert_eq!(events.len(), 1);
11180 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
11181 _ => panic!("expected BroadcastChannelUpdate event"),
11184 let new_fee = user_config.channel_config.forwarding_fee_proportional_millionths + 100;
11185 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
11186 forwarding_fee_proportional_millionths: Some(new_fee),
11187 ..Default::default()
11189 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
11190 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, new_fee);
11191 let events = nodes[0].node.get_and_clear_pending_msg_events();
11192 assert_eq!(events.len(), 1);
11194 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
11195 _ => panic!("expected BroadcastChannelUpdate event"),
11198 // If we provide a channel_id not associated with the peer, we should get an error and no updates
11199 // should be applied to ensure update atomicity as specified in the API docs.
11200 let bad_channel_id = ChannelId::v1_from_funding_txid(&[10; 32], 10);
11201 let current_fee = nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths;
11202 let new_fee = current_fee + 100;
11205 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id, bad_channel_id], &ChannelConfigUpdate {
11206 forwarding_fee_proportional_millionths: Some(new_fee),
11207 ..Default::default()
11209 Err(APIError::ChannelUnavailable { err: _ }),
11212 // Check that the fee hasn't changed for the channel that exists.
11213 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, current_fee);
11214 let events = nodes[0].node.get_and_clear_pending_msg_events();
11215 assert_eq!(events.len(), 0);
11219 fn test_payment_display() {
11220 let payment_id = PaymentId([42; 32]);
11221 assert_eq!(format!("{}", &payment_id), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
11222 let payment_hash = PaymentHash([42; 32]);
11223 assert_eq!(format!("{}", &payment_hash), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
11224 let payment_preimage = PaymentPreimage([42; 32]);
11225 assert_eq!(format!("{}", &payment_preimage), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
11231 use crate::chain::Listen;
11232 use crate::chain::chainmonitor::{ChainMonitor, Persist};
11233 use crate::sign::{KeysManager, InMemorySigner};
11234 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider};
11235 use crate::ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId, RecipientOnionFields, Retry};
11236 use crate::ln::functional_test_utils::*;
11237 use crate::ln::msgs::{ChannelMessageHandler, Init};
11238 use crate::routing::gossip::NetworkGraph;
11239 use crate::routing::router::{PaymentParameters, RouteParameters};
11240 use crate::util::test_utils;
11241 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
11243 use bitcoin::hashes::Hash;
11244 use bitcoin::hashes::sha256::Hash as Sha256;
11245 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
11247 use crate::sync::{Arc, Mutex, RwLock};
11249 use criterion::Criterion;
11251 type Manager<'a, P> = ChannelManager<
11252 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
11253 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
11254 &'a test_utils::TestLogger, &'a P>,
11255 &'a test_utils::TestBroadcaster, &'a KeysManager, &'a KeysManager, &'a KeysManager,
11256 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
11257 &'a test_utils::TestLogger>;
11259 struct ANodeHolder<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> {
11260 node: &'node_cfg Manager<'chan_mon_cfg, P>,
11262 impl<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> NodeHolder for ANodeHolder<'node_cfg, 'chan_mon_cfg, P> {
11263 type CM = Manager<'chan_mon_cfg, P>;
11265 fn node(&self) -> &Manager<'chan_mon_cfg, P> { self.node }
11267 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { None }
11270 pub fn bench_sends(bench: &mut Criterion) {
11271 bench_two_sends(bench, "bench_sends", test_utils::TestPersister::new(), test_utils::TestPersister::new());
11274 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Criterion, bench_name: &str, persister_a: P, persister_b: P) {
11275 // Do a simple benchmark of sending a payment back and forth between two nodes.
11276 // Note that this is unrealistic as each payment send will require at least two fsync
11278 let network = bitcoin::Network::Testnet;
11279 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
11281 let tx_broadcaster = test_utils::TestBroadcaster::new(network);
11282 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
11283 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
11284 let scorer = RwLock::new(test_utils::TestScorer::new());
11285 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(network, &logger_a)), &scorer);
11287 let mut config: UserConfig = Default::default();
11288 config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
11289 config.channel_handshake_config.minimum_depth = 1;
11291 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
11292 let seed_a = [1u8; 32];
11293 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
11294 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 {
11296 best_block: BestBlock::from_network(network),
11297 }, genesis_block.header.time);
11298 let node_a_holder = ANodeHolder { node: &node_a };
11300 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
11301 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
11302 let seed_b = [2u8; 32];
11303 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
11304 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 {
11306 best_block: BestBlock::from_network(network),
11307 }, genesis_block.header.time);
11308 let node_b_holder = ANodeHolder { node: &node_b };
11310 node_a.peer_connected(&node_b.get_our_node_id(), &Init {
11311 features: node_b.init_features(), networks: None, remote_network_address: None
11313 node_b.peer_connected(&node_a.get_our_node_id(), &Init {
11314 features: node_a.init_features(), networks: None, remote_network_address: None
11315 }, false).unwrap();
11316 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
11317 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()));
11318 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()));
11321 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
11322 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
11323 value: 8_000_000, script_pubkey: output_script,
11325 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
11326 } else { panic!(); }
11328 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()));
11329 let events_b = node_b.get_and_clear_pending_events();
11330 assert_eq!(events_b.len(), 1);
11331 match events_b[0] {
11332 Event::ChannelPending{ ref counterparty_node_id, .. } => {
11333 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
11335 _ => panic!("Unexpected event"),
11338 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()));
11339 let events_a = node_a.get_and_clear_pending_events();
11340 assert_eq!(events_a.len(), 1);
11341 match events_a[0] {
11342 Event::ChannelPending{ ref counterparty_node_id, .. } => {
11343 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
11345 _ => panic!("Unexpected event"),
11348 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
11350 let block = create_dummy_block(BestBlock::from_network(network).block_hash(), 42, vec![tx]);
11351 Listen::block_connected(&node_a, &block, 1);
11352 Listen::block_connected(&node_b, &block, 1);
11354 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()));
11355 let msg_events = node_a.get_and_clear_pending_msg_events();
11356 assert_eq!(msg_events.len(), 2);
11357 match msg_events[0] {
11358 MessageSendEvent::SendChannelReady { ref msg, .. } => {
11359 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
11360 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
11364 match msg_events[1] {
11365 MessageSendEvent::SendChannelUpdate { .. } => {},
11369 let events_a = node_a.get_and_clear_pending_events();
11370 assert_eq!(events_a.len(), 1);
11371 match events_a[0] {
11372 Event::ChannelReady{ ref counterparty_node_id, .. } => {
11373 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
11375 _ => panic!("Unexpected event"),
11378 let events_b = node_b.get_and_clear_pending_events();
11379 assert_eq!(events_b.len(), 1);
11380 match events_b[0] {
11381 Event::ChannelReady{ ref counterparty_node_id, .. } => {
11382 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
11384 _ => panic!("Unexpected event"),
11387 let mut payment_count: u64 = 0;
11388 macro_rules! send_payment {
11389 ($node_a: expr, $node_b: expr) => {
11390 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id(), TEST_FINAL_CLTV)
11391 .with_bolt11_features($node_b.invoice_features()).unwrap();
11392 let mut payment_preimage = PaymentPreimage([0; 32]);
11393 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
11394 payment_count += 1;
11395 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
11396 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
11398 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
11399 PaymentId(payment_hash.0),
11400 RouteParameters::from_payment_params_and_value(payment_params, 10_000),
11401 Retry::Attempts(0)).unwrap();
11402 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
11403 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
11404 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
11405 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_b }, &$node_a.get_our_node_id());
11406 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
11407 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
11408 $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()));
11410 expect_pending_htlcs_forwardable!(ANodeHolder { node: &$node_b });
11411 expect_payment_claimable!(ANodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
11412 $node_b.claim_funds(payment_preimage);
11413 expect_payment_claimed!(ANodeHolder { node: &$node_b }, payment_hash, 10_000);
11415 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
11416 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
11417 assert_eq!(node_id, $node_a.get_our_node_id());
11418 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
11419 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
11421 _ => panic!("Failed to generate claim event"),
11424 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_a }, &$node_b.get_our_node_id());
11425 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
11426 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
11427 $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()));
11429 expect_payment_sent!(ANodeHolder { node: &$node_a }, payment_preimage);
11433 bench.bench_function(bench_name, |b| b.iter(|| {
11434 send_payment!(node_a, node_b);
11435 send_payment!(node_b, node_a);