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, PaymentHash, PaymentPreimage, PaymentSecret};
43 use crate::ln::channel::{Channel, ChannelContext, ChannelError, ChannelUpdateStatus, ShutdownResult, 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};
57 use crate::ln::wire::Encode;
58 use crate::sign::{EntropySource, KeysManager, NodeSigner, Recipient, SignerProvider, ChannelSigner, 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::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, 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]>,
115 /// This was added in 0.0.116 and will break deserialization on downgrades.
116 payment_data: Option<msgs::FinalOnionHopData>,
117 payment_preimage: PaymentPreimage,
118 payment_metadata: Option<Vec<u8>>,
119 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
123 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
124 pub(super) struct PendingHTLCInfo {
125 pub(super) routing: PendingHTLCRouting,
126 pub(super) incoming_shared_secret: [u8; 32],
127 payment_hash: PaymentHash,
129 pub(super) incoming_amt_msat: Option<u64>, // Added in 0.0.113
130 /// Sender intended amount to forward or receive (actual amount received
131 /// may overshoot this in either case)
132 pub(super) outgoing_amt_msat: u64,
133 pub(super) outgoing_cltv_value: u32,
134 /// The fee being skimmed off the top of this HTLC. If this is a forward, it'll be the fee we are
135 /// skimming. If we're receiving this HTLC, it's the fee that our counterparty skimmed.
136 pub(super) skimmed_fee_msat: Option<u64>,
139 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
140 pub(super) enum HTLCFailureMsg {
141 Relay(msgs::UpdateFailHTLC),
142 Malformed(msgs::UpdateFailMalformedHTLC),
145 /// Stores whether we can't forward an HTLC or relevant forwarding info
146 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
147 pub(super) enum PendingHTLCStatus {
148 Forward(PendingHTLCInfo),
149 Fail(HTLCFailureMsg),
152 pub(super) struct PendingAddHTLCInfo {
153 pub(super) forward_info: PendingHTLCInfo,
155 // These fields are produced in `forward_htlcs()` and consumed in
156 // `process_pending_htlc_forwards()` for constructing the
157 // `HTLCSource::PreviousHopData` for failed and forwarded
160 // Note that this may be an outbound SCID alias for the associated channel.
161 prev_short_channel_id: u64,
163 prev_funding_outpoint: OutPoint,
164 prev_user_channel_id: u128,
167 pub(super) enum HTLCForwardInfo {
168 AddHTLC(PendingAddHTLCInfo),
171 err_packet: msgs::OnionErrorPacket,
175 /// Tracks the inbound corresponding to an outbound HTLC
176 #[derive(Clone, Hash, PartialEq, Eq)]
177 pub(crate) struct HTLCPreviousHopData {
178 // Note that this may be an outbound SCID alias for the associated channel.
179 short_channel_id: u64,
181 incoming_packet_shared_secret: [u8; 32],
182 phantom_shared_secret: Option<[u8; 32]>,
184 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
185 // channel with a preimage provided by the forward channel.
190 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
192 /// This is only here for backwards-compatibility in serialization, in the future it can be
193 /// removed, breaking clients running 0.0.106 and earlier.
194 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
196 /// Contains the payer-provided preimage.
197 Spontaneous(PaymentPreimage),
200 /// HTLCs that are to us and can be failed/claimed by the user
201 struct ClaimableHTLC {
202 prev_hop: HTLCPreviousHopData,
204 /// The amount (in msats) of this MPP part
206 /// The amount (in msats) that the sender intended to be sent in this MPP
207 /// part (used for validating total MPP amount)
208 sender_intended_value: u64,
209 onion_payload: OnionPayload,
211 /// The total value received for a payment (sum of all MPP parts if the payment is a MPP).
212 /// Gets set to the amount reported when pushing [`Event::PaymentClaimable`].
213 total_value_received: Option<u64>,
214 /// The sender intended sum total of all MPP parts specified in the onion
216 /// The extra fee our counterparty skimmed off the top of this HTLC.
217 counterparty_skimmed_fee_msat: Option<u64>,
220 /// A payment identifier used to uniquely identify a payment to LDK.
222 /// This is not exported to bindings users as we just use [u8; 32] directly
223 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
224 pub struct PaymentId(pub [u8; 32]);
226 impl Writeable for PaymentId {
227 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
232 impl Readable for PaymentId {
233 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
234 let buf: [u8; 32] = Readable::read(r)?;
239 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
241 /// This is not exported to bindings users as we just use [u8; 32] directly
242 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
243 pub struct InterceptId(pub [u8; 32]);
245 impl Writeable for InterceptId {
246 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
251 impl Readable for InterceptId {
252 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
253 let buf: [u8; 32] = Readable::read(r)?;
258 #[derive(Clone, Copy, PartialEq, Eq, Hash)]
259 /// Uniquely describes an HTLC by its source. Just the guaranteed-unique subset of [`HTLCSource`].
260 pub(crate) enum SentHTLCId {
261 PreviousHopData { short_channel_id: u64, htlc_id: u64 },
262 OutboundRoute { session_priv: SecretKey },
265 pub(crate) fn from_source(source: &HTLCSource) -> Self {
267 HTLCSource::PreviousHopData(hop_data) => Self::PreviousHopData {
268 short_channel_id: hop_data.short_channel_id,
269 htlc_id: hop_data.htlc_id,
271 HTLCSource::OutboundRoute { session_priv, .. } =>
272 Self::OutboundRoute { session_priv: *session_priv },
276 impl_writeable_tlv_based_enum!(SentHTLCId,
277 (0, PreviousHopData) => {
278 (0, short_channel_id, required),
279 (2, htlc_id, required),
281 (2, OutboundRoute) => {
282 (0, session_priv, required),
287 /// Tracks the inbound corresponding to an outbound HTLC
288 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
289 #[derive(Clone, PartialEq, Eq)]
290 pub(crate) enum HTLCSource {
291 PreviousHopData(HTLCPreviousHopData),
294 session_priv: SecretKey,
295 /// Technically we can recalculate this from the route, but we cache it here to avoid
296 /// doing a double-pass on route when we get a failure back
297 first_hop_htlc_msat: u64,
298 payment_id: PaymentId,
301 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
302 impl core::hash::Hash for HTLCSource {
303 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
305 HTLCSource::PreviousHopData(prev_hop_data) => {
307 prev_hop_data.hash(hasher);
309 HTLCSource::OutboundRoute { path, session_priv, payment_id, first_hop_htlc_msat } => {
312 session_priv[..].hash(hasher);
313 payment_id.hash(hasher);
314 first_hop_htlc_msat.hash(hasher);
320 #[cfg(all(feature = "_test_vectors", not(feature = "grind_signatures")))]
322 pub fn dummy() -> Self {
323 HTLCSource::OutboundRoute {
324 path: Path { hops: Vec::new(), blinded_tail: None },
325 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
326 first_hop_htlc_msat: 0,
327 payment_id: PaymentId([2; 32]),
331 #[cfg(debug_assertions)]
332 /// Checks whether this HTLCSource could possibly match the given HTLC output in a commitment
333 /// transaction. Useful to ensure different datastructures match up.
334 pub(crate) fn possibly_matches_output(&self, htlc: &super::chan_utils::HTLCOutputInCommitment) -> bool {
335 if let HTLCSource::OutboundRoute { first_hop_htlc_msat, .. } = self {
336 *first_hop_htlc_msat == htlc.amount_msat
338 // There's nothing we can check for forwarded HTLCs
344 struct ReceiveError {
350 /// This enum is used to specify which error data to send to peers when failing back an HTLC
351 /// using [`ChannelManager::fail_htlc_backwards_with_reason`].
353 /// For more info on failure codes, see <https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages>.
354 #[derive(Clone, Copy)]
355 pub enum FailureCode {
356 /// We had a temporary error processing the payment. Useful if no other error codes fit
357 /// and you want to indicate that the payer may want to retry.
358 TemporaryNodeFailure = 0x2000 | 2,
359 /// We have a required feature which was not in this onion. For example, you may require
360 /// some additional metadata that was not provided with this payment.
361 RequiredNodeFeatureMissing = 0x4000 | 0x2000 | 3,
362 /// You may wish to use this when a `payment_preimage` is unknown, or the CLTV expiry of
363 /// the HTLC is too close to the current block height for safe handling.
364 /// Using this failure code in [`ChannelManager::fail_htlc_backwards_with_reason`] is
365 /// equivalent to calling [`ChannelManager::fail_htlc_backwards`].
366 IncorrectOrUnknownPaymentDetails = 0x4000 | 15,
369 /// Error type returned across the peer_state mutex boundary. When an Err is generated for a
370 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
371 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
372 /// peer_state lock. We then return the set of things that need to be done outside the lock in
373 /// this struct and call handle_error!() on it.
375 struct MsgHandleErrInternal {
376 err: msgs::LightningError,
377 chan_id: Option<([u8; 32], u128)>, // If Some a channel of ours has been closed
378 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
380 impl MsgHandleErrInternal {
382 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
384 err: LightningError {
386 action: msgs::ErrorAction::SendErrorMessage {
387 msg: msgs::ErrorMessage {
394 shutdown_finish: None,
398 fn from_no_close(err: msgs::LightningError) -> Self {
399 Self { err, chan_id: None, shutdown_finish: None }
402 fn from_finish_shutdown(err: String, channel_id: [u8; 32], user_channel_id: u128, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
404 err: LightningError {
406 action: msgs::ErrorAction::SendErrorMessage {
407 msg: msgs::ErrorMessage {
413 chan_id: Some((channel_id, user_channel_id)),
414 shutdown_finish: Some((shutdown_res, channel_update)),
418 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
421 ChannelError::Warn(msg) => LightningError {
423 action: msgs::ErrorAction::SendWarningMessage {
424 msg: msgs::WarningMessage {
428 log_level: Level::Warn,
431 ChannelError::Ignore(msg) => LightningError {
433 action: msgs::ErrorAction::IgnoreError,
435 ChannelError::Close(msg) => LightningError {
437 action: msgs::ErrorAction::SendErrorMessage {
438 msg: msgs::ErrorMessage {
446 shutdown_finish: None,
451 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
452 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
453 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
454 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
455 pub(super) const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
457 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
458 /// be sent in the order they appear in the return value, however sometimes the order needs to be
459 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
460 /// they were originally sent). In those cases, this enum is also returned.
461 #[derive(Clone, PartialEq)]
462 pub(super) enum RAACommitmentOrder {
463 /// Send the CommitmentUpdate messages first
465 /// Send the RevokeAndACK message first
469 /// Information about a payment which is currently being claimed.
470 struct ClaimingPayment {
472 payment_purpose: events::PaymentPurpose,
473 receiver_node_id: PublicKey,
475 impl_writeable_tlv_based!(ClaimingPayment, {
476 (0, amount_msat, required),
477 (2, payment_purpose, required),
478 (4, receiver_node_id, required),
481 struct ClaimablePayment {
482 purpose: events::PaymentPurpose,
483 onion_fields: Option<RecipientOnionFields>,
484 htlcs: Vec<ClaimableHTLC>,
487 /// Information about claimable or being-claimed payments
488 struct ClaimablePayments {
489 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
490 /// failed/claimed by the user.
492 /// Note that, no consistency guarantees are made about the channels given here actually
493 /// existing anymore by the time you go to read them!
495 /// When adding to the map, [`Self::pending_claiming_payments`] must also be checked to ensure
496 /// we don't get a duplicate payment.
497 claimable_payments: HashMap<PaymentHash, ClaimablePayment>,
499 /// Map from payment hash to the payment data for HTLCs which we have begun claiming, but which
500 /// are waiting on a [`ChannelMonitorUpdate`] to complete in order to be surfaced to the user
501 /// as an [`events::Event::PaymentClaimed`].
502 pending_claiming_payments: HashMap<PaymentHash, ClaimingPayment>,
505 /// Events which we process internally but cannot be processed immediately at the generation site
506 /// usually because we're running pre-full-init. They are handled immediately once we detect we are
507 /// running normally, and specifically must be processed before any other non-background
508 /// [`ChannelMonitorUpdate`]s are applied.
509 enum BackgroundEvent {
510 /// Handle a ChannelMonitorUpdate which closes the channel or for an already-closed channel.
511 /// This is only separated from [`Self::MonitorUpdateRegeneratedOnStartup`] as the
512 /// maybe-non-closing variant needs a public key to handle channel resumption, whereas if the
513 /// channel has been force-closed we do not need the counterparty node_id.
515 /// Note that any such events are lost on shutdown, so in general they must be updates which
516 /// are regenerated on startup.
517 ClosedMonitorUpdateRegeneratedOnStartup((OutPoint, ChannelMonitorUpdate)),
518 /// Handle a ChannelMonitorUpdate which may or may not close the channel and may unblock the
519 /// channel to continue normal operation.
521 /// In general this should be used rather than
522 /// [`Self::ClosedMonitorUpdateRegeneratedOnStartup`], however in cases where the
523 /// `counterparty_node_id` is not available as the channel has closed from a [`ChannelMonitor`]
524 /// error the other variant is acceptable.
526 /// Note that any such events are lost on shutdown, so in general they must be updates which
527 /// are regenerated on startup.
528 MonitorUpdateRegeneratedOnStartup {
529 counterparty_node_id: PublicKey,
530 funding_txo: OutPoint,
531 update: ChannelMonitorUpdate
533 /// Some [`ChannelMonitorUpdate`] (s) completed before we were serialized but we still have
534 /// them marked pending, thus we need to run any [`MonitorUpdateCompletionAction`] (s) pending
536 MonitorUpdatesComplete {
537 counterparty_node_id: PublicKey,
538 channel_id: [u8; 32],
543 pub(crate) enum MonitorUpdateCompletionAction {
544 /// Indicates that a payment ultimately destined for us was claimed and we should emit an
545 /// [`events::Event::PaymentClaimed`] to the user if we haven't yet generated such an event for
546 /// this payment. Note that this is only best-effort. On restart it's possible such a duplicate
547 /// event can be generated.
548 PaymentClaimed { payment_hash: PaymentHash },
549 /// Indicates an [`events::Event`] should be surfaced to the user and possibly resume the
550 /// operation of another channel.
552 /// This is usually generated when we've forwarded an HTLC and want to block the outbound edge
553 /// from completing a monitor update which removes the payment preimage until the inbound edge
554 /// completes a monitor update containing the payment preimage. In that case, after the inbound
555 /// edge completes, we will surface an [`Event::PaymentForwarded`] as well as unblock the
557 EmitEventAndFreeOtherChannel {
558 event: events::Event,
559 downstream_counterparty_and_funding_outpoint: Option<(PublicKey, OutPoint, RAAMonitorUpdateBlockingAction)>,
563 impl_writeable_tlv_based_enum_upgradable!(MonitorUpdateCompletionAction,
564 (0, PaymentClaimed) => { (0, payment_hash, required) },
565 (2, EmitEventAndFreeOtherChannel) => {
566 (0, event, upgradable_required),
567 // LDK prior to 0.0.116 did not have this field as the monitor update application order was
568 // required by clients. If we downgrade to something prior to 0.0.116 this may result in
569 // monitor updates which aren't properly blocked or resumed, however that's fine - we don't
570 // support async monitor updates even in LDK 0.0.116 and once we do we'll require no
571 // downgrades to prior versions.
572 (1, downstream_counterparty_and_funding_outpoint, option),
576 #[derive(Clone, Debug, PartialEq, Eq)]
577 pub(crate) enum EventCompletionAction {
578 ReleaseRAAChannelMonitorUpdate {
579 counterparty_node_id: PublicKey,
580 channel_funding_outpoint: OutPoint,
583 impl_writeable_tlv_based_enum!(EventCompletionAction,
584 (0, ReleaseRAAChannelMonitorUpdate) => {
585 (0, channel_funding_outpoint, required),
586 (2, counterparty_node_id, required),
590 #[derive(Clone, PartialEq, Eq, Debug)]
591 /// If something is blocked on the completion of an RAA-generated [`ChannelMonitorUpdate`] we track
592 /// the blocked action here. See enum variants for more info.
593 pub(crate) enum RAAMonitorUpdateBlockingAction {
594 /// A forwarded payment was claimed. We block the downstream channel completing its monitor
595 /// update which removes the HTLC preimage until the upstream channel has gotten the preimage
597 ForwardedPaymentInboundClaim {
598 /// The upstream channel ID (i.e. the inbound edge).
599 channel_id: [u8; 32],
600 /// The HTLC ID on the inbound edge.
605 impl RAAMonitorUpdateBlockingAction {
607 fn from_prev_hop_data(prev_hop: &HTLCPreviousHopData) -> Self {
608 Self::ForwardedPaymentInboundClaim {
609 channel_id: prev_hop.outpoint.to_channel_id(),
610 htlc_id: prev_hop.htlc_id,
615 impl_writeable_tlv_based_enum!(RAAMonitorUpdateBlockingAction,
616 (0, ForwardedPaymentInboundClaim) => { (0, channel_id, required), (2, htlc_id, required) }
620 /// State we hold per-peer.
621 pub(super) struct PeerState<Signer: ChannelSigner> {
622 /// `channel_id` -> `Channel`.
624 /// Holds all funded channels where the peer is the counterparty.
625 pub(super) channel_by_id: HashMap<[u8; 32], Channel<Signer>>,
626 /// `temporary_channel_id` -> `OutboundV1Channel`.
628 /// Holds all outbound V1 channels where the peer is the counterparty. Once an outbound channel has
629 /// been assigned a `channel_id`, the entry in this map is removed and one is created in
631 pub(super) outbound_v1_channel_by_id: HashMap<[u8; 32], OutboundV1Channel<Signer>>,
632 /// `temporary_channel_id` -> `InboundV1Channel`.
634 /// Holds all inbound V1 channels where the peer is the counterparty. Once an inbound channel has
635 /// been assigned a `channel_id`, the entry in this map is removed and one is created in
637 pub(super) inbound_v1_channel_by_id: HashMap<[u8; 32], InboundV1Channel<Signer>>,
638 /// The latest `InitFeatures` we heard from the peer.
639 latest_features: InitFeatures,
640 /// Messages to send to the peer - pushed to in the same lock that they are generated in (except
641 /// for broadcast messages, where ordering isn't as strict).
642 pub(super) pending_msg_events: Vec<MessageSendEvent>,
643 /// Map from Channel IDs to pending [`ChannelMonitorUpdate`]s which have been passed to the
644 /// user but which have not yet completed.
646 /// Note that the channel may no longer exist. For example if the channel was closed but we
647 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
648 /// for a missing channel.
649 in_flight_monitor_updates: BTreeMap<OutPoint, Vec<ChannelMonitorUpdate>>,
650 /// Map from a specific channel to some action(s) that should be taken when all pending
651 /// [`ChannelMonitorUpdate`]s for the channel complete updating.
653 /// Note that because we generally only have one entry here a HashMap is pretty overkill. A
654 /// BTreeMap currently stores more than ten elements per leaf node, so even up to a few
655 /// channels with a peer this will just be one allocation and will amount to a linear list of
656 /// channels to walk, avoiding the whole hashing rigmarole.
658 /// Note that the channel may no longer exist. For example, if a channel was closed but we
659 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
660 /// for a missing channel. While a malicious peer could construct a second channel with the
661 /// same `temporary_channel_id` (or final `channel_id` in the case of 0conf channels or prior
662 /// to funding appearing on-chain), the downstream `ChannelMonitor` set is required to ensure
663 /// duplicates do not occur, so such channels should fail without a monitor update completing.
664 monitor_update_blocked_actions: BTreeMap<[u8; 32], Vec<MonitorUpdateCompletionAction>>,
665 /// If another channel's [`ChannelMonitorUpdate`] needs to complete before a channel we have
666 /// with this peer can complete an RAA [`ChannelMonitorUpdate`] (e.g. because the RAA update
667 /// will remove a preimage that needs to be durably in an upstream channel first), we put an
668 /// entry here to note that the channel with the key's ID is blocked on a set of actions.
669 actions_blocking_raa_monitor_updates: BTreeMap<[u8; 32], Vec<RAAMonitorUpdateBlockingAction>>,
670 /// The peer is currently connected (i.e. we've seen a
671 /// [`ChannelMessageHandler::peer_connected`] and no corresponding
672 /// [`ChannelMessageHandler::peer_disconnected`].
676 impl <Signer: ChannelSigner> PeerState<Signer> {
677 /// Indicates that a peer meets the criteria where we're ok to remove it from our storage.
678 /// If true is passed for `require_disconnected`, the function will return false if we haven't
679 /// disconnected from the node already, ie. `PeerState::is_connected` is set to `true`.
680 fn ok_to_remove(&self, require_disconnected: bool) -> bool {
681 if require_disconnected && self.is_connected {
684 self.channel_by_id.is_empty() && self.monitor_update_blocked_actions.is_empty()
685 && self.in_flight_monitor_updates.is_empty()
688 // Returns a count of all channels we have with this peer, including unfunded channels.
689 fn total_channel_count(&self) -> usize {
690 self.channel_by_id.len() +
691 self.outbound_v1_channel_by_id.len() +
692 self.inbound_v1_channel_by_id.len()
695 // Returns a bool indicating if the given `channel_id` matches a channel we have with this peer.
696 fn has_channel(&self, channel_id: &[u8; 32]) -> bool {
697 self.channel_by_id.contains_key(channel_id) ||
698 self.outbound_v1_channel_by_id.contains_key(channel_id) ||
699 self.inbound_v1_channel_by_id.contains_key(channel_id)
703 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
704 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
706 /// For users who don't want to bother doing their own payment preimage storage, we also store that
709 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
710 /// and instead encoding it in the payment secret.
711 struct PendingInboundPayment {
712 /// The payment secret that the sender must use for us to accept this payment
713 payment_secret: PaymentSecret,
714 /// Time at which this HTLC expires - blocks with a header time above this value will result in
715 /// this payment being removed.
717 /// Arbitrary identifier the user specifies (or not)
718 user_payment_id: u64,
719 // Other required attributes of the payment, optionally enforced:
720 payment_preimage: Option<PaymentPreimage>,
721 min_value_msat: Option<u64>,
724 /// [`SimpleArcChannelManager`] is useful when you need a [`ChannelManager`] with a static lifetime, e.g.
725 /// when you're using `lightning-net-tokio` (since `tokio::spawn` requires parameters with static
726 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
727 /// [`SimpleRefChannelManager`] is the more appropriate type. Defining these type aliases prevents
728 /// issues such as overly long function definitions. Note that the `ChannelManager` can take any type
729 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
730 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
731 /// of [`KeysManager`] and [`DefaultRouter`].
733 /// This is not exported to bindings users as Arcs don't make sense in bindings
734 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
742 Arc<NetworkGraph<Arc<L>>>,
744 Arc<Mutex<ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>>,
745 ProbabilisticScoringFeeParameters,
746 ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>,
751 /// [`SimpleRefChannelManager`] is a type alias for a ChannelManager reference, and is the reference
752 /// counterpart to the [`SimpleArcChannelManager`] type alias. Use this type by default when you don't
753 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
754 /// usage of lightning-net-tokio (since `tokio::spawn` requires parameters with static lifetimes).
755 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
756 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
757 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
758 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
759 /// of [`KeysManager`] and [`DefaultRouter`].
761 /// This is not exported to bindings users as Arcs don't make sense in bindings
762 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> =
771 &'f NetworkGraph<&'g L>,
773 &'h Mutex<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>,
774 ProbabilisticScoringFeeParameters,
775 ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>
780 macro_rules! define_test_pub_trait { ($vis: vis) => {
781 /// A trivial trait which describes any [`ChannelManager`] used in testing.
782 $vis trait AChannelManager {
783 type Watch: chain::Watch<Self::Signer> + ?Sized;
784 type M: Deref<Target = Self::Watch>;
785 type Broadcaster: BroadcasterInterface + ?Sized;
786 type T: Deref<Target = Self::Broadcaster>;
787 type EntropySource: EntropySource + ?Sized;
788 type ES: Deref<Target = Self::EntropySource>;
789 type NodeSigner: NodeSigner + ?Sized;
790 type NS: Deref<Target = Self::NodeSigner>;
791 type Signer: WriteableEcdsaChannelSigner + Sized;
792 type SignerProvider: SignerProvider<Signer = Self::Signer> + ?Sized;
793 type SP: Deref<Target = Self::SignerProvider>;
794 type FeeEstimator: FeeEstimator + ?Sized;
795 type F: Deref<Target = Self::FeeEstimator>;
796 type Router: Router + ?Sized;
797 type R: Deref<Target = Self::Router>;
798 type Logger: Logger + ?Sized;
799 type L: Deref<Target = Self::Logger>;
800 fn get_cm(&self) -> &ChannelManager<Self::M, Self::T, Self::ES, Self::NS, Self::SP, Self::F, Self::R, Self::L>;
803 #[cfg(any(test, feature = "_test_utils"))]
804 define_test_pub_trait!(pub);
805 #[cfg(not(any(test, feature = "_test_utils")))]
806 define_test_pub_trait!(pub(crate));
807 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> AChannelManager
808 for ChannelManager<M, T, ES, NS, SP, F, R, L>
810 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
811 T::Target: BroadcasterInterface,
812 ES::Target: EntropySource,
813 NS::Target: NodeSigner,
814 SP::Target: SignerProvider,
815 F::Target: FeeEstimator,
819 type Watch = M::Target;
821 type Broadcaster = T::Target;
823 type EntropySource = ES::Target;
825 type NodeSigner = NS::Target;
827 type Signer = <SP::Target as SignerProvider>::Signer;
828 type SignerProvider = SP::Target;
830 type FeeEstimator = F::Target;
832 type Router = R::Target;
834 type Logger = L::Target;
836 fn get_cm(&self) -> &ChannelManager<M, T, ES, NS, SP, F, R, L> { self }
839 /// Manager which keeps track of a number of channels and sends messages to the appropriate
840 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
842 /// Implements [`ChannelMessageHandler`], handling the multi-channel parts and passing things through
843 /// to individual Channels.
845 /// Implements [`Writeable`] to write out all channel state to disk. Implies [`peer_disconnected`] for
846 /// all peers during write/read (though does not modify this instance, only the instance being
847 /// serialized). This will result in any channels which have not yet exchanged [`funding_created`] (i.e.,
848 /// called [`funding_transaction_generated`] for outbound channels) being closed.
850 /// Note that you can be a bit lazier about writing out `ChannelManager` than you can be with
851 /// [`ChannelMonitor`]. With [`ChannelMonitor`] you MUST write each monitor update out to disk before
852 /// returning from [`chain::Watch::watch_channel`]/[`update_channel`], with ChannelManagers, writing updates
853 /// happens out-of-band (and will prevent any other `ChannelManager` operations from occurring during
854 /// the serialization process). If the deserialized version is out-of-date compared to the
855 /// [`ChannelMonitor`] passed by reference to [`read`], those channels will be force-closed based on the
856 /// `ChannelMonitor` state and no funds will be lost (mod on-chain transaction fees).
858 /// Note that the deserializer is only implemented for `(`[`BlockHash`]`, `[`ChannelManager`]`)`, which
859 /// tells you the last block hash which was connected. You should get the best block tip before using the manager.
860 /// See [`chain::Listen`] and [`chain::Confirm`] for more details.
862 /// Note that `ChannelManager` is responsible for tracking liveness of its channels and generating
863 /// [`ChannelUpdate`] messages informing peers that the channel is temporarily disabled. To avoid
864 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
865 /// offline for a full minute. In order to track this, you must call
866 /// [`timer_tick_occurred`] roughly once per minute, though it doesn't have to be perfect.
868 /// To avoid trivial DoS issues, `ChannelManager` limits the number of inbound connections and
869 /// inbound channels without confirmed funding transactions. This may result in nodes which we do
870 /// not have a channel with being unable to connect to us or open new channels with us if we have
871 /// many peers with unfunded channels.
873 /// Because it is an indication of trust, inbound channels which we've accepted as 0conf are
874 /// exempted from the count of unfunded channels. Similarly, outbound channels and connections are
875 /// never limited. Please ensure you limit the count of such channels yourself.
877 /// Rather than using a plain `ChannelManager`, it is preferable to use either a [`SimpleArcChannelManager`]
878 /// a [`SimpleRefChannelManager`], for conciseness. See their documentation for more details, but
879 /// essentially you should default to using a [`SimpleRefChannelManager`], and use a
880 /// [`SimpleArcChannelManager`] when you require a `ChannelManager` with a static lifetime, such as when
881 /// you're using lightning-net-tokio.
883 /// [`peer_disconnected`]: msgs::ChannelMessageHandler::peer_disconnected
884 /// [`funding_created`]: msgs::FundingCreated
885 /// [`funding_transaction_generated`]: Self::funding_transaction_generated
886 /// [`BlockHash`]: bitcoin::hash_types::BlockHash
887 /// [`update_channel`]: chain::Watch::update_channel
888 /// [`ChannelUpdate`]: msgs::ChannelUpdate
889 /// [`timer_tick_occurred`]: Self::timer_tick_occurred
890 /// [`read`]: ReadableArgs::read
893 // The tree structure below illustrates the lock order requirements for the different locks of the
894 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
895 // and should then be taken in the order of the lowest to the highest level in the tree.
896 // Note that locks on different branches shall not be taken at the same time, as doing so will
897 // create a new lock order for those specific locks in the order they were taken.
901 // `total_consistency_lock`
903 // |__`forward_htlcs`
905 // | |__`pending_intercepted_htlcs`
907 // |__`per_peer_state`
909 // | |__`pending_inbound_payments`
911 // | |__`claimable_payments`
913 // | |__`pending_outbound_payments` // This field's struct contains a map of pending outbounds
919 // | |__`short_to_chan_info`
921 // | |__`outbound_scid_aliases`
925 // | |__`pending_events`
927 // | |__`pending_background_events`
929 pub struct ChannelManager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
931 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
932 T::Target: BroadcasterInterface,
933 ES::Target: EntropySource,
934 NS::Target: NodeSigner,
935 SP::Target: SignerProvider,
936 F::Target: FeeEstimator,
940 default_configuration: UserConfig,
941 genesis_hash: BlockHash,
942 fee_estimator: LowerBoundedFeeEstimator<F>,
948 /// See `ChannelManager` struct-level documentation for lock order requirements.
950 pub(super) best_block: RwLock<BestBlock>,
952 best_block: RwLock<BestBlock>,
953 secp_ctx: Secp256k1<secp256k1::All>,
955 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
956 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
957 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
958 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
960 /// See `ChannelManager` struct-level documentation for lock order requirements.
961 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
963 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
964 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
965 /// (if the channel has been force-closed), however we track them here to prevent duplicative
966 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
967 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
968 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
969 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
970 /// after reloading from disk while replaying blocks against ChannelMonitors.
972 /// See `PendingOutboundPayment` documentation for more info.
974 /// See `ChannelManager` struct-level documentation for lock order requirements.
975 pending_outbound_payments: OutboundPayments,
977 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
979 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
980 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
981 /// and via the classic SCID.
983 /// Note that no consistency guarantees are made about the existence of a channel with the
984 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
986 /// See `ChannelManager` struct-level documentation for lock order requirements.
988 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
990 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
991 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
992 /// until the user tells us what we should do with them.
994 /// See `ChannelManager` struct-level documentation for lock order requirements.
995 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
997 /// The sets of payments which are claimable or currently being claimed. See
998 /// [`ClaimablePayments`]' individual field docs for more info.
1000 /// See `ChannelManager` struct-level documentation for lock order requirements.
1001 claimable_payments: Mutex<ClaimablePayments>,
1003 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
1004 /// and some closed channels which reached a usable state prior to being closed. This is used
1005 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
1006 /// active channel list on load.
1008 /// See `ChannelManager` struct-level documentation for lock order requirements.
1009 outbound_scid_aliases: Mutex<HashSet<u64>>,
1011 /// `channel_id` -> `counterparty_node_id`.
1013 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
1014 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
1015 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
1017 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
1018 /// the corresponding channel for the event, as we only have access to the `channel_id` during
1019 /// the handling of the events.
1021 /// Note that no consistency guarantees are made about the existence of a peer with the
1022 /// `counterparty_node_id` in our other maps.
1025 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
1026 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
1027 /// would break backwards compatability.
1028 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
1029 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
1030 /// required to access the channel with the `counterparty_node_id`.
1032 /// See `ChannelManager` struct-level documentation for lock order requirements.
1033 id_to_peer: Mutex<HashMap<[u8; 32], PublicKey>>,
1035 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
1037 /// Outbound SCID aliases are added here once the channel is available for normal use, with
1038 /// SCIDs being added once the funding transaction is confirmed at the channel's required
1039 /// confirmation depth.
1041 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
1042 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
1043 /// channel with the `channel_id` in our other maps.
1045 /// See `ChannelManager` struct-level documentation for lock order requirements.
1047 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
1049 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
1051 our_network_pubkey: PublicKey,
1053 inbound_payment_key: inbound_payment::ExpandedKey,
1055 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
1056 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
1057 /// we encrypt the namespace identifier using these bytes.
1059 /// [fake scids]: crate::util::scid_utils::fake_scid
1060 fake_scid_rand_bytes: [u8; 32],
1062 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
1063 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
1064 /// keeping additional state.
1065 probing_cookie_secret: [u8; 32],
1067 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
1068 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
1069 /// very far in the past, and can only ever be up to two hours in the future.
1070 highest_seen_timestamp: AtomicUsize,
1072 /// The bulk of our storage. Currently the `per_peer_state` stores our channels on a per-peer
1073 /// basis, as well as the peer's latest features.
1075 /// If we are connected to a peer we always at least have an entry here, even if no channels
1076 /// are currently open with that peer.
1078 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
1079 /// operate on the inner value freely. This opens up for parallel per-peer operation for
1082 /// Note that the same thread must never acquire two inner `PeerState` locks at the same time.
1084 /// See `ChannelManager` struct-level documentation for lock order requirements.
1085 #[cfg(not(any(test, feature = "_test_utils")))]
1086 per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>>>,
1087 #[cfg(any(test, feature = "_test_utils"))]
1088 pub(super) per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>>>,
1090 /// The set of events which we need to give to the user to handle. In some cases an event may
1091 /// require some further action after the user handles it (currently only blocking a monitor
1092 /// update from being handed to the user to ensure the included changes to the channel state
1093 /// are handled by the user before they're persisted durably to disk). In that case, the second
1094 /// element in the tuple is set to `Some` with further details of the action.
1096 /// Note that events MUST NOT be removed from pending_events after deserialization, as they
1097 /// could be in the middle of being processed without the direct mutex held.
1099 /// See `ChannelManager` struct-level documentation for lock order requirements.
1100 pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1101 /// A simple atomic flag to ensure only one task at a time can be processing events asynchronously.
1102 pending_events_processor: AtomicBool,
1104 /// If we are running during init (either directly during the deserialization method or in
1105 /// block connection methods which run after deserialization but before normal operation) we
1106 /// cannot provide the user with [`ChannelMonitorUpdate`]s through the normal update flow -
1107 /// prior to normal operation the user may not have loaded the [`ChannelMonitor`]s into their
1108 /// [`ChainMonitor`] and thus attempting to update it will fail or panic.
1110 /// Thus, we place them here to be handled as soon as possible once we are running normally.
1112 /// See `ChannelManager` struct-level documentation for lock order requirements.
1114 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
1115 pending_background_events: Mutex<Vec<BackgroundEvent>>,
1116 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
1117 /// Essentially just when we're serializing ourselves out.
1118 /// Taken first everywhere where we are making changes before any other locks.
1119 /// When acquiring this lock in read mode, rather than acquiring it directly, call
1120 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
1121 /// Notifier the lock contains sends out a notification when the lock is released.
1122 total_consistency_lock: RwLock<()>,
1124 background_events_processed_since_startup: AtomicBool,
1126 persistence_notifier: Notifier,
1130 signer_provider: SP,
1135 /// Chain-related parameters used to construct a new `ChannelManager`.
1137 /// Typically, the block-specific parameters are derived from the best block hash for the network,
1138 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
1139 /// are not needed when deserializing a previously constructed `ChannelManager`.
1140 #[derive(Clone, Copy, PartialEq)]
1141 pub struct ChainParameters {
1142 /// The network for determining the `chain_hash` in Lightning messages.
1143 pub network: Network,
1145 /// The hash and height of the latest block successfully connected.
1147 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
1148 pub best_block: BestBlock,
1151 #[derive(Copy, Clone, PartialEq)]
1158 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
1159 /// desirable to notify any listeners on `await_persistable_update_timeout`/
1160 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
1161 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
1162 /// sending the aforementioned notification (since the lock being released indicates that the
1163 /// updates are ready for persistence).
1165 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
1166 /// notify or not based on whether relevant changes have been made, providing a closure to
1167 /// `optionally_notify` which returns a `NotifyOption`.
1168 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
1169 persistence_notifier: &'a Notifier,
1171 // We hold onto this result so the lock doesn't get released immediately.
1172 _read_guard: RwLockReadGuard<'a, ()>,
1175 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
1176 fn notify_on_drop<C: AChannelManager>(cm: &'a C) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
1177 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1178 let _ = cm.get_cm().process_background_events(); // We always persist
1180 PersistenceNotifierGuard {
1181 persistence_notifier: &cm.get_cm().persistence_notifier,
1182 should_persist: || -> NotifyOption { NotifyOption::DoPersist },
1183 _read_guard: read_guard,
1188 /// Note that if any [`ChannelMonitorUpdate`]s are possibly generated,
1189 /// [`ChannelManager::process_background_events`] MUST be called first.
1190 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a Notifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
1191 let read_guard = lock.read().unwrap();
1193 PersistenceNotifierGuard {
1194 persistence_notifier: notifier,
1195 should_persist: persist_check,
1196 _read_guard: read_guard,
1201 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
1202 fn drop(&mut self) {
1203 if (self.should_persist)() == NotifyOption::DoPersist {
1204 self.persistence_notifier.notify();
1209 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
1210 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
1212 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
1214 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
1215 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
1216 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
1217 /// the maximum required amount in lnd as of March 2021.
1218 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
1220 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
1221 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
1223 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
1225 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
1226 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
1227 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
1228 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
1229 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
1230 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
1231 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
1232 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
1233 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
1234 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
1235 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
1236 // routing failure for any HTLC sender picking up an LDK node among the first hops.
1237 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
1239 /// Minimum CLTV difference between the current block height and received inbound payments.
1240 /// Invoices generated for payment to us must set their `min_final_cltv_expiry_delta` field to at least
1242 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
1243 // any payments to succeed. Further, we don't want payments to fail if a block was found while
1244 // a payment was being routed, so we add an extra block to be safe.
1245 pub const MIN_FINAL_CLTV_EXPIRY_DELTA: u16 = HTLC_FAIL_BACK_BUFFER as u16 + 3;
1247 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
1248 // ie that if the next-hop peer fails the HTLC within
1249 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
1250 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
1251 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
1252 // LATENCY_GRACE_PERIOD_BLOCKS.
1255 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;
1257 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
1258 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
1261 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
1263 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
1264 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
1266 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until we time-out the
1267 /// idempotency of payments by [`PaymentId`]. See
1268 /// [`OutboundPayments::remove_stale_resolved_payments`].
1269 pub(crate) const IDEMPOTENCY_TIMEOUT_TICKS: u8 = 7;
1271 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is disconnected
1272 /// until we mark the channel disabled and gossip the update.
1273 pub(crate) const DISABLE_GOSSIP_TICKS: u8 = 10;
1275 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is connected until
1276 /// we mark the channel enabled and gossip the update.
1277 pub(crate) const ENABLE_GOSSIP_TICKS: u8 = 5;
1279 /// The maximum number of unfunded channels we can have per-peer before we start rejecting new
1280 /// (inbound) ones. The number of peers with unfunded channels is limited separately in
1281 /// [`MAX_UNFUNDED_CHANNEL_PEERS`].
1282 const MAX_UNFUNDED_CHANS_PER_PEER: usize = 4;
1284 /// The maximum number of peers from which we will allow pending unfunded channels. Once we reach
1285 /// this many peers we reject new (inbound) channels from peers with which we don't have a channel.
1286 const MAX_UNFUNDED_CHANNEL_PEERS: usize = 50;
1288 /// The maximum number of peers which we do not have a (funded) channel with. Once we reach this
1289 /// many peers we reject new (inbound) connections.
1290 const MAX_NO_CHANNEL_PEERS: usize = 250;
1292 /// Information needed for constructing an invoice route hint for this channel.
1293 #[derive(Clone, Debug, PartialEq)]
1294 pub struct CounterpartyForwardingInfo {
1295 /// Base routing fee in millisatoshis.
1296 pub fee_base_msat: u32,
1297 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
1298 pub fee_proportional_millionths: u32,
1299 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
1300 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
1301 /// `cltv_expiry_delta` for more details.
1302 pub cltv_expiry_delta: u16,
1305 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
1306 /// to better separate parameters.
1307 #[derive(Clone, Debug, PartialEq)]
1308 pub struct ChannelCounterparty {
1309 /// The node_id of our counterparty
1310 pub node_id: PublicKey,
1311 /// The Features the channel counterparty provided upon last connection.
1312 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
1313 /// many routing-relevant features are present in the init context.
1314 pub features: InitFeatures,
1315 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
1316 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
1317 /// claiming at least this value on chain.
1319 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
1321 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
1322 pub unspendable_punishment_reserve: u64,
1323 /// Information on the fees and requirements that the counterparty requires when forwarding
1324 /// payments to us through this channel.
1325 pub forwarding_info: Option<CounterpartyForwardingInfo>,
1326 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
1327 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
1328 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
1329 pub outbound_htlc_minimum_msat: Option<u64>,
1330 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
1331 pub outbound_htlc_maximum_msat: Option<u64>,
1334 /// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
1335 #[derive(Clone, Debug, PartialEq)]
1336 pub struct ChannelDetails {
1337 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
1338 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
1339 /// Note that this means this value is *not* persistent - it can change once during the
1340 /// lifetime of the channel.
1341 pub channel_id: [u8; 32],
1342 /// Parameters which apply to our counterparty. See individual fields for more information.
1343 pub counterparty: ChannelCounterparty,
1344 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
1345 /// our counterparty already.
1347 /// Note that, if this has been set, `channel_id` will be equivalent to
1348 /// `funding_txo.unwrap().to_channel_id()`.
1349 pub funding_txo: Option<OutPoint>,
1350 /// The features which this channel operates with. See individual features for more info.
1352 /// `None` until negotiation completes and the channel type is finalized.
1353 pub channel_type: Option<ChannelTypeFeatures>,
1354 /// The position of the funding transaction in the chain. None if the funding transaction has
1355 /// not yet been confirmed and the channel fully opened.
1357 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1358 /// payments instead of this. See [`get_inbound_payment_scid`].
1360 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1361 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1363 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1364 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1365 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1366 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1367 /// [`confirmations_required`]: Self::confirmations_required
1368 pub short_channel_id: Option<u64>,
1369 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1370 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1371 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1374 /// This will be `None` as long as the channel is not available for routing outbound payments.
1376 /// [`short_channel_id`]: Self::short_channel_id
1377 /// [`confirmations_required`]: Self::confirmations_required
1378 pub outbound_scid_alias: Option<u64>,
1379 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1380 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1381 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1382 /// when they see a payment to be routed to us.
1384 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1385 /// previous values for inbound payment forwarding.
1387 /// [`short_channel_id`]: Self::short_channel_id
1388 pub inbound_scid_alias: Option<u64>,
1389 /// The value, in satoshis, of this channel as appears in the funding output
1390 pub channel_value_satoshis: u64,
1391 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1392 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1393 /// this value on chain.
1395 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1397 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1399 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1400 pub unspendable_punishment_reserve: Option<u64>,
1401 /// The `user_channel_id` passed in to create_channel, or a random value if the channel was
1402 /// inbound. This may be zero for inbound channels serialized with LDK versions prior to
1404 pub user_channel_id: u128,
1405 /// The currently negotiated fee rate denominated in satoshi per 1000 weight units,
1406 /// which is applied to commitment and HTLC transactions.
1408 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
1409 pub feerate_sat_per_1000_weight: Option<u32>,
1410 /// Our total balance. This is the amount we would get if we close the channel.
1411 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1412 /// amount is not likely to be recoverable on close.
1414 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1415 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1416 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1417 /// This does not consider any on-chain fees.
1419 /// See also [`ChannelDetails::outbound_capacity_msat`]
1420 pub balance_msat: u64,
1421 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1422 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1423 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1424 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1426 /// See also [`ChannelDetails::balance_msat`]
1428 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1429 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1430 /// should be able to spend nearly this amount.
1431 pub outbound_capacity_msat: u64,
1432 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1433 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1434 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1435 /// to use a limit as close as possible to the HTLC limit we can currently send.
1437 /// See also [`ChannelDetails::next_outbound_htlc_minimum_msat`],
1438 /// [`ChannelDetails::balance_msat`], and [`ChannelDetails::outbound_capacity_msat`].
1439 pub next_outbound_htlc_limit_msat: u64,
1440 /// The minimum value for sending a single HTLC to the remote peer. This is the equivalent of
1441 /// [`ChannelDetails::next_outbound_htlc_limit_msat`] but represents a lower-bound, rather than
1442 /// an upper-bound. This is intended for use when routing, allowing us to ensure we pick a
1443 /// route which is valid.
1444 pub next_outbound_htlc_minimum_msat: u64,
1445 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1446 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1447 /// available for inclusion in new inbound HTLCs).
1448 /// Note that there are some corner cases not fully handled here, so the actual available
1449 /// inbound capacity may be slightly higher than this.
1451 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1452 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1453 /// However, our counterparty should be able to spend nearly this amount.
1454 pub inbound_capacity_msat: u64,
1455 /// The number of required confirmations on the funding transaction before the funding will be
1456 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1457 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1458 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1459 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1461 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1463 /// [`is_outbound`]: ChannelDetails::is_outbound
1464 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1465 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1466 pub confirmations_required: Option<u32>,
1467 /// The current number of confirmations on the funding transaction.
1469 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1470 pub confirmations: Option<u32>,
1471 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1472 /// until we can claim our funds after we force-close the channel. During this time our
1473 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1474 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1475 /// time to claim our non-HTLC-encumbered funds.
1477 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1478 pub force_close_spend_delay: Option<u16>,
1479 /// True if the channel was initiated (and thus funded) by us.
1480 pub is_outbound: bool,
1481 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1482 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1483 /// required confirmation count has been reached (and we were connected to the peer at some
1484 /// point after the funding transaction received enough confirmations). The required
1485 /// confirmation count is provided in [`confirmations_required`].
1487 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1488 pub is_channel_ready: bool,
1489 /// The stage of the channel's shutdown.
1490 /// `None` for `ChannelDetails` serialized on LDK versions prior to 0.0.116.
1491 pub channel_shutdown_state: Option<ChannelShutdownState>,
1492 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1493 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1495 /// This is a strict superset of `is_channel_ready`.
1496 pub is_usable: bool,
1497 /// True if this channel is (or will be) publicly-announced.
1498 pub is_public: bool,
1499 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1500 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1501 pub inbound_htlc_minimum_msat: Option<u64>,
1502 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1503 pub inbound_htlc_maximum_msat: Option<u64>,
1504 /// Set of configurable parameters that affect channel operation.
1506 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1507 pub config: Option<ChannelConfig>,
1510 impl ChannelDetails {
1511 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1512 /// This should be used for providing invoice hints or in any other context where our
1513 /// counterparty will forward a payment to us.
1515 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1516 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1517 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1518 self.inbound_scid_alias.or(self.short_channel_id)
1521 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1522 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1523 /// we're sending or forwarding a payment outbound over this channel.
1525 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1526 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1527 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1528 self.short_channel_id.or(self.outbound_scid_alias)
1531 fn from_channel_context<Signer: WriteableEcdsaChannelSigner, F: Deref>(
1532 context: &ChannelContext<Signer>, best_block_height: u32, latest_features: InitFeatures,
1533 fee_estimator: &LowerBoundedFeeEstimator<F>
1535 where F::Target: FeeEstimator
1537 let balance = context.get_available_balances(fee_estimator);
1538 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1539 context.get_holder_counterparty_selected_channel_reserve_satoshis();
1541 channel_id: context.channel_id(),
1542 counterparty: ChannelCounterparty {
1543 node_id: context.get_counterparty_node_id(),
1544 features: latest_features,
1545 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1546 forwarding_info: context.counterparty_forwarding_info(),
1547 // Ensures that we have actually received the `htlc_minimum_msat` value
1548 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1549 // message (as they are always the first message from the counterparty).
1550 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1551 // default `0` value set by `Channel::new_outbound`.
1552 outbound_htlc_minimum_msat: if context.have_received_message() {
1553 Some(context.get_counterparty_htlc_minimum_msat()) } else { None },
1554 outbound_htlc_maximum_msat: context.get_counterparty_htlc_maximum_msat(),
1556 funding_txo: context.get_funding_txo(),
1557 // Note that accept_channel (or open_channel) is always the first message, so
1558 // `have_received_message` indicates that type negotiation has completed.
1559 channel_type: if context.have_received_message() { Some(context.get_channel_type().clone()) } else { None },
1560 short_channel_id: context.get_short_channel_id(),
1561 outbound_scid_alias: if context.is_usable() { Some(context.outbound_scid_alias()) } else { None },
1562 inbound_scid_alias: context.latest_inbound_scid_alias(),
1563 channel_value_satoshis: context.get_value_satoshis(),
1564 feerate_sat_per_1000_weight: Some(context.get_feerate_sat_per_1000_weight()),
1565 unspendable_punishment_reserve: to_self_reserve_satoshis,
1566 balance_msat: balance.balance_msat,
1567 inbound_capacity_msat: balance.inbound_capacity_msat,
1568 outbound_capacity_msat: balance.outbound_capacity_msat,
1569 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1570 next_outbound_htlc_minimum_msat: balance.next_outbound_htlc_minimum_msat,
1571 user_channel_id: context.get_user_id(),
1572 confirmations_required: context.minimum_depth(),
1573 confirmations: Some(context.get_funding_tx_confirmations(best_block_height)),
1574 force_close_spend_delay: context.get_counterparty_selected_contest_delay(),
1575 is_outbound: context.is_outbound(),
1576 is_channel_ready: context.is_usable(),
1577 is_usable: context.is_live(),
1578 is_public: context.should_announce(),
1579 inbound_htlc_minimum_msat: Some(context.get_holder_htlc_minimum_msat()),
1580 inbound_htlc_maximum_msat: context.get_holder_htlc_maximum_msat(),
1581 config: Some(context.config()),
1582 channel_shutdown_state: Some(context.shutdown_state()),
1587 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
1588 /// Further information on the details of the channel shutdown.
1589 /// Upon channels being forced closed (i.e. commitment transaction confirmation detected
1590 /// by `ChainMonitor`), ChannelShutdownState will be set to `ShutdownComplete` or
1591 /// the channel will be removed shortly.
1592 /// Also note, that in normal operation, peers could disconnect at any of these states
1593 /// and require peer re-connection before making progress onto other states
1594 pub enum ChannelShutdownState {
1595 /// Channel has not sent or received a shutdown message.
1597 /// Local node has sent a shutdown message for this channel.
1599 /// Shutdown message exchanges have concluded and the channels are in the midst of
1600 /// resolving all existing open HTLCs before closing can continue.
1602 /// All HTLCs have been resolved, nodes are currently negotiating channel close onchain fee rates.
1603 NegotiatingClosingFee,
1604 /// We've successfully negotiated a closing_signed dance. At this point `ChannelManager` is about
1605 /// to drop the channel.
1609 /// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
1610 /// These include payments that have yet to find a successful path, or have unresolved HTLCs.
1611 #[derive(Debug, PartialEq)]
1612 pub enum RecentPaymentDetails {
1613 /// When a payment is still being sent and awaiting successful delivery.
1615 /// Hash of the payment that is currently being sent but has yet to be fulfilled or
1617 payment_hash: PaymentHash,
1618 /// Total amount (in msat, excluding fees) across all paths for this payment,
1619 /// not just the amount currently inflight.
1622 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
1623 /// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
1624 /// payment is removed from tracking.
1626 /// Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
1627 /// made before LDK version 0.0.104.
1628 payment_hash: Option<PaymentHash>,
1630 /// After a payment's retries are exhausted per the provided [`Retry`], or it is explicitly
1631 /// abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
1632 /// pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
1634 /// Hash of the payment that we have given up trying to send.
1635 payment_hash: PaymentHash,
1639 /// Route hints used in constructing invoices for [phantom node payents].
1641 /// [phantom node payments]: crate::sign::PhantomKeysManager
1643 pub struct PhantomRouteHints {
1644 /// The list of channels to be included in the invoice route hints.
1645 pub channels: Vec<ChannelDetails>,
1646 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1648 pub phantom_scid: u64,
1649 /// The pubkey of the real backing node that would ultimately receive the payment.
1650 pub real_node_pubkey: PublicKey,
1653 macro_rules! handle_error {
1654 ($self: ident, $internal: expr, $counterparty_node_id: expr) => { {
1655 // In testing, ensure there are no deadlocks where the lock is already held upon
1656 // entering the macro.
1657 debug_assert_ne!($self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
1658 debug_assert_ne!($self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
1662 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish }) => {
1663 let mut msg_events = Vec::with_capacity(2);
1665 if let Some((shutdown_res, update_option)) = shutdown_finish {
1666 $self.finish_force_close_channel(shutdown_res);
1667 if let Some(update) = update_option {
1668 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1672 if let Some((channel_id, user_channel_id)) = chan_id {
1673 $self.pending_events.lock().unwrap().push_back((events::Event::ChannelClosed {
1674 channel_id, user_channel_id,
1675 reason: ClosureReason::ProcessingError { err: err.err.clone() }
1680 log_error!($self.logger, "{}", err.err);
1681 if let msgs::ErrorAction::IgnoreError = err.action {
1683 msg_events.push(events::MessageSendEvent::HandleError {
1684 node_id: $counterparty_node_id,
1685 action: err.action.clone()
1689 if !msg_events.is_empty() {
1690 let per_peer_state = $self.per_peer_state.read().unwrap();
1691 if let Some(peer_state_mutex) = per_peer_state.get(&$counterparty_node_id) {
1692 let mut peer_state = peer_state_mutex.lock().unwrap();
1693 peer_state.pending_msg_events.append(&mut msg_events);
1697 // Return error in case higher-API need one
1702 ($self: ident, $internal: expr) => {
1705 Err((chan, msg_handle_err)) => {
1706 let counterparty_node_id = chan.get_counterparty_node_id();
1707 handle_error!($self, Err(msg_handle_err), counterparty_node_id).map_err(|err| (chan, err))
1713 macro_rules! update_maps_on_chan_removal {
1714 ($self: expr, $channel_context: expr) => {{
1715 $self.id_to_peer.lock().unwrap().remove(&$channel_context.channel_id());
1716 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1717 if let Some(short_id) = $channel_context.get_short_channel_id() {
1718 short_to_chan_info.remove(&short_id);
1720 // If the channel was never confirmed on-chain prior to its closure, remove the
1721 // outbound SCID alias we used for it from the collision-prevention set. While we
1722 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1723 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1724 // opening a million channels with us which are closed before we ever reach the funding
1726 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel_context.outbound_scid_alias());
1727 debug_assert!(alias_removed);
1729 short_to_chan_info.remove(&$channel_context.outbound_scid_alias());
1733 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1734 macro_rules! convert_chan_err {
1735 ($self: ident, $err: expr, $channel: expr, $channel_id: expr) => {
1737 ChannelError::Warn(msg) => {
1738 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), $channel_id.clone()))
1740 ChannelError::Ignore(msg) => {
1741 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
1743 ChannelError::Close(msg) => {
1744 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
1745 update_maps_on_chan_removal!($self, &$channel.context);
1746 let shutdown_res = $channel.context.force_shutdown(true);
1747 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.context.get_user_id(),
1748 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
1752 ($self: ident, $err: expr, $channel_context: expr, $channel_id: expr, UNFUNDED) => {
1754 // We should only ever have `ChannelError::Close` when unfunded channels error.
1755 // In any case, just close the channel.
1756 ChannelError::Warn(msg) | ChannelError::Ignore(msg) | ChannelError::Close(msg) => {
1757 log_error!($self.logger, "Closing unfunded channel {} due to an error: {}", log_bytes!($channel_id[..]), msg);
1758 update_maps_on_chan_removal!($self, &$channel_context);
1759 let shutdown_res = $channel_context.force_shutdown(false);
1760 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel_context.get_user_id(),
1761 shutdown_res, None))
1767 macro_rules! break_chan_entry {
1768 ($self: ident, $res: expr, $entry: expr) => {
1772 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1774 $entry.remove_entry();
1782 macro_rules! try_v1_outbound_chan_entry {
1783 ($self: ident, $res: expr, $entry: expr) => {
1787 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut().context, $entry.key(), UNFUNDED);
1789 $entry.remove_entry();
1797 macro_rules! try_chan_entry {
1798 ($self: ident, $res: expr, $entry: expr) => {
1802 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1804 $entry.remove_entry();
1812 macro_rules! remove_channel {
1813 ($self: expr, $entry: expr) => {
1815 let channel = $entry.remove_entry().1;
1816 update_maps_on_chan_removal!($self, &channel.context);
1822 macro_rules! send_channel_ready {
1823 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
1824 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1825 node_id: $channel.context.get_counterparty_node_id(),
1826 msg: $channel_ready_msg,
1828 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1829 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1830 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1831 let outbound_alias_insert = short_to_chan_info.insert($channel.context.outbound_scid_alias(), ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
1832 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
1833 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1834 if let Some(real_scid) = $channel.context.get_short_channel_id() {
1835 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
1836 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
1837 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1842 macro_rules! emit_channel_pending_event {
1843 ($locked_events: expr, $channel: expr) => {
1844 if $channel.context.should_emit_channel_pending_event() {
1845 $locked_events.push_back((events::Event::ChannelPending {
1846 channel_id: $channel.context.channel_id(),
1847 former_temporary_channel_id: $channel.context.temporary_channel_id(),
1848 counterparty_node_id: $channel.context.get_counterparty_node_id(),
1849 user_channel_id: $channel.context.get_user_id(),
1850 funding_txo: $channel.context.get_funding_txo().unwrap().into_bitcoin_outpoint(),
1852 $channel.context.set_channel_pending_event_emitted();
1857 macro_rules! emit_channel_ready_event {
1858 ($locked_events: expr, $channel: expr) => {
1859 if $channel.context.should_emit_channel_ready_event() {
1860 debug_assert!($channel.context.channel_pending_event_emitted());
1861 $locked_events.push_back((events::Event::ChannelReady {
1862 channel_id: $channel.context.channel_id(),
1863 user_channel_id: $channel.context.get_user_id(),
1864 counterparty_node_id: $channel.context.get_counterparty_node_id(),
1865 channel_type: $channel.context.get_channel_type().clone(),
1867 $channel.context.set_channel_ready_event_emitted();
1872 macro_rules! handle_monitor_update_completion {
1873 ($self: ident, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
1874 let mut updates = $chan.monitor_updating_restored(&$self.logger,
1875 &$self.node_signer, $self.genesis_hash, &$self.default_configuration,
1876 $self.best_block.read().unwrap().height());
1877 let counterparty_node_id = $chan.context.get_counterparty_node_id();
1878 let channel_update = if updates.channel_ready.is_some() && $chan.context.is_usable() {
1879 // We only send a channel_update in the case where we are just now sending a
1880 // channel_ready and the channel is in a usable state. We may re-send a
1881 // channel_update later through the announcement_signatures process for public
1882 // channels, but there's no reason not to just inform our counterparty of our fees
1884 if let Ok(msg) = $self.get_channel_update_for_unicast($chan) {
1885 Some(events::MessageSendEvent::SendChannelUpdate {
1886 node_id: counterparty_node_id,
1892 let update_actions = $peer_state.monitor_update_blocked_actions
1893 .remove(&$chan.context.channel_id()).unwrap_or(Vec::new());
1895 let htlc_forwards = $self.handle_channel_resumption(
1896 &mut $peer_state.pending_msg_events, $chan, updates.raa,
1897 updates.commitment_update, updates.order, updates.accepted_htlcs,
1898 updates.funding_broadcastable, updates.channel_ready,
1899 updates.announcement_sigs);
1900 if let Some(upd) = channel_update {
1901 $peer_state.pending_msg_events.push(upd);
1904 let channel_id = $chan.context.channel_id();
1905 core::mem::drop($peer_state_lock);
1906 core::mem::drop($per_peer_state_lock);
1908 $self.handle_monitor_update_completion_actions(update_actions);
1910 if let Some(forwards) = htlc_forwards {
1911 $self.forward_htlcs(&mut [forwards][..]);
1913 $self.finalize_claims(updates.finalized_claimed_htlcs);
1914 for failure in updates.failed_htlcs.drain(..) {
1915 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
1916 $self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
1921 macro_rules! handle_new_monitor_update {
1922 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr, _internal, $remove: expr, $completed: expr) => { {
1923 // update_maps_on_chan_removal needs to be able to take id_to_peer, so make sure we can in
1924 // any case so that it won't deadlock.
1925 debug_assert_ne!($self.id_to_peer.held_by_thread(), LockHeldState::HeldByThread);
1926 debug_assert!($self.background_events_processed_since_startup.load(Ordering::Acquire));
1928 ChannelMonitorUpdateStatus::InProgress => {
1929 log_debug!($self.logger, "ChannelMonitor update for {} in flight, holding messages until the update completes.",
1930 log_bytes!($chan.context.channel_id()[..]));
1933 ChannelMonitorUpdateStatus::PermanentFailure => {
1934 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateStatus::PermanentFailure",
1935 log_bytes!($chan.context.channel_id()[..]));
1936 update_maps_on_chan_removal!($self, &$chan.context);
1937 let res = Err(MsgHandleErrInternal::from_finish_shutdown(
1938 "ChannelMonitor storage failure".to_owned(), $chan.context.channel_id(),
1939 $chan.context.get_user_id(), $chan.context.force_shutdown(false),
1940 $self.get_channel_update_for_broadcast(&$chan).ok()));
1944 ChannelMonitorUpdateStatus::Completed => {
1950 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr, MANUALLY_REMOVING_INITIAL_MONITOR, $remove: expr) => {
1951 handle_new_monitor_update!($self, $update_res, $peer_state_lock, $peer_state,
1952 $per_peer_state_lock, $chan, _internal, $remove,
1953 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan))
1955 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan_entry: expr, INITIAL_MONITOR) => {
1956 handle_new_monitor_update!($self, $update_res, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan_entry.get_mut(), MANUALLY_REMOVING_INITIAL_MONITOR, $chan_entry.remove_entry())
1958 ($self: ident, $funding_txo: expr, $update: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr, MANUALLY_REMOVING, $remove: expr) => { {
1959 let in_flight_updates = $peer_state.in_flight_monitor_updates.entry($funding_txo)
1960 .or_insert_with(Vec::new);
1961 // During startup, we push monitor updates as background events through to here in
1962 // order to replay updates that were in-flight when we shut down. Thus, we have to
1963 // filter for uniqueness here.
1964 let idx = in_flight_updates.iter().position(|upd| upd == &$update)
1965 .unwrap_or_else(|| {
1966 in_flight_updates.push($update);
1967 in_flight_updates.len() - 1
1969 let update_res = $self.chain_monitor.update_channel($funding_txo, &in_flight_updates[idx]);
1970 handle_new_monitor_update!($self, update_res, $peer_state_lock, $peer_state,
1971 $per_peer_state_lock, $chan, _internal, $remove,
1973 let _ = in_flight_updates.remove(idx);
1974 if in_flight_updates.is_empty() && $chan.blocked_monitor_updates_pending() == 0 {
1975 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan);
1979 ($self: ident, $funding_txo: expr, $update: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan_entry: expr) => {
1980 handle_new_monitor_update!($self, $funding_txo, $update, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan_entry.get_mut(), MANUALLY_REMOVING, $chan_entry.remove_entry())
1984 macro_rules! process_events_body {
1985 ($self: expr, $event_to_handle: expr, $handle_event: expr) => {
1986 let mut processed_all_events = false;
1987 while !processed_all_events {
1988 if $self.pending_events_processor.compare_exchange(false, true, Ordering::Acquire, Ordering::Relaxed).is_err() {
1992 let mut result = NotifyOption::SkipPersist;
1995 // We'll acquire our total consistency lock so that we can be sure no other
1996 // persists happen while processing monitor events.
1997 let _read_guard = $self.total_consistency_lock.read().unwrap();
1999 // Because `handle_post_event_actions` may send `ChannelMonitorUpdate`s to the user we must
2000 // ensure any startup-generated background events are handled first.
2001 if $self.process_background_events() == NotifyOption::DoPersist { result = NotifyOption::DoPersist; }
2003 // TODO: This behavior should be documented. It's unintuitive that we query
2004 // ChannelMonitors when clearing other events.
2005 if $self.process_pending_monitor_events() {
2006 result = NotifyOption::DoPersist;
2010 let pending_events = $self.pending_events.lock().unwrap().clone();
2011 let num_events = pending_events.len();
2012 if !pending_events.is_empty() {
2013 result = NotifyOption::DoPersist;
2016 let mut post_event_actions = Vec::new();
2018 for (event, action_opt) in pending_events {
2019 $event_to_handle = event;
2021 if let Some(action) = action_opt {
2022 post_event_actions.push(action);
2027 let mut pending_events = $self.pending_events.lock().unwrap();
2028 pending_events.drain(..num_events);
2029 processed_all_events = pending_events.is_empty();
2030 // Note that `push_pending_forwards_ev` relies on `pending_events_processor` being
2031 // updated here with the `pending_events` lock acquired.
2032 $self.pending_events_processor.store(false, Ordering::Release);
2035 if !post_event_actions.is_empty() {
2036 $self.handle_post_event_actions(post_event_actions);
2037 // If we had some actions, go around again as we may have more events now
2038 processed_all_events = false;
2041 if result == NotifyOption::DoPersist {
2042 $self.persistence_notifier.notify();
2048 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>
2050 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
2051 T::Target: BroadcasterInterface,
2052 ES::Target: EntropySource,
2053 NS::Target: NodeSigner,
2054 SP::Target: SignerProvider,
2055 F::Target: FeeEstimator,
2059 /// Constructs a new `ChannelManager` to hold several channels and route between them.
2061 /// The current time or latest block header time can be provided as the `current_timestamp`.
2063 /// This is the main "logic hub" for all channel-related actions, and implements
2064 /// [`ChannelMessageHandler`].
2066 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
2068 /// Users need to notify the new `ChannelManager` when a new block is connected or
2069 /// disconnected using its [`block_connected`] and [`block_disconnected`] methods, starting
2070 /// from after [`params.best_block.block_hash`]. See [`chain::Listen`] and [`chain::Confirm`] for
2073 /// [`block_connected`]: chain::Listen::block_connected
2074 /// [`block_disconnected`]: chain::Listen::block_disconnected
2075 /// [`params.best_block.block_hash`]: chain::BestBlock::block_hash
2077 fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, entropy_source: ES,
2078 node_signer: NS, signer_provider: SP, config: UserConfig, params: ChainParameters,
2079 current_timestamp: u32,
2081 let mut secp_ctx = Secp256k1::new();
2082 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
2083 let inbound_pmt_key_material = node_signer.get_inbound_payment_key_material();
2084 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
2086 default_configuration: config.clone(),
2087 genesis_hash: genesis_block(params.network).header.block_hash(),
2088 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
2093 best_block: RwLock::new(params.best_block),
2095 outbound_scid_aliases: Mutex::new(HashSet::new()),
2096 pending_inbound_payments: Mutex::new(HashMap::new()),
2097 pending_outbound_payments: OutboundPayments::new(),
2098 forward_htlcs: Mutex::new(HashMap::new()),
2099 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments: HashMap::new(), pending_claiming_payments: HashMap::new() }),
2100 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
2101 id_to_peer: Mutex::new(HashMap::new()),
2102 short_to_chan_info: FairRwLock::new(HashMap::new()),
2104 our_network_pubkey: node_signer.get_node_id(Recipient::Node).unwrap(),
2107 inbound_payment_key: expanded_inbound_key,
2108 fake_scid_rand_bytes: entropy_source.get_secure_random_bytes(),
2110 probing_cookie_secret: entropy_source.get_secure_random_bytes(),
2112 highest_seen_timestamp: AtomicUsize::new(current_timestamp as usize),
2114 per_peer_state: FairRwLock::new(HashMap::new()),
2116 pending_events: Mutex::new(VecDeque::new()),
2117 pending_events_processor: AtomicBool::new(false),
2118 pending_background_events: Mutex::new(Vec::new()),
2119 total_consistency_lock: RwLock::new(()),
2120 background_events_processed_since_startup: AtomicBool::new(false),
2121 persistence_notifier: Notifier::new(),
2131 /// Gets the current configuration applied to all new channels.
2132 pub fn get_current_default_configuration(&self) -> &UserConfig {
2133 &self.default_configuration
2136 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
2137 let height = self.best_block.read().unwrap().height();
2138 let mut outbound_scid_alias = 0;
2141 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
2142 outbound_scid_alias += 1;
2144 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
2146 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
2150 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"); }
2155 /// Creates a new outbound channel to the given remote node and with the given value.
2157 /// `user_channel_id` will be provided back as in
2158 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
2159 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
2160 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
2161 /// is simply copied to events and otherwise ignored.
2163 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
2164 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
2166 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be opened due to failing to
2167 /// generate a shutdown scriptpubkey or destination script set by
2168 /// [`SignerProvider::get_shutdown_scriptpubkey`] or [`SignerProvider::get_destination_script`].
2170 /// Note that we do not check if you are currently connected to the given peer. If no
2171 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
2172 /// the channel eventually being silently forgotten (dropped on reload).
2174 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
2175 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
2176 /// [`ChannelDetails::channel_id`] until after
2177 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
2178 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
2179 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
2181 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
2182 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
2183 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
2184 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<[u8; 32], APIError> {
2185 if channel_value_satoshis < 1000 {
2186 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
2189 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2190 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
2191 debug_assert!(&self.total_consistency_lock.try_write().is_err());
2193 let per_peer_state = self.per_peer_state.read().unwrap();
2195 let peer_state_mutex = per_peer_state.get(&their_network_key)
2196 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Not connected to node: {}", their_network_key) })?;
2198 let mut peer_state = peer_state_mutex.lock().unwrap();
2200 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
2201 let their_features = &peer_state.latest_features;
2202 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
2203 match OutboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider, their_network_key,
2204 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
2205 self.best_block.read().unwrap().height(), outbound_scid_alias)
2209 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
2214 let res = channel.get_open_channel(self.genesis_hash.clone());
2216 let temporary_channel_id = channel.context.channel_id();
2217 match peer_state.outbound_v1_channel_by_id.entry(temporary_channel_id) {
2218 hash_map::Entry::Occupied(_) => {
2220 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
2222 panic!("RNG is bad???");
2225 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
2228 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
2229 node_id: their_network_key,
2232 Ok(temporary_channel_id)
2235 fn list_funded_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<<SP::Target as SignerProvider>::Signer>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
2236 // Allocate our best estimate of the number of channels we have in the `res`
2237 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2238 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2239 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2240 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2241 // the same channel.
2242 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2244 let best_block_height = self.best_block.read().unwrap().height();
2245 let per_peer_state = self.per_peer_state.read().unwrap();
2246 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2247 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2248 let peer_state = &mut *peer_state_lock;
2249 // Only `Channels` in the channel_by_id map can be considered funded.
2250 for (_channel_id, channel) in peer_state.channel_by_id.iter().filter(f) {
2251 let details = ChannelDetails::from_channel_context(&channel.context, best_block_height,
2252 peer_state.latest_features.clone(), &self.fee_estimator);
2260 /// Gets the list of open channels, in random order. See [`ChannelDetails`] field documentation for
2261 /// more information.
2262 pub fn list_channels(&self) -> Vec<ChannelDetails> {
2263 // Allocate our best estimate of the number of channels we have in the `res`
2264 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2265 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2266 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2267 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2268 // the same channel.
2269 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2271 let best_block_height = self.best_block.read().unwrap().height();
2272 let per_peer_state = self.per_peer_state.read().unwrap();
2273 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2274 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2275 let peer_state = &mut *peer_state_lock;
2276 for (_channel_id, channel) in peer_state.channel_by_id.iter() {
2277 let details = ChannelDetails::from_channel_context(&channel.context, best_block_height,
2278 peer_state.latest_features.clone(), &self.fee_estimator);
2281 for (_channel_id, channel) in peer_state.inbound_v1_channel_by_id.iter() {
2282 let details = ChannelDetails::from_channel_context(&channel.context, best_block_height,
2283 peer_state.latest_features.clone(), &self.fee_estimator);
2286 for (_channel_id, channel) in peer_state.outbound_v1_channel_by_id.iter() {
2287 let details = ChannelDetails::from_channel_context(&channel.context, best_block_height,
2288 peer_state.latest_features.clone(), &self.fee_estimator);
2296 /// Gets the list of usable channels, in random order. Useful as an argument to
2297 /// [`Router::find_route`] to ensure non-announced channels are used.
2299 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
2300 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
2302 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
2303 // Note we use is_live here instead of usable which leads to somewhat confused
2304 // internal/external nomenclature, but that's ok cause that's probably what the user
2305 // really wanted anyway.
2306 self.list_funded_channels_with_filter(|&(_, ref channel)| channel.context.is_live())
2309 /// Gets the list of channels we have with a given counterparty, in random order.
2310 pub fn list_channels_with_counterparty(&self, counterparty_node_id: &PublicKey) -> Vec<ChannelDetails> {
2311 let best_block_height = self.best_block.read().unwrap().height();
2312 let per_peer_state = self.per_peer_state.read().unwrap();
2314 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
2315 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2316 let peer_state = &mut *peer_state_lock;
2317 let features = &peer_state.latest_features;
2318 let chan_context_to_details = |context| {
2319 ChannelDetails::from_channel_context(context, best_block_height, features.clone(), &self.fee_estimator)
2321 return peer_state.channel_by_id
2323 .map(|(_, channel)| &channel.context)
2324 .chain(peer_state.outbound_v1_channel_by_id.iter().map(|(_, channel)| &channel.context))
2325 .chain(peer_state.inbound_v1_channel_by_id.iter().map(|(_, channel)| &channel.context))
2326 .map(chan_context_to_details)
2332 /// Returns in an undefined order recent payments that -- if not fulfilled -- have yet to find a
2333 /// successful path, or have unresolved HTLCs.
2335 /// This can be useful for payments that may have been prepared, but ultimately not sent, as a
2336 /// result of a crash. If such a payment exists, is not listed here, and an
2337 /// [`Event::PaymentSent`] has not been received, you may consider resending the payment.
2339 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2340 pub fn list_recent_payments(&self) -> Vec<RecentPaymentDetails> {
2341 self.pending_outbound_payments.pending_outbound_payments.lock().unwrap().iter()
2342 .filter_map(|(_, pending_outbound_payment)| match pending_outbound_payment {
2343 PendingOutboundPayment::Retryable { payment_hash, total_msat, .. } => {
2344 Some(RecentPaymentDetails::Pending {
2345 payment_hash: *payment_hash,
2346 total_msat: *total_msat,
2349 PendingOutboundPayment::Abandoned { payment_hash, .. } => {
2350 Some(RecentPaymentDetails::Abandoned { payment_hash: *payment_hash })
2352 PendingOutboundPayment::Fulfilled { payment_hash, .. } => {
2353 Some(RecentPaymentDetails::Fulfilled { payment_hash: *payment_hash })
2355 PendingOutboundPayment::Legacy { .. } => None
2360 /// Helper function that issues the channel close events
2361 fn issue_channel_close_events(&self, context: &ChannelContext<<SP::Target as SignerProvider>::Signer>, closure_reason: ClosureReason) {
2362 let mut pending_events_lock = self.pending_events.lock().unwrap();
2363 match context.unbroadcasted_funding() {
2364 Some(transaction) => {
2365 pending_events_lock.push_back((events::Event::DiscardFunding {
2366 channel_id: context.channel_id(), transaction
2371 pending_events_lock.push_back((events::Event::ChannelClosed {
2372 channel_id: context.channel_id(),
2373 user_channel_id: context.get_user_id(),
2374 reason: closure_reason
2378 fn close_channel_internal(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>, override_shutdown_script: Option<ShutdownScript>) -> Result<(), APIError> {
2379 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2381 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
2382 let result: Result<(), _> = loop {
2383 let per_peer_state = self.per_peer_state.read().unwrap();
2385 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2386 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2388 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2389 let peer_state = &mut *peer_state_lock;
2390 match peer_state.channel_by_id.entry(channel_id.clone()) {
2391 hash_map::Entry::Occupied(mut chan_entry) => {
2392 let funding_txo_opt = chan_entry.get().context.get_funding_txo();
2393 let their_features = &peer_state.latest_features;
2394 let (shutdown_msg, mut monitor_update_opt, htlcs) = chan_entry.get_mut()
2395 .get_shutdown(&self.signer_provider, their_features, target_feerate_sats_per_1000_weight, override_shutdown_script)?;
2396 failed_htlcs = htlcs;
2398 // We can send the `shutdown` message before updating the `ChannelMonitor`
2399 // here as we don't need the monitor update to complete until we send a
2400 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
2401 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2402 node_id: *counterparty_node_id,
2406 // Update the monitor with the shutdown script if necessary.
2407 if let Some(monitor_update) = monitor_update_opt.take() {
2408 break handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
2409 peer_state_lock, peer_state, per_peer_state, chan_entry).map(|_| ());
2412 if chan_entry.get().is_shutdown() {
2413 let channel = remove_channel!(self, chan_entry);
2414 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
2415 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2419 self.issue_channel_close_events(&channel.context, ClosureReason::HolderForceClosed);
2423 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*channel_id), counterparty_node_id) })
2427 for htlc_source in failed_htlcs.drain(..) {
2428 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2429 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
2430 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
2433 let _ = handle_error!(self, result, *counterparty_node_id);
2437 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2438 /// will be accepted on the given channel, and after additional timeout/the closing of all
2439 /// pending HTLCs, the channel will be closed on chain.
2441 /// * If we are the channel initiator, we will pay between our [`Background`] and
2442 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
2444 /// * If our counterparty is the channel initiator, we will require a channel closing
2445 /// transaction feerate of at least our [`Background`] feerate or the feerate which
2446 /// would appear on a force-closure transaction, whichever is lower. We will allow our
2447 /// counterparty to pay as much fee as they'd like, however.
2449 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2451 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2452 /// generate a shutdown scriptpubkey or destination script set by
2453 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2456 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2457 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
2458 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
2459 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2460 pub fn close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
2461 self.close_channel_internal(channel_id, counterparty_node_id, None, None)
2464 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2465 /// will be accepted on the given channel, and after additional timeout/the closing of all
2466 /// pending HTLCs, the channel will be closed on chain.
2468 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
2469 /// the channel being closed or not:
2470 /// * If we are the channel initiator, we will pay at least this feerate on the closing
2471 /// transaction. The upper-bound is set by
2472 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
2473 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
2474 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
2475 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
2476 /// will appear on a force-closure transaction, whichever is lower).
2478 /// The `shutdown_script` provided will be used as the `scriptPubKey` for the closing transaction.
2479 /// Will fail if a shutdown script has already been set for this channel by
2480 /// ['ChannelHandshakeConfig::commit_upfront_shutdown_pubkey`]. The given shutdown script must
2481 /// also be compatible with our and the counterparty's features.
2483 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2485 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2486 /// generate a shutdown scriptpubkey or destination script set by
2487 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2490 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2491 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
2492 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
2493 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2494 pub fn close_channel_with_feerate_and_script(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>, shutdown_script: Option<ShutdownScript>) -> Result<(), APIError> {
2495 self.close_channel_internal(channel_id, counterparty_node_id, target_feerate_sats_per_1000_weight, shutdown_script)
2499 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
2500 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
2501 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
2502 for htlc_source in failed_htlcs.drain(..) {
2503 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
2504 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2505 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2506 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
2508 if let Some((_, funding_txo, monitor_update)) = monitor_update_option {
2509 // There isn't anything we can do if we get an update failure - we're already
2510 // force-closing. The monitor update on the required in-memory copy should broadcast
2511 // the latest local state, which is the best we can do anyway. Thus, it is safe to
2512 // ignore the result here.
2513 let _ = self.chain_monitor.update_channel(funding_txo, &monitor_update);
2517 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
2518 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
2519 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
2520 -> Result<PublicKey, APIError> {
2521 let per_peer_state = self.per_peer_state.read().unwrap();
2522 let peer_state_mutex = per_peer_state.get(peer_node_id)
2523 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", peer_node_id) })?;
2524 let (update_opt, counterparty_node_id) = {
2525 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2526 let peer_state = &mut *peer_state_lock;
2527 let closure_reason = if let Some(peer_msg) = peer_msg {
2528 ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(peer_msg.to_string()) }
2530 ClosureReason::HolderForceClosed
2532 if let hash_map::Entry::Occupied(chan) = peer_state.channel_by_id.entry(channel_id.clone()) {
2533 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
2534 self.issue_channel_close_events(&chan.get().context, closure_reason);
2535 let mut chan = remove_channel!(self, chan);
2536 self.finish_force_close_channel(chan.context.force_shutdown(broadcast));
2537 (self.get_channel_update_for_broadcast(&chan).ok(), chan.context.get_counterparty_node_id())
2538 } else if let hash_map::Entry::Occupied(chan) = peer_state.outbound_v1_channel_by_id.entry(channel_id.clone()) {
2539 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
2540 self.issue_channel_close_events(&chan.get().context, closure_reason);
2541 let mut chan = remove_channel!(self, chan);
2542 self.finish_force_close_channel(chan.context.force_shutdown(false));
2543 // Unfunded channel has no update
2544 (None, chan.context.get_counterparty_node_id())
2545 } else if let hash_map::Entry::Occupied(chan) = peer_state.inbound_v1_channel_by_id.entry(channel_id.clone()) {
2546 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
2547 self.issue_channel_close_events(&chan.get().context, closure_reason);
2548 let mut chan = remove_channel!(self, chan);
2549 self.finish_force_close_channel(chan.context.force_shutdown(false));
2550 // Unfunded channel has no update
2551 (None, chan.context.get_counterparty_node_id())
2553 return Err(APIError::ChannelUnavailable{ err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*channel_id), peer_node_id) });
2556 if let Some(update) = update_opt {
2557 let mut peer_state = peer_state_mutex.lock().unwrap();
2558 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2563 Ok(counterparty_node_id)
2566 fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
2567 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2568 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
2569 Ok(counterparty_node_id) => {
2570 let per_peer_state = self.per_peer_state.read().unwrap();
2571 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2572 let mut peer_state = peer_state_mutex.lock().unwrap();
2573 peer_state.pending_msg_events.push(
2574 events::MessageSendEvent::HandleError {
2575 node_id: counterparty_node_id,
2576 action: msgs::ErrorAction::SendErrorMessage {
2577 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
2588 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
2589 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
2590 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
2592 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
2593 -> Result<(), APIError> {
2594 self.force_close_sending_error(channel_id, counterparty_node_id, true)
2597 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
2598 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
2599 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
2601 /// You can always get the latest local transaction(s) to broadcast from
2602 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
2603 pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
2604 -> Result<(), APIError> {
2605 self.force_close_sending_error(channel_id, counterparty_node_id, false)
2608 /// Force close all channels, immediately broadcasting the latest local commitment transaction
2609 /// for each to the chain and rejecting new HTLCs on each.
2610 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
2611 for chan in self.list_channels() {
2612 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
2616 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
2617 /// local transaction(s).
2618 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
2619 for chan in self.list_channels() {
2620 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
2624 fn construct_recv_pending_htlc_info(
2625 &self, hop_data: msgs::OnionHopData, shared_secret: [u8; 32], payment_hash: PaymentHash,
2626 amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>, allow_underpay: bool,
2627 counterparty_skimmed_fee_msat: Option<u64>,
2628 ) -> Result<PendingHTLCInfo, ReceiveError> {
2629 // final_incorrect_cltv_expiry
2630 if hop_data.outgoing_cltv_value > cltv_expiry {
2631 return Err(ReceiveError {
2632 msg: "Upstream node set CLTV to less than the CLTV set by the sender",
2634 err_data: cltv_expiry.to_be_bytes().to_vec()
2637 // final_expiry_too_soon
2638 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
2639 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
2641 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
2642 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
2643 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
2644 let current_height: u32 = self.best_block.read().unwrap().height();
2645 if (hop_data.outgoing_cltv_value as u64) <= current_height as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
2646 let mut err_data = Vec::with_capacity(12);
2647 err_data.extend_from_slice(&amt_msat.to_be_bytes());
2648 err_data.extend_from_slice(¤t_height.to_be_bytes());
2649 return Err(ReceiveError {
2650 err_code: 0x4000 | 15, err_data,
2651 msg: "The final CLTV expiry is too soon to handle",
2654 if (!allow_underpay && hop_data.amt_to_forward > amt_msat) ||
2655 (allow_underpay && hop_data.amt_to_forward >
2656 amt_msat.saturating_add(counterparty_skimmed_fee_msat.unwrap_or(0)))
2658 return Err(ReceiveError {
2660 err_data: amt_msat.to_be_bytes().to_vec(),
2661 msg: "Upstream node sent less than we were supposed to receive in payment",
2665 let routing = match hop_data.format {
2666 msgs::OnionHopDataFormat::NonFinalNode { .. } => {
2667 return Err(ReceiveError {
2668 err_code: 0x4000|22,
2669 err_data: Vec::new(),
2670 msg: "Got non final data with an HMAC of 0",
2673 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage, payment_metadata } => {
2674 if let Some(payment_preimage) = keysend_preimage {
2675 // We need to check that the sender knows the keysend preimage before processing this
2676 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
2677 // could discover the final destination of X, by probing the adjacent nodes on the route
2678 // with a keysend payment of identical payment hash to X and observing the processing
2679 // time discrepancies due to a hash collision with X.
2680 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2681 if hashed_preimage != payment_hash {
2682 return Err(ReceiveError {
2683 err_code: 0x4000|22,
2684 err_data: Vec::new(),
2685 msg: "Payment preimage didn't match payment hash",
2688 if !self.default_configuration.accept_mpp_keysend && payment_data.is_some() {
2689 return Err(ReceiveError {
2690 err_code: 0x4000|22,
2691 err_data: Vec::new(),
2692 msg: "We don't support MPP keysend payments",
2695 PendingHTLCRouting::ReceiveKeysend {
2699 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2701 } else if let Some(data) = payment_data {
2702 PendingHTLCRouting::Receive {
2705 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2706 phantom_shared_secret,
2709 return Err(ReceiveError {
2710 err_code: 0x4000|0x2000|3,
2711 err_data: Vec::new(),
2712 msg: "We require payment_secrets",
2717 Ok(PendingHTLCInfo {
2720 incoming_shared_secret: shared_secret,
2721 incoming_amt_msat: Some(amt_msat),
2722 outgoing_amt_msat: hop_data.amt_to_forward,
2723 outgoing_cltv_value: hop_data.outgoing_cltv_value,
2724 skimmed_fee_msat: counterparty_skimmed_fee_msat,
2728 fn decode_update_add_htlc_onion(
2729 &self, msg: &msgs::UpdateAddHTLC
2730 ) -> Result<(onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg> {
2731 macro_rules! return_malformed_err {
2732 ($msg: expr, $err_code: expr) => {
2734 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2735 return Err(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
2736 channel_id: msg.channel_id,
2737 htlc_id: msg.htlc_id,
2738 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
2739 failure_code: $err_code,
2745 if let Err(_) = msg.onion_routing_packet.public_key {
2746 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2749 let shared_secret = self.node_signer.ecdh(
2750 Recipient::Node, &msg.onion_routing_packet.public_key.unwrap(), None
2751 ).unwrap().secret_bytes();
2753 if msg.onion_routing_packet.version != 0 {
2754 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2755 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2756 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2757 //receiving node would have to brute force to figure out which version was put in the
2758 //packet by the node that send us the message, in the case of hashing the hop_data, the
2759 //node knows the HMAC matched, so they already know what is there...
2760 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2762 macro_rules! return_err {
2763 ($msg: expr, $err_code: expr, $data: expr) => {
2765 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2766 return Err(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2767 channel_id: msg.channel_id,
2768 htlc_id: msg.htlc_id,
2769 reason: HTLCFailReason::reason($err_code, $data.to_vec())
2770 .get_encrypted_failure_packet(&shared_secret, &None),
2776 let next_hop = match onion_utils::decode_next_payment_hop(shared_secret, &msg.onion_routing_packet.hop_data[..], msg.onion_routing_packet.hmac, msg.payment_hash) {
2778 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2779 return_malformed_err!(err_msg, err_code);
2781 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2782 return_err!(err_msg, err_code, &[0; 0]);
2785 let (outgoing_scid, outgoing_amt_msat, outgoing_cltv_value, next_packet_pk_opt) = match next_hop {
2786 onion_utils::Hop::Forward {
2787 next_hop_data: msgs::OnionHopData {
2788 format: msgs::OnionHopDataFormat::NonFinalNode { short_channel_id }, amt_to_forward,
2789 outgoing_cltv_value,
2792 let next_pk = onion_utils::next_hop_packet_pubkey(&self.secp_ctx,
2793 msg.onion_routing_packet.public_key.unwrap(), &shared_secret);
2794 (short_channel_id, amt_to_forward, outgoing_cltv_value, Some(next_pk))
2796 // We'll do receive checks in [`Self::construct_pending_htlc_info`] so we have access to the
2797 // inbound channel's state.
2798 onion_utils::Hop::Receive { .. } => return Ok((next_hop, shared_secret, None)),
2799 onion_utils::Hop::Forward {
2800 next_hop_data: msgs::OnionHopData { format: msgs::OnionHopDataFormat::FinalNode { .. }, .. }, ..
2802 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0; 0]);
2806 // Perform outbound checks here instead of in [`Self::construct_pending_htlc_info`] because we
2807 // can't hold the outbound peer state lock at the same time as the inbound peer state lock.
2808 if let Some((err, mut code, chan_update)) = loop {
2809 let id_option = self.short_to_chan_info.read().unwrap().get(&outgoing_scid).cloned();
2810 let forwarding_chan_info_opt = match id_option {
2811 None => { // unknown_next_peer
2812 // Note that this is likely a timing oracle for detecting whether an scid is a
2813 // phantom or an intercept.
2814 if (self.default_configuration.accept_intercept_htlcs &&
2815 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, outgoing_scid, &self.genesis_hash)) ||
2816 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, outgoing_scid, &self.genesis_hash)
2820 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2823 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
2825 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
2826 let per_peer_state = self.per_peer_state.read().unwrap();
2827 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
2828 if peer_state_mutex_opt.is_none() {
2829 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2831 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
2832 let peer_state = &mut *peer_state_lock;
2833 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id) {
2835 // Channel was removed. The short_to_chan_info and channel_by_id maps
2836 // have no consistency guarantees.
2837 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2841 if !chan.context.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
2842 // Note that the behavior here should be identical to the above block - we
2843 // should NOT reveal the existence or non-existence of a private channel if
2844 // we don't allow forwards outbound over them.
2845 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
2847 if chan.context.get_channel_type().supports_scid_privacy() && outgoing_scid != chan.context.outbound_scid_alias() {
2848 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
2849 // "refuse to forward unless the SCID alias was used", so we pretend
2850 // we don't have the channel here.
2851 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
2853 let chan_update_opt = self.get_channel_update_for_onion(outgoing_scid, chan).ok();
2855 // Note that we could technically not return an error yet here and just hope
2856 // that the connection is reestablished or monitor updated by the time we get
2857 // around to doing the actual forward, but better to fail early if we can and
2858 // hopefully an attacker trying to path-trace payments cannot make this occur
2859 // on a small/per-node/per-channel scale.
2860 if !chan.context.is_live() { // channel_disabled
2861 // If the channel_update we're going to return is disabled (i.e. the
2862 // peer has been disabled for some time), return `channel_disabled`,
2863 // otherwise return `temporary_channel_failure`.
2864 if chan_update_opt.as_ref().map(|u| u.contents.flags & 2 == 2).unwrap_or(false) {
2865 break Some(("Forwarding channel has been disconnected for some time.", 0x1000 | 20, chan_update_opt));
2867 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 7, chan_update_opt));
2870 if outgoing_amt_msat < chan.context.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
2871 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
2873 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, outgoing_amt_msat, outgoing_cltv_value) {
2874 break Some((err, code, chan_update_opt));
2878 if (msg.cltv_expiry as u64) < (outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 {
2879 // We really should set `incorrect_cltv_expiry` here but as we're not
2880 // forwarding over a real channel we can't generate a channel_update
2881 // for it. Instead we just return a generic temporary_node_failure.
2883 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
2890 let cur_height = self.best_block.read().unwrap().height() + 1;
2891 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
2892 // but we want to be robust wrt to counterparty packet sanitization (see
2893 // HTLC_FAIL_BACK_BUFFER rationale).
2894 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
2895 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
2897 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
2898 break Some(("CLTV expiry is too far in the future", 21, None));
2900 // If the HTLC expires ~now, don't bother trying to forward it to our
2901 // counterparty. They should fail it anyway, but we don't want to bother with
2902 // the round-trips or risk them deciding they definitely want the HTLC and
2903 // force-closing to ensure they get it if we're offline.
2904 // We previously had a much more aggressive check here which tried to ensure
2905 // our counterparty receives an HTLC which has *our* risk threshold met on it,
2906 // but there is no need to do that, and since we're a bit conservative with our
2907 // risk threshold it just results in failing to forward payments.
2908 if (outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
2909 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
2915 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
2916 if let Some(chan_update) = chan_update {
2917 if code == 0x1000 | 11 || code == 0x1000 | 12 {
2918 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
2920 else if code == 0x1000 | 13 {
2921 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
2923 else if code == 0x1000 | 20 {
2924 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
2925 0u16.write(&mut res).expect("Writes cannot fail");
2927 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
2928 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
2929 chan_update.write(&mut res).expect("Writes cannot fail");
2930 } else if code & 0x1000 == 0x1000 {
2931 // If we're trying to return an error that requires a `channel_update` but
2932 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
2933 // generate an update), just use the generic "temporary_node_failure"
2937 return_err!(err, code, &res.0[..]);
2939 Ok((next_hop, shared_secret, next_packet_pk_opt))
2942 fn construct_pending_htlc_status<'a>(
2943 &self, msg: &msgs::UpdateAddHTLC, shared_secret: [u8; 32], decoded_hop: onion_utils::Hop,
2944 allow_underpay: bool, next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
2945 ) -> PendingHTLCStatus {
2946 macro_rules! return_err {
2947 ($msg: expr, $err_code: expr, $data: expr) => {
2949 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2950 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2951 channel_id: msg.channel_id,
2952 htlc_id: msg.htlc_id,
2953 reason: HTLCFailReason::reason($err_code, $data.to_vec())
2954 .get_encrypted_failure_packet(&shared_secret, &None),
2960 onion_utils::Hop::Receive(next_hop_data) => {
2962 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash,
2963 msg.amount_msat, msg.cltv_expiry, None, allow_underpay, msg.skimmed_fee_msat)
2966 // Note that we could obviously respond immediately with an update_fulfill_htlc
2967 // message, however that would leak that we are the recipient of this payment, so
2968 // instead we stay symmetric with the forwarding case, only responding (after a
2969 // delay) once they've send us a commitment_signed!
2970 PendingHTLCStatus::Forward(info)
2972 Err(ReceiveError { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
2975 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
2976 debug_assert!(next_packet_pubkey_opt.is_some());
2977 let outgoing_packet = msgs::OnionPacket {
2979 public_key: next_packet_pubkey_opt.unwrap_or(Err(secp256k1::Error::InvalidPublicKey)),
2980 hop_data: new_packet_bytes,
2981 hmac: next_hop_hmac.clone(),
2984 let short_channel_id = match next_hop_data.format {
2985 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
2986 msgs::OnionHopDataFormat::FinalNode { .. } => {
2987 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
2991 PendingHTLCStatus::Forward(PendingHTLCInfo {
2992 routing: PendingHTLCRouting::Forward {
2993 onion_packet: outgoing_packet,
2996 payment_hash: msg.payment_hash.clone(),
2997 incoming_shared_secret: shared_secret,
2998 incoming_amt_msat: Some(msg.amount_msat),
2999 outgoing_amt_msat: next_hop_data.amt_to_forward,
3000 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
3001 skimmed_fee_msat: None,
3007 /// Gets the current [`channel_update`] for the given channel. This first checks if the channel is
3008 /// public, and thus should be called whenever the result is going to be passed out in a
3009 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
3011 /// Note that in [`internal_closing_signed`], this function is called without the `peer_state`
3012 /// corresponding to the channel's counterparty locked, as the channel been removed from the
3013 /// storage and the `peer_state` lock has been dropped.
3015 /// [`channel_update`]: msgs::ChannelUpdate
3016 /// [`internal_closing_signed`]: Self::internal_closing_signed
3017 fn get_channel_update_for_broadcast(&self, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
3018 if !chan.context.should_announce() {
3019 return Err(LightningError {
3020 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
3021 action: msgs::ErrorAction::IgnoreError
3024 if chan.context.get_short_channel_id().is_none() {
3025 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
3027 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.context.channel_id()));
3028 self.get_channel_update_for_unicast(chan)
3031 /// Gets the current [`channel_update`] for the given channel. This does not check if the channel
3032 /// is public (only returning an `Err` if the channel does not yet have an assigned SCID),
3033 /// and thus MUST NOT be called unless the recipient of the resulting message has already
3034 /// provided evidence that they know about the existence of the channel.
3036 /// Note that through [`internal_closing_signed`], this function is called without the
3037 /// `peer_state` corresponding to the channel's counterparty locked, as the channel been
3038 /// removed from the storage and the `peer_state` lock has been dropped.
3040 /// [`channel_update`]: msgs::ChannelUpdate
3041 /// [`internal_closing_signed`]: Self::internal_closing_signed
3042 fn get_channel_update_for_unicast(&self, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
3043 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.context.channel_id()));
3044 let short_channel_id = match chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias()) {
3045 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
3049 self.get_channel_update_for_onion(short_channel_id, chan)
3052 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
3053 log_trace!(self.logger, "Generating channel update for channel {}", log_bytes!(chan.context.channel_id()));
3054 let were_node_one = self.our_network_pubkey.serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
3056 let enabled = chan.context.is_usable() && match chan.channel_update_status() {
3057 ChannelUpdateStatus::Enabled => true,
3058 ChannelUpdateStatus::DisabledStaged(_) => true,
3059 ChannelUpdateStatus::Disabled => false,
3060 ChannelUpdateStatus::EnabledStaged(_) => false,
3063 let unsigned = msgs::UnsignedChannelUpdate {
3064 chain_hash: self.genesis_hash,
3066 timestamp: chan.context.get_update_time_counter(),
3067 flags: (!were_node_one) as u8 | ((!enabled as u8) << 1),
3068 cltv_expiry_delta: chan.context.get_cltv_expiry_delta(),
3069 htlc_minimum_msat: chan.context.get_counterparty_htlc_minimum_msat(),
3070 htlc_maximum_msat: chan.context.get_announced_htlc_max_msat(),
3071 fee_base_msat: chan.context.get_outbound_forwarding_fee_base_msat(),
3072 fee_proportional_millionths: chan.context.get_fee_proportional_millionths(),
3073 excess_data: Vec::new(),
3075 // Panic on failure to signal LDK should be restarted to retry signing the `ChannelUpdate`.
3076 // If we returned an error and the `node_signer` cannot provide a signature for whatever
3077 // reason`, we wouldn't be able to receive inbound payments through the corresponding
3079 let sig = self.node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelUpdate(&unsigned)).unwrap();
3081 Ok(msgs::ChannelUpdate {
3088 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> {
3089 let _lck = self.total_consistency_lock.read().unwrap();
3090 self.send_payment_along_path(path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv_bytes)
3093 fn 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> {
3094 // The top-level caller should hold the total_consistency_lock read lock.
3095 debug_assert!(self.total_consistency_lock.try_write().is_err());
3097 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.hops.first().unwrap().short_channel_id);
3098 let prng_seed = self.entropy_source.get_secure_random_bytes();
3099 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
3101 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
3102 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected".to_owned()})?;
3103 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, recipient_onion, cur_height, keysend_preimage)?;
3105 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash)
3106 .map_err(|_| APIError::InvalidRoute { err: "Route size too large considering onion data".to_owned()})?;
3108 let err: Result<(), _> = loop {
3109 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
3110 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
3111 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3114 let per_peer_state = self.per_peer_state.read().unwrap();
3115 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
3116 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
3117 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3118 let peer_state = &mut *peer_state_lock;
3119 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(id) {
3120 if !chan.get().context.is_live() {
3121 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected".to_owned()});
3123 let funding_txo = chan.get().context.get_funding_txo().unwrap();
3124 let send_res = chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(),
3125 htlc_cltv, HTLCSource::OutboundRoute {
3127 session_priv: session_priv.clone(),
3128 first_hop_htlc_msat: htlc_msat,
3130 }, onion_packet, None, &self.fee_estimator, &self.logger);
3131 match break_chan_entry!(self, send_res, chan) {
3132 Some(monitor_update) => {
3133 match handle_new_monitor_update!(self, funding_txo, monitor_update, peer_state_lock, peer_state, per_peer_state, chan) {
3134 Err(e) => break Err(e),
3136 // Note that MonitorUpdateInProgress here indicates (per function
3137 // docs) that we will resend the commitment update once monitor
3138 // updating completes. Therefore, we must return an error
3139 // indicating that it is unsafe to retry the payment wholesale,
3140 // which we do in the send_payment check for
3141 // MonitorUpdateInProgress, below.
3142 return Err(APIError::MonitorUpdateInProgress);
3150 // The channel was likely removed after we fetched the id from the
3151 // `short_to_chan_info` map, but before we successfully locked the
3152 // `channel_by_id` map.
3153 // This can occur as no consistency guarantees exists between the two maps.
3154 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
3159 match handle_error!(self, err, path.hops.first().unwrap().pubkey) {
3160 Ok(_) => unreachable!(),
3162 Err(APIError::ChannelUnavailable { err: e.err })
3167 /// Sends a payment along a given route.
3169 /// Value parameters are provided via the last hop in route, see documentation for [`RouteHop`]
3170 /// fields for more info.
3172 /// May generate [`UpdateHTLCs`] message(s) event on success, which should be relayed (e.g. via
3173 /// [`PeerManager::process_events`]).
3175 /// # Avoiding Duplicate Payments
3177 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
3178 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
3179 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
3180 /// [`Event::PaymentSent`] or [`Event::PaymentFailed`]) LDK will not stop you from sending a
3181 /// second payment with the same [`PaymentId`].
3183 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
3184 /// tracking of payments, including state to indicate once a payment has completed. Because you
3185 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
3186 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
3187 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
3189 /// Additionally, in the scenario where we begin the process of sending a payment, but crash
3190 /// before `send_payment` returns (or prior to [`ChannelMonitorUpdate`] persistence if you're
3191 /// using [`ChannelMonitorUpdateStatus::InProgress`]), the payment may be lost on restart. See
3192 /// [`ChannelManager::list_recent_payments`] for more information.
3194 /// # Possible Error States on [`PaymentSendFailure`]
3196 /// Each path may have a different return value, and [`PaymentSendFailure`] may return a `Vec` with
3197 /// each entry matching the corresponding-index entry in the route paths, see
3198 /// [`PaymentSendFailure`] for more info.
3200 /// In general, a path may raise:
3201 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
3202 /// node public key) is specified.
3203 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
3204 /// (including due to previous monitor update failure or new permanent monitor update
3206 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
3207 /// relevant updates.
3209 /// Note that depending on the type of the [`PaymentSendFailure`] the HTLC may have been
3210 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
3211 /// different route unless you intend to pay twice!
3213 /// [`RouteHop`]: crate::routing::router::RouteHop
3214 /// [`Event::PaymentSent`]: events::Event::PaymentSent
3215 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
3216 /// [`UpdateHTLCs`]: events::MessageSendEvent::UpdateHTLCs
3217 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
3218 /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
3219 pub fn send_payment_with_route(&self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
3220 let best_block_height = self.best_block.read().unwrap().height();
3221 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3222 self.pending_outbound_payments
3223 .send_payment_with_route(route, payment_hash, recipient_onion, payment_id, &self.entropy_source, &self.node_signer, best_block_height,
3224 |path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv|
3225 self.send_payment_along_path(path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv))
3228 /// Similar to [`ChannelManager::send_payment_with_route`], but will automatically find a route based on
3229 /// `route_params` and retry failed payment paths based on `retry_strategy`.
3230 pub fn send_payment(&self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<(), RetryableSendFailure> {
3231 let best_block_height = self.best_block.read().unwrap().height();
3232 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3233 self.pending_outbound_payments
3234 .send_payment(payment_hash, recipient_onion, payment_id, retry_strategy, route_params,
3235 &self.router, self.list_usable_channels(), || self.compute_inflight_htlcs(),
3236 &self.entropy_source, &self.node_signer, best_block_height, &self.logger,
3237 &self.pending_events,
3238 |path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv|
3239 self.send_payment_along_path(path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv))
3243 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> {
3244 let best_block_height = self.best_block.read().unwrap().height();
3245 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3246 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, recipient_onion, keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.node_signer, best_block_height,
3247 |path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv|
3248 self.send_payment_along_path(path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv))
3252 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> {
3253 let best_block_height = self.best_block.read().unwrap().height();
3254 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, recipient_onion, payment_id, route, None, &self.entropy_source, best_block_height)
3258 pub(crate) fn test_set_payment_metadata(&self, payment_id: PaymentId, new_payment_metadata: Option<Vec<u8>>) {
3259 self.pending_outbound_payments.test_set_payment_metadata(payment_id, new_payment_metadata);
3263 /// Signals that no further retries for the given payment should occur. Useful if you have a
3264 /// pending outbound payment with retries remaining, but wish to stop retrying the payment before
3265 /// retries are exhausted.
3267 /// If no [`Event::PaymentFailed`] event had been generated before, one will be generated as soon
3268 /// as there are no remaining pending HTLCs for this payment.
3270 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
3271 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
3272 /// determine the ultimate status of a payment.
3274 /// If an [`Event::PaymentFailed`] event is generated and we restart without this
3275 /// [`ChannelManager`] having been persisted, another [`Event::PaymentFailed`] may be generated.
3277 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
3278 /// [`Event::PaymentSent`]: events::Event::PaymentSent
3279 pub fn abandon_payment(&self, payment_id: PaymentId) {
3280 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3281 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
3284 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
3285 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
3286 /// the preimage, it must be a cryptographically secure random value that no intermediate node
3287 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
3288 /// never reach the recipient.
3290 /// See [`send_payment`] documentation for more details on the return value of this function
3291 /// and idempotency guarantees provided by the [`PaymentId`] key.
3293 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
3294 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
3296 /// [`send_payment`]: Self::send_payment
3297 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
3298 let best_block_height = self.best_block.read().unwrap().height();
3299 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3300 self.pending_outbound_payments.send_spontaneous_payment_with_route(
3301 route, payment_preimage, recipient_onion, payment_id, &self.entropy_source,
3302 &self.node_signer, best_block_height,
3303 |path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv|
3304 self.send_payment_along_path(path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv))
3307 /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
3308 /// based on `route_params` and retry failed payment paths based on `retry_strategy`.
3310 /// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous
3313 /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
3314 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> {
3315 let best_block_height = self.best_block.read().unwrap().height();
3316 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3317 self.pending_outbound_payments.send_spontaneous_payment(payment_preimage, recipient_onion,
3318 payment_id, retry_strategy, route_params, &self.router, self.list_usable_channels(),
3319 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
3320 &self.logger, &self.pending_events,
3321 |path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv|
3322 self.send_payment_along_path(path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv))
3325 /// Send a payment that is probing the given route for liquidity. We calculate the
3326 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
3327 /// us to easily discern them from real payments.
3328 pub fn send_probe(&self, path: Path) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
3329 let best_block_height = self.best_block.read().unwrap().height();
3330 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3331 self.pending_outbound_payments.send_probe(path, self.probing_cookie_secret, &self.entropy_source, &self.node_signer, best_block_height,
3332 |path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv|
3333 self.send_payment_along_path(path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv))
3336 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
3339 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
3340 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
3343 /// Handles the generation of a funding transaction, optionally (for tests) with a function
3344 /// which checks the correctness of the funding transaction given the associated channel.
3345 fn funding_transaction_generated_intern<FundingOutput: Fn(&OutboundV1Channel<<SP::Target as SignerProvider>::Signer>, &Transaction) -> Result<OutPoint, APIError>>(
3346 &self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
3347 ) -> Result<(), APIError> {
3348 let per_peer_state = self.per_peer_state.read().unwrap();
3349 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3350 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3352 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3353 let peer_state = &mut *peer_state_lock;
3354 let (chan, msg) = match peer_state.outbound_v1_channel_by_id.remove(temporary_channel_id) {
3356 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
3358 let funding_res = chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
3359 .map_err(|(mut chan, e)| if let ChannelError::Close(msg) = e {
3360 let channel_id = chan.context.channel_id();
3361 let user_id = chan.context.get_user_id();
3362 let shutdown_res = chan.context.force_shutdown(false);
3363 (chan, MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, user_id, shutdown_res, None))
3364 } else { unreachable!(); });
3366 Ok((chan, funding_msg)) => (chan, funding_msg),
3367 Err((chan, err)) => {
3368 mem::drop(peer_state_lock);
3369 mem::drop(per_peer_state);
3371 let _: Result<(), _> = handle_error!(self, Err(err), chan.context.get_counterparty_node_id());
3372 return Err(APIError::ChannelUnavailable {
3373 err: "Signer refused to sign the initial commitment transaction".to_owned()
3379 return Err(APIError::ChannelUnavailable {
3381 "Channel with id {} not found for the passed counterparty node_id {}",
3382 log_bytes!(*temporary_channel_id), counterparty_node_id),
3387 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
3388 node_id: chan.context.get_counterparty_node_id(),
3391 match peer_state.channel_by_id.entry(chan.context.channel_id()) {
3392 hash_map::Entry::Occupied(_) => {
3393 panic!("Generated duplicate funding txid?");
3395 hash_map::Entry::Vacant(e) => {
3396 let mut id_to_peer = self.id_to_peer.lock().unwrap();
3397 if id_to_peer.insert(chan.context.channel_id(), chan.context.get_counterparty_node_id()).is_some() {
3398 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
3407 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
3408 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
3409 Ok(OutPoint { txid: tx.txid(), index: output_index })
3413 /// Call this upon creation of a funding transaction for the given channel.
3415 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
3416 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
3418 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
3419 /// across the p2p network.
3421 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
3422 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
3424 /// May panic if the output found in the funding transaction is duplicative with some other
3425 /// channel (note that this should be trivially prevented by using unique funding transaction
3426 /// keys per-channel).
3428 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
3429 /// counterparty's signature the funding transaction will automatically be broadcast via the
3430 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
3432 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
3433 /// not currently support replacing a funding transaction on an existing channel. Instead,
3434 /// create a new channel with a conflicting funding transaction.
3436 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
3437 /// the wallet software generating the funding transaction to apply anti-fee sniping as
3438 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
3439 /// for more details.
3441 /// [`Event::FundingGenerationReady`]: crate::events::Event::FundingGenerationReady
3442 /// [`Event::ChannelClosed`]: crate::events::Event::ChannelClosed
3443 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
3444 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3446 for inp in funding_transaction.input.iter() {
3447 if inp.witness.is_empty() {
3448 return Err(APIError::APIMisuseError {
3449 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
3454 let height = self.best_block.read().unwrap().height();
3455 // Transactions are evaluated as final by network mempools if their locktime is strictly
3456 // lower than the next block height. However, the modules constituting our Lightning
3457 // node might not have perfect sync about their blockchain views. Thus, if the wallet
3458 // module is ahead of LDK, only allow one more block of headroom.
3459 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 {
3460 return Err(APIError::APIMisuseError {
3461 err: "Funding transaction absolute timelock is non-final".to_owned()
3465 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
3466 if tx.output.len() > u16::max_value() as usize {
3467 return Err(APIError::APIMisuseError {
3468 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
3472 let mut output_index = None;
3473 let expected_spk = chan.context.get_funding_redeemscript().to_v0_p2wsh();
3474 for (idx, outp) in tx.output.iter().enumerate() {
3475 if outp.script_pubkey == expected_spk && outp.value == chan.context.get_value_satoshis() {
3476 if output_index.is_some() {
3477 return Err(APIError::APIMisuseError {
3478 err: "Multiple outputs matched the expected script and value".to_owned()
3481 output_index = Some(idx as u16);
3484 if output_index.is_none() {
3485 return Err(APIError::APIMisuseError {
3486 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
3489 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
3493 /// Atomically applies partial updates to the [`ChannelConfig`] of the given channels.
3495 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3496 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3497 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3498 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3500 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3501 /// `counterparty_node_id` is provided.
3503 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3504 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3506 /// If an error is returned, none of the updates should be considered applied.
3508 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3509 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3510 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3511 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3512 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3513 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3514 /// [`APIMisuseError`]: APIError::APIMisuseError
3515 pub fn update_partial_channel_config(
3516 &self, counterparty_node_id: &PublicKey, channel_ids: &[[u8; 32]], config_update: &ChannelConfigUpdate,
3517 ) -> Result<(), APIError> {
3518 if config_update.cltv_expiry_delta.map(|delta| delta < MIN_CLTV_EXPIRY_DELTA).unwrap_or(false) {
3519 return Err(APIError::APIMisuseError {
3520 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
3524 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3525 let per_peer_state = self.per_peer_state.read().unwrap();
3526 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3527 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3528 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3529 let peer_state = &mut *peer_state_lock;
3530 for channel_id in channel_ids {
3531 if !peer_state.channel_by_id.contains_key(channel_id) {
3532 return Err(APIError::ChannelUnavailable {
3533 err: format!("Channel with ID {} was not found for the passed counterparty_node_id {}", log_bytes!(*channel_id), counterparty_node_id),
3537 for channel_id in channel_ids {
3538 let channel = peer_state.channel_by_id.get_mut(channel_id).unwrap();
3539 let mut config = channel.context.config();
3540 config.apply(config_update);
3541 if !channel.context.update_config(&config) {
3544 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
3545 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
3546 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
3547 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
3548 node_id: channel.context.get_counterparty_node_id(),
3556 /// Atomically updates the [`ChannelConfig`] for the given channels.
3558 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3559 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3560 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3561 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3563 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3564 /// `counterparty_node_id` is provided.
3566 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3567 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3569 /// If an error is returned, none of the updates should be considered applied.
3571 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3572 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3573 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3574 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3575 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3576 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3577 /// [`APIMisuseError`]: APIError::APIMisuseError
3578 pub fn update_channel_config(
3579 &self, counterparty_node_id: &PublicKey, channel_ids: &[[u8; 32]], config: &ChannelConfig,
3580 ) -> Result<(), APIError> {
3581 return self.update_partial_channel_config(counterparty_node_id, channel_ids, &(*config).into());
3584 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
3585 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
3587 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
3588 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
3590 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
3591 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
3592 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
3593 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
3594 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
3596 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
3597 /// you from forwarding more than you received. See
3598 /// [`HTLCIntercepted::expected_outbound_amount_msat`] for more on forwarding a different amount
3601 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
3604 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
3605 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
3606 /// [`HTLCIntercepted::expected_outbound_amount_msat`]: events::Event::HTLCIntercepted::expected_outbound_amount_msat
3607 // TODO: when we move to deciding the best outbound channel at forward time, only take
3608 // `next_node_id` and not `next_hop_channel_id`
3609 pub fn forward_intercepted_htlc(&self, intercept_id: InterceptId, next_hop_channel_id: &[u8; 32], next_node_id: PublicKey, amt_to_forward_msat: u64) -> Result<(), APIError> {
3610 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3612 let next_hop_scid = {
3613 let peer_state_lock = self.per_peer_state.read().unwrap();
3614 let peer_state_mutex = peer_state_lock.get(&next_node_id)
3615 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) })?;
3616 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3617 let peer_state = &mut *peer_state_lock;
3618 match peer_state.channel_by_id.get(next_hop_channel_id) {
3620 if !chan.context.is_usable() {
3621 return Err(APIError::ChannelUnavailable {
3622 err: format!("Channel with id {} not fully established", log_bytes!(*next_hop_channel_id))
3625 chan.context.get_short_channel_id().unwrap_or(chan.context.outbound_scid_alias())
3627 None => return Err(APIError::ChannelUnavailable {
3628 err: format!("Funded channel with id {} not found for the passed counterparty node_id {}. Channel may still be opening.",
3629 log_bytes!(*next_hop_channel_id), next_node_id)
3634 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
3635 .ok_or_else(|| APIError::APIMisuseError {
3636 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
3639 let routing = match payment.forward_info.routing {
3640 PendingHTLCRouting::Forward { onion_packet, .. } => {
3641 PendingHTLCRouting::Forward { onion_packet, short_channel_id: next_hop_scid }
3643 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
3645 let skimmed_fee_msat =
3646 payment.forward_info.outgoing_amt_msat.saturating_sub(amt_to_forward_msat);
3647 let pending_htlc_info = PendingHTLCInfo {
3648 skimmed_fee_msat: if skimmed_fee_msat == 0 { None } else { Some(skimmed_fee_msat) },
3649 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
3652 let mut per_source_pending_forward = [(
3653 payment.prev_short_channel_id,
3654 payment.prev_funding_outpoint,
3655 payment.prev_user_channel_id,
3656 vec![(pending_htlc_info, payment.prev_htlc_id)]
3658 self.forward_htlcs(&mut per_source_pending_forward);
3662 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
3663 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
3665 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
3668 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
3669 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
3670 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3672 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
3673 .ok_or_else(|| APIError::APIMisuseError {
3674 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
3677 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
3678 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3679 short_channel_id: payment.prev_short_channel_id,
3680 outpoint: payment.prev_funding_outpoint,
3681 htlc_id: payment.prev_htlc_id,
3682 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
3683 phantom_shared_secret: None,
3686 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
3687 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
3688 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
3689 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
3694 /// Processes HTLCs which are pending waiting on random forward delay.
3696 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
3697 /// Will likely generate further events.
3698 pub fn process_pending_htlc_forwards(&self) {
3699 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3701 let mut new_events = VecDeque::new();
3702 let mut failed_forwards = Vec::new();
3703 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
3705 let mut forward_htlcs = HashMap::new();
3706 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
3708 for (short_chan_id, mut pending_forwards) in forward_htlcs {
3709 if short_chan_id != 0 {
3710 macro_rules! forwarding_channel_not_found {
3712 for forward_info in pending_forwards.drain(..) {
3713 match forward_info {
3714 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3715 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3716 forward_info: PendingHTLCInfo {
3717 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
3718 outgoing_cltv_value, ..
3721 macro_rules! failure_handler {
3722 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
3723 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3725 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3726 short_channel_id: prev_short_channel_id,
3727 outpoint: prev_funding_outpoint,
3728 htlc_id: prev_htlc_id,
3729 incoming_packet_shared_secret: incoming_shared_secret,
3730 phantom_shared_secret: $phantom_ss,
3733 let reason = if $next_hop_unknown {
3734 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
3736 HTLCDestination::FailedPayment{ payment_hash }
3739 failed_forwards.push((htlc_source, payment_hash,
3740 HTLCFailReason::reason($err_code, $err_data),
3746 macro_rules! fail_forward {
3747 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3749 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
3753 macro_rules! failed_payment {
3754 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3756 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
3760 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
3761 let phantom_pubkey_res = self.node_signer.get_node_id(Recipient::PhantomNode);
3762 if phantom_pubkey_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.genesis_hash) {
3763 let phantom_shared_secret = self.node_signer.ecdh(Recipient::PhantomNode, &onion_packet.public_key.unwrap(), None).unwrap().secret_bytes();
3764 let next_hop = match onion_utils::decode_next_payment_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
3766 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
3767 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
3768 // In this scenario, the phantom would have sent us an
3769 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
3770 // if it came from us (the second-to-last hop) but contains the sha256
3772 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
3774 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3775 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
3779 onion_utils::Hop::Receive(hop_data) => {
3780 match self.construct_recv_pending_htlc_info(hop_data,
3781 incoming_shared_secret, payment_hash, outgoing_amt_msat,
3782 outgoing_cltv_value, Some(phantom_shared_secret), false, None)
3784 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
3785 Err(ReceiveError { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
3791 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3794 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3797 HTLCForwardInfo::FailHTLC { .. } => {
3798 // Channel went away before we could fail it. This implies
3799 // the channel is now on chain and our counterparty is
3800 // trying to broadcast the HTLC-Timeout, but that's their
3801 // problem, not ours.
3807 let (counterparty_node_id, forward_chan_id) = match self.short_to_chan_info.read().unwrap().get(&short_chan_id) {
3808 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3810 forwarding_channel_not_found!();
3814 let per_peer_state = self.per_peer_state.read().unwrap();
3815 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3816 if peer_state_mutex_opt.is_none() {
3817 forwarding_channel_not_found!();
3820 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
3821 let peer_state = &mut *peer_state_lock;
3822 match peer_state.channel_by_id.entry(forward_chan_id) {
3823 hash_map::Entry::Vacant(_) => {
3824 forwarding_channel_not_found!();
3827 hash_map::Entry::Occupied(mut chan) => {
3828 for forward_info in pending_forwards.drain(..) {
3829 match forward_info {
3830 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3831 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id: _,
3832 forward_info: PendingHTLCInfo {
3833 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
3834 routing: PendingHTLCRouting::Forward { onion_packet, .. }, skimmed_fee_msat, ..
3837 log_trace!(self.logger, "Adding HTLC from short id {} with payment_hash {} to channel with short id {} after delay", prev_short_channel_id, log_bytes!(payment_hash.0), short_chan_id);
3838 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3839 short_channel_id: prev_short_channel_id,
3840 outpoint: prev_funding_outpoint,
3841 htlc_id: prev_htlc_id,
3842 incoming_packet_shared_secret: incoming_shared_secret,
3843 // Phantom payments are only PendingHTLCRouting::Receive.
3844 phantom_shared_secret: None,
3846 if let Err(e) = chan.get_mut().queue_add_htlc(outgoing_amt_msat,
3847 payment_hash, outgoing_cltv_value, htlc_source.clone(),
3848 onion_packet, skimmed_fee_msat, &self.fee_estimator,
3851 if let ChannelError::Ignore(msg) = e {
3852 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
3854 panic!("Stated return value requirements in send_htlc() were not met");
3856 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan.get());
3857 failed_forwards.push((htlc_source, payment_hash,
3858 HTLCFailReason::reason(failure_code, data),
3859 HTLCDestination::NextHopChannel { node_id: Some(chan.get().context.get_counterparty_node_id()), channel_id: forward_chan_id }
3864 HTLCForwardInfo::AddHTLC { .. } => {
3865 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
3867 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
3868 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
3869 if let Err(e) = chan.get_mut().queue_fail_htlc(
3870 htlc_id, err_packet, &self.logger
3872 if let ChannelError::Ignore(msg) = e {
3873 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
3875 panic!("Stated return value requirements in queue_fail_htlc() were not met");
3877 // fail-backs are best-effort, we probably already have one
3878 // pending, and if not that's OK, if not, the channel is on
3879 // the chain and sending the HTLC-Timeout is their problem.
3888 'next_forwardable_htlc: for forward_info in pending_forwards.drain(..) {
3889 match forward_info {
3890 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3891 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3892 forward_info: PendingHTLCInfo {
3893 routing, incoming_shared_secret, payment_hash, incoming_amt_msat, outgoing_amt_msat,
3894 skimmed_fee_msat, ..
3897 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret, mut onion_fields) = match routing {
3898 PendingHTLCRouting::Receive { payment_data, payment_metadata, incoming_cltv_expiry, phantom_shared_secret } => {
3899 let _legacy_hop_data = Some(payment_data.clone());
3901 RecipientOnionFields { payment_secret: Some(payment_data.payment_secret), payment_metadata };
3902 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data },
3903 Some(payment_data), phantom_shared_secret, onion_fields)
3905 PendingHTLCRouting::ReceiveKeysend { payment_data, payment_preimage, payment_metadata, incoming_cltv_expiry } => {
3906 let onion_fields = RecipientOnionFields {
3907 payment_secret: payment_data.as_ref().map(|data| data.payment_secret),
3910 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage),
3911 payment_data, None, onion_fields)
3914 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
3917 let claimable_htlc = ClaimableHTLC {
3918 prev_hop: HTLCPreviousHopData {
3919 short_channel_id: prev_short_channel_id,
3920 outpoint: prev_funding_outpoint,
3921 htlc_id: prev_htlc_id,
3922 incoming_packet_shared_secret: incoming_shared_secret,
3923 phantom_shared_secret,
3925 // We differentiate the received value from the sender intended value
3926 // if possible so that we don't prematurely mark MPP payments complete
3927 // if routing nodes overpay
3928 value: incoming_amt_msat.unwrap_or(outgoing_amt_msat),
3929 sender_intended_value: outgoing_amt_msat,
3931 total_value_received: None,
3932 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
3935 counterparty_skimmed_fee_msat: skimmed_fee_msat,
3938 let mut committed_to_claimable = false;
3940 macro_rules! fail_htlc {
3941 ($htlc: expr, $payment_hash: expr) => {
3942 debug_assert!(!committed_to_claimable);
3943 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
3944 htlc_msat_height_data.extend_from_slice(
3945 &self.best_block.read().unwrap().height().to_be_bytes(),
3947 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
3948 short_channel_id: $htlc.prev_hop.short_channel_id,
3949 outpoint: prev_funding_outpoint,
3950 htlc_id: $htlc.prev_hop.htlc_id,
3951 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
3952 phantom_shared_secret,
3954 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
3955 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
3957 continue 'next_forwardable_htlc;
3960 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
3961 let mut receiver_node_id = self.our_network_pubkey;
3962 if phantom_shared_secret.is_some() {
3963 receiver_node_id = self.node_signer.get_node_id(Recipient::PhantomNode)
3964 .expect("Failed to get node_id for phantom node recipient");
3967 macro_rules! check_total_value {
3968 ($purpose: expr) => {{
3969 let mut payment_claimable_generated = false;
3970 let is_keysend = match $purpose {
3971 events::PaymentPurpose::SpontaneousPayment(_) => true,
3972 events::PaymentPurpose::InvoicePayment { .. } => false,
3974 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3975 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
3976 fail_htlc!(claimable_htlc, payment_hash);
3978 let ref mut claimable_payment = claimable_payments.claimable_payments
3979 .entry(payment_hash)
3980 // Note that if we insert here we MUST NOT fail_htlc!()
3981 .or_insert_with(|| {
3982 committed_to_claimable = true;
3984 purpose: $purpose.clone(), htlcs: Vec::new(), onion_fields: None,
3987 if $purpose != claimable_payment.purpose {
3988 let log_keysend = |keysend| if keysend { "keysend" } else { "non-keysend" };
3989 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), log_bytes!(payment_hash.0), log_keysend(!is_keysend));
3990 fail_htlc!(claimable_htlc, payment_hash);
3992 if !self.default_configuration.accept_mpp_keysend && is_keysend && !claimable_payment.htlcs.is_empty() {
3993 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", log_bytes!(payment_hash.0));
3994 fail_htlc!(claimable_htlc, payment_hash);
3996 if let Some(earlier_fields) = &mut claimable_payment.onion_fields {
3997 if earlier_fields.check_merge(&mut onion_fields).is_err() {
3998 fail_htlc!(claimable_htlc, payment_hash);
4001 claimable_payment.onion_fields = Some(onion_fields);
4003 let ref mut htlcs = &mut claimable_payment.htlcs;
4004 let mut total_value = claimable_htlc.sender_intended_value;
4005 let mut earliest_expiry = claimable_htlc.cltv_expiry;
4006 for htlc in htlcs.iter() {
4007 total_value += htlc.sender_intended_value;
4008 earliest_expiry = cmp::min(earliest_expiry, htlc.cltv_expiry);
4009 if htlc.total_msat != claimable_htlc.total_msat {
4010 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
4011 log_bytes!(payment_hash.0), claimable_htlc.total_msat, htlc.total_msat);
4012 total_value = msgs::MAX_VALUE_MSAT;
4014 if total_value >= msgs::MAX_VALUE_MSAT { break; }
4016 // The condition determining whether an MPP is complete must
4017 // match exactly the condition used in `timer_tick_occurred`
4018 if total_value >= msgs::MAX_VALUE_MSAT {
4019 fail_htlc!(claimable_htlc, payment_hash);
4020 } else if total_value - claimable_htlc.sender_intended_value >= claimable_htlc.total_msat {
4021 log_trace!(self.logger, "Failing HTLC with payment_hash {} as payment is already claimable",
4022 log_bytes!(payment_hash.0));
4023 fail_htlc!(claimable_htlc, payment_hash);
4024 } else if total_value >= claimable_htlc.total_msat {
4025 #[allow(unused_assignments)] {
4026 committed_to_claimable = true;
4028 let prev_channel_id = prev_funding_outpoint.to_channel_id();
4029 htlcs.push(claimable_htlc);
4030 let amount_msat = htlcs.iter().map(|htlc| htlc.value).sum();
4031 htlcs.iter_mut().for_each(|htlc| htlc.total_value_received = Some(amount_msat));
4032 let counterparty_skimmed_fee_msat = htlcs.iter()
4033 .map(|htlc| htlc.counterparty_skimmed_fee_msat.unwrap_or(0)).sum();
4034 debug_assert!(total_value.saturating_sub(amount_msat) <=
4035 counterparty_skimmed_fee_msat);
4036 new_events.push_back((events::Event::PaymentClaimable {
4037 receiver_node_id: Some(receiver_node_id),
4041 counterparty_skimmed_fee_msat,
4042 via_channel_id: Some(prev_channel_id),
4043 via_user_channel_id: Some(prev_user_channel_id),
4044 claim_deadline: Some(earliest_expiry - HTLC_FAIL_BACK_BUFFER),
4045 onion_fields: claimable_payment.onion_fields.clone(),
4047 payment_claimable_generated = true;
4049 // Nothing to do - we haven't reached the total
4050 // payment value yet, wait until we receive more
4052 htlcs.push(claimable_htlc);
4053 #[allow(unused_assignments)] {
4054 committed_to_claimable = true;
4057 payment_claimable_generated
4061 // Check that the payment hash and secret are known. Note that we
4062 // MUST take care to handle the "unknown payment hash" and
4063 // "incorrect payment secret" cases here identically or we'd expose
4064 // that we are the ultimate recipient of the given payment hash.
4065 // Further, we must not expose whether we have any other HTLCs
4066 // associated with the same payment_hash pending or not.
4067 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4068 match payment_secrets.entry(payment_hash) {
4069 hash_map::Entry::Vacant(_) => {
4070 match claimable_htlc.onion_payload {
4071 OnionPayload::Invoice { .. } => {
4072 let payment_data = payment_data.unwrap();
4073 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) {
4074 Ok(result) => result,
4076 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as payment verification failed", log_bytes!(payment_hash.0));
4077 fail_htlc!(claimable_htlc, payment_hash);
4080 if let Some(min_final_cltv_expiry_delta) = min_final_cltv_expiry_delta {
4081 let expected_min_expiry_height = (self.current_best_block().height() + min_final_cltv_expiry_delta as u32) as u64;
4082 if (cltv_expiry as u64) < expected_min_expiry_height {
4083 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as its CLTV expiry was too soon (had {}, earliest expected {})",
4084 log_bytes!(payment_hash.0), cltv_expiry, expected_min_expiry_height);
4085 fail_htlc!(claimable_htlc, payment_hash);
4088 let purpose = events::PaymentPurpose::InvoicePayment {
4089 payment_preimage: payment_preimage.clone(),
4090 payment_secret: payment_data.payment_secret,
4092 check_total_value!(purpose);
4094 OnionPayload::Spontaneous(preimage) => {
4095 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
4096 check_total_value!(purpose);
4100 hash_map::Entry::Occupied(inbound_payment) => {
4101 if let OnionPayload::Spontaneous(_) = claimable_htlc.onion_payload {
4102 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} because we already have an inbound payment with the same payment hash", log_bytes!(payment_hash.0));
4103 fail_htlc!(claimable_htlc, payment_hash);
4105 let payment_data = payment_data.unwrap();
4106 if inbound_payment.get().payment_secret != payment_data.payment_secret {
4107 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
4108 fail_htlc!(claimable_htlc, payment_hash);
4109 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
4110 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
4111 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
4112 fail_htlc!(claimable_htlc, payment_hash);
4114 let purpose = events::PaymentPurpose::InvoicePayment {
4115 payment_preimage: inbound_payment.get().payment_preimage,
4116 payment_secret: payment_data.payment_secret,
4118 let payment_claimable_generated = check_total_value!(purpose);
4119 if payment_claimable_generated {
4120 inbound_payment.remove_entry();
4126 HTLCForwardInfo::FailHTLC { .. } => {
4127 panic!("Got pending fail of our own HTLC");
4135 let best_block_height = self.best_block.read().unwrap().height();
4136 self.pending_outbound_payments.check_retry_payments(&self.router, || self.list_usable_channels(),
4137 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
4138 &self.pending_events, &self.logger,
4139 |path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv|
4140 self.send_payment_along_path(path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv));
4142 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
4143 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4145 self.forward_htlcs(&mut phantom_receives);
4147 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
4148 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
4149 // nice to do the work now if we can rather than while we're trying to get messages in the
4151 self.check_free_holding_cells();
4153 if new_events.is_empty() { return }
4154 let mut events = self.pending_events.lock().unwrap();
4155 events.append(&mut new_events);
4158 /// Free the background events, generally called from [`PersistenceNotifierGuard`] constructors.
4160 /// Expects the caller to have a total_consistency_lock read lock.
4161 fn process_background_events(&self) -> NotifyOption {
4162 debug_assert_ne!(self.total_consistency_lock.held_by_thread(), LockHeldState::NotHeldByThread);
4164 self.background_events_processed_since_startup.store(true, Ordering::Release);
4166 let mut background_events = Vec::new();
4167 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
4168 if background_events.is_empty() {
4169 return NotifyOption::SkipPersist;
4172 for event in background_events.drain(..) {
4174 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((funding_txo, update)) => {
4175 // The channel has already been closed, so no use bothering to care about the
4176 // monitor updating completing.
4177 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4179 BackgroundEvent::MonitorUpdateRegeneratedOnStartup { counterparty_node_id, funding_txo, update } => {
4180 let mut updated_chan = false;
4182 let per_peer_state = self.per_peer_state.read().unwrap();
4183 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4184 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4185 let peer_state = &mut *peer_state_lock;
4186 match peer_state.channel_by_id.entry(funding_txo.to_channel_id()) {
4187 hash_map::Entry::Occupied(mut chan) => {
4188 updated_chan = true;
4189 handle_new_monitor_update!(self, funding_txo, update.clone(),
4190 peer_state_lock, peer_state, per_peer_state, chan).map(|_| ())
4192 hash_map::Entry::Vacant(_) => Ok(()),
4197 // TODO: Track this as in-flight even though the channel is closed.
4198 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4200 // TODO: If this channel has since closed, we're likely providing a payment
4201 // preimage update, which we must ensure is durable! We currently don't,
4202 // however, ensure that.
4204 log_error!(self.logger,
4205 "Failed to provide ChannelMonitorUpdate to closed channel! This likely lost us a payment preimage!");
4207 let _ = handle_error!(self, res, counterparty_node_id);
4209 BackgroundEvent::MonitorUpdatesComplete { counterparty_node_id, channel_id } => {
4210 let per_peer_state = self.per_peer_state.read().unwrap();
4211 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4212 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4213 let peer_state = &mut *peer_state_lock;
4214 if let Some(chan) = peer_state.channel_by_id.get_mut(&channel_id) {
4215 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, chan);
4217 let update_actions = peer_state.monitor_update_blocked_actions
4218 .remove(&channel_id).unwrap_or(Vec::new());
4219 mem::drop(peer_state_lock);
4220 mem::drop(per_peer_state);
4221 self.handle_monitor_update_completion_actions(update_actions);
4227 NotifyOption::DoPersist
4230 #[cfg(any(test, feature = "_test_utils"))]
4231 /// Process background events, for functional testing
4232 pub fn test_process_background_events(&self) {
4233 let _lck = self.total_consistency_lock.read().unwrap();
4234 let _ = self.process_background_events();
4237 fn update_channel_fee(&self, chan_id: &[u8; 32], chan: &mut Channel<<SP::Target as SignerProvider>::Signer>, new_feerate: u32) -> NotifyOption {
4238 if !chan.context.is_outbound() { return NotifyOption::SkipPersist; }
4239 // If the feerate has decreased by less than half, don't bother
4240 if new_feerate <= chan.context.get_feerate_sat_per_1000_weight() && new_feerate * 2 > chan.context.get_feerate_sat_per_1000_weight() {
4241 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
4242 log_bytes!(chan_id[..]), chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4243 return NotifyOption::SkipPersist;
4245 if !chan.context.is_live() {
4246 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).",
4247 log_bytes!(chan_id[..]), chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4248 return NotifyOption::SkipPersist;
4250 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
4251 log_bytes!(chan_id[..]), chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4253 chan.queue_update_fee(new_feerate, &self.fee_estimator, &self.logger);
4254 NotifyOption::DoPersist
4258 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
4259 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
4260 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
4261 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
4262 pub fn maybe_update_chan_fees(&self) {
4263 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4264 let mut should_persist = self.process_background_events();
4266 let normal_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4267 let min_mempool_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::MempoolMinimum);
4269 let per_peer_state = self.per_peer_state.read().unwrap();
4270 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
4271 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4272 let peer_state = &mut *peer_state_lock;
4273 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
4274 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4279 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4280 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4288 /// Performs actions which should happen on startup and roughly once per minute thereafter.
4290 /// This currently includes:
4291 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
4292 /// * Broadcasting [`ChannelUpdate`] messages if we've been disconnected from our peer for more
4293 /// than a minute, informing the network that they should no longer attempt to route over
4295 /// * Expiring a channel's previous [`ChannelConfig`] if necessary to only allow forwarding HTLCs
4296 /// with the current [`ChannelConfig`].
4297 /// * Removing peers which have disconnected but and no longer have any channels.
4299 /// Note that this may cause reentrancy through [`chain::Watch::update_channel`] calls or feerate
4300 /// estimate fetches.
4302 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4303 /// [`ChannelConfig`]: crate::util::config::ChannelConfig
4304 pub fn timer_tick_occurred(&self) {
4305 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4306 let mut should_persist = self.process_background_events();
4308 let normal_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4309 let min_mempool_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::MempoolMinimum);
4311 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
4312 let mut timed_out_mpp_htlcs = Vec::new();
4313 let mut pending_peers_awaiting_removal = Vec::new();
4315 let per_peer_state = self.per_peer_state.read().unwrap();
4316 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
4317 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4318 let peer_state = &mut *peer_state_lock;
4319 let pending_msg_events = &mut peer_state.pending_msg_events;
4320 let counterparty_node_id = *counterparty_node_id;
4321 peer_state.channel_by_id.retain(|chan_id, chan| {
4322 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4327 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4328 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4330 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
4331 let (needs_close, err) = convert_chan_err!(self, e, chan, chan_id);
4332 handle_errors.push((Err(err), counterparty_node_id));
4333 if needs_close { return false; }
4336 match chan.channel_update_status() {
4337 ChannelUpdateStatus::Enabled if !chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(0)),
4338 ChannelUpdateStatus::Disabled if chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(0)),
4339 ChannelUpdateStatus::DisabledStaged(_) if chan.context.is_live()
4340 => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
4341 ChannelUpdateStatus::EnabledStaged(_) if !chan.context.is_live()
4342 => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
4343 ChannelUpdateStatus::DisabledStaged(mut n) if !chan.context.is_live() => {
4345 if n >= DISABLE_GOSSIP_TICKS {
4346 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
4347 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4348 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4352 should_persist = NotifyOption::DoPersist;
4354 chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(n));
4357 ChannelUpdateStatus::EnabledStaged(mut n) if chan.context.is_live() => {
4359 if n >= ENABLE_GOSSIP_TICKS {
4360 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
4361 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4362 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4366 should_persist = NotifyOption::DoPersist;
4368 chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(n));
4374 chan.context.maybe_expire_prev_config();
4376 if chan.should_disconnect_peer_awaiting_response() {
4377 log_debug!(self.logger, "Disconnecting peer {} due to not making any progress on channel {}",
4378 counterparty_node_id, log_bytes!(*chan_id));
4379 pending_msg_events.push(MessageSendEvent::HandleError {
4380 node_id: counterparty_node_id,
4381 action: msgs::ErrorAction::DisconnectPeerWithWarning {
4382 msg: msgs::WarningMessage {
4383 channel_id: *chan_id,
4384 data: "Disconnecting due to timeout awaiting response".to_owned(),
4392 if peer_state.ok_to_remove(true) {
4393 pending_peers_awaiting_removal.push(counterparty_node_id);
4398 // When a peer disconnects but still has channels, the peer's `peer_state` entry in the
4399 // `per_peer_state` is not removed by the `peer_disconnected` function. If the channels
4400 // of to that peer is later closed while still being disconnected (i.e. force closed),
4401 // we therefore need to remove the peer from `peer_state` separately.
4402 // To avoid having to take the `per_peer_state` `write` lock once the channels are
4403 // closed, we instead remove such peers awaiting removal here on a timer, to limit the
4404 // negative effects on parallelism as much as possible.
4405 if pending_peers_awaiting_removal.len() > 0 {
4406 let mut per_peer_state = self.per_peer_state.write().unwrap();
4407 for counterparty_node_id in pending_peers_awaiting_removal {
4408 match per_peer_state.entry(counterparty_node_id) {
4409 hash_map::Entry::Occupied(entry) => {
4410 // Remove the entry if the peer is still disconnected and we still
4411 // have no channels to the peer.
4412 let remove_entry = {
4413 let peer_state = entry.get().lock().unwrap();
4414 peer_state.ok_to_remove(true)
4417 entry.remove_entry();
4420 hash_map::Entry::Vacant(_) => { /* The PeerState has already been removed */ }
4425 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
4426 if payment.htlcs.is_empty() {
4427 // This should be unreachable
4428 debug_assert!(false);
4431 if let OnionPayload::Invoice { .. } = payment.htlcs[0].onion_payload {
4432 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
4433 // In this case we're not going to handle any timeouts of the parts here.
4434 // This condition determining whether the MPP is complete here must match
4435 // exactly the condition used in `process_pending_htlc_forwards`.
4436 if payment.htlcs[0].total_msat <= payment.htlcs.iter()
4437 .fold(0, |total, htlc| total + htlc.sender_intended_value)
4440 } else if payment.htlcs.iter_mut().any(|htlc| {
4441 htlc.timer_ticks += 1;
4442 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
4444 timed_out_mpp_htlcs.extend(payment.htlcs.drain(..)
4445 .map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
4452 for htlc_source in timed_out_mpp_htlcs.drain(..) {
4453 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
4454 let reason = HTLCFailReason::from_failure_code(23);
4455 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
4456 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
4459 for (err, counterparty_node_id) in handle_errors.drain(..) {
4460 let _ = handle_error!(self, err, counterparty_node_id);
4463 self.pending_outbound_payments.remove_stale_resolved_payments(&self.pending_events);
4465 // Technically we don't need to do this here, but if we have holding cell entries in a
4466 // channel that need freeing, it's better to do that here and block a background task
4467 // than block the message queueing pipeline.
4468 if self.check_free_holding_cells() {
4469 should_persist = NotifyOption::DoPersist;
4476 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
4477 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
4478 /// along the path (including in our own channel on which we received it).
4480 /// Note that in some cases around unclean shutdown, it is possible the payment may have
4481 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
4482 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
4483 /// may have already been failed automatically by LDK if it was nearing its expiration time.
4485 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
4486 /// [`ChannelManager::claim_funds`]), you should still monitor for
4487 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
4488 /// startup during which time claims that were in-progress at shutdown may be replayed.
4489 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
4490 self.fail_htlc_backwards_with_reason(payment_hash, FailureCode::IncorrectOrUnknownPaymentDetails);
4493 /// This is a variant of [`ChannelManager::fail_htlc_backwards`] that allows you to specify the
4494 /// reason for the failure.
4496 /// See [`FailureCode`] for valid failure codes.
4497 pub fn fail_htlc_backwards_with_reason(&self, payment_hash: &PaymentHash, failure_code: FailureCode) {
4498 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4500 let removed_source = self.claimable_payments.lock().unwrap().claimable_payments.remove(payment_hash);
4501 if let Some(payment) = removed_source {
4502 for htlc in payment.htlcs {
4503 let reason = self.get_htlc_fail_reason_from_failure_code(failure_code, &htlc);
4504 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
4505 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
4506 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
4511 /// Gets error data to form an [`HTLCFailReason`] given a [`FailureCode`] and [`ClaimableHTLC`].
4512 fn get_htlc_fail_reason_from_failure_code(&self, failure_code: FailureCode, htlc: &ClaimableHTLC) -> HTLCFailReason {
4513 match failure_code {
4514 FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(failure_code as u16),
4515 FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(failure_code as u16),
4516 FailureCode::IncorrectOrUnknownPaymentDetails => {
4517 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
4518 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
4519 HTLCFailReason::reason(failure_code as u16, htlc_msat_height_data)
4524 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
4525 /// that we want to return and a channel.
4527 /// This is for failures on the channel on which the HTLC was *received*, not failures
4529 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> (u16, Vec<u8>) {
4530 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
4531 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
4532 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
4533 // an inbound SCID alias before the real SCID.
4534 let scid_pref = if chan.context.should_announce() {
4535 chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias())
4537 chan.context.latest_inbound_scid_alias().or(chan.context.get_short_channel_id())
4539 if let Some(scid) = scid_pref {
4540 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
4542 (0x4000|10, Vec::new())
4547 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
4548 /// that we want to return and a channel.
4549 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> (u16, Vec<u8>) {
4550 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
4551 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
4552 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
4553 if desired_err_code == 0x1000 | 20 {
4554 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
4555 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
4556 0u16.write(&mut enc).expect("Writes cannot fail");
4558 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
4559 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
4560 upd.write(&mut enc).expect("Writes cannot fail");
4561 (desired_err_code, enc.0)
4563 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
4564 // which means we really shouldn't have gotten a payment to be forwarded over this
4565 // channel yet, or if we did it's from a route hint. Either way, returning an error of
4566 // PERM|no_such_channel should be fine.
4567 (0x4000|10, Vec::new())
4571 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
4572 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
4573 // be surfaced to the user.
4574 fn fail_holding_cell_htlcs(
4575 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32],
4576 counterparty_node_id: &PublicKey
4578 let (failure_code, onion_failure_data) = {
4579 let per_peer_state = self.per_peer_state.read().unwrap();
4580 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4581 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4582 let peer_state = &mut *peer_state_lock;
4583 match peer_state.channel_by_id.entry(channel_id) {
4584 hash_map::Entry::Occupied(chan_entry) => {
4585 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan_entry.get())
4587 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
4589 } else { (0x4000|10, Vec::new()) }
4592 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
4593 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
4594 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
4595 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
4599 /// Fails an HTLC backwards to the sender of it to us.
4600 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
4601 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
4602 // Ensure that no peer state channel storage lock is held when calling this function.
4603 // This ensures that future code doesn't introduce a lock-order requirement for
4604 // `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
4605 // this function with any `per_peer_state` peer lock acquired would.
4606 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
4607 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
4610 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
4611 //identify whether we sent it or not based on the (I presume) very different runtime
4612 //between the branches here. We should make this async and move it into the forward HTLCs
4615 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4616 // from block_connected which may run during initialization prior to the chain_monitor
4617 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
4619 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, .. } => {
4620 if self.pending_outbound_payments.fail_htlc(source, payment_hash, onion_error, path,
4621 session_priv, payment_id, self.probing_cookie_secret, &self.secp_ctx,
4622 &self.pending_events, &self.logger)
4623 { self.push_pending_forwards_ev(); }
4625 HTLCSource::PreviousHopData(HTLCPreviousHopData { ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret, ref phantom_shared_secret, ref outpoint }) => {
4626 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with {:?}", log_bytes!(payment_hash.0), onion_error);
4627 let err_packet = onion_error.get_encrypted_failure_packet(incoming_packet_shared_secret, phantom_shared_secret);
4629 let mut push_forward_ev = false;
4630 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
4631 if forward_htlcs.is_empty() {
4632 push_forward_ev = true;
4634 match forward_htlcs.entry(*short_channel_id) {
4635 hash_map::Entry::Occupied(mut entry) => {
4636 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet });
4638 hash_map::Entry::Vacant(entry) => {
4639 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }));
4642 mem::drop(forward_htlcs);
4643 if push_forward_ev { self.push_pending_forwards_ev(); }
4644 let mut pending_events = self.pending_events.lock().unwrap();
4645 pending_events.push_back((events::Event::HTLCHandlingFailed {
4646 prev_channel_id: outpoint.to_channel_id(),
4647 failed_next_destination: destination,
4653 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
4654 /// [`MessageSendEvent`]s needed to claim the payment.
4656 /// This method is guaranteed to ensure the payment has been claimed but only if the current
4657 /// height is strictly below [`Event::PaymentClaimable::claim_deadline`]. To avoid race
4658 /// conditions, you should wait for an [`Event::PaymentClaimed`] before considering the payment
4659 /// successful. It will generally be available in the next [`process_pending_events`] call.
4661 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
4662 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
4663 /// event matches your expectation. If you fail to do so and call this method, you may provide
4664 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
4666 /// [`Event::PaymentClaimable`]: crate::events::Event::PaymentClaimable
4667 /// [`Event::PaymentClaimable::claim_deadline`]: crate::events::Event::PaymentClaimable::claim_deadline
4668 /// [`Event::PaymentClaimed`]: crate::events::Event::PaymentClaimed
4669 /// [`process_pending_events`]: EventsProvider::process_pending_events
4670 /// [`create_inbound_payment`]: Self::create_inbound_payment
4671 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
4672 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
4673 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4675 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4678 let mut claimable_payments = self.claimable_payments.lock().unwrap();
4679 if let Some(payment) = claimable_payments.claimable_payments.remove(&payment_hash) {
4680 let mut receiver_node_id = self.our_network_pubkey;
4681 for htlc in payment.htlcs.iter() {
4682 if htlc.prev_hop.phantom_shared_secret.is_some() {
4683 let phantom_pubkey = self.node_signer.get_node_id(Recipient::PhantomNode)
4684 .expect("Failed to get node_id for phantom node recipient");
4685 receiver_node_id = phantom_pubkey;
4690 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
4691 ClaimingPayment { amount_msat: payment.htlcs.iter().map(|source| source.value).sum(),
4692 payment_purpose: payment.purpose, receiver_node_id,
4694 if dup_purpose.is_some() {
4695 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
4696 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
4697 log_bytes!(payment_hash.0));
4702 debug_assert!(!sources.is_empty());
4704 // Just in case one HTLC has been failed between when we generated the `PaymentClaimable`
4705 // and when we got here we need to check that the amount we're about to claim matches the
4706 // amount we told the user in the last `PaymentClaimable`. We also do a sanity-check that
4707 // the MPP parts all have the same `total_msat`.
4708 let mut claimable_amt_msat = 0;
4709 let mut prev_total_msat = None;
4710 let mut expected_amt_msat = None;
4711 let mut valid_mpp = true;
4712 let mut errs = Vec::new();
4713 let per_peer_state = self.per_peer_state.read().unwrap();
4714 for htlc in sources.iter() {
4715 if prev_total_msat.is_some() && prev_total_msat != Some(htlc.total_msat) {
4716 log_error!(self.logger, "Somehow ended up with an MPP payment with different expected total amounts - this should not be reachable!");
4717 debug_assert!(false);
4721 prev_total_msat = Some(htlc.total_msat);
4723 if expected_amt_msat.is_some() && expected_amt_msat != htlc.total_value_received {
4724 log_error!(self.logger, "Somehow ended up with an MPP payment with different received total amounts - this should not be reachable!");
4725 debug_assert!(false);
4729 expected_amt_msat = htlc.total_value_received;
4730 claimable_amt_msat += htlc.value;
4732 mem::drop(per_peer_state);
4733 if sources.is_empty() || expected_amt_msat.is_none() {
4734 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4735 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
4738 if claimable_amt_msat != expected_amt_msat.unwrap() {
4739 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4740 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
4741 expected_amt_msat.unwrap(), claimable_amt_msat);
4745 for htlc in sources.drain(..) {
4746 if let Err((pk, err)) = self.claim_funds_from_hop(
4747 htlc.prev_hop, payment_preimage,
4748 |_| Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash }))
4750 if let msgs::ErrorAction::IgnoreError = err.err.action {
4751 // We got a temporary failure updating monitor, but will claim the
4752 // HTLC when the monitor updating is restored (or on chain).
4753 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
4754 } else { errs.push((pk, err)); }
4759 for htlc in sources.drain(..) {
4760 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
4761 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
4762 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
4763 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
4764 let receiver = HTLCDestination::FailedPayment { payment_hash };
4765 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
4767 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4770 // Now we can handle any errors which were generated.
4771 for (counterparty_node_id, err) in errs.drain(..) {
4772 let res: Result<(), _> = Err(err);
4773 let _ = handle_error!(self, res, counterparty_node_id);
4777 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>) -> Option<MonitorUpdateCompletionAction>>(&self,
4778 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
4779 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
4780 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
4782 // If we haven't yet run background events assume we're still deserializing and shouldn't
4783 // actually pass `ChannelMonitorUpdate`s to users yet. Instead, queue them up as
4784 // `BackgroundEvent`s.
4785 let during_init = !self.background_events_processed_since_startup.load(Ordering::Acquire);
4788 let per_peer_state = self.per_peer_state.read().unwrap();
4789 let chan_id = prev_hop.outpoint.to_channel_id();
4790 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
4791 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
4795 let peer_state_opt = counterparty_node_id_opt.as_ref().map(
4796 |counterparty_node_id| per_peer_state.get(counterparty_node_id)
4797 .map(|peer_mutex| peer_mutex.lock().unwrap())
4800 if peer_state_opt.is_some() {
4801 let mut peer_state_lock = peer_state_opt.unwrap();
4802 let peer_state = &mut *peer_state_lock;
4803 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(chan_id) {
4804 let counterparty_node_id = chan.get().context.get_counterparty_node_id();
4805 let fulfill_res = chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger);
4807 if let UpdateFulfillCommitFetch::NewClaim { htlc_value_msat, monitor_update } = fulfill_res {
4808 if let Some(action) = completion_action(Some(htlc_value_msat)) {
4809 log_trace!(self.logger, "Tracking monitor update completion action for channel {}: {:?}",
4810 log_bytes!(chan_id), action);
4811 peer_state.monitor_update_blocked_actions.entry(chan_id).or_insert(Vec::new()).push(action);
4814 let res = handle_new_monitor_update!(self, prev_hop.outpoint, monitor_update, peer_state_lock,
4815 peer_state, per_peer_state, chan);
4816 if let Err(e) = res {
4817 // TODO: This is a *critical* error - we probably updated the outbound edge
4818 // of the HTLC's monitor with a preimage. We should retry this monitor
4819 // update over and over again until morale improves.
4820 log_error!(self.logger, "Failed to update channel monitor with preimage {:?}", payment_preimage);
4821 return Err((counterparty_node_id, e));
4824 // If we're running during init we cannot update a monitor directly -
4825 // they probably haven't actually been loaded yet. Instead, push the
4826 // monitor update as a background event.
4827 self.pending_background_events.lock().unwrap().push(
4828 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
4829 counterparty_node_id,
4830 funding_txo: prev_hop.outpoint,
4831 update: monitor_update.clone(),
4839 let preimage_update = ChannelMonitorUpdate {
4840 update_id: CLOSED_CHANNEL_UPDATE_ID,
4841 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
4847 // We update the ChannelMonitor on the backward link, after
4848 // receiving an `update_fulfill_htlc` from the forward link.
4849 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, &preimage_update);
4850 if update_res != ChannelMonitorUpdateStatus::Completed {
4851 // TODO: This needs to be handled somehow - if we receive a monitor update
4852 // with a preimage we *must* somehow manage to propagate it to the upstream
4853 // channel, or we must have an ability to receive the same event and try
4854 // again on restart.
4855 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
4856 payment_preimage, update_res);
4859 // If we're running during init we cannot update a monitor directly - they probably
4860 // haven't actually been loaded yet. Instead, push the monitor update as a background
4862 // Note that while it's safe to use `ClosedMonitorUpdateRegeneratedOnStartup` here (the
4863 // channel is already closed) we need to ultimately handle the monitor update
4864 // completion action only after we've completed the monitor update. This is the only
4865 // way to guarantee this update *will* be regenerated on startup (otherwise if this was
4866 // from a forwarded HTLC the downstream preimage may be deleted before we claim
4867 // upstream). Thus, we need to transition to some new `BackgroundEvent` type which will
4868 // complete the monitor update completion action from `completion_action`.
4869 self.pending_background_events.lock().unwrap().push(
4870 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((
4871 prev_hop.outpoint, preimage_update,
4874 // Note that we do process the completion action here. This totally could be a
4875 // duplicate claim, but we have no way of knowing without interrogating the
4876 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
4877 // generally always allowed to be duplicative (and it's specifically noted in
4878 // `PaymentForwarded`).
4879 self.handle_monitor_update_completion_actions(completion_action(None));
4883 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
4884 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
4887 fn claim_funds_internal(&self, source: HTLCSource, payment_preimage: PaymentPreimage, forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, next_channel_id: [u8; 32]) {
4889 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
4890 debug_assert!(self.background_events_processed_since_startup.load(Ordering::Acquire),
4891 "We don't support claim_htlc claims during startup - monitors may not be available yet");
4892 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage, session_priv, path, from_onchain, &self.pending_events, &self.logger);
4894 HTLCSource::PreviousHopData(hop_data) => {
4895 let prev_outpoint = hop_data.outpoint;
4896 let res = self.claim_funds_from_hop(hop_data, payment_preimage,
4897 |htlc_claim_value_msat| {
4898 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
4899 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
4900 Some(claimed_htlc_value - forwarded_htlc_value)
4903 Some(MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
4904 event: events::Event::PaymentForwarded {
4906 claim_from_onchain_tx: from_onchain,
4907 prev_channel_id: Some(prev_outpoint.to_channel_id()),
4908 next_channel_id: Some(next_channel_id),
4909 outbound_amount_forwarded_msat: forwarded_htlc_value_msat,
4911 downstream_counterparty_and_funding_outpoint: None,
4915 if let Err((pk, err)) = res {
4916 let result: Result<(), _> = Err(err);
4917 let _ = handle_error!(self, result, pk);
4923 /// Gets the node_id held by this ChannelManager
4924 pub fn get_our_node_id(&self) -> PublicKey {
4925 self.our_network_pubkey.clone()
4928 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
4929 for action in actions.into_iter() {
4931 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
4932 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4933 if let Some(ClaimingPayment { amount_msat, payment_purpose: purpose, receiver_node_id }) = payment {
4934 self.pending_events.lock().unwrap().push_back((events::Event::PaymentClaimed {
4935 payment_hash, purpose, amount_msat, receiver_node_id: Some(receiver_node_id),
4939 MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
4940 event, downstream_counterparty_and_funding_outpoint
4942 self.pending_events.lock().unwrap().push_back((event, None));
4943 if let Some((node_id, funding_outpoint, blocker)) = downstream_counterparty_and_funding_outpoint {
4944 self.handle_monitor_update_release(node_id, funding_outpoint, Some(blocker));
4951 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
4952 /// update completion.
4953 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
4954 channel: &mut Channel<<SP::Target as SignerProvider>::Signer>, raa: Option<msgs::RevokeAndACK>,
4955 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
4956 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
4957 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
4958 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
4959 log_trace!(self.logger, "Handling channel resumption for channel {} with {} RAA, {} commitment update, {} pending forwards, {}broadcasting funding, {} channel ready, {} announcement",
4960 log_bytes!(channel.context.channel_id()),
4961 if raa.is_some() { "an" } else { "no" },
4962 if commitment_update.is_some() { "a" } else { "no" }, pending_forwards.len(),
4963 if funding_broadcastable.is_some() { "" } else { "not " },
4964 if channel_ready.is_some() { "sending" } else { "without" },
4965 if announcement_sigs.is_some() { "sending" } else { "without" });
4967 let mut htlc_forwards = None;
4969 let counterparty_node_id = channel.context.get_counterparty_node_id();
4970 if !pending_forwards.is_empty() {
4971 htlc_forwards = Some((channel.context.get_short_channel_id().unwrap_or(channel.context.outbound_scid_alias()),
4972 channel.context.get_funding_txo().unwrap(), channel.context.get_user_id(), pending_forwards));
4975 if let Some(msg) = channel_ready {
4976 send_channel_ready!(self, pending_msg_events, channel, msg);
4978 if let Some(msg) = announcement_sigs {
4979 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4980 node_id: counterparty_node_id,
4985 macro_rules! handle_cs { () => {
4986 if let Some(update) = commitment_update {
4987 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4988 node_id: counterparty_node_id,
4993 macro_rules! handle_raa { () => {
4994 if let Some(revoke_and_ack) = raa {
4995 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
4996 node_id: counterparty_node_id,
4997 msg: revoke_and_ack,
5002 RAACommitmentOrder::CommitmentFirst => {
5006 RAACommitmentOrder::RevokeAndACKFirst => {
5012 if let Some(tx) = funding_broadcastable {
5013 log_info!(self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
5014 self.tx_broadcaster.broadcast_transactions(&[&tx]);
5018 let mut pending_events = self.pending_events.lock().unwrap();
5019 emit_channel_pending_event!(pending_events, channel);
5020 emit_channel_ready_event!(pending_events, channel);
5026 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
5027 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
5029 let counterparty_node_id = match counterparty_node_id {
5030 Some(cp_id) => cp_id.clone(),
5032 // TODO: Once we can rely on the counterparty_node_id from the
5033 // monitor event, this and the id_to_peer map should be removed.
5034 let id_to_peer = self.id_to_peer.lock().unwrap();
5035 match id_to_peer.get(&funding_txo.to_channel_id()) {
5036 Some(cp_id) => cp_id.clone(),
5041 let per_peer_state = self.per_peer_state.read().unwrap();
5042 let mut peer_state_lock;
5043 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
5044 if peer_state_mutex_opt.is_none() { return }
5045 peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5046 let peer_state = &mut *peer_state_lock;
5048 if let Some(chan) = peer_state.channel_by_id.get_mut(&funding_txo.to_channel_id()) {
5051 let update_actions = peer_state.monitor_update_blocked_actions
5052 .remove(&funding_txo.to_channel_id()).unwrap_or(Vec::new());
5053 mem::drop(peer_state_lock);
5054 mem::drop(per_peer_state);
5055 self.handle_monitor_update_completion_actions(update_actions);
5058 let remaining_in_flight =
5059 if let Some(pending) = peer_state.in_flight_monitor_updates.get_mut(funding_txo) {
5060 pending.retain(|upd| upd.update_id > highest_applied_update_id);
5063 log_trace!(self.logger, "ChannelMonitor updated to {}. Current highest is {}. {} pending in-flight updates.",
5064 highest_applied_update_id, channel.context.get_latest_monitor_update_id(),
5065 remaining_in_flight);
5066 if !channel.is_awaiting_monitor_update() || channel.context.get_latest_monitor_update_id() != highest_applied_update_id {
5069 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, channel);
5072 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
5074 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
5075 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
5078 /// The `user_channel_id` parameter will be provided back in
5079 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5080 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5082 /// Note that this method will return an error and reject the channel, if it requires support
5083 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
5084 /// used to accept such channels.
5086 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5087 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5088 pub fn accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5089 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
5092 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
5093 /// it as confirmed immediately.
5095 /// The `user_channel_id` parameter will be provided back in
5096 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5097 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5099 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
5100 /// and (if the counterparty agrees), enables forwarding of payments immediately.
5102 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
5103 /// transaction and blindly assumes that it will eventually confirm.
5105 /// If it does not confirm before we decide to close the channel, or if the funding transaction
5106 /// does not pay to the correct script the correct amount, *you will lose funds*.
5108 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5109 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5110 pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5111 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
5114 fn do_accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
5115 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5117 let peers_without_funded_channels =
5118 self.peers_without_funded_channels(|peer| { peer.total_channel_count() > 0 });
5119 let per_peer_state = self.per_peer_state.read().unwrap();
5120 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5121 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
5122 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5123 let peer_state = &mut *peer_state_lock;
5124 let is_only_peer_channel = peer_state.total_channel_count() == 1;
5125 match peer_state.inbound_v1_channel_by_id.entry(temporary_channel_id.clone()) {
5126 hash_map::Entry::Occupied(mut channel) => {
5127 if !channel.get().is_awaiting_accept() {
5128 return Err(APIError::APIMisuseError { err: "The channel isn't currently awaiting to be accepted.".to_owned() });
5131 channel.get_mut().set_0conf();
5132 } else if channel.get().context.get_channel_type().requires_zero_conf() {
5133 let send_msg_err_event = events::MessageSendEvent::HandleError {
5134 node_id: channel.get().context.get_counterparty_node_id(),
5135 action: msgs::ErrorAction::SendErrorMessage{
5136 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
5139 peer_state.pending_msg_events.push(send_msg_err_event);
5140 let _ = remove_channel!(self, channel);
5141 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
5143 // If this peer already has some channels, a new channel won't increase our number of peers
5144 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
5145 // channels per-peer we can accept channels from a peer with existing ones.
5146 if is_only_peer_channel && peers_without_funded_channels >= MAX_UNFUNDED_CHANNEL_PEERS {
5147 let send_msg_err_event = events::MessageSendEvent::HandleError {
5148 node_id: channel.get().context.get_counterparty_node_id(),
5149 action: msgs::ErrorAction::SendErrorMessage{
5150 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "Have too many peers with unfunded channels, not accepting new ones".to_owned(), }
5153 peer_state.pending_msg_events.push(send_msg_err_event);
5154 let _ = remove_channel!(self, channel);
5155 return Err(APIError::APIMisuseError { err: "Too many peers with unfunded channels, refusing to accept new ones".to_owned() });
5159 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
5160 node_id: channel.get().context.get_counterparty_node_id(),
5161 msg: channel.get_mut().accept_inbound_channel(user_channel_id),
5164 hash_map::Entry::Vacant(_) => {
5165 return Err(APIError::ChannelUnavailable { err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*temporary_channel_id), counterparty_node_id) });
5171 /// Gets the number of peers which match the given filter and do not have any funded, outbound,
5172 /// or 0-conf channels.
5174 /// The filter is called for each peer and provided with the number of unfunded, inbound, and
5175 /// non-0-conf channels we have with the peer.
5176 fn peers_without_funded_channels<Filter>(&self, maybe_count_peer: Filter) -> usize
5177 where Filter: Fn(&PeerState<<SP::Target as SignerProvider>::Signer>) -> bool {
5178 let mut peers_without_funded_channels = 0;
5179 let best_block_height = self.best_block.read().unwrap().height();
5181 let peer_state_lock = self.per_peer_state.read().unwrap();
5182 for (_, peer_mtx) in peer_state_lock.iter() {
5183 let peer = peer_mtx.lock().unwrap();
5184 if !maybe_count_peer(&*peer) { continue; }
5185 let num_unfunded_channels = Self::unfunded_channel_count(&peer, best_block_height);
5186 if num_unfunded_channels == peer.total_channel_count() {
5187 peers_without_funded_channels += 1;
5191 return peers_without_funded_channels;
5194 fn unfunded_channel_count(
5195 peer: &PeerState<<SP::Target as SignerProvider>::Signer>, best_block_height: u32
5197 let mut num_unfunded_channels = 0;
5198 for (_, chan) in peer.channel_by_id.iter() {
5199 // This covers non-zero-conf inbound `Channel`s that we are currently monitoring, but those
5200 // which have not yet had any confirmations on-chain.
5201 if !chan.context.is_outbound() && chan.context.minimum_depth().unwrap_or(1) != 0 &&
5202 chan.context.get_funding_tx_confirmations(best_block_height) == 0
5204 num_unfunded_channels += 1;
5207 for (_, chan) in peer.inbound_v1_channel_by_id.iter() {
5208 if chan.context.minimum_depth().unwrap_or(1) != 0 {
5209 num_unfunded_channels += 1;
5212 num_unfunded_channels
5215 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
5216 if msg.chain_hash != self.genesis_hash {
5217 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
5220 if !self.default_configuration.accept_inbound_channels {
5221 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
5224 let mut random_bytes = [0u8; 16];
5225 random_bytes.copy_from_slice(&self.entropy_source.get_secure_random_bytes()[..16]);
5226 let user_channel_id = u128::from_be_bytes(random_bytes);
5227 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
5229 // Get the number of peers with channels, but without funded ones. We don't care too much
5230 // about peers that never open a channel, so we filter by peers that have at least one
5231 // channel, and then limit the number of those with unfunded channels.
5232 let channeled_peers_without_funding =
5233 self.peers_without_funded_channels(|node| node.total_channel_count() > 0);
5235 let per_peer_state = self.per_peer_state.read().unwrap();
5236 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5238 debug_assert!(false);
5239 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())
5241 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5242 let peer_state = &mut *peer_state_lock;
5244 // If this peer already has some channels, a new channel won't increase our number of peers
5245 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
5246 // channels per-peer we can accept channels from a peer with existing ones.
5247 if peer_state.total_channel_count() == 0 &&
5248 channeled_peers_without_funding >= MAX_UNFUNDED_CHANNEL_PEERS &&
5249 !self.default_configuration.manually_accept_inbound_channels
5251 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5252 "Have too many peers with unfunded channels, not accepting new ones".to_owned(),
5253 msg.temporary_channel_id.clone()));
5256 let best_block_height = self.best_block.read().unwrap().height();
5257 if Self::unfunded_channel_count(peer_state, best_block_height) >= MAX_UNFUNDED_CHANS_PER_PEER {
5258 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5259 format!("Refusing more than {} unfunded channels.", MAX_UNFUNDED_CHANS_PER_PEER),
5260 msg.temporary_channel_id.clone()));
5263 let mut channel = match InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
5264 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id,
5265 &self.default_configuration, best_block_height, &self.logger, outbound_scid_alias)
5268 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
5269 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
5273 let channel_id = channel.context.channel_id();
5274 let channel_exists = peer_state.has_channel(&channel_id);
5276 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
5277 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision for the same peer!".to_owned(), msg.temporary_channel_id.clone()))
5279 if !self.default_configuration.manually_accept_inbound_channels {
5280 let channel_type = channel.context.get_channel_type();
5281 if channel_type.requires_zero_conf() {
5282 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
5284 if channel_type.requires_anchors_zero_fee_htlc_tx() {
5285 return Err(MsgHandleErrInternal::send_err_msg_no_close("No channels with anchor outputs accepted".to_owned(), msg.temporary_channel_id.clone()));
5287 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
5288 node_id: counterparty_node_id.clone(),
5289 msg: channel.accept_inbound_channel(user_channel_id),
5292 let mut pending_events = self.pending_events.lock().unwrap();
5293 pending_events.push_back((events::Event::OpenChannelRequest {
5294 temporary_channel_id: msg.temporary_channel_id.clone(),
5295 counterparty_node_id: counterparty_node_id.clone(),
5296 funding_satoshis: msg.funding_satoshis,
5297 push_msat: msg.push_msat,
5298 channel_type: channel.context.get_channel_type().clone(),
5301 peer_state.inbound_v1_channel_by_id.insert(channel_id, channel);
5306 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
5307 let (value, output_script, user_id) = {
5308 let per_peer_state = self.per_peer_state.read().unwrap();
5309 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5311 debug_assert!(false);
5312 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)
5314 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5315 let peer_state = &mut *peer_state_lock;
5316 match peer_state.outbound_v1_channel_by_id.entry(msg.temporary_channel_id) {
5317 hash_map::Entry::Occupied(mut chan) => {
5318 try_v1_outbound_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &peer_state.latest_features), chan);
5319 (chan.get().context.get_value_satoshis(), chan.get().context.get_funding_redeemscript().to_v0_p2wsh(), chan.get().context.get_user_id())
5321 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))
5324 let mut pending_events = self.pending_events.lock().unwrap();
5325 pending_events.push_back((events::Event::FundingGenerationReady {
5326 temporary_channel_id: msg.temporary_channel_id,
5327 counterparty_node_id: *counterparty_node_id,
5328 channel_value_satoshis: value,
5330 user_channel_id: user_id,
5335 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
5336 let best_block = *self.best_block.read().unwrap();
5338 let per_peer_state = self.per_peer_state.read().unwrap();
5339 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5341 debug_assert!(false);
5342 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)
5345 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5346 let peer_state = &mut *peer_state_lock;
5347 let (chan, funding_msg, monitor) =
5348 match peer_state.inbound_v1_channel_by_id.remove(&msg.temporary_channel_id) {
5349 Some(inbound_chan) => {
5350 match inbound_chan.funding_created(msg, best_block, &self.signer_provider, &self.logger) {
5352 Err((mut inbound_chan, err)) => {
5353 // We've already removed this inbound channel from the map in `PeerState`
5354 // above so at this point we just need to clean up any lingering entries
5355 // concerning this channel as it is safe to do so.
5356 update_maps_on_chan_removal!(self, &inbound_chan.context);
5357 let user_id = inbound_chan.context.get_user_id();
5358 let shutdown_res = inbound_chan.context.force_shutdown(false);
5359 return Err(MsgHandleErrInternal::from_finish_shutdown(format!("{}", err),
5360 msg.temporary_channel_id, user_id, shutdown_res, None));
5364 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))
5367 match peer_state.channel_by_id.entry(funding_msg.channel_id) {
5368 hash_map::Entry::Occupied(_) => {
5369 Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
5371 hash_map::Entry::Vacant(e) => {
5372 match self.id_to_peer.lock().unwrap().entry(chan.context.channel_id()) {
5373 hash_map::Entry::Occupied(_) => {
5374 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5375 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
5376 funding_msg.channel_id))
5378 hash_map::Entry::Vacant(i_e) => {
5379 i_e.insert(chan.context.get_counterparty_node_id());
5383 // There's no problem signing a counterparty's funding transaction if our monitor
5384 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
5385 // accepted payment from yet. We do, however, need to wait to send our channel_ready
5386 // until we have persisted our monitor.
5387 let new_channel_id = funding_msg.channel_id;
5388 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
5389 node_id: counterparty_node_id.clone(),
5393 let monitor_res = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
5395 let chan = e.insert(chan);
5396 let mut res = handle_new_monitor_update!(self, monitor_res, peer_state_lock, peer_state,
5397 per_peer_state, chan, MANUALLY_REMOVING_INITIAL_MONITOR,
5398 { peer_state.channel_by_id.remove(&new_channel_id) });
5400 // Note that we reply with the new channel_id in error messages if we gave up on the
5401 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
5402 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
5403 // any messages referencing a previously-closed channel anyway.
5404 // We do not propagate the monitor update to the user as it would be for a monitor
5405 // that we didn't manage to store (and that we don't care about - we don't respond
5406 // with the funding_signed so the channel can never go on chain).
5407 if let Err(MsgHandleErrInternal { shutdown_finish: Some((res, _)), .. }) = &mut res {
5415 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
5416 let best_block = *self.best_block.read().unwrap();
5417 let per_peer_state = self.per_peer_state.read().unwrap();
5418 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5420 debug_assert!(false);
5421 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5424 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5425 let peer_state = &mut *peer_state_lock;
5426 match peer_state.channel_by_id.entry(msg.channel_id) {
5427 hash_map::Entry::Occupied(mut chan) => {
5428 let monitor = try_chan_entry!(self,
5429 chan.get_mut().funding_signed(&msg, best_block, &self.signer_provider, &self.logger), chan);
5430 let update_res = self.chain_monitor.watch_channel(chan.get().context.get_funding_txo().unwrap(), monitor);
5431 let mut res = handle_new_monitor_update!(self, update_res, peer_state_lock, peer_state, per_peer_state, chan, INITIAL_MONITOR);
5432 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
5433 // We weren't able to watch the channel to begin with, so no updates should be made on
5434 // it. Previously, full_stack_target found an (unreachable) panic when the
5435 // monitor update contained within `shutdown_finish` was applied.
5436 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
5437 shutdown_finish.0.take();
5442 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5446 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
5447 let per_peer_state = self.per_peer_state.read().unwrap();
5448 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5450 debug_assert!(false);
5451 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5453 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5454 let peer_state = &mut *peer_state_lock;
5455 match peer_state.channel_by_id.entry(msg.channel_id) {
5456 hash_map::Entry::Occupied(mut chan) => {
5457 let announcement_sigs_opt = try_chan_entry!(self, chan.get_mut().channel_ready(&msg, &self.node_signer,
5458 self.genesis_hash.clone(), &self.default_configuration, &self.best_block.read().unwrap(), &self.logger), chan);
5459 if let Some(announcement_sigs) = announcement_sigs_opt {
5460 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(chan.get().context.channel_id()));
5461 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5462 node_id: counterparty_node_id.clone(),
5463 msg: announcement_sigs,
5465 } else if chan.get().context.is_usable() {
5466 // If we're sending an announcement_signatures, we'll send the (public)
5467 // channel_update after sending a channel_announcement when we receive our
5468 // counterparty's announcement_signatures. Thus, we only bother to send a
5469 // channel_update here if the channel is not public, i.e. we're not sending an
5470 // announcement_signatures.
5471 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", log_bytes!(chan.get().context.channel_id()));
5472 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
5473 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
5474 node_id: counterparty_node_id.clone(),
5481 let mut pending_events = self.pending_events.lock().unwrap();
5482 emit_channel_ready_event!(pending_events, chan.get_mut());
5487 hash_map::Entry::Vacant(_) => 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))
5491 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
5492 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
5493 let result: Result<(), _> = loop {
5494 let per_peer_state = self.per_peer_state.read().unwrap();
5495 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5497 debug_assert!(false);
5498 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5500 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5501 let peer_state = &mut *peer_state_lock;
5502 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
5503 hash_map::Entry::Occupied(mut chan_entry) => {
5505 if !chan_entry.get().received_shutdown() {
5506 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
5507 log_bytes!(msg.channel_id),
5508 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
5511 let funding_txo_opt = chan_entry.get().context.get_funding_txo();
5512 let (shutdown, monitor_update_opt, htlcs) = try_chan_entry!(self,
5513 chan_entry.get_mut().shutdown(&self.signer_provider, &peer_state.latest_features, &msg), chan_entry);
5514 dropped_htlcs = htlcs;
5516 if let Some(msg) = shutdown {
5517 // We can send the `shutdown` message before updating the `ChannelMonitor`
5518 // here as we don't need the monitor update to complete until we send a
5519 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
5520 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5521 node_id: *counterparty_node_id,
5526 // Update the monitor with the shutdown script if necessary.
5527 if let Some(monitor_update) = monitor_update_opt {
5528 break handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
5529 peer_state_lock, peer_state, per_peer_state, chan_entry).map(|_| ());
5533 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))
5536 for htlc_source in dropped_htlcs.drain(..) {
5537 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
5538 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
5539 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
5545 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
5546 let per_peer_state = self.per_peer_state.read().unwrap();
5547 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5549 debug_assert!(false);
5550 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5552 let (tx, chan_option) = {
5553 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5554 let peer_state = &mut *peer_state_lock;
5555 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
5556 hash_map::Entry::Occupied(mut chan_entry) => {
5557 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), chan_entry);
5558 if let Some(msg) = closing_signed {
5559 peer_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5560 node_id: counterparty_node_id.clone(),
5565 // We're done with this channel, we've got a signed closing transaction and
5566 // will send the closing_signed back to the remote peer upon return. This
5567 // also implies there are no pending HTLCs left on the channel, so we can
5568 // fully delete it from tracking (the channel monitor is still around to
5569 // watch for old state broadcasts)!
5570 (tx, Some(remove_channel!(self, chan_entry)))
5571 } else { (tx, None) }
5573 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))
5576 if let Some(broadcast_tx) = tx {
5577 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
5578 self.tx_broadcaster.broadcast_transactions(&[&broadcast_tx]);
5580 if let Some(chan) = chan_option {
5581 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5582 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5583 let peer_state = &mut *peer_state_lock;
5584 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5588 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
5593 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
5594 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
5595 //determine the state of the payment based on our response/if we forward anything/the time
5596 //we take to respond. We should take care to avoid allowing such an attack.
5598 //TODO: There exists a further attack where a node may garble the onion data, forward it to
5599 //us repeatedly garbled in different ways, and compare our error messages, which are
5600 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
5601 //but we should prevent it anyway.
5603 let decoded_hop_res = self.decode_update_add_htlc_onion(msg);
5604 let per_peer_state = self.per_peer_state.read().unwrap();
5605 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5607 debug_assert!(false);
5608 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5610 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5611 let peer_state = &mut *peer_state_lock;
5612 match peer_state.channel_by_id.entry(msg.channel_id) {
5613 hash_map::Entry::Occupied(mut chan) => {
5615 let pending_forward_info = match decoded_hop_res {
5616 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
5617 self.construct_pending_htlc_status(msg, shared_secret, next_hop,
5618 chan.get().context.config().accept_underpaying_htlcs, next_packet_pk_opt),
5619 Err(e) => PendingHTLCStatus::Fail(e)
5621 let create_pending_htlc_status = |chan: &Channel<<SP::Target as SignerProvider>::Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
5622 // If the update_add is completely bogus, the call will Err and we will close,
5623 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
5624 // want to reject the new HTLC and fail it backwards instead of forwarding.
5625 match pending_forward_info {
5626 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
5627 let reason = if (error_code & 0x1000) != 0 {
5628 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
5629 HTLCFailReason::reason(real_code, error_data)
5631 HTLCFailReason::from_failure_code(error_code)
5632 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
5633 let msg = msgs::UpdateFailHTLC {
5634 channel_id: msg.channel_id,
5635 htlc_id: msg.htlc_id,
5638 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
5640 _ => pending_forward_info
5643 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.fee_estimator, &self.logger), chan);
5645 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))
5650 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
5651 let (htlc_source, forwarded_htlc_value) = {
5652 let per_peer_state = self.per_peer_state.read().unwrap();
5653 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5655 debug_assert!(false);
5656 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5658 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5659 let peer_state = &mut *peer_state_lock;
5660 match peer_state.channel_by_id.entry(msg.channel_id) {
5661 hash_map::Entry::Occupied(mut chan) => {
5662 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), chan)
5664 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))
5667 self.claim_funds_internal(htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, msg.channel_id);
5671 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
5672 let per_peer_state = self.per_peer_state.read().unwrap();
5673 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5675 debug_assert!(false);
5676 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5678 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5679 let peer_state = &mut *peer_state_lock;
5680 match peer_state.channel_by_id.entry(msg.channel_id) {
5681 hash_map::Entry::Occupied(mut chan) => {
5682 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan);
5684 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))
5689 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
5690 let per_peer_state = self.per_peer_state.read().unwrap();
5691 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5693 debug_assert!(false);
5694 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5696 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5697 let peer_state = &mut *peer_state_lock;
5698 match peer_state.channel_by_id.entry(msg.channel_id) {
5699 hash_map::Entry::Occupied(mut chan) => {
5700 if (msg.failure_code & 0x8000) == 0 {
5701 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
5702 try_chan_entry!(self, Err(chan_err), chan);
5704 try_chan_entry!(self, chan.get_mut().update_fail_malformed_htlc(&msg, HTLCFailReason::reason(msg.failure_code, msg.sha256_of_onion.to_vec())), chan);
5707 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))
5711 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
5712 let per_peer_state = self.per_peer_state.read().unwrap();
5713 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5715 debug_assert!(false);
5716 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5718 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5719 let peer_state = &mut *peer_state_lock;
5720 match peer_state.channel_by_id.entry(msg.channel_id) {
5721 hash_map::Entry::Occupied(mut chan) => {
5722 let funding_txo = chan.get().context.get_funding_txo();
5723 let monitor_update_opt = try_chan_entry!(self, chan.get_mut().commitment_signed(&msg, &self.logger), chan);
5724 if let Some(monitor_update) = monitor_update_opt {
5725 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update, peer_state_lock,
5726 peer_state, per_peer_state, chan).map(|_| ())
5729 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))
5734 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
5735 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
5736 let mut push_forward_event = false;
5737 let mut new_intercept_events = VecDeque::new();
5738 let mut failed_intercept_forwards = Vec::new();
5739 if !pending_forwards.is_empty() {
5740 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
5741 let scid = match forward_info.routing {
5742 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
5743 PendingHTLCRouting::Receive { .. } => 0,
5744 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
5746 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
5747 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
5749 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
5750 let forward_htlcs_empty = forward_htlcs.is_empty();
5751 match forward_htlcs.entry(scid) {
5752 hash_map::Entry::Occupied(mut entry) => {
5753 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
5754 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
5756 hash_map::Entry::Vacant(entry) => {
5757 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
5758 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.genesis_hash)
5760 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).into_inner());
5761 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
5762 match pending_intercepts.entry(intercept_id) {
5763 hash_map::Entry::Vacant(entry) => {
5764 new_intercept_events.push_back((events::Event::HTLCIntercepted {
5765 requested_next_hop_scid: scid,
5766 payment_hash: forward_info.payment_hash,
5767 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
5768 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
5771 entry.insert(PendingAddHTLCInfo {
5772 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
5774 hash_map::Entry::Occupied(_) => {
5775 log_info!(self.logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
5776 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
5777 short_channel_id: prev_short_channel_id,
5778 outpoint: prev_funding_outpoint,
5779 htlc_id: prev_htlc_id,
5780 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
5781 phantom_shared_secret: None,
5784 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
5785 HTLCFailReason::from_failure_code(0x4000 | 10),
5786 HTLCDestination::InvalidForward { requested_forward_scid: scid },
5791 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
5792 // payments are being processed.
5793 if forward_htlcs_empty {
5794 push_forward_event = true;
5796 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
5797 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
5804 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
5805 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
5808 if !new_intercept_events.is_empty() {
5809 let mut events = self.pending_events.lock().unwrap();
5810 events.append(&mut new_intercept_events);
5812 if push_forward_event { self.push_pending_forwards_ev() }
5816 fn push_pending_forwards_ev(&self) {
5817 let mut pending_events = self.pending_events.lock().unwrap();
5818 let is_processing_events = self.pending_events_processor.load(Ordering::Acquire);
5819 let num_forward_events = pending_events.iter().filter(|(ev, _)|
5820 if let events::Event::PendingHTLCsForwardable { .. } = ev { true } else { false }
5822 // We only want to push a PendingHTLCsForwardable event if no others are queued. Processing
5823 // events is done in batches and they are not removed until we're done processing each
5824 // batch. Since handling a `PendingHTLCsForwardable` event will call back into the
5825 // `ChannelManager`, we'll still see the original forwarding event not removed. Phantom
5826 // payments will need an additional forwarding event before being claimed to make them look
5827 // real by taking more time.
5828 if (is_processing_events && num_forward_events <= 1) || num_forward_events < 1 {
5829 pending_events.push_back((Event::PendingHTLCsForwardable {
5830 time_forwardable: Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
5835 /// Checks whether [`ChannelMonitorUpdate`]s generated by the receipt of a remote
5836 /// [`msgs::RevokeAndACK`] should be held for the given channel until some other action
5837 /// completes. Note that this needs to happen in the same [`PeerState`] mutex as any release of
5838 /// the [`ChannelMonitorUpdate`] in question.
5839 fn raa_monitor_updates_held(&self,
5840 actions_blocking_raa_monitor_updates: &BTreeMap<[u8; 32], Vec<RAAMonitorUpdateBlockingAction>>,
5841 channel_funding_outpoint: OutPoint, counterparty_node_id: PublicKey
5843 actions_blocking_raa_monitor_updates
5844 .get(&channel_funding_outpoint.to_channel_id()).map(|v| !v.is_empty()).unwrap_or(false)
5845 || self.pending_events.lock().unwrap().iter().any(|(_, action)| {
5846 action == &Some(EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
5847 channel_funding_outpoint,
5848 counterparty_node_id,
5853 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
5854 let (htlcs_to_fail, res) = {
5855 let per_peer_state = self.per_peer_state.read().unwrap();
5856 let mut peer_state_lock = per_peer_state.get(counterparty_node_id)
5858 debug_assert!(false);
5859 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5860 }).map(|mtx| mtx.lock().unwrap())?;
5861 let peer_state = &mut *peer_state_lock;
5862 match peer_state.channel_by_id.entry(msg.channel_id) {
5863 hash_map::Entry::Occupied(mut chan) => {
5864 let funding_txo = chan.get().context.get_funding_txo();
5865 let (htlcs_to_fail, monitor_update_opt) = try_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &self.fee_estimator, &self.logger), chan);
5866 let res = if let Some(monitor_update) = monitor_update_opt {
5867 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update,
5868 peer_state_lock, peer_state, per_peer_state, chan).map(|_| ())
5870 (htlcs_to_fail, res)
5872 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))
5875 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
5879 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
5880 let per_peer_state = self.per_peer_state.read().unwrap();
5881 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5883 debug_assert!(false);
5884 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5886 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5887 let peer_state = &mut *peer_state_lock;
5888 match peer_state.channel_by_id.entry(msg.channel_id) {
5889 hash_map::Entry::Occupied(mut chan) => {
5890 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg, &self.logger), chan);
5892 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))
5897 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
5898 let per_peer_state = self.per_peer_state.read().unwrap();
5899 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5901 debug_assert!(false);
5902 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5904 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5905 let peer_state = &mut *peer_state_lock;
5906 match peer_state.channel_by_id.entry(msg.channel_id) {
5907 hash_map::Entry::Occupied(mut chan) => {
5908 if !chan.get().context.is_usable() {
5909 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
5912 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5913 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(
5914 &self.node_signer, self.genesis_hash.clone(), self.best_block.read().unwrap().height(),
5915 msg, &self.default_configuration
5917 // Note that announcement_signatures fails if the channel cannot be announced,
5918 // so get_channel_update_for_broadcast will never fail by the time we get here.
5919 update_msg: Some(self.get_channel_update_for_broadcast(chan.get()).unwrap()),
5922 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))
5927 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
5928 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
5929 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
5930 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
5932 // It's not a local channel
5933 return Ok(NotifyOption::SkipPersist)
5936 let per_peer_state = self.per_peer_state.read().unwrap();
5937 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
5938 if peer_state_mutex_opt.is_none() {
5939 return Ok(NotifyOption::SkipPersist)
5941 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5942 let peer_state = &mut *peer_state_lock;
5943 match peer_state.channel_by_id.entry(chan_id) {
5944 hash_map::Entry::Occupied(mut chan) => {
5945 if chan.get().context.get_counterparty_node_id() != *counterparty_node_id {
5946 if chan.get().context.should_announce() {
5947 // If the announcement is about a channel of ours which is public, some
5948 // other peer may simply be forwarding all its gossip to us. Don't provide
5949 // a scary-looking error message and return Ok instead.
5950 return Ok(NotifyOption::SkipPersist);
5952 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));
5954 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().context.get_counterparty_node_id().serialize()[..];
5955 let msg_from_node_one = msg.contents.flags & 1 == 0;
5956 if were_node_one == msg_from_node_one {
5957 return Ok(NotifyOption::SkipPersist);
5959 log_debug!(self.logger, "Received channel_update for channel {}.", log_bytes!(chan_id));
5960 try_chan_entry!(self, chan.get_mut().channel_update(&msg), chan);
5963 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersist)
5965 Ok(NotifyOption::DoPersist)
5968 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
5970 let need_lnd_workaround = {
5971 let per_peer_state = self.per_peer_state.read().unwrap();
5973 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5975 debug_assert!(false);
5976 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5978 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5979 let peer_state = &mut *peer_state_lock;
5980 match peer_state.channel_by_id.entry(msg.channel_id) {
5981 hash_map::Entry::Occupied(mut chan) => {
5982 // Currently, we expect all holding cell update_adds to be dropped on peer
5983 // disconnect, so Channel's reestablish will never hand us any holding cell
5984 // freed HTLCs to fail backwards. If in the future we no longer drop pending
5985 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
5986 let responses = try_chan_entry!(self, chan.get_mut().channel_reestablish(
5987 msg, &self.logger, &self.node_signer, self.genesis_hash,
5988 &self.default_configuration, &*self.best_block.read().unwrap()), chan);
5989 let mut channel_update = None;
5990 if let Some(msg) = responses.shutdown_msg {
5991 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5992 node_id: counterparty_node_id.clone(),
5995 } else if chan.get().context.is_usable() {
5996 // If the channel is in a usable state (ie the channel is not being shut
5997 // down), send a unicast channel_update to our counterparty to make sure
5998 // they have the latest channel parameters.
5999 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
6000 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
6001 node_id: chan.get().context.get_counterparty_node_id(),
6006 let need_lnd_workaround = chan.get_mut().context.workaround_lnd_bug_4006.take();
6007 htlc_forwards = self.handle_channel_resumption(
6008 &mut peer_state.pending_msg_events, chan.get_mut(), responses.raa, responses.commitment_update, responses.order,
6009 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
6010 if let Some(upd) = channel_update {
6011 peer_state.pending_msg_events.push(upd);
6015 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))
6019 if let Some(forwards) = htlc_forwards {
6020 self.forward_htlcs(&mut [forwards][..]);
6023 if let Some(channel_ready_msg) = need_lnd_workaround {
6024 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
6029 /// Process pending events from the [`chain::Watch`], returning whether any events were processed.
6030 fn process_pending_monitor_events(&self) -> bool {
6031 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
6033 let mut failed_channels = Vec::new();
6034 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
6035 let has_pending_monitor_events = !pending_monitor_events.is_empty();
6036 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
6037 for monitor_event in monitor_events.drain(..) {
6038 match monitor_event {
6039 MonitorEvent::HTLCEvent(htlc_update) => {
6040 if let Some(preimage) = htlc_update.payment_preimage {
6041 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
6042 self.claim_funds_internal(htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, funding_outpoint.to_channel_id());
6044 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
6045 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
6046 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
6047 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
6050 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
6051 MonitorEvent::UpdateFailed(funding_outpoint) => {
6052 let counterparty_node_id_opt = match counterparty_node_id {
6053 Some(cp_id) => Some(cp_id),
6055 // TODO: Once we can rely on the counterparty_node_id from the
6056 // monitor event, this and the id_to_peer map should be removed.
6057 let id_to_peer = self.id_to_peer.lock().unwrap();
6058 id_to_peer.get(&funding_outpoint.to_channel_id()).cloned()
6061 if let Some(counterparty_node_id) = counterparty_node_id_opt {
6062 let per_peer_state = self.per_peer_state.read().unwrap();
6063 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
6064 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6065 let peer_state = &mut *peer_state_lock;
6066 let pending_msg_events = &mut peer_state.pending_msg_events;
6067 if let hash_map::Entry::Occupied(chan_entry) = peer_state.channel_by_id.entry(funding_outpoint.to_channel_id()) {
6068 let mut chan = remove_channel!(self, chan_entry);
6069 failed_channels.push(chan.context.force_shutdown(false));
6070 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6071 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6075 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
6076 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
6078 ClosureReason::CommitmentTxConfirmed
6080 self.issue_channel_close_events(&chan.context, reason);
6081 pending_msg_events.push(events::MessageSendEvent::HandleError {
6082 node_id: chan.context.get_counterparty_node_id(),
6083 action: msgs::ErrorAction::SendErrorMessage {
6084 msg: msgs::ErrorMessage { channel_id: chan.context.channel_id(), data: "Channel force-closed".to_owned() }
6091 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
6092 self.channel_monitor_updated(&funding_txo, monitor_update_id, counterparty_node_id.as_ref());
6098 for failure in failed_channels.drain(..) {
6099 self.finish_force_close_channel(failure);
6102 has_pending_monitor_events
6105 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
6106 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
6107 /// update events as a separate process method here.
6109 pub fn process_monitor_events(&self) {
6110 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6111 self.process_pending_monitor_events();
6114 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
6115 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
6116 /// update was applied.
6117 fn check_free_holding_cells(&self) -> bool {
6118 let mut has_monitor_update = false;
6119 let mut failed_htlcs = Vec::new();
6120 let mut handle_errors = Vec::new();
6122 // Walk our list of channels and find any that need to update. Note that when we do find an
6123 // update, if it includes actions that must be taken afterwards, we have to drop the
6124 // per-peer state lock as well as the top level per_peer_state lock. Thus, we loop until we
6125 // manage to go through all our peers without finding a single channel to update.
6127 let per_peer_state = self.per_peer_state.read().unwrap();
6128 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6130 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6131 let peer_state: &mut PeerState<_> = &mut *peer_state_lock;
6132 for (channel_id, chan) in peer_state.channel_by_id.iter_mut() {
6133 let counterparty_node_id = chan.context.get_counterparty_node_id();
6134 let funding_txo = chan.context.get_funding_txo();
6135 let (monitor_opt, holding_cell_failed_htlcs) =
6136 chan.maybe_free_holding_cell_htlcs(&self.fee_estimator, &self.logger);
6137 if !holding_cell_failed_htlcs.is_empty() {
6138 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id, counterparty_node_id));
6140 if let Some(monitor_update) = monitor_opt {
6141 has_monitor_update = true;
6143 let channel_id: [u8; 32] = *channel_id;
6144 let res = handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update,
6145 peer_state_lock, peer_state, per_peer_state, chan, MANUALLY_REMOVING,
6146 peer_state.channel_by_id.remove(&channel_id));
6148 handle_errors.push((counterparty_node_id, res));
6150 continue 'peer_loop;
6159 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
6160 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
6161 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
6164 for (counterparty_node_id, err) in handle_errors.drain(..) {
6165 let _ = handle_error!(self, err, counterparty_node_id);
6171 /// Check whether any channels have finished removing all pending updates after a shutdown
6172 /// exchange and can now send a closing_signed.
6173 /// Returns whether any closing_signed messages were generated.
6174 fn maybe_generate_initial_closing_signed(&self) -> bool {
6175 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
6176 let mut has_update = false;
6178 let per_peer_state = self.per_peer_state.read().unwrap();
6180 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6181 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6182 let peer_state = &mut *peer_state_lock;
6183 let pending_msg_events = &mut peer_state.pending_msg_events;
6184 peer_state.channel_by_id.retain(|channel_id, chan| {
6185 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
6186 Ok((msg_opt, tx_opt)) => {
6187 if let Some(msg) = msg_opt {
6189 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
6190 node_id: chan.context.get_counterparty_node_id(), msg,
6193 if let Some(tx) = tx_opt {
6194 // We're done with this channel. We got a closing_signed and sent back
6195 // a closing_signed with a closing transaction to broadcast.
6196 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6197 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6202 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
6204 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
6205 self.tx_broadcaster.broadcast_transactions(&[&tx]);
6206 update_maps_on_chan_removal!(self, &chan.context);
6212 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
6213 handle_errors.push((chan.context.get_counterparty_node_id(), Err(res)));
6221 for (counterparty_node_id, err) in handle_errors.drain(..) {
6222 let _ = handle_error!(self, err, counterparty_node_id);
6228 /// Handle a list of channel failures during a block_connected or block_disconnected call,
6229 /// pushing the channel monitor update (if any) to the background events queue and removing the
6231 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
6232 for mut failure in failed_channels.drain(..) {
6233 // Either a commitment transactions has been confirmed on-chain or
6234 // Channel::block_disconnected detected that the funding transaction has been
6235 // reorganized out of the main chain.
6236 // We cannot broadcast our latest local state via monitor update (as
6237 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
6238 // so we track the update internally and handle it when the user next calls
6239 // timer_tick_occurred, guaranteeing we're running normally.
6240 if let Some((counterparty_node_id, funding_txo, update)) = failure.0.take() {
6241 assert_eq!(update.updates.len(), 1);
6242 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
6243 assert!(should_broadcast);
6244 } else { unreachable!(); }
6245 self.pending_background_events.lock().unwrap().push(
6246 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
6247 counterparty_node_id, funding_txo, update
6250 self.finish_force_close_channel(failure);
6254 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
6257 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
6258 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
6260 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
6261 /// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
6262 /// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
6263 /// passed directly to [`claim_funds`].
6265 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
6267 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
6268 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
6272 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
6273 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
6275 /// Errors if `min_value_msat` is greater than total bitcoin supply.
6277 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
6278 /// on versions of LDK prior to 0.0.114.
6280 /// [`claim_funds`]: Self::claim_funds
6281 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
6282 /// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
6283 /// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
6284 /// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
6285 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
6286 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
6287 min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
6288 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs,
6289 &self.entropy_source, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
6290 min_final_cltv_expiry_delta)
6293 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
6294 /// stored external to LDK.
6296 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
6297 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
6298 /// the `min_value_msat` provided here, if one is provided.
6300 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
6301 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
6304 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
6305 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
6306 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
6307 /// sender "proof-of-payment" unless they have paid the required amount.
6309 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
6310 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
6311 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
6312 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
6313 /// invoices when no timeout is set.
6315 /// Note that we use block header time to time-out pending inbound payments (with some margin
6316 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
6317 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
6318 /// If you need exact expiry semantics, you should enforce them upon receipt of
6319 /// [`PaymentClaimable`].
6321 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
6322 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
6324 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
6325 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
6329 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
6330 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
6332 /// Errors if `min_value_msat` is greater than total bitcoin supply.
6334 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
6335 /// on versions of LDK prior to 0.0.114.
6337 /// [`create_inbound_payment`]: Self::create_inbound_payment
6338 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
6339 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>,
6340 invoice_expiry_delta_secs: u32, min_final_cltv_expiry: Option<u16>) -> Result<PaymentSecret, ()> {
6341 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash,
6342 invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
6343 min_final_cltv_expiry)
6346 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
6347 /// previously returned from [`create_inbound_payment`].
6349 /// [`create_inbound_payment`]: Self::create_inbound_payment
6350 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
6351 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
6354 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
6355 /// are used when constructing the phantom invoice's route hints.
6357 /// [phantom node payments]: crate::sign::PhantomKeysManager
6358 pub fn get_phantom_scid(&self) -> u64 {
6359 let best_block_height = self.best_block.read().unwrap().height();
6360 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
6362 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
6363 // Ensure the generated scid doesn't conflict with a real channel.
6364 match short_to_chan_info.get(&scid_candidate) {
6365 Some(_) => continue,
6366 None => return scid_candidate
6371 /// Gets route hints for use in receiving [phantom node payments].
6373 /// [phantom node payments]: crate::sign::PhantomKeysManager
6374 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
6376 channels: self.list_usable_channels(),
6377 phantom_scid: self.get_phantom_scid(),
6378 real_node_pubkey: self.get_our_node_id(),
6382 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
6383 /// used when constructing the route hints for HTLCs intended to be intercepted. See
6384 /// [`ChannelManager::forward_intercepted_htlc`].
6386 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
6387 /// times to get a unique scid.
6388 pub fn get_intercept_scid(&self) -> u64 {
6389 let best_block_height = self.best_block.read().unwrap().height();
6390 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
6392 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
6393 // Ensure the generated scid doesn't conflict with a real channel.
6394 if short_to_chan_info.contains_key(&scid_candidate) { continue }
6395 return scid_candidate
6399 /// Gets inflight HTLC information by processing pending outbound payments that are in
6400 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
6401 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
6402 let mut inflight_htlcs = InFlightHtlcs::new();
6404 let per_peer_state = self.per_peer_state.read().unwrap();
6405 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6406 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6407 let peer_state = &mut *peer_state_lock;
6408 for chan in peer_state.channel_by_id.values() {
6409 for (htlc_source, _) in chan.inflight_htlc_sources() {
6410 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
6411 inflight_htlcs.process_path(path, self.get_our_node_id());
6420 #[cfg(any(test, feature = "_test_utils"))]
6421 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
6422 let events = core::cell::RefCell::new(Vec::new());
6423 let event_handler = |event: events::Event| events.borrow_mut().push(event);
6424 self.process_pending_events(&event_handler);
6428 #[cfg(feature = "_test_utils")]
6429 pub fn push_pending_event(&self, event: events::Event) {
6430 let mut events = self.pending_events.lock().unwrap();
6431 events.push_back((event, None));
6435 pub fn pop_pending_event(&self) -> Option<events::Event> {
6436 let mut events = self.pending_events.lock().unwrap();
6437 events.pop_front().map(|(e, _)| e)
6441 pub fn has_pending_payments(&self) -> bool {
6442 self.pending_outbound_payments.has_pending_payments()
6446 pub fn clear_pending_payments(&self) {
6447 self.pending_outbound_payments.clear_pending_payments()
6450 /// When something which was blocking a channel from updating its [`ChannelMonitor`] (e.g. an
6451 /// [`Event`] being handled) completes, this should be called to restore the channel to normal
6452 /// operation. It will double-check that nothing *else* is also blocking the same channel from
6453 /// making progress and then let any blocked [`ChannelMonitorUpdate`]s fly.
6454 fn handle_monitor_update_release(&self, counterparty_node_id: PublicKey, channel_funding_outpoint: OutPoint, mut completed_blocker: Option<RAAMonitorUpdateBlockingAction>) {
6455 let mut errors = Vec::new();
6457 let per_peer_state = self.per_peer_state.read().unwrap();
6458 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
6459 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
6460 let peer_state = &mut *peer_state_lck;
6462 if let Some(blocker) = completed_blocker.take() {
6463 // Only do this on the first iteration of the loop.
6464 if let Some(blockers) = peer_state.actions_blocking_raa_monitor_updates
6465 .get_mut(&channel_funding_outpoint.to_channel_id())
6467 blockers.retain(|iter| iter != &blocker);
6471 if self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
6472 channel_funding_outpoint, counterparty_node_id) {
6473 // Check that, while holding the peer lock, we don't have anything else
6474 // blocking monitor updates for this channel. If we do, release the monitor
6475 // update(s) when those blockers complete.
6476 log_trace!(self.logger, "Delaying monitor unlock for channel {} as another channel's mon update needs to complete first",
6477 log_bytes!(&channel_funding_outpoint.to_channel_id()[..]));
6481 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(channel_funding_outpoint.to_channel_id()) {
6482 debug_assert_eq!(chan.get().context.get_funding_txo().unwrap(), channel_funding_outpoint);
6483 if let Some((monitor_update, further_update_exists)) = chan.get_mut().unblock_next_blocked_monitor_update() {
6484 log_debug!(self.logger, "Unlocking monitor updating for channel {} and updating monitor",
6485 log_bytes!(&channel_funding_outpoint.to_channel_id()[..]));
6486 if let Err(e) = handle_new_monitor_update!(self, channel_funding_outpoint, monitor_update,
6487 peer_state_lck, peer_state, per_peer_state, chan)
6489 errors.push((e, counterparty_node_id));
6491 if further_update_exists {
6492 // If there are more `ChannelMonitorUpdate`s to process, restart at the
6497 log_trace!(self.logger, "Unlocked monitor updating for channel {} without monitors to update",
6498 log_bytes!(&channel_funding_outpoint.to_channel_id()[..]));
6502 log_debug!(self.logger,
6503 "Got a release post-RAA monitor update for peer {} but the channel is gone",
6504 log_pubkey!(counterparty_node_id));
6508 for (err, counterparty_node_id) in errors {
6509 let res = Err::<(), _>(err);
6510 let _ = handle_error!(self, res, counterparty_node_id);
6514 fn handle_post_event_actions(&self, actions: Vec<EventCompletionAction>) {
6515 for action in actions {
6517 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
6518 channel_funding_outpoint, counterparty_node_id
6520 self.handle_monitor_update_release(counterparty_node_id, channel_funding_outpoint, None);
6526 /// Processes any events asynchronously in the order they were generated since the last call
6527 /// using the given event handler.
6529 /// See the trait-level documentation of [`EventsProvider`] for requirements.
6530 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
6534 process_events_body!(self, ev, { handler(ev).await });
6538 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>
6540 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6541 T::Target: BroadcasterInterface,
6542 ES::Target: EntropySource,
6543 NS::Target: NodeSigner,
6544 SP::Target: SignerProvider,
6545 F::Target: FeeEstimator,
6549 /// Returns `MessageSendEvent`s strictly ordered per-peer, in the order they were generated.
6550 /// The returned array will contain `MessageSendEvent`s for different peers if
6551 /// `MessageSendEvent`s to more than one peer exists, but `MessageSendEvent`s to the same peer
6552 /// is always placed next to each other.
6554 /// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
6555 /// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
6556 /// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
6557 /// will randomly be placed first or last in the returned array.
6559 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
6560 /// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
6561 /// the `MessageSendEvent`s to the specific peer they were generated under.
6562 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
6563 let events = RefCell::new(Vec::new());
6564 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
6565 let mut result = self.process_background_events();
6567 // TODO: This behavior should be documented. It's unintuitive that we query
6568 // ChannelMonitors when clearing other events.
6569 if self.process_pending_monitor_events() {
6570 result = NotifyOption::DoPersist;
6573 if self.check_free_holding_cells() {
6574 result = NotifyOption::DoPersist;
6576 if self.maybe_generate_initial_closing_signed() {
6577 result = NotifyOption::DoPersist;
6580 let mut pending_events = Vec::new();
6581 let per_peer_state = self.per_peer_state.read().unwrap();
6582 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6583 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6584 let peer_state = &mut *peer_state_lock;
6585 if peer_state.pending_msg_events.len() > 0 {
6586 pending_events.append(&mut peer_state.pending_msg_events);
6590 if !pending_events.is_empty() {
6591 events.replace(pending_events);
6600 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>
6602 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6603 T::Target: BroadcasterInterface,
6604 ES::Target: EntropySource,
6605 NS::Target: NodeSigner,
6606 SP::Target: SignerProvider,
6607 F::Target: FeeEstimator,
6611 /// Processes events that must be periodically handled.
6613 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
6614 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
6615 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
6617 process_events_body!(self, ev, handler.handle_event(ev));
6621 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>
6623 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6624 T::Target: BroadcasterInterface,
6625 ES::Target: EntropySource,
6626 NS::Target: NodeSigner,
6627 SP::Target: SignerProvider,
6628 F::Target: FeeEstimator,
6632 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
6634 let best_block = self.best_block.read().unwrap();
6635 assert_eq!(best_block.block_hash(), header.prev_blockhash,
6636 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
6637 assert_eq!(best_block.height(), height - 1,
6638 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
6641 self.transactions_confirmed(header, txdata, height);
6642 self.best_block_updated(header, height);
6645 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
6646 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
6647 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
6648 let new_height = height - 1;
6650 let mut best_block = self.best_block.write().unwrap();
6651 assert_eq!(best_block.block_hash(), header.block_hash(),
6652 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
6653 assert_eq!(best_block.height(), height,
6654 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
6655 *best_block = BestBlock::new(header.prev_blockhash, new_height)
6658 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));
6662 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>
6664 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6665 T::Target: BroadcasterInterface,
6666 ES::Target: EntropySource,
6667 NS::Target: NodeSigner,
6668 SP::Target: SignerProvider,
6669 F::Target: FeeEstimator,
6673 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
6674 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
6675 // during initialization prior to the chain_monitor being fully configured in some cases.
6676 // See the docs for `ChannelManagerReadArgs` for more.
6678 let block_hash = header.block_hash();
6679 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
6681 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
6682 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
6683 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)
6684 .map(|(a, b)| (a, Vec::new(), b)));
6686 let last_best_block_height = self.best_block.read().unwrap().height();
6687 if height < last_best_block_height {
6688 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
6689 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));
6693 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
6694 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
6695 // during initialization prior to the chain_monitor being fully configured in some cases.
6696 // See the docs for `ChannelManagerReadArgs` for more.
6698 let block_hash = header.block_hash();
6699 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
6701 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
6702 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
6703 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
6705 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));
6707 macro_rules! max_time {
6708 ($timestamp: expr) => {
6710 // Update $timestamp to be the max of its current value and the block
6711 // timestamp. This should keep us close to the current time without relying on
6712 // having an explicit local time source.
6713 // Just in case we end up in a race, we loop until we either successfully
6714 // update $timestamp or decide we don't need to.
6715 let old_serial = $timestamp.load(Ordering::Acquire);
6716 if old_serial >= header.time as usize { break; }
6717 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
6723 max_time!(self.highest_seen_timestamp);
6724 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
6725 payment_secrets.retain(|_, inbound_payment| {
6726 inbound_payment.expiry_time > header.time as u64
6730 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
6731 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
6732 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
6733 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6734 let peer_state = &mut *peer_state_lock;
6735 for chan in peer_state.channel_by_id.values() {
6736 if let (Some(funding_txo), Some(block_hash)) = (chan.context.get_funding_txo(), chan.context.get_funding_tx_confirmed_in()) {
6737 res.push((funding_txo.txid, Some(block_hash)));
6744 fn transaction_unconfirmed(&self, txid: &Txid) {
6745 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
6746 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
6747 self.do_chain_event(None, |channel| {
6748 if let Some(funding_txo) = channel.context.get_funding_txo() {
6749 if funding_txo.txid == *txid {
6750 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
6751 } else { Ok((None, Vec::new(), None)) }
6752 } else { Ok((None, Vec::new(), None)) }
6757 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>
6759 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6760 T::Target: BroadcasterInterface,
6761 ES::Target: EntropySource,
6762 NS::Target: NodeSigner,
6763 SP::Target: SignerProvider,
6764 F::Target: FeeEstimator,
6768 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
6769 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
6771 fn do_chain_event<FN: Fn(&mut Channel<<SP::Target as SignerProvider>::Signer>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
6772 (&self, height_opt: Option<u32>, f: FN) {
6773 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
6774 // during initialization prior to the chain_monitor being fully configured in some cases.
6775 // See the docs for `ChannelManagerReadArgs` for more.
6777 let mut failed_channels = Vec::new();
6778 let mut timed_out_htlcs = Vec::new();
6780 let per_peer_state = self.per_peer_state.read().unwrap();
6781 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6782 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6783 let peer_state = &mut *peer_state_lock;
6784 let pending_msg_events = &mut peer_state.pending_msg_events;
6785 peer_state.channel_by_id.retain(|_, channel| {
6786 let res = f(channel);
6787 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
6788 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
6789 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
6790 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
6791 HTLCDestination::NextHopChannel { node_id: Some(channel.context.get_counterparty_node_id()), channel_id: channel.context.channel_id() }));
6793 if let Some(channel_ready) = channel_ready_opt {
6794 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
6795 if channel.context.is_usable() {
6796 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", log_bytes!(channel.context.channel_id()));
6797 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
6798 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
6799 node_id: channel.context.get_counterparty_node_id(),
6804 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", log_bytes!(channel.context.channel_id()));
6809 let mut pending_events = self.pending_events.lock().unwrap();
6810 emit_channel_ready_event!(pending_events, channel);
6813 if let Some(announcement_sigs) = announcement_sigs {
6814 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(channel.context.channel_id()));
6815 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
6816 node_id: channel.context.get_counterparty_node_id(),
6817 msg: announcement_sigs,
6819 if let Some(height) = height_opt {
6820 if let Some(announcement) = channel.get_signed_channel_announcement(&self.node_signer, self.genesis_hash, height, &self.default_configuration) {
6821 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
6823 // Note that announcement_signatures fails if the channel cannot be announced,
6824 // so get_channel_update_for_broadcast will never fail by the time we get here.
6825 update_msg: Some(self.get_channel_update_for_broadcast(channel).unwrap()),
6830 if channel.is_our_channel_ready() {
6831 if let Some(real_scid) = channel.context.get_short_channel_id() {
6832 // If we sent a 0conf channel_ready, and now have an SCID, we add it
6833 // to the short_to_chan_info map here. Note that we check whether we
6834 // can relay using the real SCID at relay-time (i.e.
6835 // enforce option_scid_alias then), and if the funding tx is ever
6836 // un-confirmed we force-close the channel, ensuring short_to_chan_info
6837 // is always consistent.
6838 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
6839 let scid_insert = short_to_chan_info.insert(real_scid, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
6840 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.context.get_counterparty_node_id(), channel.context.channel_id()),
6841 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
6842 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
6845 } else if let Err(reason) = res {
6846 update_maps_on_chan_removal!(self, &channel.context);
6847 // It looks like our counterparty went on-chain or funding transaction was
6848 // reorged out of the main chain. Close the channel.
6849 failed_channels.push(channel.context.force_shutdown(true));
6850 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
6851 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6855 let reason_message = format!("{}", reason);
6856 self.issue_channel_close_events(&channel.context, reason);
6857 pending_msg_events.push(events::MessageSendEvent::HandleError {
6858 node_id: channel.context.get_counterparty_node_id(),
6859 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
6860 channel_id: channel.context.channel_id(),
6861 data: reason_message,
6871 if let Some(height) = height_opt {
6872 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
6873 payment.htlcs.retain(|htlc| {
6874 // If height is approaching the number of blocks we think it takes us to get
6875 // our commitment transaction confirmed before the HTLC expires, plus the
6876 // number of blocks we generally consider it to take to do a commitment update,
6877 // just give up on it and fail the HTLC.
6878 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
6879 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
6880 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
6882 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
6883 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
6884 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
6888 !payment.htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
6891 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
6892 intercepted_htlcs.retain(|_, htlc| {
6893 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
6894 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
6895 short_channel_id: htlc.prev_short_channel_id,
6896 htlc_id: htlc.prev_htlc_id,
6897 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
6898 phantom_shared_secret: None,
6899 outpoint: htlc.prev_funding_outpoint,
6902 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
6903 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
6904 _ => unreachable!(),
6906 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
6907 HTLCFailReason::from_failure_code(0x2000 | 2),
6908 HTLCDestination::InvalidForward { requested_forward_scid }));
6909 log_trace!(self.logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
6915 self.handle_init_event_channel_failures(failed_channels);
6917 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
6918 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
6922 /// Gets a [`Future`] that completes when this [`ChannelManager`] needs to be persisted.
6924 /// Note that callbacks registered on the [`Future`] MUST NOT call back into this
6925 /// [`ChannelManager`] and should instead register actions to be taken later.
6927 pub fn get_persistable_update_future(&self) -> Future {
6928 self.persistence_notifier.get_future()
6931 #[cfg(any(test, feature = "_test_utils"))]
6932 pub fn get_persistence_condvar_value(&self) -> bool {
6933 self.persistence_notifier.notify_pending()
6936 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
6937 /// [`chain::Confirm`] interfaces.
6938 pub fn current_best_block(&self) -> BestBlock {
6939 self.best_block.read().unwrap().clone()
6942 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
6943 /// [`ChannelManager`].
6944 pub fn node_features(&self) -> NodeFeatures {
6945 provided_node_features(&self.default_configuration)
6948 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags which are provided by or required by
6949 /// [`ChannelManager`].
6951 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
6952 /// or not. Thus, this method is not public.
6953 #[cfg(any(feature = "_test_utils", test))]
6954 pub fn invoice_features(&self) -> Bolt11InvoiceFeatures {
6955 provided_invoice_features(&self.default_configuration)
6958 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
6959 /// [`ChannelManager`].
6960 pub fn channel_features(&self) -> ChannelFeatures {
6961 provided_channel_features(&self.default_configuration)
6964 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
6965 /// [`ChannelManager`].
6966 pub fn channel_type_features(&self) -> ChannelTypeFeatures {
6967 provided_channel_type_features(&self.default_configuration)
6970 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
6971 /// [`ChannelManager`].
6972 pub fn init_features(&self) -> InitFeatures {
6973 provided_init_features(&self.default_configuration)
6977 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
6978 ChannelMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
6980 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6981 T::Target: BroadcasterInterface,
6982 ES::Target: EntropySource,
6983 NS::Target: NodeSigner,
6984 SP::Target: SignerProvider,
6985 F::Target: FeeEstimator,
6989 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) {
6990 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6991 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, msg), *counterparty_node_id);
6994 fn handle_open_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
6995 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
6996 "Dual-funded channels not supported".to_owned(),
6997 msg.temporary_channel_id.clone())), *counterparty_node_id);
7000 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
7001 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7002 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, msg), *counterparty_node_id);
7005 fn handle_accept_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
7006 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7007 "Dual-funded channels not supported".to_owned(),
7008 msg.temporary_channel_id.clone())), *counterparty_node_id);
7011 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
7012 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7013 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
7016 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
7017 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7018 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
7021 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
7022 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7023 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
7026 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
7027 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7028 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
7031 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
7032 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7033 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
7036 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
7037 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7038 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
7041 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
7042 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7043 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
7046 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
7047 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7048 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
7051 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
7052 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7053 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
7056 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
7057 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7058 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
7061 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
7062 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7063 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
7066 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
7067 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7068 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
7071 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
7072 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7073 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
7076 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
7077 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
7078 let force_persist = self.process_background_events();
7079 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
7080 if force_persist == NotifyOption::DoPersist { NotifyOption::DoPersist } else { persist }
7082 NotifyOption::SkipPersist
7087 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
7088 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7089 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
7092 fn peer_disconnected(&self, counterparty_node_id: &PublicKey) {
7093 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7094 let mut failed_channels = Vec::new();
7095 let mut per_peer_state = self.per_peer_state.write().unwrap();
7097 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates.",
7098 log_pubkey!(counterparty_node_id));
7099 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
7100 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7101 let peer_state = &mut *peer_state_lock;
7102 let pending_msg_events = &mut peer_state.pending_msg_events;
7103 peer_state.channel_by_id.retain(|_, chan| {
7104 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
7105 if chan.is_shutdown() {
7106 update_maps_on_chan_removal!(self, &chan.context);
7107 self.issue_channel_close_events(&chan.context, ClosureReason::DisconnectedPeer);
7112 peer_state.inbound_v1_channel_by_id.retain(|_, chan| {
7113 update_maps_on_chan_removal!(self, &chan.context);
7114 self.issue_channel_close_events(&chan.context, ClosureReason::DisconnectedPeer);
7117 peer_state.outbound_v1_channel_by_id.retain(|_, chan| {
7118 update_maps_on_chan_removal!(self, &chan.context);
7119 self.issue_channel_close_events(&chan.context, ClosureReason::DisconnectedPeer);
7122 pending_msg_events.retain(|msg| {
7124 // V1 Channel Establishment
7125 &events::MessageSendEvent::SendAcceptChannel { .. } => false,
7126 &events::MessageSendEvent::SendOpenChannel { .. } => false,
7127 &events::MessageSendEvent::SendFundingCreated { .. } => false,
7128 &events::MessageSendEvent::SendFundingSigned { .. } => false,
7129 // V2 Channel Establishment
7130 &events::MessageSendEvent::SendAcceptChannelV2 { .. } => false,
7131 &events::MessageSendEvent::SendOpenChannelV2 { .. } => false,
7132 // Common Channel Establishment
7133 &events::MessageSendEvent::SendChannelReady { .. } => false,
7134 &events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
7135 // Interactive Transaction Construction
7136 &events::MessageSendEvent::SendTxAddInput { .. } => false,
7137 &events::MessageSendEvent::SendTxAddOutput { .. } => false,
7138 &events::MessageSendEvent::SendTxRemoveInput { .. } => false,
7139 &events::MessageSendEvent::SendTxRemoveOutput { .. } => false,
7140 &events::MessageSendEvent::SendTxComplete { .. } => false,
7141 &events::MessageSendEvent::SendTxSignatures { .. } => false,
7142 &events::MessageSendEvent::SendTxInitRbf { .. } => false,
7143 &events::MessageSendEvent::SendTxAckRbf { .. } => false,
7144 &events::MessageSendEvent::SendTxAbort { .. } => false,
7145 // Channel Operations
7146 &events::MessageSendEvent::UpdateHTLCs { .. } => false,
7147 &events::MessageSendEvent::SendRevokeAndACK { .. } => false,
7148 &events::MessageSendEvent::SendClosingSigned { .. } => false,
7149 &events::MessageSendEvent::SendShutdown { .. } => false,
7150 &events::MessageSendEvent::SendChannelReestablish { .. } => false,
7151 &events::MessageSendEvent::HandleError { .. } => false,
7153 &events::MessageSendEvent::SendChannelAnnouncement { .. } => false,
7154 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
7155 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
7156 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
7157 &events::MessageSendEvent::SendChannelUpdate { .. } => false,
7158 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
7159 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
7160 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
7161 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
7164 debug_assert!(peer_state.is_connected, "A disconnected peer cannot disconnect");
7165 peer_state.is_connected = false;
7166 peer_state.ok_to_remove(true)
7167 } else { debug_assert!(false, "Unconnected peer disconnected"); true }
7170 per_peer_state.remove(counterparty_node_id);
7172 mem::drop(per_peer_state);
7174 for failure in failed_channels.drain(..) {
7175 self.finish_force_close_channel(failure);
7179 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init, inbound: bool) -> Result<(), ()> {
7180 if !init_msg.features.supports_static_remote_key() {
7181 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting", log_pubkey!(counterparty_node_id));
7185 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7187 // If we have too many peers connected which don't have funded channels, disconnect the
7188 // peer immediately (as long as it doesn't have funded channels). If we have a bunch of
7189 // unfunded channels taking up space in memory for disconnected peers, we still let new
7190 // peers connect, but we'll reject new channels from them.
7191 let connected_peers_without_funded_channels = self.peers_without_funded_channels(|node| node.is_connected);
7192 let inbound_peer_limited = inbound && connected_peers_without_funded_channels >= MAX_NO_CHANNEL_PEERS;
7195 let mut peer_state_lock = self.per_peer_state.write().unwrap();
7196 match peer_state_lock.entry(counterparty_node_id.clone()) {
7197 hash_map::Entry::Vacant(e) => {
7198 if inbound_peer_limited {
7201 e.insert(Mutex::new(PeerState {
7202 channel_by_id: HashMap::new(),
7203 outbound_v1_channel_by_id: HashMap::new(),
7204 inbound_v1_channel_by_id: HashMap::new(),
7205 latest_features: init_msg.features.clone(),
7206 pending_msg_events: Vec::new(),
7207 in_flight_monitor_updates: BTreeMap::new(),
7208 monitor_update_blocked_actions: BTreeMap::new(),
7209 actions_blocking_raa_monitor_updates: BTreeMap::new(),
7213 hash_map::Entry::Occupied(e) => {
7214 let mut peer_state = e.get().lock().unwrap();
7215 peer_state.latest_features = init_msg.features.clone();
7217 let best_block_height = self.best_block.read().unwrap().height();
7218 if inbound_peer_limited &&
7219 Self::unfunded_channel_count(&*peer_state, best_block_height) ==
7220 peer_state.channel_by_id.len()
7225 debug_assert!(!peer_state.is_connected, "A peer shouldn't be connected twice");
7226 peer_state.is_connected = true;
7231 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
7233 let per_peer_state = self.per_peer_state.read().unwrap();
7234 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
7235 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7236 let peer_state = &mut *peer_state_lock;
7237 let pending_msg_events = &mut peer_state.pending_msg_events;
7239 // Since unfunded channel maps are cleared upon disconnecting a peer, and they're not persisted
7240 // (so won't be recovered after a crash) we don't need to bother closing unfunded channels and
7241 // clearing their maps here. Instead we can just send queue channel_reestablish messages for
7242 // channels in the channel_by_id map.
7243 peer_state.channel_by_id.iter_mut().for_each(|(_, chan)| {
7244 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
7245 node_id: chan.context.get_counterparty_node_id(),
7246 msg: chan.get_channel_reestablish(&self.logger),
7250 //TODO: Also re-broadcast announcement_signatures
7254 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
7255 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7257 if msg.channel_id == [0; 32] {
7258 let channel_ids: Vec<[u8; 32]> = {
7259 let per_peer_state = self.per_peer_state.read().unwrap();
7260 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
7261 if peer_state_mutex_opt.is_none() { return; }
7262 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
7263 let peer_state = &mut *peer_state_lock;
7264 peer_state.channel_by_id.keys().cloned()
7265 .chain(peer_state.outbound_v1_channel_by_id.keys().cloned())
7266 .chain(peer_state.inbound_v1_channel_by_id.keys().cloned()).collect()
7268 for channel_id in channel_ids {
7269 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
7270 let _ = self.force_close_channel_with_peer(&channel_id, counterparty_node_id, Some(&msg.data), true);
7274 // First check if we can advance the channel type and try again.
7275 let per_peer_state = self.per_peer_state.read().unwrap();
7276 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
7277 if peer_state_mutex_opt.is_none() { return; }
7278 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
7279 let peer_state = &mut *peer_state_lock;
7280 if let Some(chan) = peer_state.outbound_v1_channel_by_id.get_mut(&msg.channel_id) {
7281 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash, &self.fee_estimator) {
7282 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
7283 node_id: *counterparty_node_id,
7291 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
7292 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
7296 fn provided_node_features(&self) -> NodeFeatures {
7297 provided_node_features(&self.default_configuration)
7300 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
7301 provided_init_features(&self.default_configuration)
7304 fn get_genesis_hashes(&self) -> Option<Vec<ChainHash>> {
7305 Some(vec![ChainHash::from(&self.genesis_hash[..])])
7308 fn handle_tx_add_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddInput) {
7309 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7310 "Dual-funded channels not supported".to_owned(),
7311 msg.channel_id.clone())), *counterparty_node_id);
7314 fn handle_tx_add_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
7315 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7316 "Dual-funded channels not supported".to_owned(),
7317 msg.channel_id.clone())), *counterparty_node_id);
7320 fn handle_tx_remove_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
7321 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7322 "Dual-funded channels not supported".to_owned(),
7323 msg.channel_id.clone())), *counterparty_node_id);
7326 fn handle_tx_remove_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
7327 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7328 "Dual-funded channels not supported".to_owned(),
7329 msg.channel_id.clone())), *counterparty_node_id);
7332 fn handle_tx_complete(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxComplete) {
7333 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7334 "Dual-funded channels not supported".to_owned(),
7335 msg.channel_id.clone())), *counterparty_node_id);
7338 fn handle_tx_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxSignatures) {
7339 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7340 "Dual-funded channels not supported".to_owned(),
7341 msg.channel_id.clone())), *counterparty_node_id);
7344 fn handle_tx_init_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
7345 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7346 "Dual-funded channels not supported".to_owned(),
7347 msg.channel_id.clone())), *counterparty_node_id);
7350 fn handle_tx_ack_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
7351 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7352 "Dual-funded channels not supported".to_owned(),
7353 msg.channel_id.clone())), *counterparty_node_id);
7356 fn handle_tx_abort(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAbort) {
7357 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7358 "Dual-funded channels not supported".to_owned(),
7359 msg.channel_id.clone())), *counterparty_node_id);
7363 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
7364 /// [`ChannelManager`].
7365 pub(crate) fn provided_node_features(config: &UserConfig) -> NodeFeatures {
7366 provided_init_features(config).to_context()
7369 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags which are provided by or required by
7370 /// [`ChannelManager`].
7372 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
7373 /// or not. Thus, this method is not public.
7374 #[cfg(any(feature = "_test_utils", test))]
7375 pub(crate) fn provided_invoice_features(config: &UserConfig) -> Bolt11InvoiceFeatures {
7376 provided_init_features(config).to_context()
7379 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
7380 /// [`ChannelManager`].
7381 pub(crate) fn provided_channel_features(config: &UserConfig) -> ChannelFeatures {
7382 provided_init_features(config).to_context()
7385 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
7386 /// [`ChannelManager`].
7387 pub(crate) fn provided_channel_type_features(config: &UserConfig) -> ChannelTypeFeatures {
7388 ChannelTypeFeatures::from_init(&provided_init_features(config))
7391 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
7392 /// [`ChannelManager`].
7393 pub fn provided_init_features(config: &UserConfig) -> InitFeatures {
7394 // Note that if new features are added here which other peers may (eventually) require, we
7395 // should also add the corresponding (optional) bit to the [`ChannelMessageHandler`] impl for
7396 // [`ErroringMessageHandler`].
7397 let mut features = InitFeatures::empty();
7398 features.set_data_loss_protect_required();
7399 features.set_upfront_shutdown_script_optional();
7400 features.set_variable_length_onion_required();
7401 features.set_static_remote_key_required();
7402 features.set_payment_secret_required();
7403 features.set_basic_mpp_optional();
7404 features.set_wumbo_optional();
7405 features.set_shutdown_any_segwit_optional();
7406 features.set_channel_type_optional();
7407 features.set_scid_privacy_optional();
7408 features.set_zero_conf_optional();
7409 if config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx {
7410 features.set_anchors_zero_fee_htlc_tx_optional();
7415 const SERIALIZATION_VERSION: u8 = 1;
7416 const MIN_SERIALIZATION_VERSION: u8 = 1;
7418 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
7419 (2, fee_base_msat, required),
7420 (4, fee_proportional_millionths, required),
7421 (6, cltv_expiry_delta, required),
7424 impl_writeable_tlv_based!(ChannelCounterparty, {
7425 (2, node_id, required),
7426 (4, features, required),
7427 (6, unspendable_punishment_reserve, required),
7428 (8, forwarding_info, option),
7429 (9, outbound_htlc_minimum_msat, option),
7430 (11, outbound_htlc_maximum_msat, option),
7433 impl Writeable for ChannelDetails {
7434 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
7435 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
7436 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
7437 let user_channel_id_low = self.user_channel_id as u64;
7438 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
7439 write_tlv_fields!(writer, {
7440 (1, self.inbound_scid_alias, option),
7441 (2, self.channel_id, required),
7442 (3, self.channel_type, option),
7443 (4, self.counterparty, required),
7444 (5, self.outbound_scid_alias, option),
7445 (6, self.funding_txo, option),
7446 (7, self.config, option),
7447 (8, self.short_channel_id, option),
7448 (9, self.confirmations, option),
7449 (10, self.channel_value_satoshis, required),
7450 (12, self.unspendable_punishment_reserve, option),
7451 (14, user_channel_id_low, required),
7452 (16, self.balance_msat, required),
7453 (18, self.outbound_capacity_msat, required),
7454 (19, self.next_outbound_htlc_limit_msat, required),
7455 (20, self.inbound_capacity_msat, required),
7456 (21, self.next_outbound_htlc_minimum_msat, required),
7457 (22, self.confirmations_required, option),
7458 (24, self.force_close_spend_delay, option),
7459 (26, self.is_outbound, required),
7460 (28, self.is_channel_ready, required),
7461 (30, self.is_usable, required),
7462 (32, self.is_public, required),
7463 (33, self.inbound_htlc_minimum_msat, option),
7464 (35, self.inbound_htlc_maximum_msat, option),
7465 (37, user_channel_id_high_opt, option),
7466 (39, self.feerate_sat_per_1000_weight, option),
7467 (41, self.channel_shutdown_state, option),
7473 impl Readable for ChannelDetails {
7474 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
7475 _init_and_read_tlv_fields!(reader, {
7476 (1, inbound_scid_alias, option),
7477 (2, channel_id, required),
7478 (3, channel_type, option),
7479 (4, counterparty, required),
7480 (5, outbound_scid_alias, option),
7481 (6, funding_txo, option),
7482 (7, config, option),
7483 (8, short_channel_id, option),
7484 (9, confirmations, option),
7485 (10, channel_value_satoshis, required),
7486 (12, unspendable_punishment_reserve, option),
7487 (14, user_channel_id_low, required),
7488 (16, balance_msat, required),
7489 (18, outbound_capacity_msat, required),
7490 // Note that by the time we get past the required read above, outbound_capacity_msat will be
7491 // filled in, so we can safely unwrap it here.
7492 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
7493 (20, inbound_capacity_msat, required),
7494 (21, next_outbound_htlc_minimum_msat, (default_value, 0)),
7495 (22, confirmations_required, option),
7496 (24, force_close_spend_delay, option),
7497 (26, is_outbound, required),
7498 (28, is_channel_ready, required),
7499 (30, is_usable, required),
7500 (32, is_public, required),
7501 (33, inbound_htlc_minimum_msat, option),
7502 (35, inbound_htlc_maximum_msat, option),
7503 (37, user_channel_id_high_opt, option),
7504 (39, feerate_sat_per_1000_weight, option),
7505 (41, channel_shutdown_state, option),
7508 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
7509 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
7510 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
7511 let user_channel_id = user_channel_id_low as u128 +
7512 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
7516 channel_id: channel_id.0.unwrap(),
7518 counterparty: counterparty.0.unwrap(),
7519 outbound_scid_alias,
7523 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
7524 unspendable_punishment_reserve,
7526 balance_msat: balance_msat.0.unwrap(),
7527 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
7528 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
7529 next_outbound_htlc_minimum_msat: next_outbound_htlc_minimum_msat.0.unwrap(),
7530 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
7531 confirmations_required,
7533 force_close_spend_delay,
7534 is_outbound: is_outbound.0.unwrap(),
7535 is_channel_ready: is_channel_ready.0.unwrap(),
7536 is_usable: is_usable.0.unwrap(),
7537 is_public: is_public.0.unwrap(),
7538 inbound_htlc_minimum_msat,
7539 inbound_htlc_maximum_msat,
7540 feerate_sat_per_1000_weight,
7541 channel_shutdown_state,
7546 impl_writeable_tlv_based!(PhantomRouteHints, {
7547 (2, channels, required_vec),
7548 (4, phantom_scid, required),
7549 (6, real_node_pubkey, required),
7552 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
7554 (0, onion_packet, required),
7555 (2, short_channel_id, required),
7558 (0, payment_data, required),
7559 (1, phantom_shared_secret, option),
7560 (2, incoming_cltv_expiry, required),
7561 (3, payment_metadata, option),
7563 (2, ReceiveKeysend) => {
7564 (0, payment_preimage, required),
7565 (2, incoming_cltv_expiry, required),
7566 (3, payment_metadata, option),
7567 (4, payment_data, option), // Added in 0.0.116
7571 impl_writeable_tlv_based!(PendingHTLCInfo, {
7572 (0, routing, required),
7573 (2, incoming_shared_secret, required),
7574 (4, payment_hash, required),
7575 (6, outgoing_amt_msat, required),
7576 (8, outgoing_cltv_value, required),
7577 (9, incoming_amt_msat, option),
7578 (10, skimmed_fee_msat, option),
7582 impl Writeable for HTLCFailureMsg {
7583 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
7585 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
7587 channel_id.write(writer)?;
7588 htlc_id.write(writer)?;
7589 reason.write(writer)?;
7591 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
7592 channel_id, htlc_id, sha256_of_onion, failure_code
7595 channel_id.write(writer)?;
7596 htlc_id.write(writer)?;
7597 sha256_of_onion.write(writer)?;
7598 failure_code.write(writer)?;
7605 impl Readable for HTLCFailureMsg {
7606 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
7607 let id: u8 = Readable::read(reader)?;
7610 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
7611 channel_id: Readable::read(reader)?,
7612 htlc_id: Readable::read(reader)?,
7613 reason: Readable::read(reader)?,
7617 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
7618 channel_id: Readable::read(reader)?,
7619 htlc_id: Readable::read(reader)?,
7620 sha256_of_onion: Readable::read(reader)?,
7621 failure_code: Readable::read(reader)?,
7624 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
7625 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
7626 // messages contained in the variants.
7627 // In version 0.0.101, support for reading the variants with these types was added, and
7628 // we should migrate to writing these variants when UpdateFailHTLC or
7629 // UpdateFailMalformedHTLC get TLV fields.
7631 let length: BigSize = Readable::read(reader)?;
7632 let mut s = FixedLengthReader::new(reader, length.0);
7633 let res = Readable::read(&mut s)?;
7634 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
7635 Ok(HTLCFailureMsg::Relay(res))
7638 let length: BigSize = Readable::read(reader)?;
7639 let mut s = FixedLengthReader::new(reader, length.0);
7640 let res = Readable::read(&mut s)?;
7641 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
7642 Ok(HTLCFailureMsg::Malformed(res))
7644 _ => Err(DecodeError::UnknownRequiredFeature),
7649 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
7654 impl_writeable_tlv_based!(HTLCPreviousHopData, {
7655 (0, short_channel_id, required),
7656 (1, phantom_shared_secret, option),
7657 (2, outpoint, required),
7658 (4, htlc_id, required),
7659 (6, incoming_packet_shared_secret, required)
7662 impl Writeable for ClaimableHTLC {
7663 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
7664 let (payment_data, keysend_preimage) = match &self.onion_payload {
7665 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
7666 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
7668 write_tlv_fields!(writer, {
7669 (0, self.prev_hop, required),
7670 (1, self.total_msat, required),
7671 (2, self.value, required),
7672 (3, self.sender_intended_value, required),
7673 (4, payment_data, option),
7674 (5, self.total_value_received, option),
7675 (6, self.cltv_expiry, required),
7676 (8, keysend_preimage, option),
7677 (10, self.counterparty_skimmed_fee_msat, option),
7683 impl Readable for ClaimableHTLC {
7684 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
7685 _init_and_read_tlv_fields!(reader, {
7686 (0, prev_hop, required),
7687 (1, total_msat, option),
7688 (2, value_ser, required),
7689 (3, sender_intended_value, option),
7690 (4, payment_data_opt, option),
7691 (5, total_value_received, option),
7692 (6, cltv_expiry, required),
7693 (8, keysend_preimage, option),
7694 (10, counterparty_skimmed_fee_msat, option),
7696 let payment_data: Option<msgs::FinalOnionHopData> = payment_data_opt;
7697 let value = value_ser.0.unwrap();
7698 let onion_payload = match keysend_preimage {
7700 if payment_data.is_some() {
7701 return Err(DecodeError::InvalidValue)
7703 if total_msat.is_none() {
7704 total_msat = Some(value);
7706 OnionPayload::Spontaneous(p)
7709 if total_msat.is_none() {
7710 if payment_data.is_none() {
7711 return Err(DecodeError::InvalidValue)
7713 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
7715 OnionPayload::Invoice { _legacy_hop_data: payment_data }
7719 prev_hop: prev_hop.0.unwrap(),
7722 sender_intended_value: sender_intended_value.unwrap_or(value),
7723 total_value_received,
7724 total_msat: total_msat.unwrap(),
7726 cltv_expiry: cltv_expiry.0.unwrap(),
7727 counterparty_skimmed_fee_msat,
7732 impl Readable for HTLCSource {
7733 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
7734 let id: u8 = Readable::read(reader)?;
7737 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
7738 let mut first_hop_htlc_msat: u64 = 0;
7739 let mut path_hops = Vec::new();
7740 let mut payment_id = None;
7741 let mut payment_params: Option<PaymentParameters> = None;
7742 let mut blinded_tail: Option<BlindedTail> = None;
7743 read_tlv_fields!(reader, {
7744 (0, session_priv, required),
7745 (1, payment_id, option),
7746 (2, first_hop_htlc_msat, required),
7747 (4, path_hops, required_vec),
7748 (5, payment_params, (option: ReadableArgs, 0)),
7749 (6, blinded_tail, option),
7751 if payment_id.is_none() {
7752 // For backwards compat, if there was no payment_id written, use the session_priv bytes
7754 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
7756 let path = Path { hops: path_hops, blinded_tail };
7757 if path.hops.len() == 0 {
7758 return Err(DecodeError::InvalidValue);
7760 if let Some(params) = payment_params.as_mut() {
7761 if let Payee::Clear { ref mut final_cltv_expiry_delta, .. } = params.payee {
7762 if final_cltv_expiry_delta == &0 {
7763 *final_cltv_expiry_delta = path.final_cltv_expiry_delta().ok_or(DecodeError::InvalidValue)?;
7767 Ok(HTLCSource::OutboundRoute {
7768 session_priv: session_priv.0.unwrap(),
7769 first_hop_htlc_msat,
7771 payment_id: payment_id.unwrap(),
7774 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
7775 _ => Err(DecodeError::UnknownRequiredFeature),
7780 impl Writeable for HTLCSource {
7781 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
7783 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id } => {
7785 let payment_id_opt = Some(payment_id);
7786 write_tlv_fields!(writer, {
7787 (0, session_priv, required),
7788 (1, payment_id_opt, option),
7789 (2, first_hop_htlc_msat, required),
7790 // 3 was previously used to write a PaymentSecret for the payment.
7791 (4, path.hops, required_vec),
7792 (5, None::<PaymentParameters>, option), // payment_params in LDK versions prior to 0.0.115
7793 (6, path.blinded_tail, option),
7796 HTLCSource::PreviousHopData(ref field) => {
7798 field.write(writer)?;
7805 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
7806 (0, forward_info, required),
7807 (1, prev_user_channel_id, (default_value, 0)),
7808 (2, prev_short_channel_id, required),
7809 (4, prev_htlc_id, required),
7810 (6, prev_funding_outpoint, required),
7813 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
7815 (0, htlc_id, required),
7816 (2, err_packet, required),
7821 impl_writeable_tlv_based!(PendingInboundPayment, {
7822 (0, payment_secret, required),
7823 (2, expiry_time, required),
7824 (4, user_payment_id, required),
7825 (6, payment_preimage, required),
7826 (8, min_value_msat, required),
7829 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>
7831 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7832 T::Target: BroadcasterInterface,
7833 ES::Target: EntropySource,
7834 NS::Target: NodeSigner,
7835 SP::Target: SignerProvider,
7836 F::Target: FeeEstimator,
7840 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
7841 let _consistency_lock = self.total_consistency_lock.write().unwrap();
7843 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
7845 self.genesis_hash.write(writer)?;
7847 let best_block = self.best_block.read().unwrap();
7848 best_block.height().write(writer)?;
7849 best_block.block_hash().write(writer)?;
7852 let mut serializable_peer_count: u64 = 0;
7854 let per_peer_state = self.per_peer_state.read().unwrap();
7855 let mut unfunded_channels = 0;
7856 let mut number_of_channels = 0;
7857 for (_, peer_state_mutex) in per_peer_state.iter() {
7858 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7859 let peer_state = &mut *peer_state_lock;
7860 if !peer_state.ok_to_remove(false) {
7861 serializable_peer_count += 1;
7863 number_of_channels += peer_state.channel_by_id.len();
7864 for (_, channel) in peer_state.channel_by_id.iter() {
7865 if !channel.context.is_funding_initiated() {
7866 unfunded_channels += 1;
7871 ((number_of_channels - unfunded_channels) as u64).write(writer)?;
7873 for (_, peer_state_mutex) in per_peer_state.iter() {
7874 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7875 let peer_state = &mut *peer_state_lock;
7876 for (_, channel) in peer_state.channel_by_id.iter() {
7877 if channel.context.is_funding_initiated() {
7878 channel.write(writer)?;
7885 let forward_htlcs = self.forward_htlcs.lock().unwrap();
7886 (forward_htlcs.len() as u64).write(writer)?;
7887 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
7888 short_channel_id.write(writer)?;
7889 (pending_forwards.len() as u64).write(writer)?;
7890 for forward in pending_forwards {
7891 forward.write(writer)?;
7896 let per_peer_state = self.per_peer_state.write().unwrap();
7898 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
7899 let claimable_payments = self.claimable_payments.lock().unwrap();
7900 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
7902 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
7903 let mut htlc_onion_fields: Vec<&_> = Vec::new();
7904 (claimable_payments.claimable_payments.len() as u64).write(writer)?;
7905 for (payment_hash, payment) in claimable_payments.claimable_payments.iter() {
7906 payment_hash.write(writer)?;
7907 (payment.htlcs.len() as u64).write(writer)?;
7908 for htlc in payment.htlcs.iter() {
7909 htlc.write(writer)?;
7911 htlc_purposes.push(&payment.purpose);
7912 htlc_onion_fields.push(&payment.onion_fields);
7915 let mut monitor_update_blocked_actions_per_peer = None;
7916 let mut peer_states = Vec::new();
7917 for (_, peer_state_mutex) in per_peer_state.iter() {
7918 // Because we're holding the owning `per_peer_state` write lock here there's no chance
7919 // of a lockorder violation deadlock - no other thread can be holding any
7920 // per_peer_state lock at all.
7921 peer_states.push(peer_state_mutex.unsafe_well_ordered_double_lock_self());
7924 (serializable_peer_count).write(writer)?;
7925 for ((peer_pubkey, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
7926 // Peers which we have no channels to should be dropped once disconnected. As we
7927 // disconnect all peers when shutting down and serializing the ChannelManager, we
7928 // consider all peers as disconnected here. There's therefore no need write peers with
7930 if !peer_state.ok_to_remove(false) {
7931 peer_pubkey.write(writer)?;
7932 peer_state.latest_features.write(writer)?;
7933 if !peer_state.monitor_update_blocked_actions.is_empty() {
7934 monitor_update_blocked_actions_per_peer
7935 .get_or_insert_with(Vec::new)
7936 .push((*peer_pubkey, &peer_state.monitor_update_blocked_actions));
7941 let events = self.pending_events.lock().unwrap();
7942 // LDK versions prior to 0.0.115 don't support post-event actions, thus if there's no
7943 // actions at all, skip writing the required TLV. Otherwise, pre-0.0.115 versions will
7944 // refuse to read the new ChannelManager.
7945 let events_not_backwards_compatible = events.iter().any(|(_, action)| action.is_some());
7946 if events_not_backwards_compatible {
7947 // If we're gonna write a even TLV that will overwrite our events anyway we might as
7948 // well save the space and not write any events here.
7949 0u64.write(writer)?;
7951 (events.len() as u64).write(writer)?;
7952 for (event, _) in events.iter() {
7953 event.write(writer)?;
7957 // LDK versions prior to 0.0.116 wrote the `pending_background_events`
7958 // `MonitorUpdateRegeneratedOnStartup`s here, however there was never a reason to do so -
7959 // the closing monitor updates were always effectively replayed on startup (either directly
7960 // by calling `broadcast_latest_holder_commitment_txn` on a `ChannelMonitor` during
7961 // deserialization or, in 0.0.115, by regenerating the monitor update itself).
7962 0u64.write(writer)?;
7964 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
7965 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
7966 // likely to be identical.
7967 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
7968 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
7970 (pending_inbound_payments.len() as u64).write(writer)?;
7971 for (hash, pending_payment) in pending_inbound_payments.iter() {
7972 hash.write(writer)?;
7973 pending_payment.write(writer)?;
7976 // For backwards compat, write the session privs and their total length.
7977 let mut num_pending_outbounds_compat: u64 = 0;
7978 for (_, outbound) in pending_outbound_payments.iter() {
7979 if !outbound.is_fulfilled() && !outbound.abandoned() {
7980 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
7983 num_pending_outbounds_compat.write(writer)?;
7984 for (_, outbound) in pending_outbound_payments.iter() {
7986 PendingOutboundPayment::Legacy { session_privs } |
7987 PendingOutboundPayment::Retryable { session_privs, .. } => {
7988 for session_priv in session_privs.iter() {
7989 session_priv.write(writer)?;
7992 PendingOutboundPayment::Fulfilled { .. } => {},
7993 PendingOutboundPayment::Abandoned { .. } => {},
7997 // Encode without retry info for 0.0.101 compatibility.
7998 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
7999 for (id, outbound) in pending_outbound_payments.iter() {
8001 PendingOutboundPayment::Legacy { session_privs } |
8002 PendingOutboundPayment::Retryable { session_privs, .. } => {
8003 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
8009 let mut pending_intercepted_htlcs = None;
8010 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
8011 if our_pending_intercepts.len() != 0 {
8012 pending_intercepted_htlcs = Some(our_pending_intercepts);
8015 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
8016 if pending_claiming_payments.as_ref().unwrap().is_empty() {
8017 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
8018 // map. Thus, if there are no entries we skip writing a TLV for it.
8019 pending_claiming_payments = None;
8022 let mut in_flight_monitor_updates: Option<HashMap<(&PublicKey, &OutPoint), &Vec<ChannelMonitorUpdate>>> = None;
8023 for ((counterparty_id, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
8024 for (funding_outpoint, updates) in peer_state.in_flight_monitor_updates.iter() {
8025 if !updates.is_empty() {
8026 if in_flight_monitor_updates.is_none() { in_flight_monitor_updates = Some(HashMap::new()); }
8027 in_flight_monitor_updates.as_mut().unwrap().insert((counterparty_id, funding_outpoint), updates);
8032 write_tlv_fields!(writer, {
8033 (1, pending_outbound_payments_no_retry, required),
8034 (2, pending_intercepted_htlcs, option),
8035 (3, pending_outbound_payments, required),
8036 (4, pending_claiming_payments, option),
8037 (5, self.our_network_pubkey, required),
8038 (6, monitor_update_blocked_actions_per_peer, option),
8039 (7, self.fake_scid_rand_bytes, required),
8040 (8, if events_not_backwards_compatible { Some(&*events) } else { None }, option),
8041 (9, htlc_purposes, required_vec),
8042 (10, in_flight_monitor_updates, option),
8043 (11, self.probing_cookie_secret, required),
8044 (13, htlc_onion_fields, optional_vec),
8051 impl Writeable for VecDeque<(Event, Option<EventCompletionAction>)> {
8052 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
8053 (self.len() as u64).write(w)?;
8054 for (event, action) in self.iter() {
8057 #[cfg(debug_assertions)] {
8058 // Events are MaybeReadable, in some cases indicating that they shouldn't actually
8059 // be persisted and are regenerated on restart. However, if such an event has a
8060 // post-event-handling action we'll write nothing for the event and would have to
8061 // either forget the action or fail on deserialization (which we do below). Thus,
8062 // check that the event is sane here.
8063 let event_encoded = event.encode();
8064 let event_read: Option<Event> =
8065 MaybeReadable::read(&mut &event_encoded[..]).unwrap();
8066 if action.is_some() { assert!(event_read.is_some()); }
8072 impl Readable for VecDeque<(Event, Option<EventCompletionAction>)> {
8073 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8074 let len: u64 = Readable::read(reader)?;
8075 const MAX_ALLOC_SIZE: u64 = 1024 * 16;
8076 let mut events: Self = VecDeque::with_capacity(cmp::min(
8077 MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>() as u64,
8080 let ev_opt = MaybeReadable::read(reader)?;
8081 let action = Readable::read(reader)?;
8082 if let Some(ev) = ev_opt {
8083 events.push_back((ev, action));
8084 } else if action.is_some() {
8085 return Err(DecodeError::InvalidValue);
8092 impl_writeable_tlv_based_enum!(ChannelShutdownState,
8093 (0, NotShuttingDown) => {},
8094 (2, ShutdownInitiated) => {},
8095 (4, ResolvingHTLCs) => {},
8096 (6, NegotiatingClosingFee) => {},
8097 (8, ShutdownComplete) => {}, ;
8100 /// Arguments for the creation of a ChannelManager that are not deserialized.
8102 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
8104 /// 1) Deserialize all stored [`ChannelMonitor`]s.
8105 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
8106 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
8107 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
8108 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
8109 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
8110 /// same way you would handle a [`chain::Filter`] call using
8111 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
8112 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
8113 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
8114 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
8115 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
8116 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
8118 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
8119 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
8121 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
8122 /// call any other methods on the newly-deserialized [`ChannelManager`].
8124 /// Note that because some channels may be closed during deserialization, it is critical that you
8125 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
8126 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
8127 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
8128 /// not force-close the same channels but consider them live), you may end up revoking a state for
8129 /// which you've already broadcasted the transaction.
8131 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
8132 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8134 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8135 T::Target: BroadcasterInterface,
8136 ES::Target: EntropySource,
8137 NS::Target: NodeSigner,
8138 SP::Target: SignerProvider,
8139 F::Target: FeeEstimator,
8143 /// A cryptographically secure source of entropy.
8144 pub entropy_source: ES,
8146 /// A signer that is able to perform node-scoped cryptographic operations.
8147 pub node_signer: NS,
8149 /// The keys provider which will give us relevant keys. Some keys will be loaded during
8150 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
8152 pub signer_provider: SP,
8154 /// The fee_estimator for use in the ChannelManager in the future.
8156 /// No calls to the FeeEstimator will be made during deserialization.
8157 pub fee_estimator: F,
8158 /// The chain::Watch for use in the ChannelManager in the future.
8160 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
8161 /// you have deserialized ChannelMonitors separately and will add them to your
8162 /// chain::Watch after deserializing this ChannelManager.
8163 pub chain_monitor: M,
8165 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
8166 /// used to broadcast the latest local commitment transactions of channels which must be
8167 /// force-closed during deserialization.
8168 pub tx_broadcaster: T,
8169 /// The router which will be used in the ChannelManager in the future for finding routes
8170 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
8172 /// No calls to the router will be made during deserialization.
8174 /// The Logger for use in the ChannelManager and which may be used to log information during
8175 /// deserialization.
8177 /// Default settings used for new channels. Any existing channels will continue to use the
8178 /// runtime settings which were stored when the ChannelManager was serialized.
8179 pub default_config: UserConfig,
8181 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
8182 /// value.context.get_funding_txo() should be the key).
8184 /// If a monitor is inconsistent with the channel state during deserialization the channel will
8185 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
8186 /// is true for missing channels as well. If there is a monitor missing for which we find
8187 /// channel data Err(DecodeError::InvalidValue) will be returned.
8189 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
8192 /// This is not exported to bindings users because we have no HashMap bindings
8193 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>,
8196 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8197 ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>
8199 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8200 T::Target: BroadcasterInterface,
8201 ES::Target: EntropySource,
8202 NS::Target: NodeSigner,
8203 SP::Target: SignerProvider,
8204 F::Target: FeeEstimator,
8208 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
8209 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
8210 /// populate a HashMap directly from C.
8211 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,
8212 mut channel_monitors: Vec<&'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>) -> Self {
8214 entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
8215 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
8220 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
8221 // SipmleArcChannelManager type:
8222 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8223 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, ES, NS, SP, F, R, L>>)
8225 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8226 T::Target: BroadcasterInterface,
8227 ES::Target: EntropySource,
8228 NS::Target: NodeSigner,
8229 SP::Target: SignerProvider,
8230 F::Target: FeeEstimator,
8234 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
8235 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)>::read(reader, args)?;
8236 Ok((blockhash, Arc::new(chan_manager)))
8240 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8241 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)
8243 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8244 T::Target: BroadcasterInterface,
8245 ES::Target: EntropySource,
8246 NS::Target: NodeSigner,
8247 SP::Target: SignerProvider,
8248 F::Target: FeeEstimator,
8252 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
8253 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
8255 let genesis_hash: BlockHash = Readable::read(reader)?;
8256 let best_block_height: u32 = Readable::read(reader)?;
8257 let best_block_hash: BlockHash = Readable::read(reader)?;
8259 let mut failed_htlcs = Vec::new();
8261 let channel_count: u64 = Readable::read(reader)?;
8262 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
8263 let mut peer_channels: HashMap<PublicKey, HashMap<[u8; 32], Channel<<SP::Target as SignerProvider>::Signer>>> = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8264 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8265 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8266 let mut channel_closures = VecDeque::new();
8267 let mut close_background_events = Vec::new();
8268 for _ in 0..channel_count {
8269 let mut channel: Channel<<SP::Target as SignerProvider>::Signer> = Channel::read(reader, (
8270 &args.entropy_source, &args.signer_provider, best_block_height, &provided_channel_type_features(&args.default_config)
8272 let funding_txo = channel.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
8273 funding_txo_set.insert(funding_txo.clone());
8274 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
8275 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
8276 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
8277 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
8278 channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
8279 // But if the channel is behind of the monitor, close the channel:
8280 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
8281 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
8282 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
8283 log_bytes!(channel.context.channel_id()), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
8284 let (monitor_update, mut new_failed_htlcs) = channel.context.force_shutdown(true);
8285 if let Some((counterparty_node_id, funding_txo, update)) = monitor_update {
8286 close_background_events.push(BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
8287 counterparty_node_id, funding_txo, update
8290 failed_htlcs.append(&mut new_failed_htlcs);
8291 channel_closures.push_back((events::Event::ChannelClosed {
8292 channel_id: channel.context.channel_id(),
8293 user_channel_id: channel.context.get_user_id(),
8294 reason: ClosureReason::OutdatedChannelManager
8296 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
8297 let mut found_htlc = false;
8298 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
8299 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
8302 // If we have some HTLCs in the channel which are not present in the newer
8303 // ChannelMonitor, they have been removed and should be failed back to
8304 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
8305 // were actually claimed we'd have generated and ensured the previous-hop
8306 // claim update ChannelMonitor updates were persisted prior to persising
8307 // the ChannelMonitor update for the forward leg, so attempting to fail the
8308 // backwards leg of the HTLC will simply be rejected.
8309 log_info!(args.logger,
8310 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
8311 log_bytes!(channel.context.channel_id()), log_bytes!(payment_hash.0));
8312 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8316 log_info!(args.logger, "Successfully loaded channel {} at update_id {} against monitor at update id {}",
8317 log_bytes!(channel.context.channel_id()), channel.context.get_latest_monitor_update_id(),
8318 monitor.get_latest_update_id());
8319 if let Some(short_channel_id) = channel.context.get_short_channel_id() {
8320 short_to_chan_info.insert(short_channel_id, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8322 if channel.context.is_funding_initiated() {
8323 id_to_peer.insert(channel.context.channel_id(), channel.context.get_counterparty_node_id());
8325 match peer_channels.entry(channel.context.get_counterparty_node_id()) {
8326 hash_map::Entry::Occupied(mut entry) => {
8327 let by_id_map = entry.get_mut();
8328 by_id_map.insert(channel.context.channel_id(), channel);
8330 hash_map::Entry::Vacant(entry) => {
8331 let mut by_id_map = HashMap::new();
8332 by_id_map.insert(channel.context.channel_id(), channel);
8333 entry.insert(by_id_map);
8337 } else if channel.is_awaiting_initial_mon_persist() {
8338 // If we were persisted and shut down while the initial ChannelMonitor persistence
8339 // was in-progress, we never broadcasted the funding transaction and can still
8340 // safely discard the channel.
8341 let _ = channel.context.force_shutdown(false);
8342 channel_closures.push_back((events::Event::ChannelClosed {
8343 channel_id: channel.context.channel_id(),
8344 user_channel_id: channel.context.get_user_id(),
8345 reason: ClosureReason::DisconnectedPeer,
8348 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.context.channel_id()));
8349 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
8350 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
8351 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
8352 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");
8353 return Err(DecodeError::InvalidValue);
8357 for (funding_txo, _) in args.channel_monitors.iter() {
8358 if !funding_txo_set.contains(funding_txo) {
8359 log_info!(args.logger, "Queueing monitor update to ensure missing channel {} is force closed",
8360 log_bytes!(funding_txo.to_channel_id()));
8361 let monitor_update = ChannelMonitorUpdate {
8362 update_id: CLOSED_CHANNEL_UPDATE_ID,
8363 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast: true }],
8365 close_background_events.push(BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((*funding_txo, monitor_update)));
8369 const MAX_ALLOC_SIZE: usize = 1024 * 64;
8370 let forward_htlcs_count: u64 = Readable::read(reader)?;
8371 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
8372 for _ in 0..forward_htlcs_count {
8373 let short_channel_id = Readable::read(reader)?;
8374 let pending_forwards_count: u64 = Readable::read(reader)?;
8375 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
8376 for _ in 0..pending_forwards_count {
8377 pending_forwards.push(Readable::read(reader)?);
8379 forward_htlcs.insert(short_channel_id, pending_forwards);
8382 let claimable_htlcs_count: u64 = Readable::read(reader)?;
8383 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
8384 for _ in 0..claimable_htlcs_count {
8385 let payment_hash = Readable::read(reader)?;
8386 let previous_hops_len: u64 = Readable::read(reader)?;
8387 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
8388 for _ in 0..previous_hops_len {
8389 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
8391 claimable_htlcs_list.push((payment_hash, previous_hops));
8394 let peer_state_from_chans = |channel_by_id| {
8397 outbound_v1_channel_by_id: HashMap::new(),
8398 inbound_v1_channel_by_id: HashMap::new(),
8399 latest_features: InitFeatures::empty(),
8400 pending_msg_events: Vec::new(),
8401 in_flight_monitor_updates: BTreeMap::new(),
8402 monitor_update_blocked_actions: BTreeMap::new(),
8403 actions_blocking_raa_monitor_updates: BTreeMap::new(),
8404 is_connected: false,
8408 let peer_count: u64 = Readable::read(reader)?;
8409 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>)>()));
8410 for _ in 0..peer_count {
8411 let peer_pubkey = Readable::read(reader)?;
8412 let peer_chans = peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new());
8413 let mut peer_state = peer_state_from_chans(peer_chans);
8414 peer_state.latest_features = Readable::read(reader)?;
8415 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
8418 let event_count: u64 = Readable::read(reader)?;
8419 let mut pending_events_read: VecDeque<(events::Event, Option<EventCompletionAction>)> =
8420 VecDeque::with_capacity(cmp::min(event_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>()));
8421 for _ in 0..event_count {
8422 match MaybeReadable::read(reader)? {
8423 Some(event) => pending_events_read.push_back((event, None)),
8428 let background_event_count: u64 = Readable::read(reader)?;
8429 for _ in 0..background_event_count {
8430 match <u8 as Readable>::read(reader)? {
8432 // LDK versions prior to 0.0.116 wrote pending `MonitorUpdateRegeneratedOnStartup`s here,
8433 // however we really don't (and never did) need them - we regenerate all
8434 // on-startup monitor updates.
8435 let _: OutPoint = Readable::read(reader)?;
8436 let _: ChannelMonitorUpdate = Readable::read(reader)?;
8438 _ => return Err(DecodeError::InvalidValue),
8442 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
8443 let highest_seen_timestamp: u32 = Readable::read(reader)?;
8445 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
8446 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
8447 for _ in 0..pending_inbound_payment_count {
8448 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
8449 return Err(DecodeError::InvalidValue);
8453 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
8454 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
8455 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
8456 for _ in 0..pending_outbound_payments_count_compat {
8457 let session_priv = Readable::read(reader)?;
8458 let payment = PendingOutboundPayment::Legacy {
8459 session_privs: [session_priv].iter().cloned().collect()
8461 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
8462 return Err(DecodeError::InvalidValue)
8466 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
8467 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
8468 let mut pending_outbound_payments = None;
8469 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
8470 let mut received_network_pubkey: Option<PublicKey> = None;
8471 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
8472 let mut probing_cookie_secret: Option<[u8; 32]> = None;
8473 let mut claimable_htlc_purposes = None;
8474 let mut claimable_htlc_onion_fields = None;
8475 let mut pending_claiming_payments = Some(HashMap::new());
8476 let mut monitor_update_blocked_actions_per_peer: Option<Vec<(_, BTreeMap<_, Vec<_>>)>> = Some(Vec::new());
8477 let mut events_override = None;
8478 let mut in_flight_monitor_updates: Option<HashMap<(PublicKey, OutPoint), Vec<ChannelMonitorUpdate>>> = None;
8479 read_tlv_fields!(reader, {
8480 (1, pending_outbound_payments_no_retry, option),
8481 (2, pending_intercepted_htlcs, option),
8482 (3, pending_outbound_payments, option),
8483 (4, pending_claiming_payments, option),
8484 (5, received_network_pubkey, option),
8485 (6, monitor_update_blocked_actions_per_peer, option),
8486 (7, fake_scid_rand_bytes, option),
8487 (8, events_override, option),
8488 (9, claimable_htlc_purposes, optional_vec),
8489 (10, in_flight_monitor_updates, option),
8490 (11, probing_cookie_secret, option),
8491 (13, claimable_htlc_onion_fields, optional_vec),
8493 if fake_scid_rand_bytes.is_none() {
8494 fake_scid_rand_bytes = Some(args.entropy_source.get_secure_random_bytes());
8497 if probing_cookie_secret.is_none() {
8498 probing_cookie_secret = Some(args.entropy_source.get_secure_random_bytes());
8501 if let Some(events) = events_override {
8502 pending_events_read = events;
8505 if !channel_closures.is_empty() {
8506 pending_events_read.append(&mut channel_closures);
8509 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
8510 pending_outbound_payments = Some(pending_outbound_payments_compat);
8511 } else if pending_outbound_payments.is_none() {
8512 let mut outbounds = HashMap::new();
8513 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
8514 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
8516 pending_outbound_payments = Some(outbounds);
8518 let pending_outbounds = OutboundPayments {
8519 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
8520 retry_lock: Mutex::new(())
8523 // We have to replay (or skip, if they were completed after we wrote the `ChannelManager`)
8524 // each `ChannelMonitorUpdate` in `in_flight_monitor_updates`. After doing so, we have to
8525 // check that each channel we have isn't newer than the latest `ChannelMonitorUpdate`(s) we
8526 // replayed, and for each monitor update we have to replay we have to ensure there's a
8527 // `ChannelMonitor` for it.
8529 // In order to do so we first walk all of our live channels (so that we can check their
8530 // state immediately after doing the update replays, when we have the `update_id`s
8531 // available) and then walk any remaining in-flight updates.
8533 // Because the actual handling of the in-flight updates is the same, it's macro'ized here:
8534 let mut pending_background_events = Vec::new();
8535 macro_rules! handle_in_flight_updates {
8536 ($counterparty_node_id: expr, $chan_in_flight_upds: expr, $funding_txo: expr,
8537 $monitor: expr, $peer_state: expr, $channel_info_log: expr
8539 let mut max_in_flight_update_id = 0;
8540 $chan_in_flight_upds.retain(|upd| upd.update_id > $monitor.get_latest_update_id());
8541 for update in $chan_in_flight_upds.iter() {
8542 log_trace!(args.logger, "Replaying ChannelMonitorUpdate {} for {}channel {}",
8543 update.update_id, $channel_info_log, log_bytes!($funding_txo.to_channel_id()));
8544 max_in_flight_update_id = cmp::max(max_in_flight_update_id, update.update_id);
8545 pending_background_events.push(
8546 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
8547 counterparty_node_id: $counterparty_node_id,
8548 funding_txo: $funding_txo,
8549 update: update.clone(),
8552 if $chan_in_flight_upds.is_empty() {
8553 // We had some updates to apply, but it turns out they had completed before we
8554 // were serialized, we just weren't notified of that. Thus, we may have to run
8555 // the completion actions for any monitor updates, but otherwise are done.
8556 pending_background_events.push(
8557 BackgroundEvent::MonitorUpdatesComplete {
8558 counterparty_node_id: $counterparty_node_id,
8559 channel_id: $funding_txo.to_channel_id(),
8562 if $peer_state.in_flight_monitor_updates.insert($funding_txo, $chan_in_flight_upds).is_some() {
8563 log_error!(args.logger, "Duplicate in-flight monitor update set for the same channel!");
8564 return Err(DecodeError::InvalidValue);
8566 max_in_flight_update_id
8570 for (counterparty_id, peer_state_mtx) in per_peer_state.iter_mut() {
8571 let mut peer_state_lock = peer_state_mtx.lock().unwrap();
8572 let peer_state = &mut *peer_state_lock;
8573 for (_, chan) in peer_state.channel_by_id.iter() {
8574 // Channels that were persisted have to be funded, otherwise they should have been
8576 let funding_txo = chan.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
8577 let monitor = args.channel_monitors.get(&funding_txo)
8578 .expect("We already checked for monitor presence when loading channels");
8579 let mut max_in_flight_update_id = monitor.get_latest_update_id();
8580 if let Some(in_flight_upds) = &mut in_flight_monitor_updates {
8581 if let Some(mut chan_in_flight_upds) = in_flight_upds.remove(&(*counterparty_id, funding_txo)) {
8582 max_in_flight_update_id = cmp::max(max_in_flight_update_id,
8583 handle_in_flight_updates!(*counterparty_id, chan_in_flight_upds,
8584 funding_txo, monitor, peer_state, ""));
8587 if chan.get_latest_unblocked_monitor_update_id() > max_in_flight_update_id {
8588 // If the channel is ahead of the monitor, return InvalidValue:
8589 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
8590 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} with update_id through {} in-flight",
8591 log_bytes!(chan.context.channel_id()), monitor.get_latest_update_id(), max_in_flight_update_id);
8592 log_error!(args.logger, " but the ChannelManager is at update_id {}.", chan.get_latest_unblocked_monitor_update_id());
8593 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
8594 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
8595 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
8596 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");
8597 return Err(DecodeError::InvalidValue);
8602 if let Some(in_flight_upds) = in_flight_monitor_updates {
8603 for ((counterparty_id, funding_txo), mut chan_in_flight_updates) in in_flight_upds {
8604 if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
8605 // Now that we've removed all the in-flight monitor updates for channels that are
8606 // still open, we need to replay any monitor updates that are for closed channels,
8607 // creating the neccessary peer_state entries as we go.
8608 let peer_state_mutex = per_peer_state.entry(counterparty_id).or_insert_with(|| {
8609 Mutex::new(peer_state_from_chans(HashMap::new()))
8611 let mut peer_state = peer_state_mutex.lock().unwrap();
8612 handle_in_flight_updates!(counterparty_id, chan_in_flight_updates,
8613 funding_txo, monitor, peer_state, "closed ");
8615 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!");
8616 log_error!(args.logger, " The ChannelMonitor for channel {} is missing.",
8617 log_bytes!(funding_txo.to_channel_id()));
8618 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
8619 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
8620 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
8621 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");
8622 return Err(DecodeError::InvalidValue);
8627 // Note that we have to do the above replays before we push new monitor updates.
8628 pending_background_events.append(&mut close_background_events);
8630 // If there's any preimages for forwarded HTLCs hanging around in ChannelMonitors we
8631 // should ensure we try them again on the inbound edge. We put them here and do so after we
8632 // have a fully-constructed `ChannelManager` at the end.
8633 let mut pending_claims_to_replay = Vec::new();
8636 // If we're tracking pending payments, ensure we haven't lost any by looking at the
8637 // ChannelMonitor data for any channels for which we do not have authorative state
8638 // (i.e. those for which we just force-closed above or we otherwise don't have a
8639 // corresponding `Channel` at all).
8640 // This avoids several edge-cases where we would otherwise "forget" about pending
8641 // payments which are still in-flight via their on-chain state.
8642 // We only rebuild the pending payments map if we were most recently serialized by
8644 for (_, monitor) in args.channel_monitors.iter() {
8645 let counterparty_opt = id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id());
8646 if counterparty_opt.is_none() {
8647 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
8648 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
8649 if path.hops.is_empty() {
8650 log_error!(args.logger, "Got an empty path for a pending payment");
8651 return Err(DecodeError::InvalidValue);
8654 let path_amt = path.final_value_msat();
8655 let mut session_priv_bytes = [0; 32];
8656 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
8657 match pending_outbounds.pending_outbound_payments.lock().unwrap().entry(payment_id) {
8658 hash_map::Entry::Occupied(mut entry) => {
8659 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
8660 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
8661 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), log_bytes!(htlc.payment_hash.0));
8663 hash_map::Entry::Vacant(entry) => {
8664 let path_fee = path.fee_msat();
8665 entry.insert(PendingOutboundPayment::Retryable {
8666 retry_strategy: None,
8667 attempts: PaymentAttempts::new(),
8668 payment_params: None,
8669 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
8670 payment_hash: htlc.payment_hash,
8671 payment_secret: None, // only used for retries, and we'll never retry on startup
8672 payment_metadata: None, // only used for retries, and we'll never retry on startup
8673 keysend_preimage: None, // only used for retries, and we'll never retry on startup
8674 pending_amt_msat: path_amt,
8675 pending_fee_msat: Some(path_fee),
8676 total_msat: path_amt,
8677 starting_block_height: best_block_height,
8679 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
8680 path_amt, log_bytes!(htlc.payment_hash.0), log_bytes!(session_priv_bytes));
8685 for (htlc_source, (htlc, preimage_opt)) in monitor.get_all_current_outbound_htlcs() {
8687 HTLCSource::PreviousHopData(prev_hop_data) => {
8688 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
8689 info.prev_funding_outpoint == prev_hop_data.outpoint &&
8690 info.prev_htlc_id == prev_hop_data.htlc_id
8692 // The ChannelMonitor is now responsible for this HTLC's
8693 // failure/success and will let us know what its outcome is. If we
8694 // still have an entry for this HTLC in `forward_htlcs` or
8695 // `pending_intercepted_htlcs`, we were apparently not persisted after
8696 // the monitor was when forwarding the payment.
8697 forward_htlcs.retain(|_, forwards| {
8698 forwards.retain(|forward| {
8699 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
8700 if pending_forward_matches_htlc(&htlc_info) {
8701 log_info!(args.logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
8702 log_bytes!(htlc.payment_hash.0), log_bytes!(monitor.get_funding_txo().0.to_channel_id()));
8707 !forwards.is_empty()
8709 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
8710 if pending_forward_matches_htlc(&htlc_info) {
8711 log_info!(args.logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
8712 log_bytes!(htlc.payment_hash.0), log_bytes!(monitor.get_funding_txo().0.to_channel_id()));
8713 pending_events_read.retain(|(event, _)| {
8714 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
8715 intercepted_id != ev_id
8722 HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } => {
8723 if let Some(preimage) = preimage_opt {
8724 let pending_events = Mutex::new(pending_events_read);
8725 // Note that we set `from_onchain` to "false" here,
8726 // deliberately keeping the pending payment around forever.
8727 // Given it should only occur when we have a channel we're
8728 // force-closing for being stale that's okay.
8729 // The alternative would be to wipe the state when claiming,
8730 // generating a `PaymentPathSuccessful` event but regenerating
8731 // it and the `PaymentSent` on every restart until the
8732 // `ChannelMonitor` is removed.
8733 pending_outbounds.claim_htlc(payment_id, preimage, session_priv, path, false, &pending_events, &args.logger);
8734 pending_events_read = pending_events.into_inner().unwrap();
8741 // Whether the downstream channel was closed or not, try to re-apply any payment
8742 // preimages from it which may be needed in upstream channels for forwarded
8744 let outbound_claimed_htlcs_iter = monitor.get_all_current_outbound_htlcs()
8746 .filter_map(|(htlc_source, (htlc, preimage_opt))| {
8747 if let HTLCSource::PreviousHopData(_) = htlc_source {
8748 if let Some(payment_preimage) = preimage_opt {
8749 Some((htlc_source, payment_preimage, htlc.amount_msat,
8750 // Check if `counterparty_opt.is_none()` to see if the
8751 // downstream chan is closed (because we don't have a
8752 // channel_id -> peer map entry).
8753 counterparty_opt.is_none(),
8754 monitor.get_funding_txo().0.to_channel_id()))
8757 // If it was an outbound payment, we've handled it above - if a preimage
8758 // came in and we persisted the `ChannelManager` we either handled it and
8759 // are good to go or the channel force-closed - we don't have to handle the
8760 // channel still live case here.
8764 for tuple in outbound_claimed_htlcs_iter {
8765 pending_claims_to_replay.push(tuple);
8770 if !forward_htlcs.is_empty() || pending_outbounds.needs_abandon() {
8771 // If we have pending HTLCs to forward, assume we either dropped a
8772 // `PendingHTLCsForwardable` or the user received it but never processed it as they
8773 // shut down before the timer hit. Either way, set the time_forwardable to a small
8774 // constant as enough time has likely passed that we should simply handle the forwards
8775 // now, or at least after the user gets a chance to reconnect to our peers.
8776 pending_events_read.push_back((events::Event::PendingHTLCsForwardable {
8777 time_forwardable: Duration::from_secs(2),
8781 let inbound_pmt_key_material = args.node_signer.get_inbound_payment_key_material();
8782 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
8784 let mut claimable_payments = HashMap::with_capacity(claimable_htlcs_list.len());
8785 if let Some(purposes) = claimable_htlc_purposes {
8786 if purposes.len() != claimable_htlcs_list.len() {
8787 return Err(DecodeError::InvalidValue);
8789 if let Some(onion_fields) = claimable_htlc_onion_fields {
8790 if onion_fields.len() != claimable_htlcs_list.len() {
8791 return Err(DecodeError::InvalidValue);
8793 for (purpose, (onion, (payment_hash, htlcs))) in
8794 purposes.into_iter().zip(onion_fields.into_iter().zip(claimable_htlcs_list.into_iter()))
8796 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
8797 purpose, htlcs, onion_fields: onion,
8799 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
8802 for (purpose, (payment_hash, htlcs)) in purposes.into_iter().zip(claimable_htlcs_list.into_iter()) {
8803 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
8804 purpose, htlcs, onion_fields: None,
8806 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
8810 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
8811 // include a `_legacy_hop_data` in the `OnionPayload`.
8812 for (payment_hash, htlcs) in claimable_htlcs_list.drain(..) {
8813 if htlcs.is_empty() {
8814 return Err(DecodeError::InvalidValue);
8816 let purpose = match &htlcs[0].onion_payload {
8817 OnionPayload::Invoice { _legacy_hop_data } => {
8818 if let Some(hop_data) = _legacy_hop_data {
8819 events::PaymentPurpose::InvoicePayment {
8820 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
8821 Some(inbound_payment) => inbound_payment.payment_preimage,
8822 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
8823 Ok((payment_preimage, _)) => payment_preimage,
8825 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", log_bytes!(payment_hash.0));
8826 return Err(DecodeError::InvalidValue);
8830 payment_secret: hop_data.payment_secret,
8832 } else { return Err(DecodeError::InvalidValue); }
8834 OnionPayload::Spontaneous(payment_preimage) =>
8835 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
8837 claimable_payments.insert(payment_hash, ClaimablePayment {
8838 purpose, htlcs, onion_fields: None,
8843 let mut secp_ctx = Secp256k1::new();
8844 secp_ctx.seeded_randomize(&args.entropy_source.get_secure_random_bytes());
8846 let our_network_pubkey = match args.node_signer.get_node_id(Recipient::Node) {
8848 Err(()) => return Err(DecodeError::InvalidValue)
8850 if let Some(network_pubkey) = received_network_pubkey {
8851 if network_pubkey != our_network_pubkey {
8852 log_error!(args.logger, "Key that was generated does not match the existing key.");
8853 return Err(DecodeError::InvalidValue);
8857 let mut outbound_scid_aliases = HashSet::new();
8858 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
8859 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8860 let peer_state = &mut *peer_state_lock;
8861 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
8862 if chan.context.outbound_scid_alias() == 0 {
8863 let mut outbound_scid_alias;
8865 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
8866 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.entropy_source);
8867 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
8869 chan.context.set_outbound_scid_alias(outbound_scid_alias);
8870 } else if !outbound_scid_aliases.insert(chan.context.outbound_scid_alias()) {
8871 // Note that in rare cases its possible to hit this while reading an older
8872 // channel if we just happened to pick a colliding outbound alias above.
8873 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
8874 return Err(DecodeError::InvalidValue);
8876 if chan.context.is_usable() {
8877 if short_to_chan_info.insert(chan.context.outbound_scid_alias(), (chan.context.get_counterparty_node_id(), *chan_id)).is_some() {
8878 // Note that in rare cases its possible to hit this while reading an older
8879 // channel if we just happened to pick a colliding outbound alias above.
8880 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
8881 return Err(DecodeError::InvalidValue);
8887 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
8889 for (_, monitor) in args.channel_monitors.iter() {
8890 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
8891 if let Some(payment) = claimable_payments.remove(&payment_hash) {
8892 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", log_bytes!(payment_hash.0));
8893 let mut claimable_amt_msat = 0;
8894 let mut receiver_node_id = Some(our_network_pubkey);
8895 let phantom_shared_secret = payment.htlcs[0].prev_hop.phantom_shared_secret;
8896 if phantom_shared_secret.is_some() {
8897 let phantom_pubkey = args.node_signer.get_node_id(Recipient::PhantomNode)
8898 .expect("Failed to get node_id for phantom node recipient");
8899 receiver_node_id = Some(phantom_pubkey)
8901 for claimable_htlc in payment.htlcs {
8902 claimable_amt_msat += claimable_htlc.value;
8904 // Add a holding-cell claim of the payment to the Channel, which should be
8905 // applied ~immediately on peer reconnection. Because it won't generate a
8906 // new commitment transaction we can just provide the payment preimage to
8907 // the corresponding ChannelMonitor and nothing else.
8909 // We do so directly instead of via the normal ChannelMonitor update
8910 // procedure as the ChainMonitor hasn't yet been initialized, implying
8911 // we're not allowed to call it directly yet. Further, we do the update
8912 // without incrementing the ChannelMonitor update ID as there isn't any
8914 // If we were to generate a new ChannelMonitor update ID here and then
8915 // crash before the user finishes block connect we'd end up force-closing
8916 // this channel as well. On the flip side, there's no harm in restarting
8917 // without the new monitor persisted - we'll end up right back here on
8919 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
8920 if let Some(peer_node_id) = id_to_peer.get(&previous_channel_id){
8921 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
8922 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8923 let peer_state = &mut *peer_state_lock;
8924 if let Some(channel) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
8925 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
8928 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
8929 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
8932 pending_events_read.push_back((events::Event::PaymentClaimed {
8935 purpose: payment.purpose,
8936 amount_msat: claimable_amt_msat,
8942 for (node_id, monitor_update_blocked_actions) in monitor_update_blocked_actions_per_peer.unwrap() {
8943 if let Some(peer_state) = per_peer_state.get(&node_id) {
8944 for (_, actions) in monitor_update_blocked_actions.iter() {
8945 for action in actions.iter() {
8946 if let MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
8947 downstream_counterparty_and_funding_outpoint:
8948 Some((blocked_node_id, blocked_channel_outpoint, blocking_action)), ..
8950 if let Some(blocked_peer_state) = per_peer_state.get(&blocked_node_id) {
8951 blocked_peer_state.lock().unwrap().actions_blocking_raa_monitor_updates
8952 .entry(blocked_channel_outpoint.to_channel_id())
8953 .or_insert_with(Vec::new).push(blocking_action.clone());
8955 // If the channel we were blocking has closed, we don't need to
8956 // worry about it - the blocked monitor update should never have
8957 // been released from the `Channel` object so it can't have
8958 // completed, and if the channel closed there's no reason to bother
8964 peer_state.lock().unwrap().monitor_update_blocked_actions = monitor_update_blocked_actions;
8966 log_error!(args.logger, "Got blocked actions without a per-peer-state for {}", node_id);
8967 return Err(DecodeError::InvalidValue);
8971 let channel_manager = ChannelManager {
8973 fee_estimator: bounded_fee_estimator,
8974 chain_monitor: args.chain_monitor,
8975 tx_broadcaster: args.tx_broadcaster,
8976 router: args.router,
8978 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
8980 inbound_payment_key: expanded_inbound_key,
8981 pending_inbound_payments: Mutex::new(pending_inbound_payments),
8982 pending_outbound_payments: pending_outbounds,
8983 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
8985 forward_htlcs: Mutex::new(forward_htlcs),
8986 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments, pending_claiming_payments: pending_claiming_payments.unwrap() }),
8987 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
8988 id_to_peer: Mutex::new(id_to_peer),
8989 short_to_chan_info: FairRwLock::new(short_to_chan_info),
8990 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
8992 probing_cookie_secret: probing_cookie_secret.unwrap(),
8997 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
8999 per_peer_state: FairRwLock::new(per_peer_state),
9001 pending_events: Mutex::new(pending_events_read),
9002 pending_events_processor: AtomicBool::new(false),
9003 pending_background_events: Mutex::new(pending_background_events),
9004 total_consistency_lock: RwLock::new(()),
9005 background_events_processed_since_startup: AtomicBool::new(false),
9006 persistence_notifier: Notifier::new(),
9008 entropy_source: args.entropy_source,
9009 node_signer: args.node_signer,
9010 signer_provider: args.signer_provider,
9012 logger: args.logger,
9013 default_configuration: args.default_config,
9016 for htlc_source in failed_htlcs.drain(..) {
9017 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
9018 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
9019 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
9020 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
9023 for (source, preimage, downstream_value, downstream_closed, downstream_chan_id) in pending_claims_to_replay {
9024 // We use `downstream_closed` in place of `from_onchain` here just as a guess - we
9025 // don't remember in the `ChannelMonitor` where we got a preimage from, but if the
9026 // channel is closed we just assume that it probably came from an on-chain claim.
9027 channel_manager.claim_funds_internal(source, preimage, Some(downstream_value),
9028 downstream_closed, downstream_chan_id);
9031 //TODO: Broadcast channel update for closed channels, but only after we've made a
9032 //connection or two.
9034 Ok((best_block_hash.clone(), channel_manager))
9040 use bitcoin::hashes::Hash;
9041 use bitcoin::hashes::sha256::Hash as Sha256;
9042 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
9043 use core::sync::atomic::Ordering;
9044 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
9045 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
9046 use crate::ln::channelmanager::{inbound_payment, PaymentId, PaymentSendFailure, RecipientOnionFields, InterceptId};
9047 use crate::ln::functional_test_utils::*;
9048 use crate::ln::msgs::{self, ErrorAction};
9049 use crate::ln::msgs::ChannelMessageHandler;
9050 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
9051 use crate::util::errors::APIError;
9052 use crate::util::test_utils;
9053 use crate::util::config::{ChannelConfig, ChannelConfigUpdate};
9054 use crate::sign::EntropySource;
9057 fn test_notify_limits() {
9058 // Check that a few cases which don't require the persistence of a new ChannelManager,
9059 // indeed, do not cause the persistence of a new ChannelManager.
9060 let chanmon_cfgs = create_chanmon_cfgs(3);
9061 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9062 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9063 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9065 // All nodes start with a persistable update pending as `create_network` connects each node
9066 // with all other nodes to make most tests simpler.
9067 assert!(nodes[0].node.get_persistable_update_future().poll_is_complete());
9068 assert!(nodes[1].node.get_persistable_update_future().poll_is_complete());
9069 assert!(nodes[2].node.get_persistable_update_future().poll_is_complete());
9071 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1);
9073 // We check that the channel info nodes have doesn't change too early, even though we try
9074 // to connect messages with new values
9075 chan.0.contents.fee_base_msat *= 2;
9076 chan.1.contents.fee_base_msat *= 2;
9077 let node_a_chan_info = nodes[0].node.list_channels_with_counterparty(
9078 &nodes[1].node.get_our_node_id()).pop().unwrap();
9079 let node_b_chan_info = nodes[1].node.list_channels_with_counterparty(
9080 &nodes[0].node.get_our_node_id()).pop().unwrap();
9082 // The first two nodes (which opened a channel) should now require fresh persistence
9083 assert!(nodes[0].node.get_persistable_update_future().poll_is_complete());
9084 assert!(nodes[1].node.get_persistable_update_future().poll_is_complete());
9085 // ... but the last node should not.
9086 assert!(!nodes[2].node.get_persistable_update_future().poll_is_complete());
9087 // After persisting the first two nodes they should no longer need fresh persistence.
9088 assert!(!nodes[0].node.get_persistable_update_future().poll_is_complete());
9089 assert!(!nodes[1].node.get_persistable_update_future().poll_is_complete());
9091 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
9092 // about the channel.
9093 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
9094 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
9095 assert!(!nodes[2].node.get_persistable_update_future().poll_is_complete());
9097 // The nodes which are a party to the channel should also ignore messages from unrelated
9099 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
9100 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
9101 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
9102 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
9103 assert!(!nodes[0].node.get_persistable_update_future().poll_is_complete());
9104 assert!(!nodes[1].node.get_persistable_update_future().poll_is_complete());
9106 // At this point the channel info given by peers should still be the same.
9107 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
9108 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
9110 // An earlier version of handle_channel_update didn't check the directionality of the
9111 // update message and would always update the local fee info, even if our peer was
9112 // (spuriously) forwarding us our own channel_update.
9113 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
9114 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
9115 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
9117 // First deliver each peers' own message, checking that the node doesn't need to be
9118 // persisted and that its channel info remains the same.
9119 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
9120 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
9121 assert!(!nodes[0].node.get_persistable_update_future().poll_is_complete());
9122 assert!(!nodes[1].node.get_persistable_update_future().poll_is_complete());
9123 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
9124 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
9126 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
9127 // the channel info has updated.
9128 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
9129 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
9130 assert!(nodes[0].node.get_persistable_update_future().poll_is_complete());
9131 assert!(nodes[1].node.get_persistable_update_future().poll_is_complete());
9132 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
9133 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
9137 fn test_keysend_dup_hash_partial_mpp() {
9138 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
9140 let chanmon_cfgs = create_chanmon_cfgs(2);
9141 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9142 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9143 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9144 create_announced_chan_between_nodes(&nodes, 0, 1);
9146 // First, send a partial MPP payment.
9147 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
9148 let mut mpp_route = route.clone();
9149 mpp_route.paths.push(mpp_route.paths[0].clone());
9151 let payment_id = PaymentId([42; 32]);
9152 // Use the utility function send_payment_along_path to send the payment with MPP data which
9153 // indicates there are more HTLCs coming.
9154 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.
9155 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
9156 RecipientOnionFields::secret_only(payment_secret), payment_id, &mpp_route).unwrap();
9157 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[0], &our_payment_hash,
9158 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
9159 check_added_monitors!(nodes[0], 1);
9160 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9161 assert_eq!(events.len(), 1);
9162 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
9164 // Next, send a keysend payment with the same payment_hash and make sure it fails.
9165 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9166 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9167 check_added_monitors!(nodes[0], 1);
9168 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9169 assert_eq!(events.len(), 1);
9170 let ev = events.drain(..).next().unwrap();
9171 let payment_event = SendEvent::from_event(ev);
9172 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9173 check_added_monitors!(nodes[1], 0);
9174 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9175 expect_pending_htlcs_forwardable!(nodes[1]);
9176 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
9177 check_added_monitors!(nodes[1], 1);
9178 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9179 assert!(updates.update_add_htlcs.is_empty());
9180 assert!(updates.update_fulfill_htlcs.is_empty());
9181 assert_eq!(updates.update_fail_htlcs.len(), 1);
9182 assert!(updates.update_fail_malformed_htlcs.is_empty());
9183 assert!(updates.update_fee.is_none());
9184 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9185 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9186 expect_payment_failed!(nodes[0], our_payment_hash, true);
9188 // Send the second half of the original MPP payment.
9189 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[1], &our_payment_hash,
9190 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
9191 check_added_monitors!(nodes[0], 1);
9192 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9193 assert_eq!(events.len(), 1);
9194 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
9196 // Claim the full MPP payment. Note that we can't use a test utility like
9197 // claim_funds_along_route because the ordering of the messages causes the second half of the
9198 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
9199 // lightning messages manually.
9200 nodes[1].node.claim_funds(payment_preimage);
9201 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
9202 check_added_monitors!(nodes[1], 2);
9204 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9205 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
9206 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
9207 check_added_monitors!(nodes[0], 1);
9208 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9209 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
9210 check_added_monitors!(nodes[1], 1);
9211 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9212 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
9213 check_added_monitors!(nodes[1], 1);
9214 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
9215 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
9216 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
9217 check_added_monitors!(nodes[0], 1);
9218 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
9219 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
9220 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9221 check_added_monitors!(nodes[0], 1);
9222 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
9223 check_added_monitors!(nodes[1], 1);
9224 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
9225 check_added_monitors!(nodes[1], 1);
9226 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
9227 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
9228 check_added_monitors!(nodes[0], 1);
9230 // Note that successful MPP payments will generate a single PaymentSent event upon the first
9231 // path's success and a PaymentPathSuccessful event for each path's success.
9232 let events = nodes[0].node.get_and_clear_pending_events();
9233 assert_eq!(events.len(), 3);
9235 Event::PaymentSent { payment_id: ref id, payment_preimage: ref preimage, payment_hash: ref hash, .. } => {
9236 assert_eq!(Some(payment_id), *id);
9237 assert_eq!(payment_preimage, *preimage);
9238 assert_eq!(our_payment_hash, *hash);
9240 _ => panic!("Unexpected event"),
9243 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
9244 assert_eq!(payment_id, *actual_payment_id);
9245 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
9246 assert_eq!(route.paths[0], *path);
9248 _ => panic!("Unexpected event"),
9251 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
9252 assert_eq!(payment_id, *actual_payment_id);
9253 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
9254 assert_eq!(route.paths[0], *path);
9256 _ => panic!("Unexpected event"),
9261 fn test_keysend_dup_payment_hash() {
9262 do_test_keysend_dup_payment_hash(false);
9263 do_test_keysend_dup_payment_hash(true);
9266 fn do_test_keysend_dup_payment_hash(accept_mpp_keysend: bool) {
9267 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
9268 // outbound regular payment fails as expected.
9269 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
9270 // fails as expected.
9271 // (3): Test that a keysend payment with a duplicate payment hash to an existing keysend
9272 // payment fails as expected. When `accept_mpp_keysend` is false, this tests that we
9273 // reject MPP keysend payments, since in this case where the payment has no payment
9274 // secret, a keysend payment with a duplicate hash is basically an MPP keysend. If
9275 // `accept_mpp_keysend` is true, this tests that we only accept MPP keysends with
9276 // payment secrets and reject otherwise.
9277 let chanmon_cfgs = create_chanmon_cfgs(2);
9278 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9279 let mut mpp_keysend_cfg = test_default_channel_config();
9280 mpp_keysend_cfg.accept_mpp_keysend = accept_mpp_keysend;
9281 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(mpp_keysend_cfg)]);
9282 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9283 create_announced_chan_between_nodes(&nodes, 0, 1);
9284 let scorer = test_utils::TestScorer::new();
9285 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9287 // To start (1), send a regular payment but don't claim it.
9288 let expected_route = [&nodes[1]];
9289 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
9291 // Next, attempt a keysend payment and make sure it fails.
9292 let route_params = RouteParameters {
9293 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
9294 final_value_msat: 100_000,
9296 let route = find_route(
9297 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
9298 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
9300 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9301 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9302 check_added_monitors!(nodes[0], 1);
9303 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9304 assert_eq!(events.len(), 1);
9305 let ev = events.drain(..).next().unwrap();
9306 let payment_event = SendEvent::from_event(ev);
9307 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9308 check_added_monitors!(nodes[1], 0);
9309 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9310 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
9311 // fails), the second will process the resulting failure and fail the HTLC backward
9312 expect_pending_htlcs_forwardable!(nodes[1]);
9313 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9314 check_added_monitors!(nodes[1], 1);
9315 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9316 assert!(updates.update_add_htlcs.is_empty());
9317 assert!(updates.update_fulfill_htlcs.is_empty());
9318 assert_eq!(updates.update_fail_htlcs.len(), 1);
9319 assert!(updates.update_fail_malformed_htlcs.is_empty());
9320 assert!(updates.update_fee.is_none());
9321 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9322 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9323 expect_payment_failed!(nodes[0], payment_hash, true);
9325 // Finally, claim the original payment.
9326 claim_payment(&nodes[0], &expected_route, payment_preimage);
9328 // To start (2), send a keysend payment but don't claim it.
9329 let payment_preimage = PaymentPreimage([42; 32]);
9330 let route = find_route(
9331 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
9332 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
9334 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9335 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9336 check_added_monitors!(nodes[0], 1);
9337 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9338 assert_eq!(events.len(), 1);
9339 let event = events.pop().unwrap();
9340 let path = vec![&nodes[1]];
9341 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
9343 // Next, attempt a regular payment and make sure it fails.
9344 let payment_secret = PaymentSecret([43; 32]);
9345 nodes[0].node.send_payment_with_route(&route, payment_hash,
9346 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
9347 check_added_monitors!(nodes[0], 1);
9348 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9349 assert_eq!(events.len(), 1);
9350 let ev = events.drain(..).next().unwrap();
9351 let payment_event = SendEvent::from_event(ev);
9352 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9353 check_added_monitors!(nodes[1], 0);
9354 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9355 expect_pending_htlcs_forwardable!(nodes[1]);
9356 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9357 check_added_monitors!(nodes[1], 1);
9358 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9359 assert!(updates.update_add_htlcs.is_empty());
9360 assert!(updates.update_fulfill_htlcs.is_empty());
9361 assert_eq!(updates.update_fail_htlcs.len(), 1);
9362 assert!(updates.update_fail_malformed_htlcs.is_empty());
9363 assert!(updates.update_fee.is_none());
9364 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9365 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9366 expect_payment_failed!(nodes[0], payment_hash, true);
9368 // Finally, succeed the keysend payment.
9369 claim_payment(&nodes[0], &expected_route, payment_preimage);
9371 // To start (3), send a keysend payment but don't claim it.
9372 let payment_id_1 = PaymentId([44; 32]);
9373 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9374 RecipientOnionFields::spontaneous_empty(), payment_id_1).unwrap();
9375 check_added_monitors!(nodes[0], 1);
9376 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9377 assert_eq!(events.len(), 1);
9378 let event = events.pop().unwrap();
9379 let path = vec![&nodes[1]];
9380 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
9382 // Next, attempt a keysend payment and make sure it fails.
9383 let route_params = RouteParameters {
9384 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
9385 final_value_msat: 100_000,
9387 let route = find_route(
9388 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
9389 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
9391 let payment_id_2 = PaymentId([45; 32]);
9392 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9393 RecipientOnionFields::spontaneous_empty(), payment_id_2).unwrap();
9394 check_added_monitors!(nodes[0], 1);
9395 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9396 assert_eq!(events.len(), 1);
9397 let ev = events.drain(..).next().unwrap();
9398 let payment_event = SendEvent::from_event(ev);
9399 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9400 check_added_monitors!(nodes[1], 0);
9401 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9402 expect_pending_htlcs_forwardable!(nodes[1]);
9403 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9404 check_added_monitors!(nodes[1], 1);
9405 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9406 assert!(updates.update_add_htlcs.is_empty());
9407 assert!(updates.update_fulfill_htlcs.is_empty());
9408 assert_eq!(updates.update_fail_htlcs.len(), 1);
9409 assert!(updates.update_fail_malformed_htlcs.is_empty());
9410 assert!(updates.update_fee.is_none());
9411 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9412 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9413 expect_payment_failed!(nodes[0], payment_hash, true);
9415 // Finally, claim the original payment.
9416 claim_payment(&nodes[0], &expected_route, payment_preimage);
9420 fn test_keysend_hash_mismatch() {
9421 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
9422 // preimage doesn't match the msg's payment hash.
9423 let chanmon_cfgs = create_chanmon_cfgs(2);
9424 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9425 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9426 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9428 let payer_pubkey = nodes[0].node.get_our_node_id();
9429 let payee_pubkey = nodes[1].node.get_our_node_id();
9431 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
9432 let route_params = RouteParameters {
9433 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
9434 final_value_msat: 10_000,
9436 let network_graph = nodes[0].network_graph.clone();
9437 let first_hops = nodes[0].node.list_usable_channels();
9438 let scorer = test_utils::TestScorer::new();
9439 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9440 let route = find_route(
9441 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
9442 nodes[0].logger, &scorer, &(), &random_seed_bytes
9445 let test_preimage = PaymentPreimage([42; 32]);
9446 let mismatch_payment_hash = PaymentHash([43; 32]);
9447 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash,
9448 RecipientOnionFields::spontaneous_empty(), PaymentId(mismatch_payment_hash.0), &route).unwrap();
9449 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash,
9450 RecipientOnionFields::spontaneous_empty(), Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
9451 check_added_monitors!(nodes[0], 1);
9453 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9454 assert_eq!(updates.update_add_htlcs.len(), 1);
9455 assert!(updates.update_fulfill_htlcs.is_empty());
9456 assert!(updates.update_fail_htlcs.is_empty());
9457 assert!(updates.update_fail_malformed_htlcs.is_empty());
9458 assert!(updates.update_fee.is_none());
9459 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
9461 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "Payment preimage didn't match payment hash", 1);
9465 fn test_keysend_msg_with_secret_err() {
9466 // Test that we error as expected if we receive a keysend payment that includes a payment
9467 // secret when we don't support MPP keysend.
9468 let mut reject_mpp_keysend_cfg = test_default_channel_config();
9469 reject_mpp_keysend_cfg.accept_mpp_keysend = false;
9470 let chanmon_cfgs = create_chanmon_cfgs(2);
9471 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9472 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(reject_mpp_keysend_cfg)]);
9473 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9475 let payer_pubkey = nodes[0].node.get_our_node_id();
9476 let payee_pubkey = nodes[1].node.get_our_node_id();
9478 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
9479 let route_params = RouteParameters {
9480 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
9481 final_value_msat: 10_000,
9483 let network_graph = nodes[0].network_graph.clone();
9484 let first_hops = nodes[0].node.list_usable_channels();
9485 let scorer = test_utils::TestScorer::new();
9486 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9487 let route = find_route(
9488 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
9489 nodes[0].logger, &scorer, &(), &random_seed_bytes
9492 let test_preimage = PaymentPreimage([42; 32]);
9493 let test_secret = PaymentSecret([43; 32]);
9494 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
9495 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash,
9496 RecipientOnionFields::secret_only(test_secret), PaymentId(payment_hash.0), &route).unwrap();
9497 nodes[0].node.test_send_payment_internal(&route, payment_hash,
9498 RecipientOnionFields::secret_only(test_secret), Some(test_preimage),
9499 PaymentId(payment_hash.0), None, session_privs).unwrap();
9500 check_added_monitors!(nodes[0], 1);
9502 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9503 assert_eq!(updates.update_add_htlcs.len(), 1);
9504 assert!(updates.update_fulfill_htlcs.is_empty());
9505 assert!(updates.update_fail_htlcs.is_empty());
9506 assert!(updates.update_fail_malformed_htlcs.is_empty());
9507 assert!(updates.update_fee.is_none());
9508 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
9510 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "We don't support MPP keysend payments", 1);
9514 fn test_multi_hop_missing_secret() {
9515 let chanmon_cfgs = create_chanmon_cfgs(4);
9516 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
9517 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
9518 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
9520 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
9521 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
9522 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
9523 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
9525 // Marshall an MPP route.
9526 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
9527 let path = route.paths[0].clone();
9528 route.paths.push(path);
9529 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
9530 route.paths[0].hops[0].short_channel_id = chan_1_id;
9531 route.paths[0].hops[1].short_channel_id = chan_3_id;
9532 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
9533 route.paths[1].hops[0].short_channel_id = chan_2_id;
9534 route.paths[1].hops[1].short_channel_id = chan_4_id;
9536 match nodes[0].node.send_payment_with_route(&route, payment_hash,
9537 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0))
9539 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
9540 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err))
9542 _ => panic!("unexpected error")
9547 fn test_drop_disconnected_peers_when_removing_channels() {
9548 let chanmon_cfgs = create_chanmon_cfgs(2);
9549 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9550 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9551 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9553 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
9555 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
9556 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
9558 nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
9559 check_closed_broadcast!(nodes[0], true);
9560 check_added_monitors!(nodes[0], 1);
9561 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
9564 // Assert that nodes[1] is awaiting removal for nodes[0] once nodes[1] has been
9565 // disconnected and the channel between has been force closed.
9566 let nodes_0_per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
9567 // Assert that nodes[1] isn't removed before `timer_tick_occurred` has been executed.
9568 assert_eq!(nodes_0_per_peer_state.len(), 1);
9569 assert!(nodes_0_per_peer_state.get(&nodes[1].node.get_our_node_id()).is_some());
9572 nodes[0].node.timer_tick_occurred();
9575 // Assert that nodes[1] has now been removed.
9576 assert_eq!(nodes[0].node.per_peer_state.read().unwrap().len(), 0);
9581 fn bad_inbound_payment_hash() {
9582 // Add coverage for checking that a user-provided payment hash matches the payment secret.
9583 let chanmon_cfgs = create_chanmon_cfgs(2);
9584 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9585 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9586 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9588 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
9589 let payment_data = msgs::FinalOnionHopData {
9591 total_msat: 100_000,
9594 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
9595 // payment verification fails as expected.
9596 let mut bad_payment_hash = payment_hash.clone();
9597 bad_payment_hash.0[0] += 1;
9598 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) {
9599 Ok(_) => panic!("Unexpected ok"),
9601 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment", "Failing HTLC with user-generated payment_hash", 1);
9605 // Check that using the original payment hash succeeds.
9606 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());
9610 fn test_id_to_peer_coverage() {
9611 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
9612 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
9613 // the channel is successfully closed.
9614 let chanmon_cfgs = create_chanmon_cfgs(2);
9615 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9616 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9617 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9619 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
9620 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9621 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
9622 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9623 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
9625 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
9626 let channel_id = &tx.txid().into_inner();
9628 // Ensure that the `id_to_peer` map is empty until either party has received the
9629 // funding transaction, and have the real `channel_id`.
9630 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
9631 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
9634 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
9636 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
9637 // as it has the funding transaction.
9638 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
9639 assert_eq!(nodes_0_lock.len(), 1);
9640 assert!(nodes_0_lock.contains_key(channel_id));
9643 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
9645 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9647 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9649 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
9650 assert_eq!(nodes_0_lock.len(), 1);
9651 assert!(nodes_0_lock.contains_key(channel_id));
9653 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
9656 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
9657 // as it has the funding transaction.
9658 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
9659 assert_eq!(nodes_1_lock.len(), 1);
9660 assert!(nodes_1_lock.contains_key(channel_id));
9662 check_added_monitors!(nodes[1], 1);
9663 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9664 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
9665 check_added_monitors!(nodes[0], 1);
9666 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
9667 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9668 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
9669 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
9671 nodes[0].node.close_channel(channel_id, &nodes[1].node.get_our_node_id()).unwrap();
9672 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()));
9673 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
9674 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &nodes_1_shutdown);
9676 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
9677 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
9679 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
9680 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
9681 // fee for the closing transaction has been negotiated and the parties has the other
9682 // party's signature for the fee negotiated closing transaction.)
9683 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
9684 assert_eq!(nodes_0_lock.len(), 1);
9685 assert!(nodes_0_lock.contains_key(channel_id));
9689 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
9690 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
9691 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
9692 // kept in the `nodes[1]`'s `id_to_peer` map.
9693 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
9694 assert_eq!(nodes_1_lock.len(), 1);
9695 assert!(nodes_1_lock.contains_key(channel_id));
9698 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()));
9700 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
9701 // therefore has all it needs to fully close the channel (both signatures for the
9702 // closing transaction).
9703 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
9704 // fully closed by `nodes[0]`.
9705 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
9707 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
9708 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
9709 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
9710 assert_eq!(nodes_1_lock.len(), 1);
9711 assert!(nodes_1_lock.contains_key(channel_id));
9714 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
9716 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
9718 // Assert that the channel has now been removed from both parties `id_to_peer` map once
9719 // they both have everything required to fully close the channel.
9720 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
9722 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
9724 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
9725 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
9728 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
9729 let expected_message = format!("Not connected to node: {}", expected_public_key);
9730 check_api_error_message(expected_message, res_err)
9733 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
9734 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
9735 check_api_error_message(expected_message, res_err)
9738 fn check_api_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
9740 Err(APIError::APIMisuseError { err }) => {
9741 assert_eq!(err, expected_err_message);
9743 Err(APIError::ChannelUnavailable { err }) => {
9744 assert_eq!(err, expected_err_message);
9746 Ok(_) => panic!("Unexpected Ok"),
9747 Err(_) => panic!("Unexpected Error"),
9752 fn test_api_calls_with_unkown_counterparty_node() {
9753 // Tests that our API functions that expects a `counterparty_node_id` as input, behaves as
9754 // expected if the `counterparty_node_id` is an unkown peer in the
9755 // `ChannelManager::per_peer_state` map.
9756 let chanmon_cfg = create_chanmon_cfgs(2);
9757 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
9758 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
9759 let nodes = create_network(2, &node_cfg, &node_chanmgr);
9762 let channel_id = [4; 32];
9763 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
9764 let intercept_id = InterceptId([0; 32]);
9766 // Test the API functions.
9767 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);
9769 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&channel_id, &unkown_public_key, 42), unkown_public_key);
9771 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
9773 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
9775 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
9777 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
9779 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
9783 fn test_connection_limiting() {
9784 // Test that we limit un-channel'd peers and un-funded channels properly.
9785 let chanmon_cfgs = create_chanmon_cfgs(2);
9786 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9787 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9788 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9790 // Note that create_network connects the nodes together for us
9792 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
9793 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9795 let mut funding_tx = None;
9796 for idx in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
9797 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
9798 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9801 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
9802 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
9803 funding_tx = Some(tx.clone());
9804 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx).unwrap();
9805 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9807 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9808 check_added_monitors!(nodes[1], 1);
9809 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
9811 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9813 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
9814 check_added_monitors!(nodes[0], 1);
9815 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
9817 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
9820 // A MAX_UNFUNDED_CHANS_PER_PEER + 1 channel will be summarily rejected
9821 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
9822 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
9823 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
9824 open_channel_msg.temporary_channel_id);
9826 // Further, because all of our channels with nodes[0] are inbound, and none of them funded,
9827 // it doesn't count as a "protected" peer, i.e. it counts towards the MAX_NO_CHANNEL_PEERS
9829 let mut peer_pks = Vec::with_capacity(super::MAX_NO_CHANNEL_PEERS);
9830 for _ in 1..super::MAX_NO_CHANNEL_PEERS {
9831 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
9832 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
9833 peer_pks.push(random_pk);
9834 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
9835 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
9838 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
9839 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
9840 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
9841 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
9842 }, true).unwrap_err();
9844 // Also importantly, because nodes[0] isn't "protected", we will refuse a reconnection from
9845 // them if we have too many un-channel'd peers.
9846 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
9847 let chan_closed_events = nodes[1].node.get_and_clear_pending_events();
9848 assert_eq!(chan_closed_events.len(), super::MAX_UNFUNDED_CHANS_PER_PEER - 1);
9849 for ev in chan_closed_events {
9850 if let Event::ChannelClosed { .. } = ev { } else { panic!(); }
9852 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
9853 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
9855 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
9856 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
9857 }, true).unwrap_err();
9859 // but of course if the connection is outbound its allowed...
9860 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
9861 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
9863 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
9865 // Now nodes[0] is disconnected but still has a pending, un-funded channel lying around.
9866 // Even though we accept one more connection from new peers, we won't actually let them
9868 assert!(peer_pks.len() > super::MAX_UNFUNDED_CHANNEL_PEERS - 1);
9869 for i in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
9870 nodes[1].node.handle_open_channel(&peer_pks[i], &open_channel_msg);
9871 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, peer_pks[i]);
9872 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
9874 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
9875 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
9876 open_channel_msg.temporary_channel_id);
9878 // Of course, however, outbound channels are always allowed
9879 nodes[1].node.create_channel(last_random_pk, 100_000, 0, 42, None).unwrap();
9880 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, last_random_pk);
9882 // If we fund the first channel, nodes[0] has a live on-chain channel with us, it is now
9883 // "protected" and can connect again.
9884 mine_transaction(&nodes[1], funding_tx.as_ref().unwrap());
9885 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
9886 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
9888 get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
9890 // Further, because the first channel was funded, we can open another channel with
9892 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
9893 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
9897 fn test_outbound_chans_unlimited() {
9898 // Test that we never refuse an outbound channel even if a peer is unfuned-channel-limited
9899 let chanmon_cfgs = create_chanmon_cfgs(2);
9900 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9901 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9902 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9904 // Note that create_network connects the nodes together for us
9906 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
9907 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9909 for _ in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
9910 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
9911 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9912 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
9915 // Once we have MAX_UNFUNDED_CHANS_PER_PEER unfunded channels, new inbound channels will be
9917 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
9918 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
9919 open_channel_msg.temporary_channel_id);
9921 // but we can still open an outbound channel.
9922 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
9923 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
9925 // but even with such an outbound channel, additional inbound channels will still fail.
9926 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
9927 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
9928 open_channel_msg.temporary_channel_id);
9932 fn test_0conf_limiting() {
9933 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
9934 // flag set and (sometimes) accept channels as 0conf.
9935 let chanmon_cfgs = create_chanmon_cfgs(2);
9936 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9937 let mut settings = test_default_channel_config();
9938 settings.manually_accept_inbound_channels = true;
9939 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(settings)]);
9940 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9942 // Note that create_network connects the nodes together for us
9944 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
9945 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9947 // First, get us up to MAX_UNFUNDED_CHANNEL_PEERS so we can test at the edge
9948 for _ in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
9949 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
9950 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
9951 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
9952 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
9955 nodes[1].node.handle_open_channel(&random_pk, &open_channel_msg);
9956 let events = nodes[1].node.get_and_clear_pending_events();
9958 Event::OpenChannelRequest { temporary_channel_id, .. } => {
9959 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23).unwrap();
9961 _ => panic!("Unexpected event"),
9963 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, random_pk);
9964 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
9967 // If we try to accept a channel from another peer non-0conf it will fail.
9968 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
9969 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
9970 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
9971 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
9973 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
9974 let events = nodes[1].node.get_and_clear_pending_events();
9976 Event::OpenChannelRequest { temporary_channel_id, .. } => {
9977 match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23) {
9978 Err(APIError::APIMisuseError { err }) =>
9979 assert_eq!(err, "Too many peers with unfunded channels, refusing to accept new ones"),
9983 _ => panic!("Unexpected event"),
9985 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
9986 open_channel_msg.temporary_channel_id);
9988 // ...however if we accept the same channel 0conf it should work just fine.
9989 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
9990 let events = nodes[1].node.get_and_clear_pending_events();
9992 Event::OpenChannelRequest { temporary_channel_id, .. } => {
9993 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23).unwrap();
9995 _ => panic!("Unexpected event"),
9997 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
10001 fn reject_excessively_underpaying_htlcs() {
10002 let chanmon_cfg = create_chanmon_cfgs(1);
10003 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
10004 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
10005 let node = create_network(1, &node_cfg, &node_chanmgr);
10006 let sender_intended_amt_msat = 100;
10007 let extra_fee_msat = 10;
10008 let hop_data = msgs::OnionHopData {
10009 amt_to_forward: 100,
10010 outgoing_cltv_value: 42,
10011 format: msgs::OnionHopDataFormat::FinalNode {
10012 keysend_preimage: None,
10013 payment_metadata: None,
10014 payment_data: Some(msgs::FinalOnionHopData {
10015 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
10019 // Check that if the amount we received + the penultimate hop extra fee is less than the sender
10020 // intended amount, we fail the payment.
10021 if let Err(crate::ln::channelmanager::ReceiveError { err_code, .. }) =
10022 node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
10023 sender_intended_amt_msat - extra_fee_msat - 1, 42, None, true, Some(extra_fee_msat))
10025 assert_eq!(err_code, 19);
10026 } else { panic!(); }
10028 // If amt_received + extra_fee is equal to the sender intended amount, we're fine.
10029 let hop_data = msgs::OnionHopData { // This is the same hop_data as above, OnionHopData doesn't implement Clone
10030 amt_to_forward: 100,
10031 outgoing_cltv_value: 42,
10032 format: msgs::OnionHopDataFormat::FinalNode {
10033 keysend_preimage: None,
10034 payment_metadata: None,
10035 payment_data: Some(msgs::FinalOnionHopData {
10036 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
10040 assert!(node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
10041 sender_intended_amt_msat - extra_fee_msat, 42, None, true, Some(extra_fee_msat)).is_ok());
10045 fn test_inbound_anchors_manual_acceptance() {
10046 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
10047 // flag set and (sometimes) accept channels as 0conf.
10048 let mut anchors_cfg = test_default_channel_config();
10049 anchors_cfg.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
10051 let mut anchors_manual_accept_cfg = anchors_cfg.clone();
10052 anchors_manual_accept_cfg.manually_accept_inbound_channels = true;
10054 let chanmon_cfgs = create_chanmon_cfgs(3);
10055 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
10056 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs,
10057 &[Some(anchors_cfg.clone()), Some(anchors_cfg.clone()), Some(anchors_manual_accept_cfg.clone())]);
10058 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
10060 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10061 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10063 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10064 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
10065 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
10066 match &msg_events[0] {
10067 MessageSendEvent::HandleError { node_id, action } => {
10068 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
10070 ErrorAction::SendErrorMessage { msg } =>
10071 assert_eq!(msg.data, "No channels with anchor outputs accepted".to_owned()),
10072 _ => panic!("Unexpected error action"),
10075 _ => panic!("Unexpected event"),
10078 nodes[2].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10079 let events = nodes[2].node.get_and_clear_pending_events();
10081 Event::OpenChannelRequest { temporary_channel_id, .. } =>
10082 nodes[2].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap(),
10083 _ => panic!("Unexpected event"),
10085 get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10089 fn test_anchors_zero_fee_htlc_tx_fallback() {
10090 // Tests that if both nodes support anchors, but the remote node does not want to accept
10091 // anchor channels at the moment, an error it sent to the local node such that it can retry
10092 // the channel without the anchors feature.
10093 let chanmon_cfgs = create_chanmon_cfgs(2);
10094 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10095 let mut anchors_config = test_default_channel_config();
10096 anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
10097 anchors_config.manually_accept_inbound_channels = true;
10098 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config.clone()), Some(anchors_config.clone())]);
10099 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10101 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 0, None).unwrap();
10102 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10103 assert!(open_channel_msg.channel_type.as_ref().unwrap().supports_anchors_zero_fee_htlc_tx());
10105 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10106 let events = nodes[1].node.get_and_clear_pending_events();
10108 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10109 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
10111 _ => panic!("Unexpected event"),
10114 let error_msg = get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id());
10115 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &error_msg);
10117 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10118 assert!(!open_channel_msg.channel_type.unwrap().supports_anchors_zero_fee_htlc_tx());
10120 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
10124 fn test_update_channel_config() {
10125 let chanmon_cfg = create_chanmon_cfgs(2);
10126 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
10127 let mut user_config = test_default_channel_config();
10128 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
10129 let nodes = create_network(2, &node_cfg, &node_chanmgr);
10130 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
10131 let channel = &nodes[0].node.list_channels()[0];
10133 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
10134 let events = nodes[0].node.get_and_clear_pending_msg_events();
10135 assert_eq!(events.len(), 0);
10137 user_config.channel_config.forwarding_fee_base_msat += 10;
10138 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
10139 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_base_msat, user_config.channel_config.forwarding_fee_base_msat);
10140 let events = nodes[0].node.get_and_clear_pending_msg_events();
10141 assert_eq!(events.len(), 1);
10143 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10144 _ => panic!("expected BroadcastChannelUpdate event"),
10147 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate::default()).unwrap();
10148 let events = nodes[0].node.get_and_clear_pending_msg_events();
10149 assert_eq!(events.len(), 0);
10151 let new_cltv_expiry_delta = user_config.channel_config.cltv_expiry_delta + 6;
10152 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
10153 cltv_expiry_delta: Some(new_cltv_expiry_delta),
10154 ..Default::default()
10156 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
10157 let events = nodes[0].node.get_and_clear_pending_msg_events();
10158 assert_eq!(events.len(), 1);
10160 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10161 _ => panic!("expected BroadcastChannelUpdate event"),
10164 let new_fee = user_config.channel_config.forwarding_fee_proportional_millionths + 100;
10165 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
10166 forwarding_fee_proportional_millionths: Some(new_fee),
10167 ..Default::default()
10169 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
10170 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, new_fee);
10171 let events = nodes[0].node.get_and_clear_pending_msg_events();
10172 assert_eq!(events.len(), 1);
10174 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10175 _ => panic!("expected BroadcastChannelUpdate event"),
10182 use crate::chain::Listen;
10183 use crate::chain::chainmonitor::{ChainMonitor, Persist};
10184 use crate::sign::{KeysManager, InMemorySigner};
10185 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider};
10186 use crate::ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId, RecipientOnionFields, Retry};
10187 use crate::ln::functional_test_utils::*;
10188 use crate::ln::msgs::{ChannelMessageHandler, Init};
10189 use crate::routing::gossip::NetworkGraph;
10190 use crate::routing::router::{PaymentParameters, RouteParameters};
10191 use crate::util::test_utils;
10192 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
10194 use bitcoin::hashes::Hash;
10195 use bitcoin::hashes::sha256::Hash as Sha256;
10196 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
10198 use crate::sync::{Arc, Mutex};
10200 use criterion::Criterion;
10202 type Manager<'a, P> = ChannelManager<
10203 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
10204 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
10205 &'a test_utils::TestLogger, &'a P>,
10206 &'a test_utils::TestBroadcaster, &'a KeysManager, &'a KeysManager, &'a KeysManager,
10207 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
10208 &'a test_utils::TestLogger>;
10210 struct ANodeHolder<'a, P: Persist<InMemorySigner>> {
10211 node: &'a Manager<'a, P>,
10213 impl<'a, P: Persist<InMemorySigner>> NodeHolder for ANodeHolder<'a, P> {
10214 type CM = Manager<'a, P>;
10216 fn node(&self) -> &Manager<'a, P> { self.node }
10218 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { None }
10221 pub fn bench_sends(bench: &mut Criterion) {
10222 bench_two_sends(bench, "bench_sends", test_utils::TestPersister::new(), test_utils::TestPersister::new());
10225 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Criterion, bench_name: &str, persister_a: P, persister_b: P) {
10226 // Do a simple benchmark of sending a payment back and forth between two nodes.
10227 // Note that this is unrealistic as each payment send will require at least two fsync
10229 let network = bitcoin::Network::Testnet;
10230 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
10232 let tx_broadcaster = test_utils::TestBroadcaster::new(network);
10233 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
10234 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
10235 let scorer = Mutex::new(test_utils::TestScorer::new());
10236 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(network, &logger_a)), &scorer);
10238 let mut config: UserConfig = Default::default();
10239 config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
10240 config.channel_handshake_config.minimum_depth = 1;
10242 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
10243 let seed_a = [1u8; 32];
10244 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
10245 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 {
10247 best_block: BestBlock::from_network(network),
10248 }, genesis_block.header.time);
10249 let node_a_holder = ANodeHolder { node: &node_a };
10251 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
10252 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
10253 let seed_b = [2u8; 32];
10254 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
10255 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 {
10257 best_block: BestBlock::from_network(network),
10258 }, genesis_block.header.time);
10259 let node_b_holder = ANodeHolder { node: &node_b };
10261 node_a.peer_connected(&node_b.get_our_node_id(), &Init {
10262 features: node_b.init_features(), networks: None, remote_network_address: None
10264 node_b.peer_connected(&node_a.get_our_node_id(), &Init {
10265 features: node_a.init_features(), networks: None, remote_network_address: None
10266 }, false).unwrap();
10267 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
10268 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()));
10269 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()));
10272 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
10273 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
10274 value: 8_000_000, script_pubkey: output_script,
10276 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
10277 } else { panic!(); }
10279 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()));
10280 let events_b = node_b.get_and_clear_pending_events();
10281 assert_eq!(events_b.len(), 1);
10282 match events_b[0] {
10283 Event::ChannelPending{ ref counterparty_node_id, .. } => {
10284 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
10286 _ => panic!("Unexpected event"),
10289 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()));
10290 let events_a = node_a.get_and_clear_pending_events();
10291 assert_eq!(events_a.len(), 1);
10292 match events_a[0] {
10293 Event::ChannelPending{ ref counterparty_node_id, .. } => {
10294 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
10296 _ => panic!("Unexpected event"),
10299 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
10301 let block = create_dummy_block(BestBlock::from_network(network).block_hash(), 42, vec![tx]);
10302 Listen::block_connected(&node_a, &block, 1);
10303 Listen::block_connected(&node_b, &block, 1);
10305 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()));
10306 let msg_events = node_a.get_and_clear_pending_msg_events();
10307 assert_eq!(msg_events.len(), 2);
10308 match msg_events[0] {
10309 MessageSendEvent::SendChannelReady { ref msg, .. } => {
10310 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
10311 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
10315 match msg_events[1] {
10316 MessageSendEvent::SendChannelUpdate { .. } => {},
10320 let events_a = node_a.get_and_clear_pending_events();
10321 assert_eq!(events_a.len(), 1);
10322 match events_a[0] {
10323 Event::ChannelReady{ ref counterparty_node_id, .. } => {
10324 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
10326 _ => panic!("Unexpected event"),
10329 let events_b = node_b.get_and_clear_pending_events();
10330 assert_eq!(events_b.len(), 1);
10331 match events_b[0] {
10332 Event::ChannelReady{ ref counterparty_node_id, .. } => {
10333 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
10335 _ => panic!("Unexpected event"),
10338 let mut payment_count: u64 = 0;
10339 macro_rules! send_payment {
10340 ($node_a: expr, $node_b: expr) => {
10341 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id(), TEST_FINAL_CLTV)
10342 .with_bolt11_features($node_b.invoice_features()).unwrap();
10343 let mut payment_preimage = PaymentPreimage([0; 32]);
10344 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
10345 payment_count += 1;
10346 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
10347 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
10349 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
10350 PaymentId(payment_hash.0), RouteParameters {
10351 payment_params, final_value_msat: 10_000,
10352 }, Retry::Attempts(0)).unwrap();
10353 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
10354 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
10355 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
10356 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_b }, &$node_a.get_our_node_id());
10357 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
10358 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
10359 $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()));
10361 expect_pending_htlcs_forwardable!(ANodeHolder { node: &$node_b });
10362 expect_payment_claimable!(ANodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
10363 $node_b.claim_funds(payment_preimage);
10364 expect_payment_claimed!(ANodeHolder { node: &$node_b }, payment_hash, 10_000);
10366 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
10367 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
10368 assert_eq!(node_id, $node_a.get_our_node_id());
10369 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
10370 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
10372 _ => panic!("Failed to generate claim event"),
10375 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_a }, &$node_b.get_our_node_id());
10376 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
10377 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
10378 $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()));
10380 expect_payment_sent!(ANodeHolder { node: &$node_a }, payment_preimage);
10384 bench.bench_function(bench_name, |b| b.iter(|| {
10385 send_payment!(node_a, node_b);
10386 send_payment!(node_b, node_a);