1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! The top-level channel management and payment tracking stuff lives here.
12 //! The [`ChannelManager`] is the main chunk of logic implementing the lightning protocol and is
13 //! responsible for tracking which channels are open, HTLCs are in flight and reestablishing those
14 //! upon reconnect to the relevant peer(s).
16 //! It does not manage routing logic (see [`Router`] for that) nor does it manage constructing
17 //! on-chain transactions (it only monitors the chain to watch for any force-closes that might
18 //! imply it needs to fail HTLCs/payments/channels it manages).
20 use bitcoin::blockdata::block::BlockHeader;
21 use bitcoin::blockdata::transaction::Transaction;
22 use bitcoin::blockdata::constants::{genesis_block, ChainHash};
23 use bitcoin::network::constants::Network;
25 use bitcoin::hashes::Hash;
26 use bitcoin::hashes::sha256::Hash as Sha256;
27 use bitcoin::hash_types::{BlockHash, Txid};
29 use bitcoin::secp256k1::{SecretKey,PublicKey};
30 use bitcoin::secp256k1::Secp256k1;
31 use bitcoin::{LockTime, secp256k1, Sequence};
34 use crate::chain::{Confirm, ChannelMonitorUpdateStatus, Watch, BestBlock};
35 use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator};
36 use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
37 use crate::chain::transaction::{OutPoint, TransactionData};
39 use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination, PaymentFailureReason};
40 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
41 // construct one themselves.
42 use crate::ln::{inbound_payment, ChannelId, PaymentHash, PaymentPreimage, PaymentSecret};
43 use crate::ln::channel::{Channel, ChannelPhase, ChannelContext, ChannelError, ChannelUpdateStatus, ShutdownResult, UnfundedChannelContext, UpdateFulfillCommitFetch, OutboundV1Channel, InboundV1Channel};
44 use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
45 #[cfg(any(feature = "_test_utils", test))]
46 use crate::ln::features::Bolt11InvoiceFeatures;
47 use crate::routing::gossip::NetworkGraph;
48 use crate::routing::router::{BlindedTail, DefaultRouter, InFlightHtlcs, Path, Payee, PaymentParameters, Route, RouteParameters, Router};
49 use crate::routing::scoring::{ProbabilisticScorer, ProbabilisticScoringFeeParameters};
51 use crate::ln::onion_utils;
52 use crate::ln::onion_utils::HTLCFailReason;
53 use crate::ln::msgs::{ChannelMessageHandler, DecodeError, LightningError};
55 use crate::ln::outbound_payment;
56 use crate::ln::outbound_payment::{OutboundPayments, PaymentAttempts, PendingOutboundPayment, SendAlongPathArgs};
57 use crate::ln::wire::Encode;
58 use crate::sign::{EntropySource, KeysManager, NodeSigner, Recipient, SignerProvider, WriteableEcdsaChannelSigner};
59 use crate::util::config::{UserConfig, ChannelConfig, ChannelConfigUpdate};
60 use crate::util::wakers::{Future, Notifier};
61 use crate::util::scid_utils::fake_scid;
62 use crate::util::string::UntrustedString;
63 use crate::util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
64 use crate::util::logger::{Level, Logger};
65 use crate::util::errors::APIError;
67 use alloc::collections::BTreeMap;
70 use crate::prelude::*;
72 use core::cell::RefCell;
74 use crate::sync::{Arc, Mutex, RwLock, RwLockReadGuard, FairRwLock, LockTestExt, LockHeldState};
75 use core::sync::atomic::{AtomicUsize, AtomicBool, Ordering};
76 use core::time::Duration;
79 // Re-export this for use in the public API.
80 pub use crate::ln::outbound_payment::{PaymentSendFailure, ProbeSendFailure, Retry, RetryableSendFailure, RecipientOnionFields};
81 use crate::ln::script::ShutdownScript;
83 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
85 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
86 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
87 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
89 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
90 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
91 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
92 // before we forward it.
94 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
95 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
96 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
97 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
98 // our payment, which we can use to decode errors or inform the user that the payment was sent.
100 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
101 pub(super) enum PendingHTLCRouting {
103 onion_packet: msgs::OnionPacket,
104 /// The SCID from the onion that we should forward to. This could be a real SCID or a fake one
105 /// generated using `get_fake_scid` from the scid_utils::fake_scid module.
106 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
109 payment_data: msgs::FinalOnionHopData,
110 payment_metadata: Option<Vec<u8>>,
111 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
112 phantom_shared_secret: Option<[u8; 32]>,
113 /// See [`RecipientOnionFields::custom_tlvs`] for more info.
114 custom_tlvs: Vec<(u64, Vec<u8>)>,
117 /// This was added in 0.0.116 and will break deserialization on downgrades.
118 payment_data: Option<msgs::FinalOnionHopData>,
119 payment_preimage: PaymentPreimage,
120 payment_metadata: Option<Vec<u8>>,
121 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
122 /// See [`RecipientOnionFields::custom_tlvs`] for more info.
123 custom_tlvs: Vec<(u64, Vec<u8>)>,
127 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
128 pub(super) struct PendingHTLCInfo {
129 pub(super) routing: PendingHTLCRouting,
130 pub(super) incoming_shared_secret: [u8; 32],
131 payment_hash: PaymentHash,
133 pub(super) incoming_amt_msat: Option<u64>, // Added in 0.0.113
134 /// Sender intended amount to forward or receive (actual amount received
135 /// may overshoot this in either case)
136 pub(super) outgoing_amt_msat: u64,
137 pub(super) outgoing_cltv_value: u32,
138 /// The fee being skimmed off the top of this HTLC. If this is a forward, it'll be the fee we are
139 /// skimming. If we're receiving this HTLC, it's the fee that our counterparty skimmed.
140 pub(super) skimmed_fee_msat: Option<u64>,
143 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
144 pub(super) enum HTLCFailureMsg {
145 Relay(msgs::UpdateFailHTLC),
146 Malformed(msgs::UpdateFailMalformedHTLC),
149 /// Stores whether we can't forward an HTLC or relevant forwarding info
150 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
151 pub(super) enum PendingHTLCStatus {
152 Forward(PendingHTLCInfo),
153 Fail(HTLCFailureMsg),
156 pub(super) struct PendingAddHTLCInfo {
157 pub(super) forward_info: PendingHTLCInfo,
159 // These fields are produced in `forward_htlcs()` and consumed in
160 // `process_pending_htlc_forwards()` for constructing the
161 // `HTLCSource::PreviousHopData` for failed and forwarded
164 // Note that this may be an outbound SCID alias for the associated channel.
165 prev_short_channel_id: u64,
167 prev_funding_outpoint: OutPoint,
168 prev_user_channel_id: u128,
171 pub(super) enum HTLCForwardInfo {
172 AddHTLC(PendingAddHTLCInfo),
175 err_packet: msgs::OnionErrorPacket,
179 /// Tracks the inbound corresponding to an outbound HTLC
180 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
181 pub(crate) struct HTLCPreviousHopData {
182 // Note that this may be an outbound SCID alias for the associated channel.
183 short_channel_id: u64,
184 user_channel_id: Option<u128>,
186 incoming_packet_shared_secret: [u8; 32],
187 phantom_shared_secret: Option<[u8; 32]>,
189 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
190 // channel with a preimage provided by the forward channel.
195 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
197 /// This is only here for backwards-compatibility in serialization, in the future it can be
198 /// removed, breaking clients running 0.0.106 and earlier.
199 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
201 /// Contains the payer-provided preimage.
202 Spontaneous(PaymentPreimage),
205 /// HTLCs that are to us and can be failed/claimed by the user
206 struct ClaimableHTLC {
207 prev_hop: HTLCPreviousHopData,
209 /// The amount (in msats) of this MPP part
211 /// The amount (in msats) that the sender intended to be sent in this MPP
212 /// part (used for validating total MPP amount)
213 sender_intended_value: u64,
214 onion_payload: OnionPayload,
216 /// The total value received for a payment (sum of all MPP parts if the payment is a MPP).
217 /// Gets set to the amount reported when pushing [`Event::PaymentClaimable`].
218 total_value_received: Option<u64>,
219 /// The sender intended sum total of all MPP parts specified in the onion
221 /// The extra fee our counterparty skimmed off the top of this HTLC.
222 counterparty_skimmed_fee_msat: Option<u64>,
225 impl From<&ClaimableHTLC> for events::ClaimedHTLC {
226 fn from(val: &ClaimableHTLC) -> Self {
227 events::ClaimedHTLC {
228 channel_id: val.prev_hop.outpoint.to_channel_id(),
229 user_channel_id: val.prev_hop.user_channel_id.unwrap_or(0),
230 cltv_expiry: val.cltv_expiry,
231 value_msat: val.value,
236 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
237 /// a payment and ensure idempotency in LDK.
239 /// This is not exported to bindings users as we just use [u8; 32] directly
240 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
241 pub struct PaymentId(pub [u8; Self::LENGTH]);
244 /// Number of bytes in the id.
245 pub const LENGTH: usize = 32;
248 impl Writeable for PaymentId {
249 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
254 impl Readable for PaymentId {
255 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
256 let buf: [u8; 32] = Readable::read(r)?;
261 impl core::fmt::Display for PaymentId {
262 fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
263 crate::util::logger::DebugBytes(&self.0).fmt(f)
267 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
269 /// This is not exported to bindings users as we just use [u8; 32] directly
270 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
271 pub struct InterceptId(pub [u8; 32]);
273 impl Writeable for InterceptId {
274 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
279 impl Readable for InterceptId {
280 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
281 let buf: [u8; 32] = Readable::read(r)?;
286 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
287 /// Uniquely describes an HTLC by its source. Just the guaranteed-unique subset of [`HTLCSource`].
288 pub(crate) enum SentHTLCId {
289 PreviousHopData { short_channel_id: u64, htlc_id: u64 },
290 OutboundRoute { session_priv: SecretKey },
293 pub(crate) fn from_source(source: &HTLCSource) -> Self {
295 HTLCSource::PreviousHopData(hop_data) => Self::PreviousHopData {
296 short_channel_id: hop_data.short_channel_id,
297 htlc_id: hop_data.htlc_id,
299 HTLCSource::OutboundRoute { session_priv, .. } =>
300 Self::OutboundRoute { session_priv: *session_priv },
304 impl_writeable_tlv_based_enum!(SentHTLCId,
305 (0, PreviousHopData) => {
306 (0, short_channel_id, required),
307 (2, htlc_id, required),
309 (2, OutboundRoute) => {
310 (0, session_priv, required),
315 /// Tracks the inbound corresponding to an outbound HTLC
316 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
317 #[derive(Clone, Debug, PartialEq, Eq)]
318 pub(crate) enum HTLCSource {
319 PreviousHopData(HTLCPreviousHopData),
322 session_priv: SecretKey,
323 /// Technically we can recalculate this from the route, but we cache it here to avoid
324 /// doing a double-pass on route when we get a failure back
325 first_hop_htlc_msat: u64,
326 payment_id: PaymentId,
329 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
330 impl core::hash::Hash for HTLCSource {
331 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
333 HTLCSource::PreviousHopData(prev_hop_data) => {
335 prev_hop_data.hash(hasher);
337 HTLCSource::OutboundRoute { path, session_priv, payment_id, first_hop_htlc_msat } => {
340 session_priv[..].hash(hasher);
341 payment_id.hash(hasher);
342 first_hop_htlc_msat.hash(hasher);
348 #[cfg(all(feature = "_test_vectors", not(feature = "grind_signatures")))]
350 pub fn dummy() -> Self {
351 HTLCSource::OutboundRoute {
352 path: Path { hops: Vec::new(), blinded_tail: None },
353 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
354 first_hop_htlc_msat: 0,
355 payment_id: PaymentId([2; 32]),
359 #[cfg(debug_assertions)]
360 /// Checks whether this HTLCSource could possibly match the given HTLC output in a commitment
361 /// transaction. Useful to ensure different datastructures match up.
362 pub(crate) fn possibly_matches_output(&self, htlc: &super::chan_utils::HTLCOutputInCommitment) -> bool {
363 if let HTLCSource::OutboundRoute { first_hop_htlc_msat, .. } = self {
364 *first_hop_htlc_msat == htlc.amount_msat
366 // There's nothing we can check for forwarded HTLCs
372 struct InboundOnionErr {
378 /// This enum is used to specify which error data to send to peers when failing back an HTLC
379 /// using [`ChannelManager::fail_htlc_backwards_with_reason`].
381 /// For more info on failure codes, see <https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages>.
382 #[derive(Clone, Copy)]
383 pub enum FailureCode {
384 /// We had a temporary error processing the payment. Useful if no other error codes fit
385 /// and you want to indicate that the payer may want to retry.
386 TemporaryNodeFailure,
387 /// We have a required feature which was not in this onion. For example, you may require
388 /// some additional metadata that was not provided with this payment.
389 RequiredNodeFeatureMissing,
390 /// You may wish to use this when a `payment_preimage` is unknown, or the CLTV expiry of
391 /// the HTLC is too close to the current block height for safe handling.
392 /// Using this failure code in [`ChannelManager::fail_htlc_backwards_with_reason`] is
393 /// equivalent to calling [`ChannelManager::fail_htlc_backwards`].
394 IncorrectOrUnknownPaymentDetails,
395 /// We failed to process the payload after the onion was decrypted. You may wish to
396 /// use this when receiving custom HTLC TLVs with even type numbers that you don't recognize.
398 /// If available, the tuple data may include the type number and byte offset in the
399 /// decrypted byte stream where the failure occurred.
400 InvalidOnionPayload(Option<(u64, u16)>),
403 impl Into<u16> for FailureCode {
404 fn into(self) -> u16 {
406 FailureCode::TemporaryNodeFailure => 0x2000 | 2,
407 FailureCode::RequiredNodeFeatureMissing => 0x4000 | 0x2000 | 3,
408 FailureCode::IncorrectOrUnknownPaymentDetails => 0x4000 | 15,
409 FailureCode::InvalidOnionPayload(_) => 0x4000 | 22,
414 /// Error type returned across the peer_state mutex boundary. When an Err is generated for a
415 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
416 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
417 /// peer_state lock. We then return the set of things that need to be done outside the lock in
418 /// this struct and call handle_error!() on it.
420 struct MsgHandleErrInternal {
421 err: msgs::LightningError,
422 chan_id: Option<(ChannelId, u128)>, // If Some a channel of ours has been closed
423 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
424 channel_capacity: Option<u64>,
426 impl MsgHandleErrInternal {
428 fn send_err_msg_no_close(err: String, channel_id: ChannelId) -> Self {
430 err: LightningError {
432 action: msgs::ErrorAction::SendErrorMessage {
433 msg: msgs::ErrorMessage {
440 shutdown_finish: None,
441 channel_capacity: None,
445 fn from_no_close(err: msgs::LightningError) -> Self {
446 Self { err, chan_id: None, shutdown_finish: None, channel_capacity: None }
449 fn from_finish_shutdown(err: String, channel_id: ChannelId, user_channel_id: u128, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>, channel_capacity: u64) -> Self {
451 err: LightningError {
453 action: msgs::ErrorAction::SendErrorMessage {
454 msg: msgs::ErrorMessage {
460 chan_id: Some((channel_id, user_channel_id)),
461 shutdown_finish: Some((shutdown_res, channel_update)),
462 channel_capacity: Some(channel_capacity)
466 fn from_chan_no_close(err: ChannelError, channel_id: ChannelId) -> Self {
469 ChannelError::Warn(msg) => LightningError {
471 action: msgs::ErrorAction::SendWarningMessage {
472 msg: msgs::WarningMessage {
476 log_level: Level::Warn,
479 ChannelError::Ignore(msg) => LightningError {
481 action: msgs::ErrorAction::IgnoreError,
483 ChannelError::Close(msg) => LightningError {
485 action: msgs::ErrorAction::SendErrorMessage {
486 msg: msgs::ErrorMessage {
494 shutdown_finish: None,
495 channel_capacity: None,
500 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
501 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
502 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
503 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
504 pub(super) const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
506 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
507 /// be sent in the order they appear in the return value, however sometimes the order needs to be
508 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
509 /// they were originally sent). In those cases, this enum is also returned.
510 #[derive(Clone, PartialEq)]
511 pub(super) enum RAACommitmentOrder {
512 /// Send the CommitmentUpdate messages first
514 /// Send the RevokeAndACK message first
518 /// Information about a payment which is currently being claimed.
519 struct ClaimingPayment {
521 payment_purpose: events::PaymentPurpose,
522 receiver_node_id: PublicKey,
523 htlcs: Vec<events::ClaimedHTLC>,
524 sender_intended_value: Option<u64>,
526 impl_writeable_tlv_based!(ClaimingPayment, {
527 (0, amount_msat, required),
528 (2, payment_purpose, required),
529 (4, receiver_node_id, required),
530 (5, htlcs, optional_vec),
531 (7, sender_intended_value, option),
534 struct ClaimablePayment {
535 purpose: events::PaymentPurpose,
536 onion_fields: Option<RecipientOnionFields>,
537 htlcs: Vec<ClaimableHTLC>,
540 /// Information about claimable or being-claimed payments
541 struct ClaimablePayments {
542 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
543 /// failed/claimed by the user.
545 /// Note that, no consistency guarantees are made about the channels given here actually
546 /// existing anymore by the time you go to read them!
548 /// When adding to the map, [`Self::pending_claiming_payments`] must also be checked to ensure
549 /// we don't get a duplicate payment.
550 claimable_payments: HashMap<PaymentHash, ClaimablePayment>,
552 /// Map from payment hash to the payment data for HTLCs which we have begun claiming, but which
553 /// are waiting on a [`ChannelMonitorUpdate`] to complete in order to be surfaced to the user
554 /// as an [`events::Event::PaymentClaimed`].
555 pending_claiming_payments: HashMap<PaymentHash, ClaimingPayment>,
558 /// Events which we process internally but cannot be processed immediately at the generation site
559 /// usually because we're running pre-full-init. They are handled immediately once we detect we are
560 /// running normally, and specifically must be processed before any other non-background
561 /// [`ChannelMonitorUpdate`]s are applied.
562 enum BackgroundEvent {
563 /// Handle a ChannelMonitorUpdate which closes the channel or for an already-closed channel.
564 /// This is only separated from [`Self::MonitorUpdateRegeneratedOnStartup`] as the
565 /// maybe-non-closing variant needs a public key to handle channel resumption, whereas if the
566 /// channel has been force-closed we do not need the counterparty node_id.
568 /// Note that any such events are lost on shutdown, so in general they must be updates which
569 /// are regenerated on startup.
570 ClosedMonitorUpdateRegeneratedOnStartup((OutPoint, ChannelMonitorUpdate)),
571 /// Handle a ChannelMonitorUpdate which may or may not close the channel and may unblock the
572 /// channel to continue normal operation.
574 /// In general this should be used rather than
575 /// [`Self::ClosedMonitorUpdateRegeneratedOnStartup`], however in cases where the
576 /// `counterparty_node_id` is not available as the channel has closed from a [`ChannelMonitor`]
577 /// error the other variant is acceptable.
579 /// Note that any such events are lost on shutdown, so in general they must be updates which
580 /// are regenerated on startup.
581 MonitorUpdateRegeneratedOnStartup {
582 counterparty_node_id: PublicKey,
583 funding_txo: OutPoint,
584 update: ChannelMonitorUpdate
586 /// Some [`ChannelMonitorUpdate`] (s) completed before we were serialized but we still have
587 /// them marked pending, thus we need to run any [`MonitorUpdateCompletionAction`] (s) pending
589 MonitorUpdatesComplete {
590 counterparty_node_id: PublicKey,
591 channel_id: ChannelId,
596 pub(crate) enum MonitorUpdateCompletionAction {
597 /// Indicates that a payment ultimately destined for us was claimed and we should emit an
598 /// [`events::Event::PaymentClaimed`] to the user if we haven't yet generated such an event for
599 /// this payment. Note that this is only best-effort. On restart it's possible such a duplicate
600 /// event can be generated.
601 PaymentClaimed { payment_hash: PaymentHash },
602 /// Indicates an [`events::Event`] should be surfaced to the user and possibly resume the
603 /// operation of another channel.
605 /// This is usually generated when we've forwarded an HTLC and want to block the outbound edge
606 /// from completing a monitor update which removes the payment preimage until the inbound edge
607 /// completes a monitor update containing the payment preimage. In that case, after the inbound
608 /// edge completes, we will surface an [`Event::PaymentForwarded`] as well as unblock the
610 EmitEventAndFreeOtherChannel {
611 event: events::Event,
612 downstream_counterparty_and_funding_outpoint: Option<(PublicKey, OutPoint, RAAMonitorUpdateBlockingAction)>,
616 impl_writeable_tlv_based_enum_upgradable!(MonitorUpdateCompletionAction,
617 (0, PaymentClaimed) => { (0, payment_hash, required) },
618 (2, EmitEventAndFreeOtherChannel) => {
619 (0, event, upgradable_required),
620 // LDK prior to 0.0.116 did not have this field as the monitor update application order was
621 // required by clients. If we downgrade to something prior to 0.0.116 this may result in
622 // monitor updates which aren't properly blocked or resumed, however that's fine - we don't
623 // support async monitor updates even in LDK 0.0.116 and once we do we'll require no
624 // downgrades to prior versions.
625 (1, downstream_counterparty_and_funding_outpoint, option),
629 #[derive(Clone, Debug, PartialEq, Eq)]
630 pub(crate) enum EventCompletionAction {
631 ReleaseRAAChannelMonitorUpdate {
632 counterparty_node_id: PublicKey,
633 channel_funding_outpoint: OutPoint,
636 impl_writeable_tlv_based_enum!(EventCompletionAction,
637 (0, ReleaseRAAChannelMonitorUpdate) => {
638 (0, channel_funding_outpoint, required),
639 (2, counterparty_node_id, required),
643 #[derive(Clone, PartialEq, Eq, Debug)]
644 /// If something is blocked on the completion of an RAA-generated [`ChannelMonitorUpdate`] we track
645 /// the blocked action here. See enum variants for more info.
646 pub(crate) enum RAAMonitorUpdateBlockingAction {
647 /// A forwarded payment was claimed. We block the downstream channel completing its monitor
648 /// update which removes the HTLC preimage until the upstream channel has gotten the preimage
650 ForwardedPaymentInboundClaim {
651 /// The upstream channel ID (i.e. the inbound edge).
652 channel_id: ChannelId,
653 /// The HTLC ID on the inbound edge.
658 impl RAAMonitorUpdateBlockingAction {
659 fn from_prev_hop_data(prev_hop: &HTLCPreviousHopData) -> Self {
660 Self::ForwardedPaymentInboundClaim {
661 channel_id: prev_hop.outpoint.to_channel_id(),
662 htlc_id: prev_hop.htlc_id,
667 impl_writeable_tlv_based_enum!(RAAMonitorUpdateBlockingAction,
668 (0, ForwardedPaymentInboundClaim) => { (0, channel_id, required), (2, htlc_id, required) }
672 /// State we hold per-peer.
673 pub(super) struct PeerState<SP: Deref> where SP::Target: SignerProvider {
674 /// `channel_id` -> `ChannelPhase`
676 /// Holds all channels within corresponding `ChannelPhase`s where the peer is the counterparty.
677 pub(super) channel_by_id: HashMap<ChannelId, ChannelPhase<SP>>,
678 /// `temporary_channel_id` -> `InboundChannelRequest`.
680 /// When manual channel acceptance is enabled, this holds all unaccepted inbound channels where
681 /// the peer is the counterparty. If the channel is accepted, then the entry in this table is
682 /// removed, and an InboundV1Channel is created and placed in the `inbound_v1_channel_by_id` table. If
683 /// the channel is rejected, then the entry is simply removed.
684 pub(super) inbound_channel_request_by_id: HashMap<ChannelId, InboundChannelRequest>,
685 /// The latest `InitFeatures` we heard from the peer.
686 latest_features: InitFeatures,
687 /// Messages to send to the peer - pushed to in the same lock that they are generated in (except
688 /// for broadcast messages, where ordering isn't as strict).
689 pub(super) pending_msg_events: Vec<MessageSendEvent>,
690 /// Map from Channel IDs to pending [`ChannelMonitorUpdate`]s which have been passed to the
691 /// user but which have not yet completed.
693 /// Note that the channel may no longer exist. For example if the channel was closed but we
694 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
695 /// for a missing channel.
696 in_flight_monitor_updates: BTreeMap<OutPoint, Vec<ChannelMonitorUpdate>>,
697 /// Map from a specific channel to some action(s) that should be taken when all pending
698 /// [`ChannelMonitorUpdate`]s for the channel complete updating.
700 /// Note that because we generally only have one entry here a HashMap is pretty overkill. A
701 /// BTreeMap currently stores more than ten elements per leaf node, so even up to a few
702 /// channels with a peer this will just be one allocation and will amount to a linear list of
703 /// channels to walk, avoiding the whole hashing rigmarole.
705 /// Note that the channel may no longer exist. For example, if a channel was closed but we
706 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
707 /// for a missing channel. While a malicious peer could construct a second channel with the
708 /// same `temporary_channel_id` (or final `channel_id` in the case of 0conf channels or prior
709 /// to funding appearing on-chain), the downstream `ChannelMonitor` set is required to ensure
710 /// duplicates do not occur, so such channels should fail without a monitor update completing.
711 monitor_update_blocked_actions: BTreeMap<ChannelId, Vec<MonitorUpdateCompletionAction>>,
712 /// If another channel's [`ChannelMonitorUpdate`] needs to complete before a channel we have
713 /// with this peer can complete an RAA [`ChannelMonitorUpdate`] (e.g. because the RAA update
714 /// will remove a preimage that needs to be durably in an upstream channel first), we put an
715 /// entry here to note that the channel with the key's ID is blocked on a set of actions.
716 actions_blocking_raa_monitor_updates: BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
717 /// The peer is currently connected (i.e. we've seen a
718 /// [`ChannelMessageHandler::peer_connected`] and no corresponding
719 /// [`ChannelMessageHandler::peer_disconnected`].
723 impl <SP: Deref> PeerState<SP> where SP::Target: SignerProvider {
724 /// Indicates that a peer meets the criteria where we're ok to remove it from our storage.
725 /// If true is passed for `require_disconnected`, the function will return false if we haven't
726 /// disconnected from the node already, ie. `PeerState::is_connected` is set to `true`.
727 fn ok_to_remove(&self, require_disconnected: bool) -> bool {
728 if require_disconnected && self.is_connected {
731 self.channel_by_id.iter().filter(|(_, phase)| matches!(phase, ChannelPhase::Funded(_))).count() == 0
732 && self.monitor_update_blocked_actions.is_empty()
733 && self.in_flight_monitor_updates.is_empty()
736 // Returns a count of all channels we have with this peer, including unfunded channels.
737 fn total_channel_count(&self) -> usize {
738 self.channel_by_id.len() + self.inbound_channel_request_by_id.len()
741 // Returns a bool indicating if the given `channel_id` matches a channel we have with this peer.
742 fn has_channel(&self, channel_id: &ChannelId) -> bool {
743 self.channel_by_id.contains_key(channel_id) ||
744 self.inbound_channel_request_by_id.contains_key(channel_id)
748 /// A not-yet-accepted inbound (from counterparty) channel. Once
749 /// accepted, the parameters will be used to construct a channel.
750 pub(super) struct InboundChannelRequest {
751 /// The original OpenChannel message.
752 pub open_channel_msg: msgs::OpenChannel,
753 /// The number of ticks remaining before the request expires.
754 pub ticks_remaining: i32,
757 /// The number of ticks that may elapse while we're waiting for an unaccepted inbound channel to be
758 /// accepted. An unaccepted channel that exceeds this limit will be abandoned.
759 const UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS: i32 = 2;
761 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
762 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
764 /// For users who don't want to bother doing their own payment preimage storage, we also store that
767 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
768 /// and instead encoding it in the payment secret.
769 struct PendingInboundPayment {
770 /// The payment secret that the sender must use for us to accept this payment
771 payment_secret: PaymentSecret,
772 /// Time at which this HTLC expires - blocks with a header time above this value will result in
773 /// this payment being removed.
775 /// Arbitrary identifier the user specifies (or not)
776 user_payment_id: u64,
777 // Other required attributes of the payment, optionally enforced:
778 payment_preimage: Option<PaymentPreimage>,
779 min_value_msat: Option<u64>,
782 /// [`SimpleArcChannelManager`] is useful when you need a [`ChannelManager`] with a static lifetime, e.g.
783 /// when you're using `lightning-net-tokio` (since `tokio::spawn` requires parameters with static
784 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
785 /// [`SimpleRefChannelManager`] is the more appropriate type. Defining these type aliases prevents
786 /// issues such as overly long function definitions. Note that the `ChannelManager` can take any type
787 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
788 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
789 /// of [`KeysManager`] and [`DefaultRouter`].
791 /// This is not exported to bindings users as Arcs don't make sense in bindings
792 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
800 Arc<NetworkGraph<Arc<L>>>,
802 Arc<Mutex<ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>>,
803 ProbabilisticScoringFeeParameters,
804 ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>,
809 /// [`SimpleRefChannelManager`] is a type alias for a ChannelManager reference, and is the reference
810 /// counterpart to the [`SimpleArcChannelManager`] type alias. Use this type by default when you don't
811 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
812 /// usage of lightning-net-tokio (since `tokio::spawn` requires parameters with static lifetimes).
813 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
814 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
815 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
816 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
817 /// of [`KeysManager`] and [`DefaultRouter`].
819 /// This is not exported to bindings users as Arcs don't make sense in bindings
820 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> =
829 &'f NetworkGraph<&'g L>,
831 &'h Mutex<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>,
832 ProbabilisticScoringFeeParameters,
833 ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>
838 macro_rules! define_test_pub_trait { ($vis: vis) => {
839 /// A trivial trait which describes any [`ChannelManager`] used in testing.
840 $vis trait AChannelManager {
841 type Watch: chain::Watch<Self::Signer> + ?Sized;
842 type M: Deref<Target = Self::Watch>;
843 type Broadcaster: BroadcasterInterface + ?Sized;
844 type T: Deref<Target = Self::Broadcaster>;
845 type EntropySource: EntropySource + ?Sized;
846 type ES: Deref<Target = Self::EntropySource>;
847 type NodeSigner: NodeSigner + ?Sized;
848 type NS: Deref<Target = Self::NodeSigner>;
849 type Signer: WriteableEcdsaChannelSigner + Sized;
850 type SignerProvider: SignerProvider<Signer = Self::Signer> + ?Sized;
851 type SP: Deref<Target = Self::SignerProvider>;
852 type FeeEstimator: FeeEstimator + ?Sized;
853 type F: Deref<Target = Self::FeeEstimator>;
854 type Router: Router + ?Sized;
855 type R: Deref<Target = Self::Router>;
856 type Logger: Logger + ?Sized;
857 type L: Deref<Target = Self::Logger>;
858 fn get_cm(&self) -> &ChannelManager<Self::M, Self::T, Self::ES, Self::NS, Self::SP, Self::F, Self::R, Self::L>;
861 #[cfg(any(test, feature = "_test_utils"))]
862 define_test_pub_trait!(pub);
863 #[cfg(not(any(test, feature = "_test_utils")))]
864 define_test_pub_trait!(pub(crate));
865 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> AChannelManager
866 for ChannelManager<M, T, ES, NS, SP, F, R, L>
868 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
869 T::Target: BroadcasterInterface,
870 ES::Target: EntropySource,
871 NS::Target: NodeSigner,
872 SP::Target: SignerProvider,
873 F::Target: FeeEstimator,
877 type Watch = M::Target;
879 type Broadcaster = T::Target;
881 type EntropySource = ES::Target;
883 type NodeSigner = NS::Target;
885 type Signer = <SP::Target as SignerProvider>::Signer;
886 type SignerProvider = SP::Target;
888 type FeeEstimator = F::Target;
890 type Router = R::Target;
892 type Logger = L::Target;
894 fn get_cm(&self) -> &ChannelManager<M, T, ES, NS, SP, F, R, L> { self }
897 /// Manager which keeps track of a number of channels and sends messages to the appropriate
898 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
900 /// Implements [`ChannelMessageHandler`], handling the multi-channel parts and passing things through
901 /// to individual Channels.
903 /// Implements [`Writeable`] to write out all channel state to disk. Implies [`peer_disconnected`] for
904 /// all peers during write/read (though does not modify this instance, only the instance being
905 /// serialized). This will result in any channels which have not yet exchanged [`funding_created`] (i.e.,
906 /// called [`funding_transaction_generated`] for outbound channels) being closed.
908 /// Note that you can be a bit lazier about writing out `ChannelManager` than you can be with
909 /// [`ChannelMonitor`]. With [`ChannelMonitor`] you MUST write each monitor update out to disk before
910 /// returning from [`chain::Watch::watch_channel`]/[`update_channel`], with ChannelManagers, writing updates
911 /// happens out-of-band (and will prevent any other `ChannelManager` operations from occurring during
912 /// the serialization process). If the deserialized version is out-of-date compared to the
913 /// [`ChannelMonitor`] passed by reference to [`read`], those channels will be force-closed based on the
914 /// `ChannelMonitor` state and no funds will be lost (mod on-chain transaction fees).
916 /// Note that the deserializer is only implemented for `(`[`BlockHash`]`, `[`ChannelManager`]`)`, which
917 /// tells you the last block hash which was connected. You should get the best block tip before using the manager.
918 /// See [`chain::Listen`] and [`chain::Confirm`] for more details.
920 /// Note that `ChannelManager` is responsible for tracking liveness of its channels and generating
921 /// [`ChannelUpdate`] messages informing peers that the channel is temporarily disabled. To avoid
922 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
923 /// offline for a full minute. In order to track this, you must call
924 /// [`timer_tick_occurred`] roughly once per minute, though it doesn't have to be perfect.
926 /// To avoid trivial DoS issues, `ChannelManager` limits the number of inbound connections and
927 /// inbound channels without confirmed funding transactions. This may result in nodes which we do
928 /// not have a channel with being unable to connect to us or open new channels with us if we have
929 /// many peers with unfunded channels.
931 /// Because it is an indication of trust, inbound channels which we've accepted as 0conf are
932 /// exempted from the count of unfunded channels. Similarly, outbound channels and connections are
933 /// never limited. Please ensure you limit the count of such channels yourself.
935 /// Rather than using a plain `ChannelManager`, it is preferable to use either a [`SimpleArcChannelManager`]
936 /// a [`SimpleRefChannelManager`], for conciseness. See their documentation for more details, but
937 /// essentially you should default to using a [`SimpleRefChannelManager`], and use a
938 /// [`SimpleArcChannelManager`] when you require a `ChannelManager` with a static lifetime, such as when
939 /// you're using lightning-net-tokio.
941 /// [`peer_disconnected`]: msgs::ChannelMessageHandler::peer_disconnected
942 /// [`funding_created`]: msgs::FundingCreated
943 /// [`funding_transaction_generated`]: Self::funding_transaction_generated
944 /// [`BlockHash`]: bitcoin::hash_types::BlockHash
945 /// [`update_channel`]: chain::Watch::update_channel
946 /// [`ChannelUpdate`]: msgs::ChannelUpdate
947 /// [`timer_tick_occurred`]: Self::timer_tick_occurred
948 /// [`read`]: ReadableArgs::read
951 // The tree structure below illustrates the lock order requirements for the different locks of the
952 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
953 // and should then be taken in the order of the lowest to the highest level in the tree.
954 // Note that locks on different branches shall not be taken at the same time, as doing so will
955 // create a new lock order for those specific locks in the order they were taken.
959 // `total_consistency_lock`
961 // |__`forward_htlcs`
963 // | |__`pending_intercepted_htlcs`
965 // |__`per_peer_state`
967 // | |__`pending_inbound_payments`
969 // | |__`claimable_payments`
971 // | |__`pending_outbound_payments` // This field's struct contains a map of pending outbounds
977 // | |__`short_to_chan_info`
979 // | |__`outbound_scid_aliases`
983 // | |__`pending_events`
985 // | |__`pending_background_events`
987 pub struct ChannelManager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
989 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
990 T::Target: BroadcasterInterface,
991 ES::Target: EntropySource,
992 NS::Target: NodeSigner,
993 SP::Target: SignerProvider,
994 F::Target: FeeEstimator,
998 default_configuration: UserConfig,
999 genesis_hash: BlockHash,
1000 fee_estimator: LowerBoundedFeeEstimator<F>,
1006 /// See `ChannelManager` struct-level documentation for lock order requirements.
1008 pub(super) best_block: RwLock<BestBlock>,
1010 best_block: RwLock<BestBlock>,
1011 secp_ctx: Secp256k1<secp256k1::All>,
1013 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
1014 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
1015 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
1016 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
1018 /// See `ChannelManager` struct-level documentation for lock order requirements.
1019 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
1021 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
1022 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
1023 /// (if the channel has been force-closed), however we track them here to prevent duplicative
1024 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
1025 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
1026 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
1027 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
1028 /// after reloading from disk while replaying blocks against ChannelMonitors.
1030 /// See `PendingOutboundPayment` documentation for more info.
1032 /// See `ChannelManager` struct-level documentation for lock order requirements.
1033 pending_outbound_payments: OutboundPayments,
1035 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
1037 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
1038 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
1039 /// and via the classic SCID.
1041 /// Note that no consistency guarantees are made about the existence of a channel with the
1042 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
1044 /// See `ChannelManager` struct-level documentation for lock order requirements.
1046 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1048 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1049 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
1050 /// until the user tells us what we should do with them.
1052 /// See `ChannelManager` struct-level documentation for lock order requirements.
1053 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
1055 /// The sets of payments which are claimable or currently being claimed. See
1056 /// [`ClaimablePayments`]' individual field docs for more info.
1058 /// See `ChannelManager` struct-level documentation for lock order requirements.
1059 claimable_payments: Mutex<ClaimablePayments>,
1061 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
1062 /// and some closed channels which reached a usable state prior to being closed. This is used
1063 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
1064 /// active channel list on load.
1066 /// See `ChannelManager` struct-level documentation for lock order requirements.
1067 outbound_scid_aliases: Mutex<HashSet<u64>>,
1069 /// `channel_id` -> `counterparty_node_id`.
1071 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
1072 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
1073 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
1075 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
1076 /// the corresponding channel for the event, as we only have access to the `channel_id` during
1077 /// the handling of the events.
1079 /// Note that no consistency guarantees are made about the existence of a peer with the
1080 /// `counterparty_node_id` in our other maps.
1083 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
1084 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
1085 /// would break backwards compatability.
1086 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
1087 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
1088 /// required to access the channel with the `counterparty_node_id`.
1090 /// See `ChannelManager` struct-level documentation for lock order requirements.
1091 id_to_peer: Mutex<HashMap<ChannelId, PublicKey>>,
1093 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
1095 /// Outbound SCID aliases are added here once the channel is available for normal use, with
1096 /// SCIDs being added once the funding transaction is confirmed at the channel's required
1097 /// confirmation depth.
1099 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
1100 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
1101 /// channel with the `channel_id` in our other maps.
1103 /// See `ChannelManager` struct-level documentation for lock order requirements.
1105 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1107 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1109 our_network_pubkey: PublicKey,
1111 inbound_payment_key: inbound_payment::ExpandedKey,
1113 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
1114 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
1115 /// we encrypt the namespace identifier using these bytes.
1117 /// [fake scids]: crate::util::scid_utils::fake_scid
1118 fake_scid_rand_bytes: [u8; 32],
1120 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
1121 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
1122 /// keeping additional state.
1123 probing_cookie_secret: [u8; 32],
1125 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
1126 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
1127 /// very far in the past, and can only ever be up to two hours in the future.
1128 highest_seen_timestamp: AtomicUsize,
1130 /// The bulk of our storage. Currently the `per_peer_state` stores our channels on a per-peer
1131 /// basis, as well as the peer's latest features.
1133 /// If we are connected to a peer we always at least have an entry here, even if no channels
1134 /// are currently open with that peer.
1136 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
1137 /// operate on the inner value freely. This opens up for parallel per-peer operation for
1140 /// Note that the same thread must never acquire two inner `PeerState` locks at the same time.
1142 /// See `ChannelManager` struct-level documentation for lock order requirements.
1143 #[cfg(not(any(test, feature = "_test_utils")))]
1144 per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1145 #[cfg(any(test, feature = "_test_utils"))]
1146 pub(super) per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1148 /// The set of events which we need to give to the user to handle. In some cases an event may
1149 /// require some further action after the user handles it (currently only blocking a monitor
1150 /// update from being handed to the user to ensure the included changes to the channel state
1151 /// are handled by the user before they're persisted durably to disk). In that case, the second
1152 /// element in the tuple is set to `Some` with further details of the action.
1154 /// Note that events MUST NOT be removed from pending_events after deserialization, as they
1155 /// could be in the middle of being processed without the direct mutex held.
1157 /// See `ChannelManager` struct-level documentation for lock order requirements.
1158 #[cfg(not(any(test, feature = "_test_utils")))]
1159 pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1160 #[cfg(any(test, feature = "_test_utils"))]
1161 pub(crate) pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1163 /// A simple atomic flag to ensure only one task at a time can be processing events asynchronously.
1164 pending_events_processor: AtomicBool,
1166 /// If we are running during init (either directly during the deserialization method or in
1167 /// block connection methods which run after deserialization but before normal operation) we
1168 /// cannot provide the user with [`ChannelMonitorUpdate`]s through the normal update flow -
1169 /// prior to normal operation the user may not have loaded the [`ChannelMonitor`]s into their
1170 /// [`ChainMonitor`] and thus attempting to update it will fail or panic.
1172 /// Thus, we place them here to be handled as soon as possible once we are running normally.
1174 /// See `ChannelManager` struct-level documentation for lock order requirements.
1176 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
1177 pending_background_events: Mutex<Vec<BackgroundEvent>>,
1178 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
1179 /// Essentially just when we're serializing ourselves out.
1180 /// Taken first everywhere where we are making changes before any other locks.
1181 /// When acquiring this lock in read mode, rather than acquiring it directly, call
1182 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
1183 /// Notifier the lock contains sends out a notification when the lock is released.
1184 total_consistency_lock: RwLock<()>,
1186 background_events_processed_since_startup: AtomicBool,
1188 persistence_notifier: Notifier,
1192 signer_provider: SP,
1197 /// Chain-related parameters used to construct a new `ChannelManager`.
1199 /// Typically, the block-specific parameters are derived from the best block hash for the network,
1200 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
1201 /// are not needed when deserializing a previously constructed `ChannelManager`.
1202 #[derive(Clone, Copy, PartialEq)]
1203 pub struct ChainParameters {
1204 /// The network for determining the `chain_hash` in Lightning messages.
1205 pub network: Network,
1207 /// The hash and height of the latest block successfully connected.
1209 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
1210 pub best_block: BestBlock,
1213 #[derive(Copy, Clone, PartialEq)]
1220 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
1221 /// desirable to notify any listeners on `await_persistable_update_timeout`/
1222 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
1223 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
1224 /// sending the aforementioned notification (since the lock being released indicates that the
1225 /// updates are ready for persistence).
1227 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
1228 /// notify or not based on whether relevant changes have been made, providing a closure to
1229 /// `optionally_notify` which returns a `NotifyOption`.
1230 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
1231 persistence_notifier: &'a Notifier,
1233 // We hold onto this result so the lock doesn't get released immediately.
1234 _read_guard: RwLockReadGuard<'a, ()>,
1237 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
1238 fn notify_on_drop<C: AChannelManager>(cm: &'a C) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
1239 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1240 let _ = cm.get_cm().process_background_events(); // We always persist
1242 PersistenceNotifierGuard {
1243 persistence_notifier: &cm.get_cm().persistence_notifier,
1244 should_persist: || -> NotifyOption { NotifyOption::DoPersist },
1245 _read_guard: read_guard,
1250 /// Note that if any [`ChannelMonitorUpdate`]s are possibly generated,
1251 /// [`ChannelManager::process_background_events`] MUST be called first.
1252 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a Notifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
1253 let read_guard = lock.read().unwrap();
1255 PersistenceNotifierGuard {
1256 persistence_notifier: notifier,
1257 should_persist: persist_check,
1258 _read_guard: read_guard,
1263 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
1264 fn drop(&mut self) {
1265 if (self.should_persist)() == NotifyOption::DoPersist {
1266 self.persistence_notifier.notify();
1271 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
1272 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
1274 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
1276 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
1277 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
1278 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
1279 /// the maximum required amount in lnd as of March 2021.
1280 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
1282 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
1283 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
1285 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
1287 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
1288 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
1289 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
1290 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
1291 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
1292 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
1293 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
1294 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
1295 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
1296 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
1297 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
1298 // routing failure for any HTLC sender picking up an LDK node among the first hops.
1299 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
1301 /// Minimum CLTV difference between the current block height and received inbound payments.
1302 /// Invoices generated for payment to us must set their `min_final_cltv_expiry_delta` field to at least
1304 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
1305 // any payments to succeed. Further, we don't want payments to fail if a block was found while
1306 // a payment was being routed, so we add an extra block to be safe.
1307 pub const MIN_FINAL_CLTV_EXPIRY_DELTA: u16 = HTLC_FAIL_BACK_BUFFER as u16 + 3;
1309 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
1310 // ie that if the next-hop peer fails the HTLC within
1311 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
1312 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
1313 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
1314 // LATENCY_GRACE_PERIOD_BLOCKS.
1317 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;
1319 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
1320 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
1323 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
1325 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
1326 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
1328 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is disconnected
1329 /// until we mark the channel disabled and gossip the update.
1330 pub(crate) const DISABLE_GOSSIP_TICKS: u8 = 10;
1332 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is connected until
1333 /// we mark the channel enabled and gossip the update.
1334 pub(crate) const ENABLE_GOSSIP_TICKS: u8 = 5;
1336 /// The maximum number of unfunded channels we can have per-peer before we start rejecting new
1337 /// (inbound) ones. The number of peers with unfunded channels is limited separately in
1338 /// [`MAX_UNFUNDED_CHANNEL_PEERS`].
1339 const MAX_UNFUNDED_CHANS_PER_PEER: usize = 4;
1341 /// The maximum number of peers from which we will allow pending unfunded channels. Once we reach
1342 /// this many peers we reject new (inbound) channels from peers with which we don't have a channel.
1343 const MAX_UNFUNDED_CHANNEL_PEERS: usize = 50;
1345 /// The maximum number of peers which we do not have a (funded) channel with. Once we reach this
1346 /// many peers we reject new (inbound) connections.
1347 const MAX_NO_CHANNEL_PEERS: usize = 250;
1349 /// Information needed for constructing an invoice route hint for this channel.
1350 #[derive(Clone, Debug, PartialEq)]
1351 pub struct CounterpartyForwardingInfo {
1352 /// Base routing fee in millisatoshis.
1353 pub fee_base_msat: u32,
1354 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
1355 pub fee_proportional_millionths: u32,
1356 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
1357 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
1358 /// `cltv_expiry_delta` for more details.
1359 pub cltv_expiry_delta: u16,
1362 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
1363 /// to better separate parameters.
1364 #[derive(Clone, Debug, PartialEq)]
1365 pub struct ChannelCounterparty {
1366 /// The node_id of our counterparty
1367 pub node_id: PublicKey,
1368 /// The Features the channel counterparty provided upon last connection.
1369 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
1370 /// many routing-relevant features are present in the init context.
1371 pub features: InitFeatures,
1372 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
1373 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
1374 /// claiming at least this value on chain.
1376 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
1378 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
1379 pub unspendable_punishment_reserve: u64,
1380 /// Information on the fees and requirements that the counterparty requires when forwarding
1381 /// payments to us through this channel.
1382 pub forwarding_info: Option<CounterpartyForwardingInfo>,
1383 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
1384 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
1385 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
1386 pub outbound_htlc_minimum_msat: Option<u64>,
1387 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
1388 pub outbound_htlc_maximum_msat: Option<u64>,
1391 /// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
1393 /// Balances of a channel are available through [`ChainMonitor::get_claimable_balances`] and
1394 /// [`ChannelMonitor::get_claimable_balances`], calculated with respect to the corresponding on-chain
1397 /// [`ChainMonitor::get_claimable_balances`]: crate::chain::chainmonitor::ChainMonitor::get_claimable_balances
1398 #[derive(Clone, Debug, PartialEq)]
1399 pub struct ChannelDetails {
1400 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
1401 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
1402 /// Note that this means this value is *not* persistent - it can change once during the
1403 /// lifetime of the channel.
1404 pub channel_id: ChannelId,
1405 /// Parameters which apply to our counterparty. See individual fields for more information.
1406 pub counterparty: ChannelCounterparty,
1407 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
1408 /// our counterparty already.
1410 /// Note that, if this has been set, `channel_id` will be equivalent to
1411 /// `funding_txo.unwrap().to_channel_id()`.
1412 pub funding_txo: Option<OutPoint>,
1413 /// The features which this channel operates with. See individual features for more info.
1415 /// `None` until negotiation completes and the channel type is finalized.
1416 pub channel_type: Option<ChannelTypeFeatures>,
1417 /// The position of the funding transaction in the chain. None if the funding transaction has
1418 /// not yet been confirmed and the channel fully opened.
1420 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1421 /// payments instead of this. See [`get_inbound_payment_scid`].
1423 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1424 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1426 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1427 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1428 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1429 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1430 /// [`confirmations_required`]: Self::confirmations_required
1431 pub short_channel_id: Option<u64>,
1432 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1433 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1434 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1437 /// This will be `None` as long as the channel is not available for routing outbound payments.
1439 /// [`short_channel_id`]: Self::short_channel_id
1440 /// [`confirmations_required`]: Self::confirmations_required
1441 pub outbound_scid_alias: Option<u64>,
1442 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1443 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1444 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1445 /// when they see a payment to be routed to us.
1447 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1448 /// previous values for inbound payment forwarding.
1450 /// [`short_channel_id`]: Self::short_channel_id
1451 pub inbound_scid_alias: Option<u64>,
1452 /// The value, in satoshis, of this channel as appears in the funding output
1453 pub channel_value_satoshis: u64,
1454 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1455 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1456 /// this value on chain.
1458 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1460 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1462 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1463 pub unspendable_punishment_reserve: Option<u64>,
1464 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
1465 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
1466 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
1467 /// `user_channel_id` will be randomized for an inbound channel. This may be zero for objects
1468 /// serialized with LDK versions prior to 0.0.113.
1470 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
1471 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
1472 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
1473 pub user_channel_id: u128,
1474 /// The currently negotiated fee rate denominated in satoshi per 1000 weight units,
1475 /// which is applied to commitment and HTLC transactions.
1477 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
1478 pub feerate_sat_per_1000_weight: Option<u32>,
1479 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1480 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1481 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1482 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1484 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1485 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1486 /// should be able to spend nearly this amount.
1487 pub outbound_capacity_msat: u64,
1488 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1489 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1490 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1491 /// to use a limit as close as possible to the HTLC limit we can currently send.
1493 /// See also [`ChannelDetails::next_outbound_htlc_minimum_msat`] and
1494 /// [`ChannelDetails::outbound_capacity_msat`].
1495 pub next_outbound_htlc_limit_msat: u64,
1496 /// The minimum value for sending a single HTLC to the remote peer. This is the equivalent of
1497 /// [`ChannelDetails::next_outbound_htlc_limit_msat`] but represents a lower-bound, rather than
1498 /// an upper-bound. This is intended for use when routing, allowing us to ensure we pick a
1499 /// route which is valid.
1500 pub next_outbound_htlc_minimum_msat: u64,
1501 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1502 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1503 /// available for inclusion in new inbound HTLCs).
1504 /// Note that there are some corner cases not fully handled here, so the actual available
1505 /// inbound capacity may be slightly higher than this.
1507 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1508 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1509 /// However, our counterparty should be able to spend nearly this amount.
1510 pub inbound_capacity_msat: u64,
1511 /// The number of required confirmations on the funding transaction before the funding will be
1512 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1513 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1514 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1515 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1517 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1519 /// [`is_outbound`]: ChannelDetails::is_outbound
1520 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1521 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1522 pub confirmations_required: Option<u32>,
1523 /// The current number of confirmations on the funding transaction.
1525 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1526 pub confirmations: Option<u32>,
1527 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1528 /// until we can claim our funds after we force-close the channel. During this time our
1529 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1530 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1531 /// time to claim our non-HTLC-encumbered funds.
1533 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1534 pub force_close_spend_delay: Option<u16>,
1535 /// True if the channel was initiated (and thus funded) by us.
1536 pub is_outbound: bool,
1537 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1538 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1539 /// required confirmation count has been reached (and we were connected to the peer at some
1540 /// point after the funding transaction received enough confirmations). The required
1541 /// confirmation count is provided in [`confirmations_required`].
1543 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1544 pub is_channel_ready: bool,
1545 /// The stage of the channel's shutdown.
1546 /// `None` for `ChannelDetails` serialized on LDK versions prior to 0.0.116.
1547 pub channel_shutdown_state: Option<ChannelShutdownState>,
1548 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1549 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1551 /// This is a strict superset of `is_channel_ready`.
1552 pub is_usable: bool,
1553 /// True if this channel is (or will be) publicly-announced.
1554 pub is_public: bool,
1555 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1556 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1557 pub inbound_htlc_minimum_msat: Option<u64>,
1558 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1559 pub inbound_htlc_maximum_msat: Option<u64>,
1560 /// Set of configurable parameters that affect channel operation.
1562 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1563 pub config: Option<ChannelConfig>,
1566 impl ChannelDetails {
1567 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1568 /// This should be used for providing invoice hints or in any other context where our
1569 /// counterparty will forward a payment to us.
1571 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1572 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1573 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1574 self.inbound_scid_alias.or(self.short_channel_id)
1577 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1578 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1579 /// we're sending or forwarding a payment outbound over this channel.
1581 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1582 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1583 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1584 self.short_channel_id.or(self.outbound_scid_alias)
1587 fn from_channel_context<SP: Deref, F: Deref>(
1588 context: &ChannelContext<SP>, best_block_height: u32, latest_features: InitFeatures,
1589 fee_estimator: &LowerBoundedFeeEstimator<F>
1592 SP::Target: SignerProvider,
1593 F::Target: FeeEstimator
1595 let balance = context.get_available_balances(fee_estimator);
1596 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1597 context.get_holder_counterparty_selected_channel_reserve_satoshis();
1599 channel_id: context.channel_id(),
1600 counterparty: ChannelCounterparty {
1601 node_id: context.get_counterparty_node_id(),
1602 features: latest_features,
1603 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1604 forwarding_info: context.counterparty_forwarding_info(),
1605 // Ensures that we have actually received the `htlc_minimum_msat` value
1606 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1607 // message (as they are always the first message from the counterparty).
1608 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1609 // default `0` value set by `Channel::new_outbound`.
1610 outbound_htlc_minimum_msat: if context.have_received_message() {
1611 Some(context.get_counterparty_htlc_minimum_msat()) } else { None },
1612 outbound_htlc_maximum_msat: context.get_counterparty_htlc_maximum_msat(),
1614 funding_txo: context.get_funding_txo(),
1615 // Note that accept_channel (or open_channel) is always the first message, so
1616 // `have_received_message` indicates that type negotiation has completed.
1617 channel_type: if context.have_received_message() { Some(context.get_channel_type().clone()) } else { None },
1618 short_channel_id: context.get_short_channel_id(),
1619 outbound_scid_alias: if context.is_usable() { Some(context.outbound_scid_alias()) } else { None },
1620 inbound_scid_alias: context.latest_inbound_scid_alias(),
1621 channel_value_satoshis: context.get_value_satoshis(),
1622 feerate_sat_per_1000_weight: Some(context.get_feerate_sat_per_1000_weight()),
1623 unspendable_punishment_reserve: to_self_reserve_satoshis,
1624 inbound_capacity_msat: balance.inbound_capacity_msat,
1625 outbound_capacity_msat: balance.outbound_capacity_msat,
1626 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1627 next_outbound_htlc_minimum_msat: balance.next_outbound_htlc_minimum_msat,
1628 user_channel_id: context.get_user_id(),
1629 confirmations_required: context.minimum_depth(),
1630 confirmations: Some(context.get_funding_tx_confirmations(best_block_height)),
1631 force_close_spend_delay: context.get_counterparty_selected_contest_delay(),
1632 is_outbound: context.is_outbound(),
1633 is_channel_ready: context.is_usable(),
1634 is_usable: context.is_live(),
1635 is_public: context.should_announce(),
1636 inbound_htlc_minimum_msat: Some(context.get_holder_htlc_minimum_msat()),
1637 inbound_htlc_maximum_msat: context.get_holder_htlc_maximum_msat(),
1638 config: Some(context.config()),
1639 channel_shutdown_state: Some(context.shutdown_state()),
1644 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
1645 /// Further information on the details of the channel shutdown.
1646 /// Upon channels being forced closed (i.e. commitment transaction confirmation detected
1647 /// by `ChainMonitor`), ChannelShutdownState will be set to `ShutdownComplete` or
1648 /// the channel will be removed shortly.
1649 /// Also note, that in normal operation, peers could disconnect at any of these states
1650 /// and require peer re-connection before making progress onto other states
1651 pub enum ChannelShutdownState {
1652 /// Channel has not sent or received a shutdown message.
1654 /// Local node has sent a shutdown message for this channel.
1656 /// Shutdown message exchanges have concluded and the channels are in the midst of
1657 /// resolving all existing open HTLCs before closing can continue.
1659 /// All HTLCs have been resolved, nodes are currently negotiating channel close onchain fee rates.
1660 NegotiatingClosingFee,
1661 /// We've successfully negotiated a closing_signed dance. At this point `ChannelManager` is about
1662 /// to drop the channel.
1666 /// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
1667 /// These include payments that have yet to find a successful path, or have unresolved HTLCs.
1668 #[derive(Debug, PartialEq)]
1669 pub enum RecentPaymentDetails {
1670 /// When an invoice was requested and thus a payment has not yet been sent.
1672 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1673 /// a payment and ensure idempotency in LDK.
1674 payment_id: PaymentId,
1676 /// When a payment is still being sent and awaiting successful delivery.
1678 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1679 /// a payment and ensure idempotency in LDK.
1680 payment_id: PaymentId,
1681 /// Hash of the payment that is currently being sent but has yet to be fulfilled or
1683 payment_hash: PaymentHash,
1684 /// Total amount (in msat, excluding fees) across all paths for this payment,
1685 /// not just the amount currently inflight.
1688 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
1689 /// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
1690 /// payment is removed from tracking.
1692 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1693 /// a payment and ensure idempotency in LDK.
1694 payment_id: PaymentId,
1695 /// Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
1696 /// made before LDK version 0.0.104.
1697 payment_hash: Option<PaymentHash>,
1699 /// After a payment's retries are exhausted per the provided [`Retry`], or it is explicitly
1700 /// abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
1701 /// pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
1703 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1704 /// a payment and ensure idempotency in LDK.
1705 payment_id: PaymentId,
1706 /// Hash of the payment that we have given up trying to send.
1707 payment_hash: PaymentHash,
1711 /// Route hints used in constructing invoices for [phantom node payents].
1713 /// [phantom node payments]: crate::sign::PhantomKeysManager
1715 pub struct PhantomRouteHints {
1716 /// The list of channels to be included in the invoice route hints.
1717 pub channels: Vec<ChannelDetails>,
1718 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1720 pub phantom_scid: u64,
1721 /// The pubkey of the real backing node that would ultimately receive the payment.
1722 pub real_node_pubkey: PublicKey,
1725 macro_rules! handle_error {
1726 ($self: ident, $internal: expr, $counterparty_node_id: expr) => { {
1727 // In testing, ensure there are no deadlocks where the lock is already held upon
1728 // entering the macro.
1729 debug_assert_ne!($self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
1730 debug_assert_ne!($self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
1734 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish, channel_capacity }) => {
1735 let mut msg_events = Vec::with_capacity(2);
1737 if let Some((shutdown_res, update_option)) = shutdown_finish {
1738 $self.finish_force_close_channel(shutdown_res);
1739 if let Some(update) = update_option {
1740 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1744 if let Some((channel_id, user_channel_id)) = chan_id {
1745 $self.pending_events.lock().unwrap().push_back((events::Event::ChannelClosed {
1746 channel_id, user_channel_id,
1747 reason: ClosureReason::ProcessingError { err: err.err.clone() },
1748 counterparty_node_id: Some($counterparty_node_id),
1749 channel_capacity_sats: channel_capacity,
1754 log_error!($self.logger, "{}", err.err);
1755 if let msgs::ErrorAction::IgnoreError = err.action {
1757 msg_events.push(events::MessageSendEvent::HandleError {
1758 node_id: $counterparty_node_id,
1759 action: err.action.clone()
1763 if !msg_events.is_empty() {
1764 let per_peer_state = $self.per_peer_state.read().unwrap();
1765 if let Some(peer_state_mutex) = per_peer_state.get(&$counterparty_node_id) {
1766 let mut peer_state = peer_state_mutex.lock().unwrap();
1767 peer_state.pending_msg_events.append(&mut msg_events);
1771 // Return error in case higher-API need one
1776 ($self: ident, $internal: expr) => {
1779 Err((chan, msg_handle_err)) => {
1780 let counterparty_node_id = chan.get_counterparty_node_id();
1781 handle_error!($self, Err(msg_handle_err), counterparty_node_id).map_err(|err| (chan, err))
1787 macro_rules! update_maps_on_chan_removal {
1788 ($self: expr, $channel_context: expr) => {{
1789 $self.id_to_peer.lock().unwrap().remove(&$channel_context.channel_id());
1790 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1791 if let Some(short_id) = $channel_context.get_short_channel_id() {
1792 short_to_chan_info.remove(&short_id);
1794 // If the channel was never confirmed on-chain prior to its closure, remove the
1795 // outbound SCID alias we used for it from the collision-prevention set. While we
1796 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1797 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1798 // opening a million channels with us which are closed before we ever reach the funding
1800 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel_context.outbound_scid_alias());
1801 debug_assert!(alias_removed);
1803 short_to_chan_info.remove(&$channel_context.outbound_scid_alias());
1807 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1808 macro_rules! convert_chan_phase_err {
1809 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, MANUAL_CHANNEL_UPDATE, $channel_update: expr) => {
1811 ChannelError::Warn(msg) => {
1812 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), *$channel_id))
1814 ChannelError::Ignore(msg) => {
1815 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), *$channel_id))
1817 ChannelError::Close(msg) => {
1818 log_error!($self.logger, "Closing channel {} due to close-required error: {}", $channel_id, msg);
1819 update_maps_on_chan_removal!($self, $channel.context);
1820 let shutdown_res = $channel.context.force_shutdown(true);
1821 let user_id = $channel.context.get_user_id();
1822 let channel_capacity_satoshis = $channel.context.get_value_satoshis();
1824 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, user_id,
1825 shutdown_res, $channel_update, channel_capacity_satoshis))
1829 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, FUNDED_CHANNEL) => {
1830 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, { $self.get_channel_update_for_broadcast($channel).ok() })
1832 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, UNFUNDED_CHANNEL) => {
1833 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, None)
1835 ($self: ident, $err: expr, $channel_phase: expr, $channel_id: expr) => {
1836 match $channel_phase {
1837 ChannelPhase::Funded(channel) => {
1838 convert_chan_phase_err!($self, $err, channel, $channel_id, FUNDED_CHANNEL)
1840 ChannelPhase::UnfundedOutboundV1(channel) => {
1841 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
1843 ChannelPhase::UnfundedInboundV1(channel) => {
1844 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
1850 macro_rules! break_chan_phase_entry {
1851 ($self: ident, $res: expr, $entry: expr) => {
1855 let key = *$entry.key();
1856 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
1858 $entry.remove_entry();
1866 macro_rules! try_chan_phase_entry {
1867 ($self: ident, $res: expr, $entry: expr) => {
1871 let key = *$entry.key();
1872 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
1874 $entry.remove_entry();
1882 macro_rules! remove_channel_phase {
1883 ($self: expr, $entry: expr) => {
1885 let channel = $entry.remove_entry().1;
1886 update_maps_on_chan_removal!($self, &channel.context());
1892 macro_rules! send_channel_ready {
1893 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
1894 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1895 node_id: $channel.context.get_counterparty_node_id(),
1896 msg: $channel_ready_msg,
1898 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1899 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1900 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1901 let outbound_alias_insert = short_to_chan_info.insert($channel.context.outbound_scid_alias(), ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
1902 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
1903 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1904 if let Some(real_scid) = $channel.context.get_short_channel_id() {
1905 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
1906 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
1907 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1912 macro_rules! emit_channel_pending_event {
1913 ($locked_events: expr, $channel: expr) => {
1914 if $channel.context.should_emit_channel_pending_event() {
1915 $locked_events.push_back((events::Event::ChannelPending {
1916 channel_id: $channel.context.channel_id(),
1917 former_temporary_channel_id: $channel.context.temporary_channel_id(),
1918 counterparty_node_id: $channel.context.get_counterparty_node_id(),
1919 user_channel_id: $channel.context.get_user_id(),
1920 funding_txo: $channel.context.get_funding_txo().unwrap().into_bitcoin_outpoint(),
1922 $channel.context.set_channel_pending_event_emitted();
1927 macro_rules! emit_channel_ready_event {
1928 ($locked_events: expr, $channel: expr) => {
1929 if $channel.context.should_emit_channel_ready_event() {
1930 debug_assert!($channel.context.channel_pending_event_emitted());
1931 $locked_events.push_back((events::Event::ChannelReady {
1932 channel_id: $channel.context.channel_id(),
1933 user_channel_id: $channel.context.get_user_id(),
1934 counterparty_node_id: $channel.context.get_counterparty_node_id(),
1935 channel_type: $channel.context.get_channel_type().clone(),
1937 $channel.context.set_channel_ready_event_emitted();
1942 macro_rules! handle_monitor_update_completion {
1943 ($self: ident, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
1944 let mut updates = $chan.monitor_updating_restored(&$self.logger,
1945 &$self.node_signer, $self.genesis_hash, &$self.default_configuration,
1946 $self.best_block.read().unwrap().height());
1947 let counterparty_node_id = $chan.context.get_counterparty_node_id();
1948 let channel_update = if updates.channel_ready.is_some() && $chan.context.is_usable() {
1949 // We only send a channel_update in the case where we are just now sending a
1950 // channel_ready and the channel is in a usable state. We may re-send a
1951 // channel_update later through the announcement_signatures process for public
1952 // channels, but there's no reason not to just inform our counterparty of our fees
1954 if let Ok(msg) = $self.get_channel_update_for_unicast($chan) {
1955 Some(events::MessageSendEvent::SendChannelUpdate {
1956 node_id: counterparty_node_id,
1962 let update_actions = $peer_state.monitor_update_blocked_actions
1963 .remove(&$chan.context.channel_id()).unwrap_or(Vec::new());
1965 let htlc_forwards = $self.handle_channel_resumption(
1966 &mut $peer_state.pending_msg_events, $chan, updates.raa,
1967 updates.commitment_update, updates.order, updates.accepted_htlcs,
1968 updates.funding_broadcastable, updates.channel_ready,
1969 updates.announcement_sigs);
1970 if let Some(upd) = channel_update {
1971 $peer_state.pending_msg_events.push(upd);
1974 let channel_id = $chan.context.channel_id();
1975 core::mem::drop($peer_state_lock);
1976 core::mem::drop($per_peer_state_lock);
1978 $self.handle_monitor_update_completion_actions(update_actions);
1980 if let Some(forwards) = htlc_forwards {
1981 $self.forward_htlcs(&mut [forwards][..]);
1983 $self.finalize_claims(updates.finalized_claimed_htlcs);
1984 for failure in updates.failed_htlcs.drain(..) {
1985 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
1986 $self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
1991 macro_rules! handle_new_monitor_update {
1992 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr, _internal, $remove: expr, $completed: expr) => { {
1993 // update_maps_on_chan_removal needs to be able to take id_to_peer, so make sure we can in
1994 // any case so that it won't deadlock.
1995 debug_assert_ne!($self.id_to_peer.held_by_thread(), LockHeldState::HeldByThread);
1996 debug_assert!($self.background_events_processed_since_startup.load(Ordering::Acquire));
1998 ChannelMonitorUpdateStatus::InProgress => {
1999 log_debug!($self.logger, "ChannelMonitor update for {} in flight, holding messages until the update completes.",
2000 &$chan.context.channel_id());
2003 ChannelMonitorUpdateStatus::PermanentFailure => {
2004 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateStatus::PermanentFailure",
2005 &$chan.context.channel_id());
2006 update_maps_on_chan_removal!($self, &$chan.context);
2007 let res = Err(MsgHandleErrInternal::from_finish_shutdown(
2008 "ChannelMonitor storage failure".to_owned(), $chan.context.channel_id(),
2009 $chan.context.get_user_id(), $chan.context.force_shutdown(false),
2010 $self.get_channel_update_for_broadcast(&$chan).ok(), $chan.context.get_value_satoshis()));
2014 ChannelMonitorUpdateStatus::Completed => {
2020 ($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) => {
2021 handle_new_monitor_update!($self, $update_res, $peer_state_lock, $peer_state,
2022 $per_peer_state_lock, $chan, _internal, $remove,
2023 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan))
2025 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan_entry: expr, INITIAL_MONITOR) => {
2026 if let ChannelPhase::Funded(chan) = $chan_entry.get_mut() {
2027 handle_new_monitor_update!($self, $update_res, $peer_state_lock, $peer_state,
2028 $per_peer_state_lock, chan, MANUALLY_REMOVING_INITIAL_MONITOR, { $chan_entry.remove() })
2030 // We're not supposed to handle monitor updates for unfunded channels (they have no monitors to
2032 debug_assert!(false);
2033 let channel_id = *$chan_entry.key();
2034 let (_, err) = convert_chan_phase_err!($self, ChannelError::Close(
2035 "Cannot update monitor for unfunded channels as they don't have monitors yet".into()),
2036 $chan_entry.get_mut(), &channel_id);
2037 $chan_entry.remove();
2041 ($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) => { {
2042 let in_flight_updates = $peer_state.in_flight_monitor_updates.entry($funding_txo)
2043 .or_insert_with(Vec::new);
2044 // During startup, we push monitor updates as background events through to here in
2045 // order to replay updates that were in-flight when we shut down. Thus, we have to
2046 // filter for uniqueness here.
2047 let idx = in_flight_updates.iter().position(|upd| upd == &$update)
2048 .unwrap_or_else(|| {
2049 in_flight_updates.push($update);
2050 in_flight_updates.len() - 1
2052 let update_res = $self.chain_monitor.update_channel($funding_txo, &in_flight_updates[idx]);
2053 handle_new_monitor_update!($self, update_res, $peer_state_lock, $peer_state,
2054 $per_peer_state_lock, $chan, _internal, $remove,
2056 let _ = in_flight_updates.remove(idx);
2057 if in_flight_updates.is_empty() && $chan.blocked_monitor_updates_pending() == 0 {
2058 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan);
2062 ($self: ident, $funding_txo: expr, $update: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan_entry: expr) => {
2063 if let ChannelPhase::Funded(chan) = $chan_entry.get_mut() {
2064 handle_new_monitor_update!($self, $funding_txo, $update, $peer_state_lock, $peer_state,
2065 $per_peer_state_lock, chan, MANUALLY_REMOVING, { $chan_entry.remove() })
2067 // We're not supposed to handle monitor updates for unfunded channels (they have no monitors to
2069 debug_assert!(false);
2070 let channel_id = *$chan_entry.key();
2071 let (_, err) = convert_chan_phase_err!($self, ChannelError::Close(
2072 "Cannot update monitor for unfunded channels as they don't have monitors yet".into()),
2073 $chan_entry.get_mut(), &channel_id);
2074 $chan_entry.remove();
2080 macro_rules! process_events_body {
2081 ($self: expr, $event_to_handle: expr, $handle_event: expr) => {
2082 let mut processed_all_events = false;
2083 while !processed_all_events {
2084 if $self.pending_events_processor.compare_exchange(false, true, Ordering::Acquire, Ordering::Relaxed).is_err() {
2088 let mut result = NotifyOption::SkipPersist;
2091 // We'll acquire our total consistency lock so that we can be sure no other
2092 // persists happen while processing monitor events.
2093 let _read_guard = $self.total_consistency_lock.read().unwrap();
2095 // Because `handle_post_event_actions` may send `ChannelMonitorUpdate`s to the user we must
2096 // ensure any startup-generated background events are handled first.
2097 if $self.process_background_events() == NotifyOption::DoPersist { result = NotifyOption::DoPersist; }
2099 // TODO: This behavior should be documented. It's unintuitive that we query
2100 // ChannelMonitors when clearing other events.
2101 if $self.process_pending_monitor_events() {
2102 result = NotifyOption::DoPersist;
2106 let pending_events = $self.pending_events.lock().unwrap().clone();
2107 let num_events = pending_events.len();
2108 if !pending_events.is_empty() {
2109 result = NotifyOption::DoPersist;
2112 let mut post_event_actions = Vec::new();
2114 for (event, action_opt) in pending_events {
2115 $event_to_handle = event;
2117 if let Some(action) = action_opt {
2118 post_event_actions.push(action);
2123 let mut pending_events = $self.pending_events.lock().unwrap();
2124 pending_events.drain(..num_events);
2125 processed_all_events = pending_events.is_empty();
2126 // Note that `push_pending_forwards_ev` relies on `pending_events_processor` being
2127 // updated here with the `pending_events` lock acquired.
2128 $self.pending_events_processor.store(false, Ordering::Release);
2131 if !post_event_actions.is_empty() {
2132 $self.handle_post_event_actions(post_event_actions);
2133 // If we had some actions, go around again as we may have more events now
2134 processed_all_events = false;
2137 if result == NotifyOption::DoPersist {
2138 $self.persistence_notifier.notify();
2144 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>
2146 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
2147 T::Target: BroadcasterInterface,
2148 ES::Target: EntropySource,
2149 NS::Target: NodeSigner,
2150 SP::Target: SignerProvider,
2151 F::Target: FeeEstimator,
2155 /// Constructs a new `ChannelManager` to hold several channels and route between them.
2157 /// The current time or latest block header time can be provided as the `current_timestamp`.
2159 /// This is the main "logic hub" for all channel-related actions, and implements
2160 /// [`ChannelMessageHandler`].
2162 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
2164 /// Users need to notify the new `ChannelManager` when a new block is connected or
2165 /// disconnected using its [`block_connected`] and [`block_disconnected`] methods, starting
2166 /// from after [`params.best_block.block_hash`]. See [`chain::Listen`] and [`chain::Confirm`] for
2169 /// [`block_connected`]: chain::Listen::block_connected
2170 /// [`block_disconnected`]: chain::Listen::block_disconnected
2171 /// [`params.best_block.block_hash`]: chain::BestBlock::block_hash
2173 fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, entropy_source: ES,
2174 node_signer: NS, signer_provider: SP, config: UserConfig, params: ChainParameters,
2175 current_timestamp: u32,
2177 let mut secp_ctx = Secp256k1::new();
2178 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
2179 let inbound_pmt_key_material = node_signer.get_inbound_payment_key_material();
2180 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
2182 default_configuration: config.clone(),
2183 genesis_hash: genesis_block(params.network).header.block_hash(),
2184 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
2189 best_block: RwLock::new(params.best_block),
2191 outbound_scid_aliases: Mutex::new(HashSet::new()),
2192 pending_inbound_payments: Mutex::new(HashMap::new()),
2193 pending_outbound_payments: OutboundPayments::new(),
2194 forward_htlcs: Mutex::new(HashMap::new()),
2195 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments: HashMap::new(), pending_claiming_payments: HashMap::new() }),
2196 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
2197 id_to_peer: Mutex::new(HashMap::new()),
2198 short_to_chan_info: FairRwLock::new(HashMap::new()),
2200 our_network_pubkey: node_signer.get_node_id(Recipient::Node).unwrap(),
2203 inbound_payment_key: expanded_inbound_key,
2204 fake_scid_rand_bytes: entropy_source.get_secure_random_bytes(),
2206 probing_cookie_secret: entropy_source.get_secure_random_bytes(),
2208 highest_seen_timestamp: AtomicUsize::new(current_timestamp as usize),
2210 per_peer_state: FairRwLock::new(HashMap::new()),
2212 pending_events: Mutex::new(VecDeque::new()),
2213 pending_events_processor: AtomicBool::new(false),
2214 pending_background_events: Mutex::new(Vec::new()),
2215 total_consistency_lock: RwLock::new(()),
2216 background_events_processed_since_startup: AtomicBool::new(false),
2217 persistence_notifier: Notifier::new(),
2227 /// Gets the current configuration applied to all new channels.
2228 pub fn get_current_default_configuration(&self) -> &UserConfig {
2229 &self.default_configuration
2232 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
2233 let height = self.best_block.read().unwrap().height();
2234 let mut outbound_scid_alias = 0;
2237 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
2238 outbound_scid_alias += 1;
2240 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
2242 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
2246 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"); }
2251 /// Creates a new outbound channel to the given remote node and with the given value.
2253 /// `user_channel_id` will be provided back as in
2254 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
2255 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
2256 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
2257 /// is simply copied to events and otherwise ignored.
2259 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
2260 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
2262 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be opened due to failing to
2263 /// generate a shutdown scriptpubkey or destination script set by
2264 /// [`SignerProvider::get_shutdown_scriptpubkey`] or [`SignerProvider::get_destination_script`].
2266 /// Note that we do not check if you are currently connected to the given peer. If no
2267 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
2268 /// the channel eventually being silently forgotten (dropped on reload).
2270 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
2271 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
2272 /// [`ChannelDetails::channel_id`] until after
2273 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
2274 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
2275 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
2277 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
2278 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
2279 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
2280 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_channel_id: u128, override_config: Option<UserConfig>) -> Result<ChannelId, APIError> {
2281 if channel_value_satoshis < 1000 {
2282 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
2285 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2286 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
2287 debug_assert!(&self.total_consistency_lock.try_write().is_err());
2289 let per_peer_state = self.per_peer_state.read().unwrap();
2291 let peer_state_mutex = per_peer_state.get(&their_network_key)
2292 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Not connected to node: {}", their_network_key) })?;
2294 let mut peer_state = peer_state_mutex.lock().unwrap();
2296 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
2297 let their_features = &peer_state.latest_features;
2298 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
2299 match OutboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider, their_network_key,
2300 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
2301 self.best_block.read().unwrap().height(), outbound_scid_alias)
2305 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
2310 let res = channel.get_open_channel(self.genesis_hash.clone());
2312 let temporary_channel_id = channel.context.channel_id();
2313 match peer_state.channel_by_id.entry(temporary_channel_id) {
2314 hash_map::Entry::Occupied(_) => {
2316 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
2318 panic!("RNG is bad???");
2321 hash_map::Entry::Vacant(entry) => { entry.insert(ChannelPhase::UnfundedOutboundV1(channel)); }
2324 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
2325 node_id: their_network_key,
2328 Ok(temporary_channel_id)
2331 fn list_funded_channels_with_filter<Fn: FnMut(&(&ChannelId, &Channel<SP>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
2332 // Allocate our best estimate of the number of channels we have in the `res`
2333 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2334 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2335 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2336 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2337 // the same channel.
2338 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2340 let best_block_height = self.best_block.read().unwrap().height();
2341 let per_peer_state = self.per_peer_state.read().unwrap();
2342 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2343 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2344 let peer_state = &mut *peer_state_lock;
2345 res.extend(peer_state.channel_by_id.iter()
2346 .filter_map(|(chan_id, phase)| match phase {
2347 // Only `Channels` in the `ChannelPhase::Funded` phase can be considered funded.
2348 ChannelPhase::Funded(chan) => Some((chan_id, chan)),
2352 .map(|(_channel_id, channel)| {
2353 ChannelDetails::from_channel_context(&channel.context, best_block_height,
2354 peer_state.latest_features.clone(), &self.fee_estimator)
2362 /// Gets the list of open channels, in random order. See [`ChannelDetails`] field documentation for
2363 /// more information.
2364 pub fn list_channels(&self) -> Vec<ChannelDetails> {
2365 // Allocate our best estimate of the number of channels we have in the `res`
2366 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2367 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2368 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2369 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2370 // the same channel.
2371 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2373 let best_block_height = self.best_block.read().unwrap().height();
2374 let per_peer_state = self.per_peer_state.read().unwrap();
2375 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2376 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2377 let peer_state = &mut *peer_state_lock;
2378 for context in peer_state.channel_by_id.iter().map(|(_, phase)| phase.context()) {
2379 let details = ChannelDetails::from_channel_context(context, best_block_height,
2380 peer_state.latest_features.clone(), &self.fee_estimator);
2388 /// Gets the list of usable channels, in random order. Useful as an argument to
2389 /// [`Router::find_route`] to ensure non-announced channels are used.
2391 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
2392 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
2394 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
2395 // Note we use is_live here instead of usable which leads to somewhat confused
2396 // internal/external nomenclature, but that's ok cause that's probably what the user
2397 // really wanted anyway.
2398 self.list_funded_channels_with_filter(|&(_, ref channel)| channel.context.is_live())
2401 /// Gets the list of channels we have with a given counterparty, in random order.
2402 pub fn list_channels_with_counterparty(&self, counterparty_node_id: &PublicKey) -> Vec<ChannelDetails> {
2403 let best_block_height = self.best_block.read().unwrap().height();
2404 let per_peer_state = self.per_peer_state.read().unwrap();
2406 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
2407 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2408 let peer_state = &mut *peer_state_lock;
2409 let features = &peer_state.latest_features;
2410 let context_to_details = |context| {
2411 ChannelDetails::from_channel_context(context, best_block_height, features.clone(), &self.fee_estimator)
2413 return peer_state.channel_by_id
2415 .map(|(_, phase)| phase.context())
2416 .map(context_to_details)
2422 /// Returns in an undefined order recent payments that -- if not fulfilled -- have yet to find a
2423 /// successful path, or have unresolved HTLCs.
2425 /// This can be useful for payments that may have been prepared, but ultimately not sent, as a
2426 /// result of a crash. If such a payment exists, is not listed here, and an
2427 /// [`Event::PaymentSent`] has not been received, you may consider resending the payment.
2429 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2430 pub fn list_recent_payments(&self) -> Vec<RecentPaymentDetails> {
2431 self.pending_outbound_payments.pending_outbound_payments.lock().unwrap().iter()
2432 .filter_map(|(payment_id, pending_outbound_payment)| match pending_outbound_payment {
2433 PendingOutboundPayment::AwaitingInvoice { .. } => {
2434 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2436 // InvoiceReceived is an intermediate state and doesn't need to be exposed
2437 PendingOutboundPayment::InvoiceReceived { .. } => {
2438 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2440 PendingOutboundPayment::Retryable { payment_hash, total_msat, .. } => {
2441 Some(RecentPaymentDetails::Pending {
2442 payment_id: *payment_id,
2443 payment_hash: *payment_hash,
2444 total_msat: *total_msat,
2447 PendingOutboundPayment::Abandoned { payment_hash, .. } => {
2448 Some(RecentPaymentDetails::Abandoned { payment_id: *payment_id, payment_hash: *payment_hash })
2450 PendingOutboundPayment::Fulfilled { payment_hash, .. } => {
2451 Some(RecentPaymentDetails::Fulfilled { payment_id: *payment_id, payment_hash: *payment_hash })
2453 PendingOutboundPayment::Legacy { .. } => None
2458 /// Helper function that issues the channel close events
2459 fn issue_channel_close_events(&self, context: &ChannelContext<SP>, closure_reason: ClosureReason) {
2460 let mut pending_events_lock = self.pending_events.lock().unwrap();
2461 match context.unbroadcasted_funding() {
2462 Some(transaction) => {
2463 pending_events_lock.push_back((events::Event::DiscardFunding {
2464 channel_id: context.channel_id(), transaction
2469 pending_events_lock.push_back((events::Event::ChannelClosed {
2470 channel_id: context.channel_id(),
2471 user_channel_id: context.get_user_id(),
2472 reason: closure_reason,
2473 counterparty_node_id: Some(context.get_counterparty_node_id()),
2474 channel_capacity_sats: Some(context.get_value_satoshis()),
2478 fn close_channel_internal(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>, override_shutdown_script: Option<ShutdownScript>) -> Result<(), APIError> {
2479 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2481 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
2482 let result: Result<(), _> = loop {
2484 let per_peer_state = self.per_peer_state.read().unwrap();
2486 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2487 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2489 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2490 let peer_state = &mut *peer_state_lock;
2492 match peer_state.channel_by_id.entry(channel_id.clone()) {
2493 hash_map::Entry::Occupied(mut chan_phase_entry) => {
2494 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
2495 let funding_txo_opt = chan.context.get_funding_txo();
2496 let their_features = &peer_state.latest_features;
2497 let (shutdown_msg, mut monitor_update_opt, htlcs) =
2498 chan.get_shutdown(&self.signer_provider, their_features, target_feerate_sats_per_1000_weight, override_shutdown_script)?;
2499 failed_htlcs = htlcs;
2501 // We can send the `shutdown` message before updating the `ChannelMonitor`
2502 // here as we don't need the monitor update to complete until we send a
2503 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
2504 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2505 node_id: *counterparty_node_id,
2509 // Update the monitor with the shutdown script if necessary.
2510 if let Some(monitor_update) = monitor_update_opt.take() {
2511 break handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
2512 peer_state_lock, peer_state, per_peer_state, chan_phase_entry).map(|_| ());
2515 if chan.is_shutdown() {
2516 if let ChannelPhase::Funded(chan) = remove_channel_phase!(self, chan_phase_entry) {
2517 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&chan) {
2518 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2522 self.issue_channel_close_events(&chan.context, ClosureReason::HolderForceClosed);
2528 hash_map::Entry::Vacant(_) => (),
2531 // If we reach this point, it means that the channel_id either refers to an unfunded channel or
2532 // it does not exist for this peer. Either way, we can attempt to force-close it.
2534 // An appropriate error will be returned for non-existence of the channel if that's the case.
2535 return self.force_close_channel_with_peer(&channel_id, counterparty_node_id, None, false).map(|_| ())
2538 for htlc_source in failed_htlcs.drain(..) {
2539 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2540 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
2541 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
2544 let _ = handle_error!(self, result, *counterparty_node_id);
2548 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2549 /// will be accepted on the given channel, and after additional timeout/the closing of all
2550 /// pending HTLCs, the channel will be closed on chain.
2552 /// * If we are the channel initiator, we will pay between our [`Background`] and
2553 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
2555 /// * If our counterparty is the channel initiator, we will require a channel closing
2556 /// transaction feerate of at least our [`Background`] feerate or the feerate which
2557 /// would appear on a force-closure transaction, whichever is lower. We will allow our
2558 /// counterparty to pay as much fee as they'd like, however.
2560 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2562 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2563 /// generate a shutdown scriptpubkey or destination script set by
2564 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2567 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2568 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
2569 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
2570 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2571 pub fn close_channel(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey) -> Result<(), APIError> {
2572 self.close_channel_internal(channel_id, counterparty_node_id, None, None)
2575 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2576 /// will be accepted on the given channel, and after additional timeout/the closing of all
2577 /// pending HTLCs, the channel will be closed on chain.
2579 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
2580 /// the channel being closed or not:
2581 /// * If we are the channel initiator, we will pay at least this feerate on the closing
2582 /// transaction. The upper-bound is set by
2583 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
2584 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
2585 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
2586 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
2587 /// will appear on a force-closure transaction, whichever is lower).
2589 /// The `shutdown_script` provided will be used as the `scriptPubKey` for the closing transaction.
2590 /// Will fail if a shutdown script has already been set for this channel by
2591 /// ['ChannelHandshakeConfig::commit_upfront_shutdown_pubkey`]. The given shutdown script must
2592 /// also be compatible with our and the counterparty's features.
2594 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2596 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2597 /// generate a shutdown scriptpubkey or destination script set by
2598 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2601 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2602 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
2603 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
2604 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2605 pub fn close_channel_with_feerate_and_script(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>, shutdown_script: Option<ShutdownScript>) -> Result<(), APIError> {
2606 self.close_channel_internal(channel_id, counterparty_node_id, target_feerate_sats_per_1000_weight, shutdown_script)
2610 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
2611 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
2612 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
2613 for htlc_source in failed_htlcs.drain(..) {
2614 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
2615 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2616 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2617 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
2619 if let Some((_, funding_txo, monitor_update)) = monitor_update_option {
2620 // There isn't anything we can do if we get an update failure - we're already
2621 // force-closing. The monitor update on the required in-memory copy should broadcast
2622 // the latest local state, which is the best we can do anyway. Thus, it is safe to
2623 // ignore the result here.
2624 let _ = self.chain_monitor.update_channel(funding_txo, &monitor_update);
2628 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
2629 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
2630 fn force_close_channel_with_peer(&self, channel_id: &ChannelId, peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
2631 -> Result<PublicKey, APIError> {
2632 let per_peer_state = self.per_peer_state.read().unwrap();
2633 let peer_state_mutex = per_peer_state.get(peer_node_id)
2634 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", peer_node_id) })?;
2635 let (update_opt, counterparty_node_id) = {
2636 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2637 let peer_state = &mut *peer_state_lock;
2638 let closure_reason = if let Some(peer_msg) = peer_msg {
2639 ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(peer_msg.to_string()) }
2641 ClosureReason::HolderForceClosed
2643 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(channel_id.clone()) {
2644 log_error!(self.logger, "Force-closing channel {}", channel_id);
2645 self.issue_channel_close_events(&chan_phase_entry.get().context(), closure_reason);
2646 let mut chan_phase = remove_channel_phase!(self, chan_phase_entry);
2648 ChannelPhase::Funded(mut chan) => {
2649 self.finish_force_close_channel(chan.context.force_shutdown(broadcast));
2650 (self.get_channel_update_for_broadcast(&chan).ok(), chan.context.get_counterparty_node_id())
2652 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => {
2653 self.finish_force_close_channel(chan_phase.context_mut().force_shutdown(false));
2654 // Unfunded channel has no update
2655 (None, chan_phase.context().get_counterparty_node_id())
2658 } else if peer_state.inbound_channel_request_by_id.remove(channel_id).is_some() {
2659 log_error!(self.logger, "Force-closing channel {}", &channel_id);
2660 // N.B. that we don't send any channel close event here: we
2661 // don't have a user_channel_id, and we never sent any opening
2663 (None, *peer_node_id)
2665 return Err(APIError::ChannelUnavailable{ err: format!("Channel with id {} not found for the passed counterparty node_id {}", channel_id, peer_node_id) });
2668 if let Some(update) = update_opt {
2669 let mut peer_state = peer_state_mutex.lock().unwrap();
2670 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2675 Ok(counterparty_node_id)
2678 fn force_close_sending_error(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
2679 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2680 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
2681 Ok(counterparty_node_id) => {
2682 let per_peer_state = self.per_peer_state.read().unwrap();
2683 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2684 let mut peer_state = peer_state_mutex.lock().unwrap();
2685 peer_state.pending_msg_events.push(
2686 events::MessageSendEvent::HandleError {
2687 node_id: counterparty_node_id,
2688 action: msgs::ErrorAction::SendErrorMessage {
2689 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
2700 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
2701 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
2702 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
2704 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
2705 -> Result<(), APIError> {
2706 self.force_close_sending_error(channel_id, counterparty_node_id, true)
2709 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
2710 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
2711 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
2713 /// You can always get the latest local transaction(s) to broadcast from
2714 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
2715 pub fn force_close_without_broadcasting_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
2716 -> Result<(), APIError> {
2717 self.force_close_sending_error(channel_id, counterparty_node_id, false)
2720 /// Force close all channels, immediately broadcasting the latest local commitment transaction
2721 /// for each to the chain and rejecting new HTLCs on each.
2722 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
2723 for chan in self.list_channels() {
2724 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
2728 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
2729 /// local transaction(s).
2730 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
2731 for chan in self.list_channels() {
2732 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
2736 fn construct_fwd_pending_htlc_info(
2737 &self, msg: &msgs::UpdateAddHTLC, hop_data: msgs::InboundOnionPayload, hop_hmac: [u8; 32],
2738 new_packet_bytes: [u8; onion_utils::ONION_DATA_LEN], shared_secret: [u8; 32],
2739 next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
2740 ) -> Result<PendingHTLCInfo, InboundOnionErr> {
2741 debug_assert!(next_packet_pubkey_opt.is_some());
2742 let outgoing_packet = msgs::OnionPacket {
2744 public_key: next_packet_pubkey_opt.unwrap_or(Err(secp256k1::Error::InvalidPublicKey)),
2745 hop_data: new_packet_bytes,
2749 let (short_channel_id, amt_to_forward, outgoing_cltv_value) = match hop_data {
2750 msgs::InboundOnionPayload::Forward { short_channel_id, amt_to_forward, outgoing_cltv_value } =>
2751 (short_channel_id, amt_to_forward, outgoing_cltv_value),
2752 msgs::InboundOnionPayload::Receive { .. } =>
2753 return Err(InboundOnionErr {
2754 msg: "Final Node OnionHopData provided for us as an intermediary node",
2755 err_code: 0x4000 | 22,
2756 err_data: Vec::new(),
2760 Ok(PendingHTLCInfo {
2761 routing: PendingHTLCRouting::Forward {
2762 onion_packet: outgoing_packet,
2765 payment_hash: msg.payment_hash,
2766 incoming_shared_secret: shared_secret,
2767 incoming_amt_msat: Some(msg.amount_msat),
2768 outgoing_amt_msat: amt_to_forward,
2769 outgoing_cltv_value,
2770 skimmed_fee_msat: None,
2774 fn construct_recv_pending_htlc_info(
2775 &self, hop_data: msgs::InboundOnionPayload, shared_secret: [u8; 32], payment_hash: PaymentHash,
2776 amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>, allow_underpay: bool,
2777 counterparty_skimmed_fee_msat: Option<u64>,
2778 ) -> Result<PendingHTLCInfo, InboundOnionErr> {
2779 let (payment_data, keysend_preimage, custom_tlvs, onion_amt_msat, outgoing_cltv_value, payment_metadata) = match hop_data {
2780 msgs::InboundOnionPayload::Receive {
2781 payment_data, keysend_preimage, custom_tlvs, amt_msat, outgoing_cltv_value, payment_metadata, ..
2783 (payment_data, keysend_preimage, custom_tlvs, amt_msat, outgoing_cltv_value, payment_metadata),
2785 return Err(InboundOnionErr {
2786 err_code: 0x4000|22,
2787 err_data: Vec::new(),
2788 msg: "Got non final data with an HMAC of 0",
2791 // final_incorrect_cltv_expiry
2792 if outgoing_cltv_value > cltv_expiry {
2793 return Err(InboundOnionErr {
2794 msg: "Upstream node set CLTV to less than the CLTV set by the sender",
2796 err_data: cltv_expiry.to_be_bytes().to_vec()
2799 // final_expiry_too_soon
2800 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
2801 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
2803 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
2804 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
2805 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
2806 let current_height: u32 = self.best_block.read().unwrap().height();
2807 if (outgoing_cltv_value as u64) <= current_height as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
2808 let mut err_data = Vec::with_capacity(12);
2809 err_data.extend_from_slice(&amt_msat.to_be_bytes());
2810 err_data.extend_from_slice(¤t_height.to_be_bytes());
2811 return Err(InboundOnionErr {
2812 err_code: 0x4000 | 15, err_data,
2813 msg: "The final CLTV expiry is too soon to handle",
2816 if (!allow_underpay && onion_amt_msat > amt_msat) ||
2817 (allow_underpay && onion_amt_msat >
2818 amt_msat.saturating_add(counterparty_skimmed_fee_msat.unwrap_or(0)))
2820 return Err(InboundOnionErr {
2822 err_data: amt_msat.to_be_bytes().to_vec(),
2823 msg: "Upstream node sent less than we were supposed to receive in payment",
2827 let routing = if let Some(payment_preimage) = keysend_preimage {
2828 // We need to check that the sender knows the keysend preimage before processing this
2829 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
2830 // could discover the final destination of X, by probing the adjacent nodes on the route
2831 // with a keysend payment of identical payment hash to X and observing the processing
2832 // time discrepancies due to a hash collision with X.
2833 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2834 if hashed_preimage != payment_hash {
2835 return Err(InboundOnionErr {
2836 err_code: 0x4000|22,
2837 err_data: Vec::new(),
2838 msg: "Payment preimage didn't match payment hash",
2841 if !self.default_configuration.accept_mpp_keysend && payment_data.is_some() {
2842 return Err(InboundOnionErr {
2843 err_code: 0x4000|22,
2844 err_data: Vec::new(),
2845 msg: "We don't support MPP keysend payments",
2848 PendingHTLCRouting::ReceiveKeysend {
2852 incoming_cltv_expiry: outgoing_cltv_value,
2855 } else if let Some(data) = payment_data {
2856 PendingHTLCRouting::Receive {
2859 incoming_cltv_expiry: outgoing_cltv_value,
2860 phantom_shared_secret,
2864 return Err(InboundOnionErr {
2865 err_code: 0x4000|0x2000|3,
2866 err_data: Vec::new(),
2867 msg: "We require payment_secrets",
2870 Ok(PendingHTLCInfo {
2873 incoming_shared_secret: shared_secret,
2874 incoming_amt_msat: Some(amt_msat),
2875 outgoing_amt_msat: onion_amt_msat,
2876 outgoing_cltv_value,
2877 skimmed_fee_msat: counterparty_skimmed_fee_msat,
2881 fn decode_update_add_htlc_onion(
2882 &self, msg: &msgs::UpdateAddHTLC
2883 ) -> Result<(onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg> {
2884 macro_rules! return_malformed_err {
2885 ($msg: expr, $err_code: expr) => {
2887 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2888 return Err(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
2889 channel_id: msg.channel_id,
2890 htlc_id: msg.htlc_id,
2891 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
2892 failure_code: $err_code,
2898 if let Err(_) = msg.onion_routing_packet.public_key {
2899 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2902 let shared_secret = self.node_signer.ecdh(
2903 Recipient::Node, &msg.onion_routing_packet.public_key.unwrap(), None
2904 ).unwrap().secret_bytes();
2906 if msg.onion_routing_packet.version != 0 {
2907 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2908 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2909 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2910 //receiving node would have to brute force to figure out which version was put in the
2911 //packet by the node that send us the message, in the case of hashing the hop_data, the
2912 //node knows the HMAC matched, so they already know what is there...
2913 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2915 macro_rules! return_err {
2916 ($msg: expr, $err_code: expr, $data: expr) => {
2918 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2919 return Err(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2920 channel_id: msg.channel_id,
2921 htlc_id: msg.htlc_id,
2922 reason: HTLCFailReason::reason($err_code, $data.to_vec())
2923 .get_encrypted_failure_packet(&shared_secret, &None),
2929 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) {
2931 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2932 return_malformed_err!(err_msg, err_code);
2934 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2935 return_err!(err_msg, err_code, &[0; 0]);
2938 let (outgoing_scid, outgoing_amt_msat, outgoing_cltv_value, next_packet_pk_opt) = match next_hop {
2939 onion_utils::Hop::Forward {
2940 next_hop_data: msgs::InboundOnionPayload::Forward {
2941 short_channel_id, amt_to_forward, outgoing_cltv_value
2944 let next_packet_pk = onion_utils::next_hop_pubkey(&self.secp_ctx,
2945 msg.onion_routing_packet.public_key.unwrap(), &shared_secret);
2946 (short_channel_id, amt_to_forward, outgoing_cltv_value, Some(next_packet_pk))
2948 // We'll do receive checks in [`Self::construct_pending_htlc_info`] so we have access to the
2949 // inbound channel's state.
2950 onion_utils::Hop::Receive { .. } => return Ok((next_hop, shared_secret, None)),
2951 onion_utils::Hop::Forward { next_hop_data: msgs::InboundOnionPayload::Receive { .. }, .. } => {
2952 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0; 0]);
2956 // Perform outbound checks here instead of in [`Self::construct_pending_htlc_info`] because we
2957 // can't hold the outbound peer state lock at the same time as the inbound peer state lock.
2958 if let Some((err, mut code, chan_update)) = loop {
2959 let id_option = self.short_to_chan_info.read().unwrap().get(&outgoing_scid).cloned();
2960 let forwarding_chan_info_opt = match id_option {
2961 None => { // unknown_next_peer
2962 // Note that this is likely a timing oracle for detecting whether an scid is a
2963 // phantom or an intercept.
2964 if (self.default_configuration.accept_intercept_htlcs &&
2965 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, outgoing_scid, &self.genesis_hash)) ||
2966 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, outgoing_scid, &self.genesis_hash)
2970 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2973 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
2975 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
2976 let per_peer_state = self.per_peer_state.read().unwrap();
2977 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
2978 if peer_state_mutex_opt.is_none() {
2979 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2981 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
2982 let peer_state = &mut *peer_state_lock;
2983 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id).map(
2984 |chan_phase| if let ChannelPhase::Funded(chan) = chan_phase { Some(chan) } else { None }
2987 // Channel was removed. The short_to_chan_info and channel_by_id maps
2988 // have no consistency guarantees.
2989 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2993 if !chan.context.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
2994 // Note that the behavior here should be identical to the above block - we
2995 // should NOT reveal the existence or non-existence of a private channel if
2996 // we don't allow forwards outbound over them.
2997 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
2999 if chan.context.get_channel_type().supports_scid_privacy() && outgoing_scid != chan.context.outbound_scid_alias() {
3000 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
3001 // "refuse to forward unless the SCID alias was used", so we pretend
3002 // we don't have the channel here.
3003 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
3005 let chan_update_opt = self.get_channel_update_for_onion(outgoing_scid, chan).ok();
3007 // Note that we could technically not return an error yet here and just hope
3008 // that the connection is reestablished or monitor updated by the time we get
3009 // around to doing the actual forward, but better to fail early if we can and
3010 // hopefully an attacker trying to path-trace payments cannot make this occur
3011 // on a small/per-node/per-channel scale.
3012 if !chan.context.is_live() { // channel_disabled
3013 // If the channel_update we're going to return is disabled (i.e. the
3014 // peer has been disabled for some time), return `channel_disabled`,
3015 // otherwise return `temporary_channel_failure`.
3016 if chan_update_opt.as_ref().map(|u| u.contents.flags & 2 == 2).unwrap_or(false) {
3017 break Some(("Forwarding channel has been disconnected for some time.", 0x1000 | 20, chan_update_opt));
3019 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 7, chan_update_opt));
3022 if outgoing_amt_msat < chan.context.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
3023 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
3025 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, outgoing_amt_msat, outgoing_cltv_value) {
3026 break Some((err, code, chan_update_opt));
3030 if (msg.cltv_expiry as u64) < (outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 {
3031 // We really should set `incorrect_cltv_expiry` here but as we're not
3032 // forwarding over a real channel we can't generate a channel_update
3033 // for it. Instead we just return a generic temporary_node_failure.
3035 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
3042 let cur_height = self.best_block.read().unwrap().height() + 1;
3043 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
3044 // but we want to be robust wrt to counterparty packet sanitization (see
3045 // HTLC_FAIL_BACK_BUFFER rationale).
3046 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
3047 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
3049 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
3050 break Some(("CLTV expiry is too far in the future", 21, None));
3052 // If the HTLC expires ~now, don't bother trying to forward it to our
3053 // counterparty. They should fail it anyway, but we don't want to bother with
3054 // the round-trips or risk them deciding they definitely want the HTLC and
3055 // force-closing to ensure they get it if we're offline.
3056 // We previously had a much more aggressive check here which tried to ensure
3057 // our counterparty receives an HTLC which has *our* risk threshold met on it,
3058 // but there is no need to do that, and since we're a bit conservative with our
3059 // risk threshold it just results in failing to forward payments.
3060 if (outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
3061 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
3067 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
3068 if let Some(chan_update) = chan_update {
3069 if code == 0x1000 | 11 || code == 0x1000 | 12 {
3070 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
3072 else if code == 0x1000 | 13 {
3073 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
3075 else if code == 0x1000 | 20 {
3076 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
3077 0u16.write(&mut res).expect("Writes cannot fail");
3079 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
3080 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
3081 chan_update.write(&mut res).expect("Writes cannot fail");
3082 } else if code & 0x1000 == 0x1000 {
3083 // If we're trying to return an error that requires a `channel_update` but
3084 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
3085 // generate an update), just use the generic "temporary_node_failure"
3089 return_err!(err, code, &res.0[..]);
3091 Ok((next_hop, shared_secret, next_packet_pk_opt))
3094 fn construct_pending_htlc_status<'a>(
3095 &self, msg: &msgs::UpdateAddHTLC, shared_secret: [u8; 32], decoded_hop: onion_utils::Hop,
3096 allow_underpay: bool, next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
3097 ) -> PendingHTLCStatus {
3098 macro_rules! return_err {
3099 ($msg: expr, $err_code: expr, $data: expr) => {
3101 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3102 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3103 channel_id: msg.channel_id,
3104 htlc_id: msg.htlc_id,
3105 reason: HTLCFailReason::reason($err_code, $data.to_vec())
3106 .get_encrypted_failure_packet(&shared_secret, &None),
3112 onion_utils::Hop::Receive(next_hop_data) => {
3114 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash,
3115 msg.amount_msat, msg.cltv_expiry, None, allow_underpay, msg.skimmed_fee_msat)
3118 // Note that we could obviously respond immediately with an update_fulfill_htlc
3119 // message, however that would leak that we are the recipient of this payment, so
3120 // instead we stay symmetric with the forwarding case, only responding (after a
3121 // delay) once they've send us a commitment_signed!
3122 PendingHTLCStatus::Forward(info)
3124 Err(InboundOnionErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3127 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
3128 match self.construct_fwd_pending_htlc_info(msg, next_hop_data, next_hop_hmac,
3129 new_packet_bytes, shared_secret, next_packet_pubkey_opt) {
3130 Ok(info) => PendingHTLCStatus::Forward(info),
3131 Err(InboundOnionErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3137 /// Gets the current [`channel_update`] for the given channel. This first checks if the channel is
3138 /// public, and thus should be called whenever the result is going to be passed out in a
3139 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
3141 /// Note that in [`internal_closing_signed`], this function is called without the `peer_state`
3142 /// corresponding to the channel's counterparty locked, as the channel been removed from the
3143 /// storage and the `peer_state` lock has been dropped.
3145 /// [`channel_update`]: msgs::ChannelUpdate
3146 /// [`internal_closing_signed`]: Self::internal_closing_signed
3147 fn get_channel_update_for_broadcast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3148 if !chan.context.should_announce() {
3149 return Err(LightningError {
3150 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
3151 action: msgs::ErrorAction::IgnoreError
3154 if chan.context.get_short_channel_id().is_none() {
3155 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
3157 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", &chan.context.channel_id());
3158 self.get_channel_update_for_unicast(chan)
3161 /// Gets the current [`channel_update`] for the given channel. This does not check if the channel
3162 /// is public (only returning an `Err` if the channel does not yet have an assigned SCID),
3163 /// and thus MUST NOT be called unless the recipient of the resulting message has already
3164 /// provided evidence that they know about the existence of the channel.
3166 /// Note that through [`internal_closing_signed`], this function is called without the
3167 /// `peer_state` corresponding to the channel's counterparty locked, as the channel been
3168 /// removed from the storage and the `peer_state` lock has been dropped.
3170 /// [`channel_update`]: msgs::ChannelUpdate
3171 /// [`internal_closing_signed`]: Self::internal_closing_signed
3172 fn get_channel_update_for_unicast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3173 log_trace!(self.logger, "Attempting to generate channel update for channel {}", &chan.context.channel_id());
3174 let short_channel_id = match chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias()) {
3175 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
3179 self.get_channel_update_for_onion(short_channel_id, chan)
3182 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3183 log_trace!(self.logger, "Generating channel update for channel {}", &chan.context.channel_id());
3184 let were_node_one = self.our_network_pubkey.serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
3186 let enabled = chan.context.is_usable() && match chan.channel_update_status() {
3187 ChannelUpdateStatus::Enabled => true,
3188 ChannelUpdateStatus::DisabledStaged(_) => true,
3189 ChannelUpdateStatus::Disabled => false,
3190 ChannelUpdateStatus::EnabledStaged(_) => false,
3193 let unsigned = msgs::UnsignedChannelUpdate {
3194 chain_hash: self.genesis_hash,
3196 timestamp: chan.context.get_update_time_counter(),
3197 flags: (!were_node_one) as u8 | ((!enabled as u8) << 1),
3198 cltv_expiry_delta: chan.context.get_cltv_expiry_delta(),
3199 htlc_minimum_msat: chan.context.get_counterparty_htlc_minimum_msat(),
3200 htlc_maximum_msat: chan.context.get_announced_htlc_max_msat(),
3201 fee_base_msat: chan.context.get_outbound_forwarding_fee_base_msat(),
3202 fee_proportional_millionths: chan.context.get_fee_proportional_millionths(),
3203 excess_data: Vec::new(),
3205 // Panic on failure to signal LDK should be restarted to retry signing the `ChannelUpdate`.
3206 // If we returned an error and the `node_signer` cannot provide a signature for whatever
3207 // reason`, we wouldn't be able to receive inbound payments through the corresponding
3209 let sig = self.node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelUpdate(&unsigned)).unwrap();
3211 Ok(msgs::ChannelUpdate {
3218 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> {
3219 let _lck = self.total_consistency_lock.read().unwrap();
3220 self.send_payment_along_path(SendAlongPathArgs {
3221 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3226 fn send_payment_along_path(&self, args: SendAlongPathArgs) -> Result<(), APIError> {
3227 let SendAlongPathArgs {
3228 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3231 // The top-level caller should hold the total_consistency_lock read lock.
3232 debug_assert!(self.total_consistency_lock.try_write().is_err());
3234 log_trace!(self.logger,
3235 "Attempting to send payment with payment hash {} along path with next hop {}",
3236 payment_hash, path.hops.first().unwrap().short_channel_id);
3237 let prng_seed = self.entropy_source.get_secure_random_bytes();
3238 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
3240 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
3241 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected".to_owned()})?;
3242 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, recipient_onion, cur_height, keysend_preimage)?;
3244 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash)
3245 .map_err(|_| APIError::InvalidRoute { err: "Route size too large considering onion data".to_owned()})?;
3247 let err: Result<(), _> = loop {
3248 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
3249 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
3250 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3253 let per_peer_state = self.per_peer_state.read().unwrap();
3254 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
3255 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
3256 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3257 let peer_state = &mut *peer_state_lock;
3258 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(id) {
3259 match chan_phase_entry.get_mut() {
3260 ChannelPhase::Funded(chan) => {
3261 if !chan.context.is_live() {
3262 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected".to_owned()});
3264 let funding_txo = chan.context.get_funding_txo().unwrap();
3265 let send_res = chan.send_htlc_and_commit(htlc_msat, payment_hash.clone(),
3266 htlc_cltv, HTLCSource::OutboundRoute {
3268 session_priv: session_priv.clone(),
3269 first_hop_htlc_msat: htlc_msat,
3271 }, onion_packet, None, &self.fee_estimator, &self.logger);
3272 match break_chan_phase_entry!(self, send_res, chan_phase_entry) {
3273 Some(monitor_update) => {
3274 match handle_new_monitor_update!(self, funding_txo, monitor_update, peer_state_lock, peer_state, per_peer_state, chan_phase_entry) {
3275 Err(e) => break Err(e),
3277 // Note that MonitorUpdateInProgress here indicates (per function
3278 // docs) that we will resend the commitment update once monitor
3279 // updating completes. Therefore, we must return an error
3280 // indicating that it is unsafe to retry the payment wholesale,
3281 // which we do in the send_payment check for
3282 // MonitorUpdateInProgress, below.
3283 return Err(APIError::MonitorUpdateInProgress);
3291 _ => return Err(APIError::ChannelUnavailable{err: "Channel to first hop is unfunded".to_owned()}),
3294 // The channel was likely removed after we fetched the id from the
3295 // `short_to_chan_info` map, but before we successfully locked the
3296 // `channel_by_id` map.
3297 // This can occur as no consistency guarantees exists between the two maps.
3298 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
3303 match handle_error!(self, err, path.hops.first().unwrap().pubkey) {
3304 Ok(_) => unreachable!(),
3306 Err(APIError::ChannelUnavailable { err: e.err })
3311 /// Sends a payment along a given route.
3313 /// Value parameters are provided via the last hop in route, see documentation for [`RouteHop`]
3314 /// fields for more info.
3316 /// May generate [`UpdateHTLCs`] message(s) event on success, which should be relayed (e.g. via
3317 /// [`PeerManager::process_events`]).
3319 /// # Avoiding Duplicate Payments
3321 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
3322 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
3323 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
3324 /// [`Event::PaymentSent`] or [`Event::PaymentFailed`]) LDK will not stop you from sending a
3325 /// second payment with the same [`PaymentId`].
3327 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
3328 /// tracking of payments, including state to indicate once a payment has completed. Because you
3329 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
3330 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
3331 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
3333 /// Additionally, in the scenario where we begin the process of sending a payment, but crash
3334 /// before `send_payment` returns (or prior to [`ChannelMonitorUpdate`] persistence if you're
3335 /// using [`ChannelMonitorUpdateStatus::InProgress`]), the payment may be lost on restart. See
3336 /// [`ChannelManager::list_recent_payments`] for more information.
3338 /// # Possible Error States on [`PaymentSendFailure`]
3340 /// Each path may have a different return value, and [`PaymentSendFailure`] may return a `Vec` with
3341 /// each entry matching the corresponding-index entry in the route paths, see
3342 /// [`PaymentSendFailure`] for more info.
3344 /// In general, a path may raise:
3345 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
3346 /// node public key) is specified.
3347 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
3348 /// (including due to previous monitor update failure or new permanent monitor update
3350 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
3351 /// relevant updates.
3353 /// Note that depending on the type of the [`PaymentSendFailure`] the HTLC may have been
3354 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
3355 /// different route unless you intend to pay twice!
3357 /// [`RouteHop`]: crate::routing::router::RouteHop
3358 /// [`Event::PaymentSent`]: events::Event::PaymentSent
3359 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
3360 /// [`UpdateHTLCs`]: events::MessageSendEvent::UpdateHTLCs
3361 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
3362 /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
3363 pub fn send_payment_with_route(&self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
3364 let best_block_height = self.best_block.read().unwrap().height();
3365 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3366 self.pending_outbound_payments
3367 .send_payment_with_route(route, payment_hash, recipient_onion, payment_id,
3368 &self.entropy_source, &self.node_signer, best_block_height,
3369 |args| self.send_payment_along_path(args))
3372 /// Similar to [`ChannelManager::send_payment_with_route`], but will automatically find a route based on
3373 /// `route_params` and retry failed payment paths based on `retry_strategy`.
3374 pub fn send_payment(&self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<(), RetryableSendFailure> {
3375 let best_block_height = self.best_block.read().unwrap().height();
3376 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3377 self.pending_outbound_payments
3378 .send_payment(payment_hash, recipient_onion, payment_id, retry_strategy, route_params,
3379 &self.router, self.list_usable_channels(), || self.compute_inflight_htlcs(),
3380 &self.entropy_source, &self.node_signer, best_block_height, &self.logger,
3381 &self.pending_events, |args| self.send_payment_along_path(args))
3385 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> {
3386 let best_block_height = self.best_block.read().unwrap().height();
3387 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3388 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, recipient_onion,
3389 keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.node_signer,
3390 best_block_height, |args| self.send_payment_along_path(args))
3394 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> {
3395 let best_block_height = self.best_block.read().unwrap().height();
3396 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, recipient_onion, payment_id, route, None, &self.entropy_source, best_block_height)
3400 pub(crate) fn test_set_payment_metadata(&self, payment_id: PaymentId, new_payment_metadata: Option<Vec<u8>>) {
3401 self.pending_outbound_payments.test_set_payment_metadata(payment_id, new_payment_metadata);
3405 /// Signals that no further attempts for the given payment should occur. Useful if you have a
3406 /// pending outbound payment with retries remaining, but wish to stop retrying the payment before
3407 /// retries are exhausted.
3409 /// # Event Generation
3411 /// If no [`Event::PaymentFailed`] event had been generated before, one will be generated as soon
3412 /// as there are no remaining pending HTLCs for this payment.
3414 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
3415 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
3416 /// determine the ultimate status of a payment.
3418 /// # Requested Invoices
3420 /// In the case of paying a [`Bolt12Invoice`], abandoning the payment prior to receiving the
3421 /// invoice will result in an [`Event::InvoiceRequestFailed`] and prevent any attempts at paying
3422 /// it once received. The other events may only be generated once the invoice has been received.
3424 /// # Restart Behavior
3426 /// If an [`Event::PaymentFailed`] is generated and we restart without first persisting the
3427 /// [`ChannelManager`], another [`Event::PaymentFailed`] may be generated; likewise for
3428 /// [`Event::InvoiceRequestFailed`].
3430 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
3431 pub fn abandon_payment(&self, payment_id: PaymentId) {
3432 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3433 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
3436 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
3437 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
3438 /// the preimage, it must be a cryptographically secure random value that no intermediate node
3439 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
3440 /// never reach the recipient.
3442 /// See [`send_payment`] documentation for more details on the return value of this function
3443 /// and idempotency guarantees provided by the [`PaymentId`] key.
3445 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
3446 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
3448 /// [`send_payment`]: Self::send_payment
3449 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
3450 let best_block_height = self.best_block.read().unwrap().height();
3451 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3452 self.pending_outbound_payments.send_spontaneous_payment_with_route(
3453 route, payment_preimage, recipient_onion, payment_id, &self.entropy_source,
3454 &self.node_signer, best_block_height, |args| self.send_payment_along_path(args))
3457 /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
3458 /// based on `route_params` and retry failed payment paths based on `retry_strategy`.
3460 /// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous
3463 /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
3464 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> {
3465 let best_block_height = self.best_block.read().unwrap().height();
3466 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3467 self.pending_outbound_payments.send_spontaneous_payment(payment_preimage, recipient_onion,
3468 payment_id, retry_strategy, route_params, &self.router, self.list_usable_channels(),
3469 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
3470 &self.logger, &self.pending_events, |args| self.send_payment_along_path(args))
3473 /// Send a payment that is probing the given route for liquidity. We calculate the
3474 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
3475 /// us to easily discern them from real payments.
3476 pub fn send_probe(&self, path: Path) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
3477 let best_block_height = self.best_block.read().unwrap().height();
3478 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3479 self.pending_outbound_payments.send_probe(path, self.probing_cookie_secret,
3480 &self.entropy_source, &self.node_signer, best_block_height,
3481 |args| self.send_payment_along_path(args))
3484 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
3487 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
3488 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
3491 /// Sends payment probes over all paths of a route that would be used to pay the given
3492 /// amount to the given `node_id`.
3494 /// See [`ChannelManager::send_preflight_probes`] for more information.
3495 pub fn send_spontaneous_preflight_probes(
3496 &self, node_id: PublicKey, amount_msat: u64, final_cltv_expiry_delta: u32,
3497 liquidity_limit_multiplier: Option<u64>,
3498 ) -> Result<Vec<(PaymentHash, PaymentId)>, ProbeSendFailure> {
3499 let payment_params =
3500 PaymentParameters::from_node_id(node_id, final_cltv_expiry_delta);
3502 let route_params = RouteParameters { payment_params, final_value_msat: amount_msat };
3504 self.send_preflight_probes(route_params, liquidity_limit_multiplier)
3507 /// Sends payment probes over all paths of a route that would be used to pay a route found
3508 /// according to the given [`RouteParameters`].
3510 /// This may be used to send "pre-flight" probes, i.e., to train our scorer before conducting
3511 /// the actual payment. Note this is only useful if there likely is sufficient time for the
3512 /// probe to settle before sending out the actual payment, e.g., when waiting for user
3513 /// confirmation in a wallet UI.
3515 /// Otherwise, there is a chance the probe could take up some liquidity needed to complete the
3516 /// actual payment. Users should therefore be cautious and might avoid sending probes if
3517 /// liquidity is scarce and/or they don't expect the probe to return before they send the
3518 /// payment. To mitigate this issue, channels with available liquidity less than the required
3519 /// amount times the given `liquidity_limit_multiplier` won't be used to send pre-flight
3520 /// probes. If `None` is given as `liquidity_limit_multiplier`, it defaults to `3`.
3521 pub fn send_preflight_probes(
3522 &self, route_params: RouteParameters, liquidity_limit_multiplier: Option<u64>,
3523 ) -> Result<Vec<(PaymentHash, PaymentId)>, ProbeSendFailure> {
3524 let liquidity_limit_multiplier = liquidity_limit_multiplier.unwrap_or(3);
3526 let payer = self.get_our_node_id();
3527 let usable_channels = self.list_usable_channels();
3528 let first_hops = usable_channels.iter().collect::<Vec<_>>();
3529 let inflight_htlcs = self.compute_inflight_htlcs();
3533 .find_route(&payer, &route_params, Some(&first_hops), inflight_htlcs)
3535 log_error!(self.logger, "Failed to find path for payment probe: {:?}", e);
3536 ProbeSendFailure::RouteNotFound
3539 let mut used_liquidity_map = HashMap::with_capacity(first_hops.len());
3541 let mut res = Vec::new();
3542 for path in route.paths {
3543 if path.hops.len() < 2 {
3546 "Skipped sending payment probe over path with less than two hops."
3551 if let Some(first_path_hop) = path.hops.first() {
3552 if let Some(first_hop) = first_hops.iter().find(|h| {
3553 h.get_outbound_payment_scid() == Some(first_path_hop.short_channel_id)
3555 let path_value = path.final_value_msat() + path.fee_msat();
3556 let used_liquidity =
3557 used_liquidity_map.entry(first_path_hop.short_channel_id).or_insert(0);
3559 if first_hop.next_outbound_htlc_limit_msat
3560 < (*used_liquidity + path_value) * liquidity_limit_multiplier
3562 log_debug!(self.logger, "Skipped sending payment probe to avoid putting channel {} under the liquidity limit.", first_path_hop.short_channel_id);
3565 *used_liquidity += path_value;
3570 res.push(self.send_probe(path).map_err(|e| {
3571 log_error!(self.logger, "Failed to send pre-flight probe: {:?}", e);
3572 ProbeSendFailure::SendingFailed(e)
3579 /// Handles the generation of a funding transaction, optionally (for tests) with a function
3580 /// which checks the correctness of the funding transaction given the associated channel.
3581 fn funding_transaction_generated_intern<FundingOutput: Fn(&OutboundV1Channel<SP>, &Transaction) -> Result<OutPoint, APIError>>(
3582 &self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
3583 ) -> Result<(), APIError> {
3584 let per_peer_state = self.per_peer_state.read().unwrap();
3585 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3586 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3588 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3589 let peer_state = &mut *peer_state_lock;
3590 let (chan, msg) = match peer_state.channel_by_id.remove(temporary_channel_id) {
3591 Some(ChannelPhase::UnfundedOutboundV1(chan)) => {
3592 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
3594 let funding_res = chan.get_funding_created(funding_transaction, funding_txo, &self.logger)
3595 .map_err(|(mut chan, e)| if let ChannelError::Close(msg) = e {
3596 let channel_id = chan.context.channel_id();
3597 let user_id = chan.context.get_user_id();
3598 let shutdown_res = chan.context.force_shutdown(false);
3599 let channel_capacity = chan.context.get_value_satoshis();
3600 (chan, MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, user_id, shutdown_res, None, channel_capacity))
3601 } else { unreachable!(); });
3603 Ok((chan, funding_msg)) => (chan, funding_msg),
3604 Err((chan, err)) => {
3605 mem::drop(peer_state_lock);
3606 mem::drop(per_peer_state);
3608 let _: Result<(), _> = handle_error!(self, Err(err), chan.context.get_counterparty_node_id());
3609 return Err(APIError::ChannelUnavailable {
3610 err: "Signer refused to sign the initial commitment transaction".to_owned()
3616 peer_state.channel_by_id.insert(*temporary_channel_id, phase);
3617 return Err(APIError::APIMisuseError {
3619 "Channel with id {} for the passed counterparty node_id {} is not an unfunded, outbound V1 channel",
3620 temporary_channel_id, counterparty_node_id),
3623 None => return Err(APIError::ChannelUnavailable {err: format!(
3624 "Channel with id {} not found for the passed counterparty node_id {}",
3625 temporary_channel_id, counterparty_node_id),
3629 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
3630 node_id: chan.context.get_counterparty_node_id(),
3633 match peer_state.channel_by_id.entry(chan.context.channel_id()) {
3634 hash_map::Entry::Occupied(_) => {
3635 panic!("Generated duplicate funding txid?");
3637 hash_map::Entry::Vacant(e) => {
3638 let mut id_to_peer = self.id_to_peer.lock().unwrap();
3639 if id_to_peer.insert(chan.context.channel_id(), chan.context.get_counterparty_node_id()).is_some() {
3640 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
3642 e.insert(ChannelPhase::Funded(chan));
3649 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
3650 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
3651 Ok(OutPoint { txid: tx.txid(), index: output_index })
3655 /// Call this upon creation of a funding transaction for the given channel.
3657 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
3658 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
3660 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
3661 /// across the p2p network.
3663 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
3664 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
3666 /// May panic if the output found in the funding transaction is duplicative with some other
3667 /// channel (note that this should be trivially prevented by using unique funding transaction
3668 /// keys per-channel).
3670 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
3671 /// counterparty's signature the funding transaction will automatically be broadcast via the
3672 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
3674 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
3675 /// not currently support replacing a funding transaction on an existing channel. Instead,
3676 /// create a new channel with a conflicting funding transaction.
3678 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
3679 /// the wallet software generating the funding transaction to apply anti-fee sniping as
3680 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
3681 /// for more details.
3683 /// [`Event::FundingGenerationReady`]: crate::events::Event::FundingGenerationReady
3684 /// [`Event::ChannelClosed`]: crate::events::Event::ChannelClosed
3685 pub fn funding_transaction_generated(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
3686 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3688 if !funding_transaction.is_coin_base() {
3689 for inp in funding_transaction.input.iter() {
3690 if inp.witness.is_empty() {
3691 return Err(APIError::APIMisuseError {
3692 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
3698 let height = self.best_block.read().unwrap().height();
3699 // Transactions are evaluated as final by network mempools if their locktime is strictly
3700 // lower than the next block height. However, the modules constituting our Lightning
3701 // node might not have perfect sync about their blockchain views. Thus, if the wallet
3702 // module is ahead of LDK, only allow one more block of headroom.
3703 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 {
3704 return Err(APIError::APIMisuseError {
3705 err: "Funding transaction absolute timelock is non-final".to_owned()
3709 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
3710 if tx.output.len() > u16::max_value() as usize {
3711 return Err(APIError::APIMisuseError {
3712 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
3716 let mut output_index = None;
3717 let expected_spk = chan.context.get_funding_redeemscript().to_v0_p2wsh();
3718 for (idx, outp) in tx.output.iter().enumerate() {
3719 if outp.script_pubkey == expected_spk && outp.value == chan.context.get_value_satoshis() {
3720 if output_index.is_some() {
3721 return Err(APIError::APIMisuseError {
3722 err: "Multiple outputs matched the expected script and value".to_owned()
3725 output_index = Some(idx as u16);
3728 if output_index.is_none() {
3729 return Err(APIError::APIMisuseError {
3730 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
3733 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
3737 /// Atomically applies partial updates to the [`ChannelConfig`] of the given channels.
3739 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3740 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3741 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3742 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3744 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3745 /// `counterparty_node_id` is provided.
3747 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3748 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3750 /// If an error is returned, none of the updates should be considered applied.
3752 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3753 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3754 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3755 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3756 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3757 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3758 /// [`APIMisuseError`]: APIError::APIMisuseError
3759 pub fn update_partial_channel_config(
3760 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config_update: &ChannelConfigUpdate,
3761 ) -> Result<(), APIError> {
3762 if config_update.cltv_expiry_delta.map(|delta| delta < MIN_CLTV_EXPIRY_DELTA).unwrap_or(false) {
3763 return Err(APIError::APIMisuseError {
3764 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
3768 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3769 let per_peer_state = self.per_peer_state.read().unwrap();
3770 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3771 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3772 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3773 let peer_state = &mut *peer_state_lock;
3774 for channel_id in channel_ids {
3775 if !peer_state.has_channel(channel_id) {
3776 return Err(APIError::ChannelUnavailable {
3777 err: format!("Channel with ID {} was not found for the passed counterparty_node_id {}", channel_id, counterparty_node_id),
3781 for channel_id in channel_ids {
3782 if let Some(channel_phase) = peer_state.channel_by_id.get_mut(channel_id) {
3783 let mut config = channel_phase.context().config();
3784 config.apply(config_update);
3785 if !channel_phase.context_mut().update_config(&config) {
3788 if let ChannelPhase::Funded(channel) = channel_phase {
3789 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
3790 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
3791 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
3792 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
3793 node_id: channel.context.get_counterparty_node_id(),
3800 // This should not be reachable as we've already checked for non-existence in the previous channel_id loop.
3801 debug_assert!(false);
3802 return Err(APIError::ChannelUnavailable {
3804 "Channel with ID {} for passed counterparty_node_id {} disappeared after we confirmed its existence - this should not be reachable!",
3805 channel_id, counterparty_node_id),
3812 /// Atomically updates the [`ChannelConfig`] for the given channels.
3814 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3815 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3816 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3817 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3819 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3820 /// `counterparty_node_id` is provided.
3822 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3823 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3825 /// If an error is returned, none of the updates should be considered applied.
3827 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3828 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3829 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3830 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3831 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3832 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3833 /// [`APIMisuseError`]: APIError::APIMisuseError
3834 pub fn update_channel_config(
3835 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config: &ChannelConfig,
3836 ) -> Result<(), APIError> {
3837 return self.update_partial_channel_config(counterparty_node_id, channel_ids, &(*config).into());
3840 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
3841 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
3843 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
3844 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
3846 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
3847 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
3848 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
3849 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
3850 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
3852 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
3853 /// you from forwarding more than you received. See
3854 /// [`HTLCIntercepted::expected_outbound_amount_msat`] for more on forwarding a different amount
3857 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
3860 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
3861 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
3862 /// [`HTLCIntercepted::expected_outbound_amount_msat`]: events::Event::HTLCIntercepted::expected_outbound_amount_msat
3863 // TODO: when we move to deciding the best outbound channel at forward time, only take
3864 // `next_node_id` and not `next_hop_channel_id`
3865 pub fn forward_intercepted_htlc(&self, intercept_id: InterceptId, next_hop_channel_id: &ChannelId, next_node_id: PublicKey, amt_to_forward_msat: u64) -> Result<(), APIError> {
3866 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3868 let next_hop_scid = {
3869 let peer_state_lock = self.per_peer_state.read().unwrap();
3870 let peer_state_mutex = peer_state_lock.get(&next_node_id)
3871 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) })?;
3872 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3873 let peer_state = &mut *peer_state_lock;
3874 match peer_state.channel_by_id.get(next_hop_channel_id) {
3875 Some(ChannelPhase::Funded(chan)) => {
3876 if !chan.context.is_usable() {
3877 return Err(APIError::ChannelUnavailable {
3878 err: format!("Channel with id {} not fully established", next_hop_channel_id)
3881 chan.context.get_short_channel_id().unwrap_or(chan.context.outbound_scid_alias())
3883 Some(_) => return Err(APIError::ChannelUnavailable {
3884 err: format!("Channel with id {} for the passed counterparty node_id {} is still opening.",
3885 next_hop_channel_id, next_node_id)
3887 None => return Err(APIError::ChannelUnavailable {
3888 err: format!("Channel with id {} not found for the passed counterparty node_id {}.",
3889 next_hop_channel_id, next_node_id)
3894 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
3895 .ok_or_else(|| APIError::APIMisuseError {
3896 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
3899 let routing = match payment.forward_info.routing {
3900 PendingHTLCRouting::Forward { onion_packet, .. } => {
3901 PendingHTLCRouting::Forward { onion_packet, short_channel_id: next_hop_scid }
3903 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
3905 let skimmed_fee_msat =
3906 payment.forward_info.outgoing_amt_msat.saturating_sub(amt_to_forward_msat);
3907 let pending_htlc_info = PendingHTLCInfo {
3908 skimmed_fee_msat: if skimmed_fee_msat == 0 { None } else { Some(skimmed_fee_msat) },
3909 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
3912 let mut per_source_pending_forward = [(
3913 payment.prev_short_channel_id,
3914 payment.prev_funding_outpoint,
3915 payment.prev_user_channel_id,
3916 vec![(pending_htlc_info, payment.prev_htlc_id)]
3918 self.forward_htlcs(&mut per_source_pending_forward);
3922 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
3923 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
3925 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
3928 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
3929 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
3930 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3932 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
3933 .ok_or_else(|| APIError::APIMisuseError {
3934 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
3937 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
3938 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3939 short_channel_id: payment.prev_short_channel_id,
3940 user_channel_id: Some(payment.prev_user_channel_id),
3941 outpoint: payment.prev_funding_outpoint,
3942 htlc_id: payment.prev_htlc_id,
3943 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
3944 phantom_shared_secret: None,
3947 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
3948 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
3949 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
3950 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
3955 /// Processes HTLCs which are pending waiting on random forward delay.
3957 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
3958 /// Will likely generate further events.
3959 pub fn process_pending_htlc_forwards(&self) {
3960 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3962 let mut new_events = VecDeque::new();
3963 let mut failed_forwards = Vec::new();
3964 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
3966 let mut forward_htlcs = HashMap::new();
3967 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
3969 for (short_chan_id, mut pending_forwards) in forward_htlcs {
3970 if short_chan_id != 0 {
3971 macro_rules! forwarding_channel_not_found {
3973 for forward_info in pending_forwards.drain(..) {
3974 match forward_info {
3975 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3976 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3977 forward_info: PendingHTLCInfo {
3978 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
3979 outgoing_cltv_value, ..
3982 macro_rules! failure_handler {
3983 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
3984 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3986 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3987 short_channel_id: prev_short_channel_id,
3988 user_channel_id: Some(prev_user_channel_id),
3989 outpoint: prev_funding_outpoint,
3990 htlc_id: prev_htlc_id,
3991 incoming_packet_shared_secret: incoming_shared_secret,
3992 phantom_shared_secret: $phantom_ss,
3995 let reason = if $next_hop_unknown {
3996 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
3998 HTLCDestination::FailedPayment{ payment_hash }
4001 failed_forwards.push((htlc_source, payment_hash,
4002 HTLCFailReason::reason($err_code, $err_data),
4008 macro_rules! fail_forward {
4009 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
4011 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
4015 macro_rules! failed_payment {
4016 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
4018 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
4022 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
4023 let phantom_pubkey_res = self.node_signer.get_node_id(Recipient::PhantomNode);
4024 if phantom_pubkey_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.genesis_hash) {
4025 let phantom_shared_secret = self.node_signer.ecdh(Recipient::PhantomNode, &onion_packet.public_key.unwrap(), None).unwrap().secret_bytes();
4026 let next_hop = match onion_utils::decode_next_payment_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
4028 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
4029 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
4030 // In this scenario, the phantom would have sent us an
4031 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
4032 // if it came from us (the second-to-last hop) but contains the sha256
4034 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
4036 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
4037 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
4041 onion_utils::Hop::Receive(hop_data) => {
4042 match self.construct_recv_pending_htlc_info(hop_data,
4043 incoming_shared_secret, payment_hash, outgoing_amt_msat,
4044 outgoing_cltv_value, Some(phantom_shared_secret), false, None)
4046 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
4047 Err(InboundOnionErr { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
4053 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
4056 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
4059 HTLCForwardInfo::FailHTLC { .. } => {
4060 // Channel went away before we could fail it. This implies
4061 // the channel is now on chain and our counterparty is
4062 // trying to broadcast the HTLC-Timeout, but that's their
4063 // problem, not ours.
4069 let (counterparty_node_id, forward_chan_id) = match self.short_to_chan_info.read().unwrap().get(&short_chan_id) {
4070 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
4072 forwarding_channel_not_found!();
4076 let per_peer_state = self.per_peer_state.read().unwrap();
4077 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
4078 if peer_state_mutex_opt.is_none() {
4079 forwarding_channel_not_found!();
4082 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4083 let peer_state = &mut *peer_state_lock;
4084 if let Some(ChannelPhase::Funded(ref mut chan)) = peer_state.channel_by_id.get_mut(&forward_chan_id) {
4085 for forward_info in pending_forwards.drain(..) {
4086 match forward_info {
4087 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4088 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4089 forward_info: PendingHTLCInfo {
4090 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
4091 routing: PendingHTLCRouting::Forward { onion_packet, .. }, skimmed_fee_msat, ..
4094 log_trace!(self.logger, "Adding HTLC from short id {} with payment_hash {} to channel with short id {} after delay", prev_short_channel_id, &payment_hash, short_chan_id);
4095 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4096 short_channel_id: prev_short_channel_id,
4097 user_channel_id: Some(prev_user_channel_id),
4098 outpoint: prev_funding_outpoint,
4099 htlc_id: prev_htlc_id,
4100 incoming_packet_shared_secret: incoming_shared_secret,
4101 // Phantom payments are only PendingHTLCRouting::Receive.
4102 phantom_shared_secret: None,
4104 if let Err(e) = chan.queue_add_htlc(outgoing_amt_msat,
4105 payment_hash, outgoing_cltv_value, htlc_source.clone(),
4106 onion_packet, skimmed_fee_msat, &self.fee_estimator,
4109 if let ChannelError::Ignore(msg) = e {
4110 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", &payment_hash, msg);
4112 panic!("Stated return value requirements in send_htlc() were not met");
4114 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan);
4115 failed_forwards.push((htlc_source, payment_hash,
4116 HTLCFailReason::reason(failure_code, data),
4117 HTLCDestination::NextHopChannel { node_id: Some(chan.context.get_counterparty_node_id()), channel_id: forward_chan_id }
4122 HTLCForwardInfo::AddHTLC { .. } => {
4123 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
4125 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
4126 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
4127 if let Err(e) = chan.queue_fail_htlc(
4128 htlc_id, err_packet, &self.logger
4130 if let ChannelError::Ignore(msg) = e {
4131 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
4133 panic!("Stated return value requirements in queue_fail_htlc() were not met");
4135 // fail-backs are best-effort, we probably already have one
4136 // pending, and if not that's OK, if not, the channel is on
4137 // the chain and sending the HTLC-Timeout is their problem.
4144 forwarding_channel_not_found!();
4148 'next_forwardable_htlc: for forward_info in pending_forwards.drain(..) {
4149 match forward_info {
4150 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4151 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4152 forward_info: PendingHTLCInfo {
4153 routing, incoming_shared_secret, payment_hash, incoming_amt_msat, outgoing_amt_msat,
4154 skimmed_fee_msat, ..
4157 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret, mut onion_fields) = match routing {
4158 PendingHTLCRouting::Receive { payment_data, payment_metadata, incoming_cltv_expiry, phantom_shared_secret, custom_tlvs } => {
4159 let _legacy_hop_data = Some(payment_data.clone());
4160 let onion_fields = RecipientOnionFields { payment_secret: Some(payment_data.payment_secret),
4161 payment_metadata, custom_tlvs };
4162 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data },
4163 Some(payment_data), phantom_shared_secret, onion_fields)
4165 PendingHTLCRouting::ReceiveKeysend { payment_data, payment_preimage, payment_metadata, incoming_cltv_expiry, custom_tlvs } => {
4166 let onion_fields = RecipientOnionFields {
4167 payment_secret: payment_data.as_ref().map(|data| data.payment_secret),
4171 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage),
4172 payment_data, None, onion_fields)
4175 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
4178 let claimable_htlc = ClaimableHTLC {
4179 prev_hop: HTLCPreviousHopData {
4180 short_channel_id: prev_short_channel_id,
4181 user_channel_id: Some(prev_user_channel_id),
4182 outpoint: prev_funding_outpoint,
4183 htlc_id: prev_htlc_id,
4184 incoming_packet_shared_secret: incoming_shared_secret,
4185 phantom_shared_secret,
4187 // We differentiate the received value from the sender intended value
4188 // if possible so that we don't prematurely mark MPP payments complete
4189 // if routing nodes overpay
4190 value: incoming_amt_msat.unwrap_or(outgoing_amt_msat),
4191 sender_intended_value: outgoing_amt_msat,
4193 total_value_received: None,
4194 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
4197 counterparty_skimmed_fee_msat: skimmed_fee_msat,
4200 let mut committed_to_claimable = false;
4202 macro_rules! fail_htlc {
4203 ($htlc: expr, $payment_hash: expr) => {
4204 debug_assert!(!committed_to_claimable);
4205 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
4206 htlc_msat_height_data.extend_from_slice(
4207 &self.best_block.read().unwrap().height().to_be_bytes(),
4209 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
4210 short_channel_id: $htlc.prev_hop.short_channel_id,
4211 user_channel_id: $htlc.prev_hop.user_channel_id,
4212 outpoint: prev_funding_outpoint,
4213 htlc_id: $htlc.prev_hop.htlc_id,
4214 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
4215 phantom_shared_secret,
4217 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
4218 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
4220 continue 'next_forwardable_htlc;
4223 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
4224 let mut receiver_node_id = self.our_network_pubkey;
4225 if phantom_shared_secret.is_some() {
4226 receiver_node_id = self.node_signer.get_node_id(Recipient::PhantomNode)
4227 .expect("Failed to get node_id for phantom node recipient");
4230 macro_rules! check_total_value {
4231 ($purpose: expr) => {{
4232 let mut payment_claimable_generated = false;
4233 let is_keysend = match $purpose {
4234 events::PaymentPurpose::SpontaneousPayment(_) => true,
4235 events::PaymentPurpose::InvoicePayment { .. } => false,
4237 let mut claimable_payments = self.claimable_payments.lock().unwrap();
4238 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
4239 fail_htlc!(claimable_htlc, payment_hash);
4241 let ref mut claimable_payment = claimable_payments.claimable_payments
4242 .entry(payment_hash)
4243 // Note that if we insert here we MUST NOT fail_htlc!()
4244 .or_insert_with(|| {
4245 committed_to_claimable = true;
4247 purpose: $purpose.clone(), htlcs: Vec::new(), onion_fields: None,
4250 if $purpose != claimable_payment.purpose {
4251 let log_keysend = |keysend| if keysend { "keysend" } else { "non-keysend" };
4252 log_trace!(self.logger, "Failing new {} HTLC with payment_hash {} as we already had an existing {} HTLC with the same payment hash", log_keysend(is_keysend), &payment_hash, log_keysend(!is_keysend));
4253 fail_htlc!(claimable_htlc, payment_hash);
4255 if !self.default_configuration.accept_mpp_keysend && is_keysend && !claimable_payment.htlcs.is_empty() {
4256 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} as we already had an existing keysend HTLC with the same payment hash and our config states we don't accept MPP keysend", &payment_hash);
4257 fail_htlc!(claimable_htlc, payment_hash);
4259 if let Some(earlier_fields) = &mut claimable_payment.onion_fields {
4260 if earlier_fields.check_merge(&mut onion_fields).is_err() {
4261 fail_htlc!(claimable_htlc, payment_hash);
4264 claimable_payment.onion_fields = Some(onion_fields);
4266 let ref mut htlcs = &mut claimable_payment.htlcs;
4267 let mut total_value = claimable_htlc.sender_intended_value;
4268 let mut earliest_expiry = claimable_htlc.cltv_expiry;
4269 for htlc in htlcs.iter() {
4270 total_value += htlc.sender_intended_value;
4271 earliest_expiry = cmp::min(earliest_expiry, htlc.cltv_expiry);
4272 if htlc.total_msat != claimable_htlc.total_msat {
4273 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
4274 &payment_hash, claimable_htlc.total_msat, htlc.total_msat);
4275 total_value = msgs::MAX_VALUE_MSAT;
4277 if total_value >= msgs::MAX_VALUE_MSAT { break; }
4279 // The condition determining whether an MPP is complete must
4280 // match exactly the condition used in `timer_tick_occurred`
4281 if total_value >= msgs::MAX_VALUE_MSAT {
4282 fail_htlc!(claimable_htlc, payment_hash);
4283 } else if total_value - claimable_htlc.sender_intended_value >= claimable_htlc.total_msat {
4284 log_trace!(self.logger, "Failing HTLC with payment_hash {} as payment is already claimable",
4286 fail_htlc!(claimable_htlc, payment_hash);
4287 } else if total_value >= claimable_htlc.total_msat {
4288 #[allow(unused_assignments)] {
4289 committed_to_claimable = true;
4291 let prev_channel_id = prev_funding_outpoint.to_channel_id();
4292 htlcs.push(claimable_htlc);
4293 let amount_msat = htlcs.iter().map(|htlc| htlc.value).sum();
4294 htlcs.iter_mut().for_each(|htlc| htlc.total_value_received = Some(amount_msat));
4295 let counterparty_skimmed_fee_msat = htlcs.iter()
4296 .map(|htlc| htlc.counterparty_skimmed_fee_msat.unwrap_or(0)).sum();
4297 debug_assert!(total_value.saturating_sub(amount_msat) <=
4298 counterparty_skimmed_fee_msat);
4299 new_events.push_back((events::Event::PaymentClaimable {
4300 receiver_node_id: Some(receiver_node_id),
4304 counterparty_skimmed_fee_msat,
4305 via_channel_id: Some(prev_channel_id),
4306 via_user_channel_id: Some(prev_user_channel_id),
4307 claim_deadline: Some(earliest_expiry - HTLC_FAIL_BACK_BUFFER),
4308 onion_fields: claimable_payment.onion_fields.clone(),
4310 payment_claimable_generated = true;
4312 // Nothing to do - we haven't reached the total
4313 // payment value yet, wait until we receive more
4315 htlcs.push(claimable_htlc);
4316 #[allow(unused_assignments)] {
4317 committed_to_claimable = true;
4320 payment_claimable_generated
4324 // Check that the payment hash and secret are known. Note that we
4325 // MUST take care to handle the "unknown payment hash" and
4326 // "incorrect payment secret" cases here identically or we'd expose
4327 // that we are the ultimate recipient of the given payment hash.
4328 // Further, we must not expose whether we have any other HTLCs
4329 // associated with the same payment_hash pending or not.
4330 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4331 match payment_secrets.entry(payment_hash) {
4332 hash_map::Entry::Vacant(_) => {
4333 match claimable_htlc.onion_payload {
4334 OnionPayload::Invoice { .. } => {
4335 let payment_data = payment_data.unwrap();
4336 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) {
4337 Ok(result) => result,
4339 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as payment verification failed", &payment_hash);
4340 fail_htlc!(claimable_htlc, payment_hash);
4343 if let Some(min_final_cltv_expiry_delta) = min_final_cltv_expiry_delta {
4344 let expected_min_expiry_height = (self.current_best_block().height() + min_final_cltv_expiry_delta as u32) as u64;
4345 if (cltv_expiry as u64) < expected_min_expiry_height {
4346 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as its CLTV expiry was too soon (had {}, earliest expected {})",
4347 &payment_hash, cltv_expiry, expected_min_expiry_height);
4348 fail_htlc!(claimable_htlc, payment_hash);
4351 let purpose = events::PaymentPurpose::InvoicePayment {
4352 payment_preimage: payment_preimage.clone(),
4353 payment_secret: payment_data.payment_secret,
4355 check_total_value!(purpose);
4357 OnionPayload::Spontaneous(preimage) => {
4358 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
4359 check_total_value!(purpose);
4363 hash_map::Entry::Occupied(inbound_payment) => {
4364 if let OnionPayload::Spontaneous(_) = claimable_htlc.onion_payload {
4365 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} because we already have an inbound payment with the same payment hash", &payment_hash);
4366 fail_htlc!(claimable_htlc, payment_hash);
4368 let payment_data = payment_data.unwrap();
4369 if inbound_payment.get().payment_secret != payment_data.payment_secret {
4370 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", &payment_hash);
4371 fail_htlc!(claimable_htlc, payment_hash);
4372 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
4373 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
4374 &payment_hash, payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
4375 fail_htlc!(claimable_htlc, payment_hash);
4377 let purpose = events::PaymentPurpose::InvoicePayment {
4378 payment_preimage: inbound_payment.get().payment_preimage,
4379 payment_secret: payment_data.payment_secret,
4381 let payment_claimable_generated = check_total_value!(purpose);
4382 if payment_claimable_generated {
4383 inbound_payment.remove_entry();
4389 HTLCForwardInfo::FailHTLC { .. } => {
4390 panic!("Got pending fail of our own HTLC");
4398 let best_block_height = self.best_block.read().unwrap().height();
4399 self.pending_outbound_payments.check_retry_payments(&self.router, || self.list_usable_channels(),
4400 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
4401 &self.pending_events, &self.logger, |args| self.send_payment_along_path(args));
4403 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
4404 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4406 self.forward_htlcs(&mut phantom_receives);
4408 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
4409 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
4410 // nice to do the work now if we can rather than while we're trying to get messages in the
4412 self.check_free_holding_cells();
4414 if new_events.is_empty() { return }
4415 let mut events = self.pending_events.lock().unwrap();
4416 events.append(&mut new_events);
4419 /// Free the background events, generally called from [`PersistenceNotifierGuard`] constructors.
4421 /// Expects the caller to have a total_consistency_lock read lock.
4422 fn process_background_events(&self) -> NotifyOption {
4423 debug_assert_ne!(self.total_consistency_lock.held_by_thread(), LockHeldState::NotHeldByThread);
4425 self.background_events_processed_since_startup.store(true, Ordering::Release);
4427 let mut background_events = Vec::new();
4428 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
4429 if background_events.is_empty() {
4430 return NotifyOption::SkipPersist;
4433 for event in background_events.drain(..) {
4435 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((funding_txo, update)) => {
4436 // The channel has already been closed, so no use bothering to care about the
4437 // monitor updating completing.
4438 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4440 BackgroundEvent::MonitorUpdateRegeneratedOnStartup { counterparty_node_id, funding_txo, update } => {
4441 let mut updated_chan = false;
4443 let per_peer_state = self.per_peer_state.read().unwrap();
4444 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4445 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4446 let peer_state = &mut *peer_state_lock;
4447 match peer_state.channel_by_id.entry(funding_txo.to_channel_id()) {
4448 hash_map::Entry::Occupied(mut chan_phase) => {
4449 updated_chan = true;
4450 handle_new_monitor_update!(self, funding_txo, update.clone(),
4451 peer_state_lock, peer_state, per_peer_state, chan_phase).map(|_| ())
4453 hash_map::Entry::Vacant(_) => Ok(()),
4458 // TODO: Track this as in-flight even though the channel is closed.
4459 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4461 // TODO: If this channel has since closed, we're likely providing a payment
4462 // preimage update, which we must ensure is durable! We currently don't,
4463 // however, ensure that.
4465 log_error!(self.logger,
4466 "Failed to provide ChannelMonitorUpdate to closed channel! This likely lost us a payment preimage!");
4468 let _ = handle_error!(self, res, counterparty_node_id);
4470 BackgroundEvent::MonitorUpdatesComplete { counterparty_node_id, channel_id } => {
4471 let per_peer_state = self.per_peer_state.read().unwrap();
4472 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4473 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4474 let peer_state = &mut *peer_state_lock;
4475 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
4476 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, chan);
4478 let update_actions = peer_state.monitor_update_blocked_actions
4479 .remove(&channel_id).unwrap_or(Vec::new());
4480 mem::drop(peer_state_lock);
4481 mem::drop(per_peer_state);
4482 self.handle_monitor_update_completion_actions(update_actions);
4488 NotifyOption::DoPersist
4491 #[cfg(any(test, feature = "_test_utils"))]
4492 /// Process background events, for functional testing
4493 pub fn test_process_background_events(&self) {
4494 let _lck = self.total_consistency_lock.read().unwrap();
4495 let _ = self.process_background_events();
4498 fn update_channel_fee(&self, chan_id: &ChannelId, chan: &mut Channel<SP>, new_feerate: u32) -> NotifyOption {
4499 if !chan.context.is_outbound() { return NotifyOption::SkipPersist; }
4500 // If the feerate has decreased by less than half, don't bother
4501 if new_feerate <= chan.context.get_feerate_sat_per_1000_weight() && new_feerate * 2 > chan.context.get_feerate_sat_per_1000_weight() {
4502 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
4503 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4504 return NotifyOption::SkipPersist;
4506 if !chan.context.is_live() {
4507 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).",
4508 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4509 return NotifyOption::SkipPersist;
4511 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
4512 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4514 chan.queue_update_fee(new_feerate, &self.fee_estimator, &self.logger);
4515 NotifyOption::DoPersist
4519 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
4520 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
4521 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
4522 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
4523 pub fn maybe_update_chan_fees(&self) {
4524 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4525 let mut should_persist = self.process_background_events();
4527 let normal_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4528 let min_mempool_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::MempoolMinimum);
4530 let per_peer_state = self.per_peer_state.read().unwrap();
4531 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
4532 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4533 let peer_state = &mut *peer_state_lock;
4534 for (chan_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
4535 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
4537 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4542 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4543 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4551 /// Performs actions which should happen on startup and roughly once per minute thereafter.
4553 /// This currently includes:
4554 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
4555 /// * Broadcasting [`ChannelUpdate`] messages if we've been disconnected from our peer for more
4556 /// than a minute, informing the network that they should no longer attempt to route over
4558 /// * Expiring a channel's previous [`ChannelConfig`] if necessary to only allow forwarding HTLCs
4559 /// with the current [`ChannelConfig`].
4560 /// * Removing peers which have disconnected but and no longer have any channels.
4561 /// * Force-closing and removing channels which have not completed establishment in a timely manner.
4563 /// Note that this may cause reentrancy through [`chain::Watch::update_channel`] calls or feerate
4564 /// estimate fetches.
4566 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4567 /// [`ChannelConfig`]: crate::util::config::ChannelConfig
4568 pub fn timer_tick_occurred(&self) {
4569 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4570 let mut should_persist = self.process_background_events();
4572 let normal_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4573 let min_mempool_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::MempoolMinimum);
4575 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
4576 let mut timed_out_mpp_htlcs = Vec::new();
4577 let mut pending_peers_awaiting_removal = Vec::new();
4579 let process_unfunded_channel_tick = |
4580 chan_id: &ChannelId,
4581 context: &mut ChannelContext<SP>,
4582 unfunded_context: &mut UnfundedChannelContext,
4583 pending_msg_events: &mut Vec<MessageSendEvent>,
4584 counterparty_node_id: PublicKey,
4586 context.maybe_expire_prev_config();
4587 if unfunded_context.should_expire_unfunded_channel() {
4588 log_error!(self.logger,
4589 "Force-closing pending channel with ID {} for not establishing in a timely manner", chan_id);
4590 update_maps_on_chan_removal!(self, &context);
4591 self.issue_channel_close_events(&context, ClosureReason::HolderForceClosed);
4592 self.finish_force_close_channel(context.force_shutdown(false));
4593 pending_msg_events.push(MessageSendEvent::HandleError {
4594 node_id: counterparty_node_id,
4595 action: msgs::ErrorAction::SendErrorMessage {
4596 msg: msgs::ErrorMessage {
4597 channel_id: *chan_id,
4598 data: "Force-closing pending channel due to timeout awaiting establishment handshake".to_owned(),
4609 let per_peer_state = self.per_peer_state.read().unwrap();
4610 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
4611 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4612 let peer_state = &mut *peer_state_lock;
4613 let pending_msg_events = &mut peer_state.pending_msg_events;
4614 let counterparty_node_id = *counterparty_node_id;
4615 peer_state.channel_by_id.retain(|chan_id, phase| {
4617 ChannelPhase::Funded(chan) => {
4618 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4623 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4624 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4626 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
4627 let (needs_close, err) = convert_chan_phase_err!(self, e, chan, chan_id, FUNDED_CHANNEL);
4628 handle_errors.push((Err(err), counterparty_node_id));
4629 if needs_close { return false; }
4632 match chan.channel_update_status() {
4633 ChannelUpdateStatus::Enabled if !chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(0)),
4634 ChannelUpdateStatus::Disabled if chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(0)),
4635 ChannelUpdateStatus::DisabledStaged(_) if chan.context.is_live()
4636 => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
4637 ChannelUpdateStatus::EnabledStaged(_) if !chan.context.is_live()
4638 => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
4639 ChannelUpdateStatus::DisabledStaged(mut n) if !chan.context.is_live() => {
4641 if n >= DISABLE_GOSSIP_TICKS {
4642 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
4643 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4644 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4648 should_persist = NotifyOption::DoPersist;
4650 chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(n));
4653 ChannelUpdateStatus::EnabledStaged(mut n) if chan.context.is_live() => {
4655 if n >= ENABLE_GOSSIP_TICKS {
4656 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
4657 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4658 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4662 should_persist = NotifyOption::DoPersist;
4664 chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(n));
4670 chan.context.maybe_expire_prev_config();
4672 if chan.should_disconnect_peer_awaiting_response() {
4673 log_debug!(self.logger, "Disconnecting peer {} due to not making any progress on channel {}",
4674 counterparty_node_id, chan_id);
4675 pending_msg_events.push(MessageSendEvent::HandleError {
4676 node_id: counterparty_node_id,
4677 action: msgs::ErrorAction::DisconnectPeerWithWarning {
4678 msg: msgs::WarningMessage {
4679 channel_id: *chan_id,
4680 data: "Disconnecting due to timeout awaiting response".to_owned(),
4688 ChannelPhase::UnfundedInboundV1(chan) => {
4689 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
4690 pending_msg_events, counterparty_node_id)
4692 ChannelPhase::UnfundedOutboundV1(chan) => {
4693 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
4694 pending_msg_events, counterparty_node_id)
4699 for (chan_id, req) in peer_state.inbound_channel_request_by_id.iter_mut() {
4700 if { req.ticks_remaining -= 1 ; req.ticks_remaining } <= 0 {
4701 log_error!(self.logger, "Force-closing unaccepted inbound channel {} for not accepting in a timely manner", &chan_id);
4702 peer_state.pending_msg_events.push(
4703 events::MessageSendEvent::HandleError {
4704 node_id: counterparty_node_id,
4705 action: msgs::ErrorAction::SendErrorMessage {
4706 msg: msgs::ErrorMessage { channel_id: chan_id.clone(), data: "Channel force-closed".to_owned() }
4712 peer_state.inbound_channel_request_by_id.retain(|_, req| req.ticks_remaining > 0);
4714 if peer_state.ok_to_remove(true) {
4715 pending_peers_awaiting_removal.push(counterparty_node_id);
4720 // When a peer disconnects but still has channels, the peer's `peer_state` entry in the
4721 // `per_peer_state` is not removed by the `peer_disconnected` function. If the channels
4722 // of to that peer is later closed while still being disconnected (i.e. force closed),
4723 // we therefore need to remove the peer from `peer_state` separately.
4724 // To avoid having to take the `per_peer_state` `write` lock once the channels are
4725 // closed, we instead remove such peers awaiting removal here on a timer, to limit the
4726 // negative effects on parallelism as much as possible.
4727 if pending_peers_awaiting_removal.len() > 0 {
4728 let mut per_peer_state = self.per_peer_state.write().unwrap();
4729 for counterparty_node_id in pending_peers_awaiting_removal {
4730 match per_peer_state.entry(counterparty_node_id) {
4731 hash_map::Entry::Occupied(entry) => {
4732 // Remove the entry if the peer is still disconnected and we still
4733 // have no channels to the peer.
4734 let remove_entry = {
4735 let peer_state = entry.get().lock().unwrap();
4736 peer_state.ok_to_remove(true)
4739 entry.remove_entry();
4742 hash_map::Entry::Vacant(_) => { /* The PeerState has already been removed */ }
4747 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
4748 if payment.htlcs.is_empty() {
4749 // This should be unreachable
4750 debug_assert!(false);
4753 if let OnionPayload::Invoice { .. } = payment.htlcs[0].onion_payload {
4754 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
4755 // In this case we're not going to handle any timeouts of the parts here.
4756 // This condition determining whether the MPP is complete here must match
4757 // exactly the condition used in `process_pending_htlc_forwards`.
4758 if payment.htlcs[0].total_msat <= payment.htlcs.iter()
4759 .fold(0, |total, htlc| total + htlc.sender_intended_value)
4762 } else if payment.htlcs.iter_mut().any(|htlc| {
4763 htlc.timer_ticks += 1;
4764 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
4766 timed_out_mpp_htlcs.extend(payment.htlcs.drain(..)
4767 .map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
4774 for htlc_source in timed_out_mpp_htlcs.drain(..) {
4775 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
4776 let reason = HTLCFailReason::from_failure_code(23);
4777 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
4778 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
4781 for (err, counterparty_node_id) in handle_errors.drain(..) {
4782 let _ = handle_error!(self, err, counterparty_node_id);
4785 self.pending_outbound_payments.remove_stale_payments(&self.pending_events);
4787 // Technically we don't need to do this here, but if we have holding cell entries in a
4788 // channel that need freeing, it's better to do that here and block a background task
4789 // than block the message queueing pipeline.
4790 if self.check_free_holding_cells() {
4791 should_persist = NotifyOption::DoPersist;
4798 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
4799 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
4800 /// along the path (including in our own channel on which we received it).
4802 /// Note that in some cases around unclean shutdown, it is possible the payment may have
4803 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
4804 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
4805 /// may have already been failed automatically by LDK if it was nearing its expiration time.
4807 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
4808 /// [`ChannelManager::claim_funds`]), you should still monitor for
4809 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
4810 /// startup during which time claims that were in-progress at shutdown may be replayed.
4811 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
4812 self.fail_htlc_backwards_with_reason(payment_hash, FailureCode::IncorrectOrUnknownPaymentDetails);
4815 /// This is a variant of [`ChannelManager::fail_htlc_backwards`] that allows you to specify the
4816 /// reason for the failure.
4818 /// See [`FailureCode`] for valid failure codes.
4819 pub fn fail_htlc_backwards_with_reason(&self, payment_hash: &PaymentHash, failure_code: FailureCode) {
4820 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4822 let removed_source = self.claimable_payments.lock().unwrap().claimable_payments.remove(payment_hash);
4823 if let Some(payment) = removed_source {
4824 for htlc in payment.htlcs {
4825 let reason = self.get_htlc_fail_reason_from_failure_code(failure_code, &htlc);
4826 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
4827 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
4828 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
4833 /// Gets error data to form an [`HTLCFailReason`] given a [`FailureCode`] and [`ClaimableHTLC`].
4834 fn get_htlc_fail_reason_from_failure_code(&self, failure_code: FailureCode, htlc: &ClaimableHTLC) -> HTLCFailReason {
4835 match failure_code {
4836 FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(failure_code.into()),
4837 FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(failure_code.into()),
4838 FailureCode::IncorrectOrUnknownPaymentDetails => {
4839 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
4840 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
4841 HTLCFailReason::reason(failure_code.into(), htlc_msat_height_data)
4843 FailureCode::InvalidOnionPayload(data) => {
4844 let fail_data = match data {
4845 Some((typ, offset)) => [BigSize(typ).encode(), offset.encode()].concat(),
4848 HTLCFailReason::reason(failure_code.into(), fail_data)
4853 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
4854 /// that we want to return and a channel.
4856 /// This is for failures on the channel on which the HTLC was *received*, not failures
4858 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<SP>) -> (u16, Vec<u8>) {
4859 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
4860 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
4861 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
4862 // an inbound SCID alias before the real SCID.
4863 let scid_pref = if chan.context.should_announce() {
4864 chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias())
4866 chan.context.latest_inbound_scid_alias().or(chan.context.get_short_channel_id())
4868 if let Some(scid) = scid_pref {
4869 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
4871 (0x4000|10, Vec::new())
4876 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
4877 /// that we want to return and a channel.
4878 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<SP>) -> (u16, Vec<u8>) {
4879 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
4880 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
4881 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
4882 if desired_err_code == 0x1000 | 20 {
4883 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
4884 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
4885 0u16.write(&mut enc).expect("Writes cannot fail");
4887 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
4888 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
4889 upd.write(&mut enc).expect("Writes cannot fail");
4890 (desired_err_code, enc.0)
4892 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
4893 // which means we really shouldn't have gotten a payment to be forwarded over this
4894 // channel yet, or if we did it's from a route hint. Either way, returning an error of
4895 // PERM|no_such_channel should be fine.
4896 (0x4000|10, Vec::new())
4900 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
4901 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
4902 // be surfaced to the user.
4903 fn fail_holding_cell_htlcs(
4904 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: ChannelId,
4905 counterparty_node_id: &PublicKey
4907 let (failure_code, onion_failure_data) = {
4908 let per_peer_state = self.per_peer_state.read().unwrap();
4909 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4910 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4911 let peer_state = &mut *peer_state_lock;
4912 match peer_state.channel_by_id.entry(channel_id) {
4913 hash_map::Entry::Occupied(chan_phase_entry) => {
4914 if let ChannelPhase::Funded(chan) = chan_phase_entry.get() {
4915 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan)
4917 // We shouldn't be trying to fail holding cell HTLCs on an unfunded channel.
4918 debug_assert!(false);
4919 (0x4000|10, Vec::new())
4922 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
4924 } else { (0x4000|10, Vec::new()) }
4927 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
4928 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
4929 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
4930 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
4934 /// Fails an HTLC backwards to the sender of it to us.
4935 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
4936 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
4937 // Ensure that no peer state channel storage lock is held when calling this function.
4938 // This ensures that future code doesn't introduce a lock-order requirement for
4939 // `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
4940 // this function with any `per_peer_state` peer lock acquired would.
4941 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
4942 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
4945 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
4946 //identify whether we sent it or not based on the (I presume) very different runtime
4947 //between the branches here. We should make this async and move it into the forward HTLCs
4950 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4951 // from block_connected which may run during initialization prior to the chain_monitor
4952 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
4954 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, .. } => {
4955 if self.pending_outbound_payments.fail_htlc(source, payment_hash, onion_error, path,
4956 session_priv, payment_id, self.probing_cookie_secret, &self.secp_ctx,
4957 &self.pending_events, &self.logger)
4958 { self.push_pending_forwards_ev(); }
4960 HTLCSource::PreviousHopData(HTLCPreviousHopData { ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret, ref phantom_shared_secret, ref outpoint, .. }) => {
4961 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with {:?}", &payment_hash, onion_error);
4962 let err_packet = onion_error.get_encrypted_failure_packet(incoming_packet_shared_secret, phantom_shared_secret);
4964 let mut push_forward_ev = false;
4965 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
4966 if forward_htlcs.is_empty() {
4967 push_forward_ev = true;
4969 match forward_htlcs.entry(*short_channel_id) {
4970 hash_map::Entry::Occupied(mut entry) => {
4971 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet });
4973 hash_map::Entry::Vacant(entry) => {
4974 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }));
4977 mem::drop(forward_htlcs);
4978 if push_forward_ev { self.push_pending_forwards_ev(); }
4979 let mut pending_events = self.pending_events.lock().unwrap();
4980 pending_events.push_back((events::Event::HTLCHandlingFailed {
4981 prev_channel_id: outpoint.to_channel_id(),
4982 failed_next_destination: destination,
4988 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
4989 /// [`MessageSendEvent`]s needed to claim the payment.
4991 /// This method is guaranteed to ensure the payment has been claimed but only if the current
4992 /// height is strictly below [`Event::PaymentClaimable::claim_deadline`]. To avoid race
4993 /// conditions, you should wait for an [`Event::PaymentClaimed`] before considering the payment
4994 /// successful. It will generally be available in the next [`process_pending_events`] call.
4996 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
4997 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
4998 /// event matches your expectation. If you fail to do so and call this method, you may provide
4999 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
5001 /// This function will fail the payment if it has custom TLVs with even type numbers, as we
5002 /// will assume they are unknown. If you intend to accept even custom TLVs, you should use
5003 /// [`claim_funds_with_known_custom_tlvs`].
5005 /// [`Event::PaymentClaimable`]: crate::events::Event::PaymentClaimable
5006 /// [`Event::PaymentClaimable::claim_deadline`]: crate::events::Event::PaymentClaimable::claim_deadline
5007 /// [`Event::PaymentClaimed`]: crate::events::Event::PaymentClaimed
5008 /// [`process_pending_events`]: EventsProvider::process_pending_events
5009 /// [`create_inbound_payment`]: Self::create_inbound_payment
5010 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5011 /// [`claim_funds_with_known_custom_tlvs`]: Self::claim_funds_with_known_custom_tlvs
5012 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
5013 self.claim_payment_internal(payment_preimage, false);
5016 /// This is a variant of [`claim_funds`] that allows accepting a payment with custom TLVs with
5017 /// even type numbers.
5021 /// You MUST check you've understood all even TLVs before using this to
5022 /// claim, otherwise you may unintentionally agree to some protocol you do not understand.
5024 /// [`claim_funds`]: Self::claim_funds
5025 pub fn claim_funds_with_known_custom_tlvs(&self, payment_preimage: PaymentPreimage) {
5026 self.claim_payment_internal(payment_preimage, true);
5029 fn claim_payment_internal(&self, payment_preimage: PaymentPreimage, custom_tlvs_known: bool) {
5030 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
5032 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5035 let mut claimable_payments = self.claimable_payments.lock().unwrap();
5036 if let Some(payment) = claimable_payments.claimable_payments.remove(&payment_hash) {
5037 let mut receiver_node_id = self.our_network_pubkey;
5038 for htlc in payment.htlcs.iter() {
5039 if htlc.prev_hop.phantom_shared_secret.is_some() {
5040 let phantom_pubkey = self.node_signer.get_node_id(Recipient::PhantomNode)
5041 .expect("Failed to get node_id for phantom node recipient");
5042 receiver_node_id = phantom_pubkey;
5047 let htlcs = payment.htlcs.iter().map(events::ClaimedHTLC::from).collect();
5048 let sender_intended_value = payment.htlcs.first().map(|htlc| htlc.total_msat);
5049 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
5050 ClaimingPayment { amount_msat: payment.htlcs.iter().map(|source| source.value).sum(),
5051 payment_purpose: payment.purpose, receiver_node_id, htlcs, sender_intended_value
5053 if dup_purpose.is_some() {
5054 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
5055 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
5059 if let Some(RecipientOnionFields { ref custom_tlvs, .. }) = payment.onion_fields {
5060 if !custom_tlvs_known && custom_tlvs.iter().any(|(typ, _)| typ % 2 == 0) {
5061 log_info!(self.logger, "Rejecting payment with payment hash {} as we cannot accept payment with unknown even TLVs: {}",
5062 &payment_hash, log_iter!(custom_tlvs.iter().map(|(typ, _)| typ).filter(|typ| *typ % 2 == 0)));
5063 claimable_payments.pending_claiming_payments.remove(&payment_hash);
5064 mem::drop(claimable_payments);
5065 for htlc in payment.htlcs {
5066 let reason = self.get_htlc_fail_reason_from_failure_code(FailureCode::InvalidOnionPayload(None), &htlc);
5067 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5068 let receiver = HTLCDestination::FailedPayment { payment_hash };
5069 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5078 debug_assert!(!sources.is_empty());
5080 // Just in case one HTLC has been failed between when we generated the `PaymentClaimable`
5081 // and when we got here we need to check that the amount we're about to claim matches the
5082 // amount we told the user in the last `PaymentClaimable`. We also do a sanity-check that
5083 // the MPP parts all have the same `total_msat`.
5084 let mut claimable_amt_msat = 0;
5085 let mut prev_total_msat = None;
5086 let mut expected_amt_msat = None;
5087 let mut valid_mpp = true;
5088 let mut errs = Vec::new();
5089 let per_peer_state = self.per_peer_state.read().unwrap();
5090 for htlc in sources.iter() {
5091 if prev_total_msat.is_some() && prev_total_msat != Some(htlc.total_msat) {
5092 log_error!(self.logger, "Somehow ended up with an MPP payment with different expected total amounts - this should not be reachable!");
5093 debug_assert!(false);
5097 prev_total_msat = Some(htlc.total_msat);
5099 if expected_amt_msat.is_some() && expected_amt_msat != htlc.total_value_received {
5100 log_error!(self.logger, "Somehow ended up with an MPP payment with different received total amounts - this should not be reachable!");
5101 debug_assert!(false);
5105 expected_amt_msat = htlc.total_value_received;
5106 claimable_amt_msat += htlc.value;
5108 mem::drop(per_peer_state);
5109 if sources.is_empty() || expected_amt_msat.is_none() {
5110 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5111 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
5114 if claimable_amt_msat != expected_amt_msat.unwrap() {
5115 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5116 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
5117 expected_amt_msat.unwrap(), claimable_amt_msat);
5121 for htlc in sources.drain(..) {
5122 if let Err((pk, err)) = self.claim_funds_from_hop(
5123 htlc.prev_hop, payment_preimage,
5124 |_| Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash }))
5126 if let msgs::ErrorAction::IgnoreError = err.err.action {
5127 // We got a temporary failure updating monitor, but will claim the
5128 // HTLC when the monitor updating is restored (or on chain).
5129 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
5130 } else { errs.push((pk, err)); }
5135 for htlc in sources.drain(..) {
5136 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5137 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5138 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5139 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
5140 let receiver = HTLCDestination::FailedPayment { payment_hash };
5141 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5143 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5146 // Now we can handle any errors which were generated.
5147 for (counterparty_node_id, err) in errs.drain(..) {
5148 let res: Result<(), _> = Err(err);
5149 let _ = handle_error!(self, res, counterparty_node_id);
5153 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>) -> Option<MonitorUpdateCompletionAction>>(&self,
5154 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
5155 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
5156 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
5158 // If we haven't yet run background events assume we're still deserializing and shouldn't
5159 // actually pass `ChannelMonitorUpdate`s to users yet. Instead, queue them up as
5160 // `BackgroundEvent`s.
5161 let during_init = !self.background_events_processed_since_startup.load(Ordering::Acquire);
5164 let per_peer_state = self.per_peer_state.read().unwrap();
5165 let chan_id = prev_hop.outpoint.to_channel_id();
5166 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
5167 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
5171 let peer_state_opt = counterparty_node_id_opt.as_ref().map(
5172 |counterparty_node_id| per_peer_state.get(counterparty_node_id)
5173 .map(|peer_mutex| peer_mutex.lock().unwrap())
5176 if peer_state_opt.is_some() {
5177 let mut peer_state_lock = peer_state_opt.unwrap();
5178 let peer_state = &mut *peer_state_lock;
5179 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(chan_id) {
5180 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
5181 let counterparty_node_id = chan.context.get_counterparty_node_id();
5182 let fulfill_res = chan.get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger);
5184 if let UpdateFulfillCommitFetch::NewClaim { htlc_value_msat, monitor_update } = fulfill_res {
5185 if let Some(action) = completion_action(Some(htlc_value_msat)) {
5186 log_trace!(self.logger, "Tracking monitor update completion action for channel {}: {:?}",
5188 peer_state.monitor_update_blocked_actions.entry(chan_id).or_insert(Vec::new()).push(action);
5191 let res = handle_new_monitor_update!(self, prev_hop.outpoint, monitor_update, peer_state_lock,
5192 peer_state, per_peer_state, chan_phase_entry);
5193 if let Err(e) = res {
5194 // TODO: This is a *critical* error - we probably updated the outbound edge
5195 // of the HTLC's monitor with a preimage. We should retry this monitor
5196 // update over and over again until morale improves.
5197 log_error!(self.logger, "Failed to update channel monitor with preimage {:?}", payment_preimage);
5198 return Err((counterparty_node_id, e));
5201 // If we're running during init we cannot update a monitor directly -
5202 // they probably haven't actually been loaded yet. Instead, push the
5203 // monitor update as a background event.
5204 self.pending_background_events.lock().unwrap().push(
5205 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
5206 counterparty_node_id,
5207 funding_txo: prev_hop.outpoint,
5208 update: monitor_update.clone(),
5217 let preimage_update = ChannelMonitorUpdate {
5218 update_id: CLOSED_CHANNEL_UPDATE_ID,
5219 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
5225 // We update the ChannelMonitor on the backward link, after
5226 // receiving an `update_fulfill_htlc` from the forward link.
5227 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, &preimage_update);
5228 if update_res != ChannelMonitorUpdateStatus::Completed {
5229 // TODO: This needs to be handled somehow - if we receive a monitor update
5230 // with a preimage we *must* somehow manage to propagate it to the upstream
5231 // channel, or we must have an ability to receive the same event and try
5232 // again on restart.
5233 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
5234 payment_preimage, update_res);
5237 // If we're running during init we cannot update a monitor directly - they probably
5238 // haven't actually been loaded yet. Instead, push the monitor update as a background
5240 // Note that while it's safe to use `ClosedMonitorUpdateRegeneratedOnStartup` here (the
5241 // channel is already closed) we need to ultimately handle the monitor update
5242 // completion action only after we've completed the monitor update. This is the only
5243 // way to guarantee this update *will* be regenerated on startup (otherwise if this was
5244 // from a forwarded HTLC the downstream preimage may be deleted before we claim
5245 // upstream). Thus, we need to transition to some new `BackgroundEvent` type which will
5246 // complete the monitor update completion action from `completion_action`.
5247 self.pending_background_events.lock().unwrap().push(
5248 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((
5249 prev_hop.outpoint, preimage_update,
5252 // Note that we do process the completion action here. This totally could be a
5253 // duplicate claim, but we have no way of knowing without interrogating the
5254 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
5255 // generally always allowed to be duplicative (and it's specifically noted in
5256 // `PaymentForwarded`).
5257 self.handle_monitor_update_completion_actions(completion_action(None));
5261 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
5262 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
5265 fn claim_funds_internal(&self, source: HTLCSource, payment_preimage: PaymentPreimage,
5266 forwarded_htlc_value_msat: Option<u64>, from_onchain: bool,
5267 next_channel_counterparty_node_id: Option<PublicKey>, next_channel_outpoint: OutPoint
5270 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
5271 debug_assert!(self.background_events_processed_since_startup.load(Ordering::Acquire),
5272 "We don't support claim_htlc claims during startup - monitors may not be available yet");
5273 if let Some(pubkey) = next_channel_counterparty_node_id {
5274 debug_assert_eq!(pubkey, path.hops[0].pubkey);
5276 let ev_completion_action = EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
5277 channel_funding_outpoint: next_channel_outpoint,
5278 counterparty_node_id: path.hops[0].pubkey,
5280 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage,
5281 session_priv, path, from_onchain, ev_completion_action, &self.pending_events,
5284 HTLCSource::PreviousHopData(hop_data) => {
5285 let prev_outpoint = hop_data.outpoint;
5286 let completed_blocker = RAAMonitorUpdateBlockingAction::from_prev_hop_data(&hop_data);
5287 let res = self.claim_funds_from_hop(hop_data, payment_preimage,
5288 |htlc_claim_value_msat| {
5289 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
5290 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
5291 Some(claimed_htlc_value - forwarded_htlc_value)
5294 Some(MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5295 event: events::Event::PaymentForwarded {
5297 claim_from_onchain_tx: from_onchain,
5298 prev_channel_id: Some(prev_outpoint.to_channel_id()),
5299 next_channel_id: Some(next_channel_outpoint.to_channel_id()),
5300 outbound_amount_forwarded_msat: forwarded_htlc_value_msat,
5302 downstream_counterparty_and_funding_outpoint:
5303 if let Some(node_id) = next_channel_counterparty_node_id {
5304 Some((node_id, next_channel_outpoint, completed_blocker))
5306 // We can only get `None` here if we are processing a
5307 // `ChannelMonitor`-originated event, in which case we
5308 // don't care about ensuring we wake the downstream
5309 // channel's monitor updating - the channel is already
5316 if let Err((pk, err)) = res {
5317 let result: Result<(), _> = Err(err);
5318 let _ = handle_error!(self, result, pk);
5324 /// Gets the node_id held by this ChannelManager
5325 pub fn get_our_node_id(&self) -> PublicKey {
5326 self.our_network_pubkey.clone()
5329 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
5330 for action in actions.into_iter() {
5332 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
5333 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5334 if let Some(ClaimingPayment {
5336 payment_purpose: purpose,
5339 sender_intended_value: sender_intended_total_msat,
5341 self.pending_events.lock().unwrap().push_back((events::Event::PaymentClaimed {
5345 receiver_node_id: Some(receiver_node_id),
5347 sender_intended_total_msat,
5351 MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5352 event, downstream_counterparty_and_funding_outpoint
5354 self.pending_events.lock().unwrap().push_back((event, None));
5355 if let Some((node_id, funding_outpoint, blocker)) = downstream_counterparty_and_funding_outpoint {
5356 self.handle_monitor_update_release(node_id, funding_outpoint, Some(blocker));
5363 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
5364 /// update completion.
5365 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
5366 channel: &mut Channel<SP>, raa: Option<msgs::RevokeAndACK>,
5367 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
5368 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
5369 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
5370 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
5371 log_trace!(self.logger, "Handling channel resumption for channel {} with {} RAA, {} commitment update, {} pending forwards, {}broadcasting funding, {} channel ready, {} announcement",
5372 &channel.context.channel_id(),
5373 if raa.is_some() { "an" } else { "no" },
5374 if commitment_update.is_some() { "a" } else { "no" }, pending_forwards.len(),
5375 if funding_broadcastable.is_some() { "" } else { "not " },
5376 if channel_ready.is_some() { "sending" } else { "without" },
5377 if announcement_sigs.is_some() { "sending" } else { "without" });
5379 let mut htlc_forwards = None;
5381 let counterparty_node_id = channel.context.get_counterparty_node_id();
5382 if !pending_forwards.is_empty() {
5383 htlc_forwards = Some((channel.context.get_short_channel_id().unwrap_or(channel.context.outbound_scid_alias()),
5384 channel.context.get_funding_txo().unwrap(), channel.context.get_user_id(), pending_forwards));
5387 if let Some(msg) = channel_ready {
5388 send_channel_ready!(self, pending_msg_events, channel, msg);
5390 if let Some(msg) = announcement_sigs {
5391 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5392 node_id: counterparty_node_id,
5397 macro_rules! handle_cs { () => {
5398 if let Some(update) = commitment_update {
5399 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5400 node_id: counterparty_node_id,
5405 macro_rules! handle_raa { () => {
5406 if let Some(revoke_and_ack) = raa {
5407 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
5408 node_id: counterparty_node_id,
5409 msg: revoke_and_ack,
5414 RAACommitmentOrder::CommitmentFirst => {
5418 RAACommitmentOrder::RevokeAndACKFirst => {
5424 if let Some(tx) = funding_broadcastable {
5425 log_info!(self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
5426 self.tx_broadcaster.broadcast_transactions(&[&tx]);
5430 let mut pending_events = self.pending_events.lock().unwrap();
5431 emit_channel_pending_event!(pending_events, channel);
5432 emit_channel_ready_event!(pending_events, channel);
5438 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
5439 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
5441 let counterparty_node_id = match counterparty_node_id {
5442 Some(cp_id) => cp_id.clone(),
5444 // TODO: Once we can rely on the counterparty_node_id from the
5445 // monitor event, this and the id_to_peer map should be removed.
5446 let id_to_peer = self.id_to_peer.lock().unwrap();
5447 match id_to_peer.get(&funding_txo.to_channel_id()) {
5448 Some(cp_id) => cp_id.clone(),
5453 let per_peer_state = self.per_peer_state.read().unwrap();
5454 let mut peer_state_lock;
5455 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
5456 if peer_state_mutex_opt.is_none() { return }
5457 peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5458 let peer_state = &mut *peer_state_lock;
5460 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&funding_txo.to_channel_id()) {
5463 let update_actions = peer_state.monitor_update_blocked_actions
5464 .remove(&funding_txo.to_channel_id()).unwrap_or(Vec::new());
5465 mem::drop(peer_state_lock);
5466 mem::drop(per_peer_state);
5467 self.handle_monitor_update_completion_actions(update_actions);
5470 let remaining_in_flight =
5471 if let Some(pending) = peer_state.in_flight_monitor_updates.get_mut(funding_txo) {
5472 pending.retain(|upd| upd.update_id > highest_applied_update_id);
5475 log_trace!(self.logger, "ChannelMonitor updated to {}. Current highest is {}. {} pending in-flight updates.",
5476 highest_applied_update_id, channel.context.get_latest_monitor_update_id(),
5477 remaining_in_flight);
5478 if !channel.is_awaiting_monitor_update() || channel.context.get_latest_monitor_update_id() != highest_applied_update_id {
5481 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, channel);
5484 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
5486 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
5487 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
5490 /// The `user_channel_id` parameter will be provided back in
5491 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5492 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5494 /// Note that this method will return an error and reject the channel, if it requires support
5495 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
5496 /// used to accept such channels.
5498 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5499 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5500 pub fn accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5501 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
5504 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
5505 /// it as confirmed immediately.
5507 /// The `user_channel_id` parameter will be provided back in
5508 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5509 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5511 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
5512 /// and (if the counterparty agrees), enables forwarding of payments immediately.
5514 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
5515 /// transaction and blindly assumes that it will eventually confirm.
5517 /// If it does not confirm before we decide to close the channel, or if the funding transaction
5518 /// does not pay to the correct script the correct amount, *you will lose funds*.
5520 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5521 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5522 pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5523 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
5526 fn do_accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
5527 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5529 let peers_without_funded_channels =
5530 self.peers_without_funded_channels(|peer| { peer.total_channel_count() > 0 });
5531 let per_peer_state = self.per_peer_state.read().unwrap();
5532 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5533 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
5534 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5535 let peer_state = &mut *peer_state_lock;
5536 let is_only_peer_channel = peer_state.total_channel_count() == 1;
5538 // Find (and remove) the channel in the unaccepted table. If it's not there, something weird is
5539 // happening and return an error. N.B. that we create channel with an outbound SCID of zero so
5540 // that we can delay allocating the SCID until after we're sure that the checks below will
5542 let mut channel = match peer_state.inbound_channel_request_by_id.remove(temporary_channel_id) {
5543 Some(unaccepted_channel) => {
5544 let best_block_height = self.best_block.read().unwrap().height();
5545 InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
5546 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features,
5547 &unaccepted_channel.open_channel_msg, user_channel_id, &self.default_configuration, best_block_height,
5548 &self.logger, accept_0conf).map_err(|e| APIError::ChannelUnavailable { err: e.to_string() })
5550 _ => Err(APIError::APIMisuseError { err: "No such channel awaiting to be accepted.".to_owned() })
5554 // This should have been correctly configured by the call to InboundV1Channel::new.
5555 debug_assert!(channel.context.minimum_depth().unwrap() == 0);
5556 } else if channel.context.get_channel_type().requires_zero_conf() {
5557 let send_msg_err_event = events::MessageSendEvent::HandleError {
5558 node_id: channel.context.get_counterparty_node_id(),
5559 action: msgs::ErrorAction::SendErrorMessage{
5560 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
5563 peer_state.pending_msg_events.push(send_msg_err_event);
5564 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
5566 // If this peer already has some channels, a new channel won't increase our number of peers
5567 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
5568 // channels per-peer we can accept channels from a peer with existing ones.
5569 if is_only_peer_channel && peers_without_funded_channels >= MAX_UNFUNDED_CHANNEL_PEERS {
5570 let send_msg_err_event = events::MessageSendEvent::HandleError {
5571 node_id: channel.context.get_counterparty_node_id(),
5572 action: msgs::ErrorAction::SendErrorMessage{
5573 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "Have too many peers with unfunded channels, not accepting new ones".to_owned(), }
5576 peer_state.pending_msg_events.push(send_msg_err_event);
5577 return Err(APIError::APIMisuseError { err: "Too many peers with unfunded channels, refusing to accept new ones".to_owned() });
5581 // Now that we know we have a channel, assign an outbound SCID alias.
5582 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
5583 channel.context.set_outbound_scid_alias(outbound_scid_alias);
5585 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
5586 node_id: channel.context.get_counterparty_node_id(),
5587 msg: channel.accept_inbound_channel(),
5590 peer_state.channel_by_id.insert(temporary_channel_id.clone(), ChannelPhase::UnfundedInboundV1(channel));
5595 /// Gets the number of peers which match the given filter and do not have any funded, outbound,
5596 /// or 0-conf channels.
5598 /// The filter is called for each peer and provided with the number of unfunded, inbound, and
5599 /// non-0-conf channels we have with the peer.
5600 fn peers_without_funded_channels<Filter>(&self, maybe_count_peer: Filter) -> usize
5601 where Filter: Fn(&PeerState<SP>) -> bool {
5602 let mut peers_without_funded_channels = 0;
5603 let best_block_height = self.best_block.read().unwrap().height();
5605 let peer_state_lock = self.per_peer_state.read().unwrap();
5606 for (_, peer_mtx) in peer_state_lock.iter() {
5607 let peer = peer_mtx.lock().unwrap();
5608 if !maybe_count_peer(&*peer) { continue; }
5609 let num_unfunded_channels = Self::unfunded_channel_count(&peer, best_block_height);
5610 if num_unfunded_channels == peer.total_channel_count() {
5611 peers_without_funded_channels += 1;
5615 return peers_without_funded_channels;
5618 fn unfunded_channel_count(
5619 peer: &PeerState<SP>, best_block_height: u32
5621 let mut num_unfunded_channels = 0;
5622 for (_, phase) in peer.channel_by_id.iter() {
5624 ChannelPhase::Funded(chan) => {
5625 // This covers non-zero-conf inbound `Channel`s that we are currently monitoring, but those
5626 // which have not yet had any confirmations on-chain.
5627 if !chan.context.is_outbound() && chan.context.minimum_depth().unwrap_or(1) != 0 &&
5628 chan.context.get_funding_tx_confirmations(best_block_height) == 0
5630 num_unfunded_channels += 1;
5633 ChannelPhase::UnfundedInboundV1(chan) => {
5634 if chan.context.minimum_depth().unwrap_or(1) != 0 {
5635 num_unfunded_channels += 1;
5638 ChannelPhase::UnfundedOutboundV1(_) => {
5639 // Outbound channels don't contribute to the unfunded count in the DoS context.
5644 num_unfunded_channels + peer.inbound_channel_request_by_id.len()
5647 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
5648 if msg.chain_hash != self.genesis_hash {
5649 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
5652 if !self.default_configuration.accept_inbound_channels {
5653 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
5656 // Get the number of peers with channels, but without funded ones. We don't care too much
5657 // about peers that never open a channel, so we filter by peers that have at least one
5658 // channel, and then limit the number of those with unfunded channels.
5659 let channeled_peers_without_funding =
5660 self.peers_without_funded_channels(|node| node.total_channel_count() > 0);
5662 let per_peer_state = self.per_peer_state.read().unwrap();
5663 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5665 debug_assert!(false);
5666 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())
5668 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5669 let peer_state = &mut *peer_state_lock;
5671 // If this peer already has some channels, a new channel won't increase our number of peers
5672 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
5673 // channels per-peer we can accept channels from a peer with existing ones.
5674 if peer_state.total_channel_count() == 0 &&
5675 channeled_peers_without_funding >= MAX_UNFUNDED_CHANNEL_PEERS &&
5676 !self.default_configuration.manually_accept_inbound_channels
5678 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5679 "Have too many peers with unfunded channels, not accepting new ones".to_owned(),
5680 msg.temporary_channel_id.clone()));
5683 let best_block_height = self.best_block.read().unwrap().height();
5684 if Self::unfunded_channel_count(peer_state, best_block_height) >= MAX_UNFUNDED_CHANS_PER_PEER {
5685 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5686 format!("Refusing more than {} unfunded channels.", MAX_UNFUNDED_CHANS_PER_PEER),
5687 msg.temporary_channel_id.clone()));
5690 let channel_id = msg.temporary_channel_id;
5691 let channel_exists = peer_state.has_channel(&channel_id);
5693 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision for the same peer!".to_owned(), msg.temporary_channel_id.clone()));
5696 // If we're doing manual acceptance checks on the channel, then defer creation until we're sure we want to accept.
5697 if self.default_configuration.manually_accept_inbound_channels {
5698 let mut pending_events = self.pending_events.lock().unwrap();
5699 pending_events.push_back((events::Event::OpenChannelRequest {
5700 temporary_channel_id: msg.temporary_channel_id.clone(),
5701 counterparty_node_id: counterparty_node_id.clone(),
5702 funding_satoshis: msg.funding_satoshis,
5703 push_msat: msg.push_msat,
5704 channel_type: msg.channel_type.clone().unwrap(),
5706 peer_state.inbound_channel_request_by_id.insert(channel_id, InboundChannelRequest {
5707 open_channel_msg: msg.clone(),
5708 ticks_remaining: UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS,
5713 // Otherwise create the channel right now.
5714 let mut random_bytes = [0u8; 16];
5715 random_bytes.copy_from_slice(&self.entropy_source.get_secure_random_bytes()[..16]);
5716 let user_channel_id = u128::from_be_bytes(random_bytes);
5717 let mut channel = match InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
5718 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id,
5719 &self.default_configuration, best_block_height, &self.logger, /*is_0conf=*/false)
5722 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
5727 let channel_type = channel.context.get_channel_type();
5728 if channel_type.requires_zero_conf() {
5729 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
5731 if channel_type.requires_anchors_zero_fee_htlc_tx() {
5732 return Err(MsgHandleErrInternal::send_err_msg_no_close("No channels with anchor outputs accepted".to_owned(), msg.temporary_channel_id.clone()));
5735 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
5736 channel.context.set_outbound_scid_alias(outbound_scid_alias);
5738 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
5739 node_id: counterparty_node_id.clone(),
5740 msg: channel.accept_inbound_channel(),
5742 peer_state.channel_by_id.insert(channel_id, ChannelPhase::UnfundedInboundV1(channel));
5746 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
5747 let (value, output_script, user_id) = {
5748 let per_peer_state = self.per_peer_state.read().unwrap();
5749 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5751 debug_assert!(false);
5752 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)
5754 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5755 let peer_state = &mut *peer_state_lock;
5756 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
5757 hash_map::Entry::Occupied(mut phase) => {
5758 match phase.get_mut() {
5759 ChannelPhase::UnfundedOutboundV1(chan) => {
5760 try_chan_phase_entry!(self, chan.accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &peer_state.latest_features), phase);
5761 (chan.context.get_value_satoshis(), chan.context.get_funding_redeemscript().to_v0_p2wsh(), chan.context.get_user_id())
5764 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got an unexpected accept_channel message from peer with counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id));
5768 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))
5771 let mut pending_events = self.pending_events.lock().unwrap();
5772 pending_events.push_back((events::Event::FundingGenerationReady {
5773 temporary_channel_id: msg.temporary_channel_id,
5774 counterparty_node_id: *counterparty_node_id,
5775 channel_value_satoshis: value,
5777 user_channel_id: user_id,
5782 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
5783 let best_block = *self.best_block.read().unwrap();
5785 let per_peer_state = self.per_peer_state.read().unwrap();
5786 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5788 debug_assert!(false);
5789 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)
5792 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5793 let peer_state = &mut *peer_state_lock;
5794 let (chan, funding_msg, monitor) =
5795 match peer_state.channel_by_id.remove(&msg.temporary_channel_id) {
5796 Some(ChannelPhase::UnfundedInboundV1(inbound_chan)) => {
5797 match inbound_chan.funding_created(msg, best_block, &self.signer_provider, &self.logger) {
5799 Err((mut inbound_chan, err)) => {
5800 // We've already removed this inbound channel from the map in `PeerState`
5801 // above so at this point we just need to clean up any lingering entries
5802 // concerning this channel as it is safe to do so.
5803 update_maps_on_chan_removal!(self, &inbound_chan.context);
5804 let user_id = inbound_chan.context.get_user_id();
5805 let shutdown_res = inbound_chan.context.force_shutdown(false);
5806 return Err(MsgHandleErrInternal::from_finish_shutdown(format!("{}", err),
5807 msg.temporary_channel_id, user_id, shutdown_res, None, inbound_chan.context.get_value_satoshis()));
5811 Some(ChannelPhase::Funded(_)) | Some(ChannelPhase::UnfundedOutboundV1(_)) => {
5812 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got an unexpected funding_created message from peer with counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id));
5814 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))
5817 match peer_state.channel_by_id.entry(funding_msg.channel_id) {
5818 hash_map::Entry::Occupied(_) => {
5819 Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
5821 hash_map::Entry::Vacant(e) => {
5822 match self.id_to_peer.lock().unwrap().entry(chan.context.channel_id()) {
5823 hash_map::Entry::Occupied(_) => {
5824 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5825 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
5826 funding_msg.channel_id))
5828 hash_map::Entry::Vacant(i_e) => {
5829 i_e.insert(chan.context.get_counterparty_node_id());
5833 // There's no problem signing a counterparty's funding transaction if our monitor
5834 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
5835 // accepted payment from yet. We do, however, need to wait to send our channel_ready
5836 // until we have persisted our monitor.
5837 let new_channel_id = funding_msg.channel_id;
5838 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
5839 node_id: counterparty_node_id.clone(),
5843 let monitor_res = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
5845 if let ChannelPhase::Funded(chan) = e.insert(ChannelPhase::Funded(chan)) {
5846 let mut res = handle_new_monitor_update!(self, monitor_res, peer_state_lock, peer_state,
5847 per_peer_state, chan, MANUALLY_REMOVING_INITIAL_MONITOR,
5848 { peer_state.channel_by_id.remove(&new_channel_id) });
5850 // Note that we reply with the new channel_id in error messages if we gave up on the
5851 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
5852 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
5853 // any messages referencing a previously-closed channel anyway.
5854 // We do not propagate the monitor update to the user as it would be for a monitor
5855 // that we didn't manage to store (and that we don't care about - we don't respond
5856 // with the funding_signed so the channel can never go on chain).
5857 if let Err(MsgHandleErrInternal { shutdown_finish: Some((res, _)), .. }) = &mut res {
5862 unreachable!("This must be a funded channel as we just inserted it.");
5868 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
5869 let best_block = *self.best_block.read().unwrap();
5870 let per_peer_state = self.per_peer_state.read().unwrap();
5871 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5873 debug_assert!(false);
5874 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5877 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5878 let peer_state = &mut *peer_state_lock;
5879 match peer_state.channel_by_id.entry(msg.channel_id) {
5880 hash_map::Entry::Occupied(mut chan_phase_entry) => {
5881 match chan_phase_entry.get_mut() {
5882 ChannelPhase::Funded(ref mut chan) => {
5883 let monitor = try_chan_phase_entry!(self,
5884 chan.funding_signed(&msg, best_block, &self.signer_provider, &self.logger), chan_phase_entry);
5885 let update_res = self.chain_monitor.watch_channel(chan.context.get_funding_txo().unwrap(), monitor);
5886 let mut res = handle_new_monitor_update!(self, update_res, peer_state_lock, peer_state, per_peer_state, chan_phase_entry, INITIAL_MONITOR);
5887 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
5888 // We weren't able to watch the channel to begin with, so no updates should be made on
5889 // it. Previously, full_stack_target found an (unreachable) panic when the
5890 // monitor update contained within `shutdown_finish` was applied.
5891 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
5892 shutdown_finish.0.take();
5898 return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id));
5902 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5906 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
5907 let per_peer_state = self.per_peer_state.read().unwrap();
5908 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5910 debug_assert!(false);
5911 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5913 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5914 let peer_state = &mut *peer_state_lock;
5915 match peer_state.channel_by_id.entry(msg.channel_id) {
5916 hash_map::Entry::Occupied(mut chan_phase_entry) => {
5917 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
5918 let announcement_sigs_opt = try_chan_phase_entry!(self, chan.channel_ready(&msg, &self.node_signer,
5919 self.genesis_hash.clone(), &self.default_configuration, &self.best_block.read().unwrap(), &self.logger), chan_phase_entry);
5920 if let Some(announcement_sigs) = announcement_sigs_opt {
5921 log_trace!(self.logger, "Sending announcement_signatures for channel {}", chan.context.channel_id());
5922 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5923 node_id: counterparty_node_id.clone(),
5924 msg: announcement_sigs,
5926 } else if chan.context.is_usable() {
5927 // If we're sending an announcement_signatures, we'll send the (public)
5928 // channel_update after sending a channel_announcement when we receive our
5929 // counterparty's announcement_signatures. Thus, we only bother to send a
5930 // channel_update here if the channel is not public, i.e. we're not sending an
5931 // announcement_signatures.
5932 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", chan.context.channel_id());
5933 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
5934 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
5935 node_id: counterparty_node_id.clone(),
5942 let mut pending_events = self.pending_events.lock().unwrap();
5943 emit_channel_ready_event!(pending_events, chan);
5948 try_chan_phase_entry!(self, Err(ChannelError::Close(
5949 "Got a channel_ready message for an unfunded channel!".into())), chan_phase_entry)
5952 hash_map::Entry::Vacant(_) => {
5953 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))
5958 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
5959 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
5960 let result: Result<(), _> = loop {
5961 let per_peer_state = self.per_peer_state.read().unwrap();
5962 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5964 debug_assert!(false);
5965 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5967 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5968 let peer_state = &mut *peer_state_lock;
5969 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(msg.channel_id.clone()) {
5970 let phase = chan_phase_entry.get_mut();
5972 ChannelPhase::Funded(chan) => {
5973 if !chan.received_shutdown() {
5974 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
5976 if chan.sent_shutdown() { " after we initiated shutdown" } else { "" });
5979 let funding_txo_opt = chan.context.get_funding_txo();
5980 let (shutdown, monitor_update_opt, htlcs) = try_chan_phase_entry!(self,
5981 chan.shutdown(&self.signer_provider, &peer_state.latest_features, &msg), chan_phase_entry);
5982 dropped_htlcs = htlcs;
5984 if let Some(msg) = shutdown {
5985 // We can send the `shutdown` message before updating the `ChannelMonitor`
5986 // here as we don't need the monitor update to complete until we send a
5987 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
5988 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5989 node_id: *counterparty_node_id,
5993 // Update the monitor with the shutdown script if necessary.
5994 if let Some(monitor_update) = monitor_update_opt {
5995 break handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
5996 peer_state_lock, peer_state, per_peer_state, chan_phase_entry).map(|_| ());
6000 ChannelPhase::UnfundedInboundV1(_) | ChannelPhase::UnfundedOutboundV1(_) => {
6001 let context = phase.context_mut();
6002 log_error!(self.logger, "Immediately closing unfunded channel {} as peer asked to cooperatively shut it down (which is unnecessary)", &msg.channel_id);
6003 self.issue_channel_close_events(&context, ClosureReason::CounterpartyCoopClosedUnfundedChannel);
6004 let mut chan = remove_channel_phase!(self, chan_phase_entry);
6005 self.finish_force_close_channel(chan.context_mut().force_shutdown(false));
6010 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))
6013 for htlc_source in dropped_htlcs.drain(..) {
6014 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
6015 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
6016 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
6022 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
6023 let per_peer_state = self.per_peer_state.read().unwrap();
6024 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6026 debug_assert!(false);
6027 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6029 let (tx, chan_option) = {
6030 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6031 let peer_state = &mut *peer_state_lock;
6032 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
6033 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6034 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6035 let (closing_signed, tx) = try_chan_phase_entry!(self, chan.closing_signed(&self.fee_estimator, &msg), chan_phase_entry);
6036 if let Some(msg) = closing_signed {
6037 peer_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
6038 node_id: counterparty_node_id.clone(),
6043 // We're done with this channel, we've got a signed closing transaction and
6044 // will send the closing_signed back to the remote peer upon return. This
6045 // also implies there are no pending HTLCs left on the channel, so we can
6046 // fully delete it from tracking (the channel monitor is still around to
6047 // watch for old state broadcasts)!
6048 (tx, Some(remove_channel_phase!(self, chan_phase_entry)))
6049 } else { (tx, None) }
6051 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6052 "Got a closing_signed message for an unfunded channel!".into())), chan_phase_entry);
6055 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))
6058 if let Some(broadcast_tx) = tx {
6059 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
6060 self.tx_broadcaster.broadcast_transactions(&[&broadcast_tx]);
6062 if let Some(ChannelPhase::Funded(chan)) = chan_option {
6063 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6064 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6065 let peer_state = &mut *peer_state_lock;
6066 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6070 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
6075 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
6076 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
6077 //determine the state of the payment based on our response/if we forward anything/the time
6078 //we take to respond. We should take care to avoid allowing such an attack.
6080 //TODO: There exists a further attack where a node may garble the onion data, forward it to
6081 //us repeatedly garbled in different ways, and compare our error messages, which are
6082 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
6083 //but we should prevent it anyway.
6085 let decoded_hop_res = self.decode_update_add_htlc_onion(msg);
6086 let per_peer_state = self.per_peer_state.read().unwrap();
6087 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6089 debug_assert!(false);
6090 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6092 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6093 let peer_state = &mut *peer_state_lock;
6094 match peer_state.channel_by_id.entry(msg.channel_id) {
6095 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6096 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6097 let pending_forward_info = match decoded_hop_res {
6098 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
6099 self.construct_pending_htlc_status(msg, shared_secret, next_hop,
6100 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt),
6101 Err(e) => PendingHTLCStatus::Fail(e)
6103 let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
6104 // If the update_add is completely bogus, the call will Err and we will close,
6105 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
6106 // want to reject the new HTLC and fail it backwards instead of forwarding.
6107 match pending_forward_info {
6108 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
6109 let reason = if (error_code & 0x1000) != 0 {
6110 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
6111 HTLCFailReason::reason(real_code, error_data)
6113 HTLCFailReason::from_failure_code(error_code)
6114 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
6115 let msg = msgs::UpdateFailHTLC {
6116 channel_id: msg.channel_id,
6117 htlc_id: msg.htlc_id,
6120 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
6122 _ => pending_forward_info
6125 try_chan_phase_entry!(self, chan.update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.fee_estimator, &self.logger), chan_phase_entry);
6127 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6128 "Got an update_add_htlc message for an unfunded channel!".into())), chan_phase_entry);
6131 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))
6136 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
6138 let (htlc_source, forwarded_htlc_value) = {
6139 let per_peer_state = self.per_peer_state.read().unwrap();
6140 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6142 debug_assert!(false);
6143 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6145 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6146 let peer_state = &mut *peer_state_lock;
6147 match peer_state.channel_by_id.entry(msg.channel_id) {
6148 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6149 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6150 let res = try_chan_phase_entry!(self, chan.update_fulfill_htlc(&msg), chan_phase_entry);
6151 if let HTLCSource::PreviousHopData(prev_hop) = &res.0 {
6152 peer_state.actions_blocking_raa_monitor_updates.entry(msg.channel_id)
6153 .or_insert_with(Vec::new)
6154 .push(RAAMonitorUpdateBlockingAction::from_prev_hop_data(&prev_hop));
6156 // Note that we do not need to push an `actions_blocking_raa_monitor_updates`
6157 // entry here, even though we *do* need to block the next RAA monitor update.
6158 // We do this instead in the `claim_funds_internal` by attaching a
6159 // `ReleaseRAAChannelMonitorUpdate` action to the event generated when the
6160 // outbound HTLC is claimed. This is guaranteed to all complete before we
6161 // process the RAA as messages are processed from single peers serially.
6162 funding_txo = chan.context.get_funding_txo().expect("We won't accept a fulfill until funded");
6165 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6166 "Got an update_fulfill_htlc message for an unfunded channel!".into())), chan_phase_entry);
6169 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))
6172 self.claim_funds_internal(htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, Some(*counterparty_node_id), funding_txo);
6176 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
6177 let per_peer_state = self.per_peer_state.read().unwrap();
6178 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6180 debug_assert!(false);
6181 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6183 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6184 let peer_state = &mut *peer_state_lock;
6185 match peer_state.channel_by_id.entry(msg.channel_id) {
6186 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6187 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6188 try_chan_phase_entry!(self, chan.update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan_phase_entry);
6190 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6191 "Got an update_fail_htlc message for an unfunded channel!".into())), chan_phase_entry);
6194 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))
6199 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
6200 let per_peer_state = self.per_peer_state.read().unwrap();
6201 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6203 debug_assert!(false);
6204 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6206 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6207 let peer_state = &mut *peer_state_lock;
6208 match peer_state.channel_by_id.entry(msg.channel_id) {
6209 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6210 if (msg.failure_code & 0x8000) == 0 {
6211 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
6212 try_chan_phase_entry!(self, Err(chan_err), chan_phase_entry);
6214 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6215 try_chan_phase_entry!(self, chan.update_fail_malformed_htlc(&msg, HTLCFailReason::reason(msg.failure_code, msg.sha256_of_onion.to_vec())), chan_phase_entry);
6217 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6218 "Got an update_fail_malformed_htlc message for an unfunded channel!".into())), chan_phase_entry);
6222 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))
6226 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
6227 let per_peer_state = self.per_peer_state.read().unwrap();
6228 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6230 debug_assert!(false);
6231 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6233 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6234 let peer_state = &mut *peer_state_lock;
6235 match peer_state.channel_by_id.entry(msg.channel_id) {
6236 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6237 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6238 let funding_txo = chan.context.get_funding_txo();
6239 let monitor_update_opt = try_chan_phase_entry!(self, chan.commitment_signed(&msg, &self.logger), chan_phase_entry);
6240 if let Some(monitor_update) = monitor_update_opt {
6241 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update, peer_state_lock,
6242 peer_state, per_peer_state, chan_phase_entry).map(|_| ())
6245 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6246 "Got a commitment_signed message for an unfunded channel!".into())), chan_phase_entry);
6249 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))
6254 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
6255 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
6256 let mut push_forward_event = false;
6257 let mut new_intercept_events = VecDeque::new();
6258 let mut failed_intercept_forwards = Vec::new();
6259 if !pending_forwards.is_empty() {
6260 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
6261 let scid = match forward_info.routing {
6262 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
6263 PendingHTLCRouting::Receive { .. } => 0,
6264 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
6266 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
6267 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
6269 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
6270 let forward_htlcs_empty = forward_htlcs.is_empty();
6271 match forward_htlcs.entry(scid) {
6272 hash_map::Entry::Occupied(mut entry) => {
6273 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6274 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
6276 hash_map::Entry::Vacant(entry) => {
6277 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
6278 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.genesis_hash)
6280 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).into_inner());
6281 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
6282 match pending_intercepts.entry(intercept_id) {
6283 hash_map::Entry::Vacant(entry) => {
6284 new_intercept_events.push_back((events::Event::HTLCIntercepted {
6285 requested_next_hop_scid: scid,
6286 payment_hash: forward_info.payment_hash,
6287 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
6288 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
6291 entry.insert(PendingAddHTLCInfo {
6292 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
6294 hash_map::Entry::Occupied(_) => {
6295 log_info!(self.logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
6296 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
6297 short_channel_id: prev_short_channel_id,
6298 user_channel_id: Some(prev_user_channel_id),
6299 outpoint: prev_funding_outpoint,
6300 htlc_id: prev_htlc_id,
6301 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
6302 phantom_shared_secret: None,
6305 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
6306 HTLCFailReason::from_failure_code(0x4000 | 10),
6307 HTLCDestination::InvalidForward { requested_forward_scid: scid },
6312 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
6313 // payments are being processed.
6314 if forward_htlcs_empty {
6315 push_forward_event = true;
6317 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6318 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
6325 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
6326 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
6329 if !new_intercept_events.is_empty() {
6330 let mut events = self.pending_events.lock().unwrap();
6331 events.append(&mut new_intercept_events);
6333 if push_forward_event { self.push_pending_forwards_ev() }
6337 fn push_pending_forwards_ev(&self) {
6338 let mut pending_events = self.pending_events.lock().unwrap();
6339 let is_processing_events = self.pending_events_processor.load(Ordering::Acquire);
6340 let num_forward_events = pending_events.iter().filter(|(ev, _)|
6341 if let events::Event::PendingHTLCsForwardable { .. } = ev { true } else { false }
6343 // We only want to push a PendingHTLCsForwardable event if no others are queued. Processing
6344 // events is done in batches and they are not removed until we're done processing each
6345 // batch. Since handling a `PendingHTLCsForwardable` event will call back into the
6346 // `ChannelManager`, we'll still see the original forwarding event not removed. Phantom
6347 // payments will need an additional forwarding event before being claimed to make them look
6348 // real by taking more time.
6349 if (is_processing_events && num_forward_events <= 1) || num_forward_events < 1 {
6350 pending_events.push_back((Event::PendingHTLCsForwardable {
6351 time_forwardable: Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
6356 /// Checks whether [`ChannelMonitorUpdate`]s generated by the receipt of a remote
6357 /// [`msgs::RevokeAndACK`] should be held for the given channel until some other action
6358 /// completes. Note that this needs to happen in the same [`PeerState`] mutex as any release of
6359 /// the [`ChannelMonitorUpdate`] in question.
6360 fn raa_monitor_updates_held(&self,
6361 actions_blocking_raa_monitor_updates: &BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
6362 channel_funding_outpoint: OutPoint, counterparty_node_id: PublicKey
6364 actions_blocking_raa_monitor_updates
6365 .get(&channel_funding_outpoint.to_channel_id()).map(|v| !v.is_empty()).unwrap_or(false)
6366 || self.pending_events.lock().unwrap().iter().any(|(_, action)| {
6367 action == &Some(EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
6368 channel_funding_outpoint,
6369 counterparty_node_id,
6374 #[cfg(any(test, feature = "_test_utils"))]
6375 pub(crate) fn test_raa_monitor_updates_held(&self,
6376 counterparty_node_id: PublicKey, channel_id: ChannelId
6378 let per_peer_state = self.per_peer_state.read().unwrap();
6379 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
6380 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
6381 let peer_state = &mut *peer_state_lck;
6383 if let Some(chan) = peer_state.channel_by_id.get(&channel_id) {
6384 return self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
6385 chan.context().get_funding_txo().unwrap(), counterparty_node_id);
6391 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
6392 let (htlcs_to_fail, res) = {
6393 let per_peer_state = self.per_peer_state.read().unwrap();
6394 let mut peer_state_lock = per_peer_state.get(counterparty_node_id)
6396 debug_assert!(false);
6397 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6398 }).map(|mtx| mtx.lock().unwrap())?;
6399 let peer_state = &mut *peer_state_lock;
6400 match peer_state.channel_by_id.entry(msg.channel_id) {
6401 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6402 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6403 let funding_txo_opt = chan.context.get_funding_txo();
6404 let mon_update_blocked = if let Some(funding_txo) = funding_txo_opt {
6405 self.raa_monitor_updates_held(
6406 &peer_state.actions_blocking_raa_monitor_updates, funding_txo,
6407 *counterparty_node_id)
6409 let (htlcs_to_fail, monitor_update_opt) = try_chan_phase_entry!(self,
6410 chan.revoke_and_ack(&msg, &self.fee_estimator, &self.logger, mon_update_blocked), chan_phase_entry);
6411 let res = if let Some(monitor_update) = monitor_update_opt {
6412 let funding_txo = funding_txo_opt
6413 .expect("Funding outpoint must have been set for RAA handling to succeed");
6414 handle_new_monitor_update!(self, funding_txo, monitor_update,
6415 peer_state_lock, peer_state, per_peer_state, chan_phase_entry).map(|_| ())
6417 (htlcs_to_fail, res)
6419 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6420 "Got a revoke_and_ack message for an unfunded channel!".into())), chan_phase_entry);
6423 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))
6426 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
6430 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
6431 let per_peer_state = self.per_peer_state.read().unwrap();
6432 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6434 debug_assert!(false);
6435 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6437 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6438 let peer_state = &mut *peer_state_lock;
6439 match peer_state.channel_by_id.entry(msg.channel_id) {
6440 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6441 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6442 try_chan_phase_entry!(self, chan.update_fee(&self.fee_estimator, &msg, &self.logger), chan_phase_entry);
6444 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6445 "Got an update_fee message for an unfunded channel!".into())), chan_phase_entry);
6448 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))
6453 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
6454 let per_peer_state = self.per_peer_state.read().unwrap();
6455 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6457 debug_assert!(false);
6458 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6460 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6461 let peer_state = &mut *peer_state_lock;
6462 match peer_state.channel_by_id.entry(msg.channel_id) {
6463 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6464 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6465 if !chan.context.is_usable() {
6466 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
6469 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
6470 msg: try_chan_phase_entry!(self, chan.announcement_signatures(
6471 &self.node_signer, self.genesis_hash.clone(), self.best_block.read().unwrap().height(),
6472 msg, &self.default_configuration
6473 ), chan_phase_entry),
6474 // Note that announcement_signatures fails if the channel cannot be announced,
6475 // so get_channel_update_for_broadcast will never fail by the time we get here.
6476 update_msg: Some(self.get_channel_update_for_broadcast(chan).unwrap()),
6479 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6480 "Got an announcement_signatures message for an unfunded channel!".into())), chan_phase_entry);
6483 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))
6488 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
6489 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
6490 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
6491 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
6493 // It's not a local channel
6494 return Ok(NotifyOption::SkipPersist)
6497 let per_peer_state = self.per_peer_state.read().unwrap();
6498 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
6499 if peer_state_mutex_opt.is_none() {
6500 return Ok(NotifyOption::SkipPersist)
6502 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
6503 let peer_state = &mut *peer_state_lock;
6504 match peer_state.channel_by_id.entry(chan_id) {
6505 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6506 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6507 if chan.context.get_counterparty_node_id() != *counterparty_node_id {
6508 if chan.context.should_announce() {
6509 // If the announcement is about a channel of ours which is public, some
6510 // other peer may simply be forwarding all its gossip to us. Don't provide
6511 // a scary-looking error message and return Ok instead.
6512 return Ok(NotifyOption::SkipPersist);
6514 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));
6516 let were_node_one = self.get_our_node_id().serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
6517 let msg_from_node_one = msg.contents.flags & 1 == 0;
6518 if were_node_one == msg_from_node_one {
6519 return Ok(NotifyOption::SkipPersist);
6521 log_debug!(self.logger, "Received channel_update for channel {}.", chan_id);
6522 try_chan_phase_entry!(self, chan.channel_update(&msg), chan_phase_entry);
6525 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6526 "Got a channel_update for an unfunded channel!".into())), chan_phase_entry);
6529 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersist)
6531 Ok(NotifyOption::DoPersist)
6534 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
6536 let need_lnd_workaround = {
6537 let per_peer_state = self.per_peer_state.read().unwrap();
6539 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6541 debug_assert!(false);
6542 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6544 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6545 let peer_state = &mut *peer_state_lock;
6546 match peer_state.channel_by_id.entry(msg.channel_id) {
6547 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6548 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6549 // Currently, we expect all holding cell update_adds to be dropped on peer
6550 // disconnect, so Channel's reestablish will never hand us any holding cell
6551 // freed HTLCs to fail backwards. If in the future we no longer drop pending
6552 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
6553 let responses = try_chan_phase_entry!(self, chan.channel_reestablish(
6554 msg, &self.logger, &self.node_signer, self.genesis_hash,
6555 &self.default_configuration, &*self.best_block.read().unwrap()), chan_phase_entry);
6556 let mut channel_update = None;
6557 if let Some(msg) = responses.shutdown_msg {
6558 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
6559 node_id: counterparty_node_id.clone(),
6562 } else if chan.context.is_usable() {
6563 // If the channel is in a usable state (ie the channel is not being shut
6564 // down), send a unicast channel_update to our counterparty to make sure
6565 // they have the latest channel parameters.
6566 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
6567 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
6568 node_id: chan.context.get_counterparty_node_id(),
6573 let need_lnd_workaround = chan.context.workaround_lnd_bug_4006.take();
6574 htlc_forwards = self.handle_channel_resumption(
6575 &mut peer_state.pending_msg_events, chan, responses.raa, responses.commitment_update, responses.order,
6576 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
6577 if let Some(upd) = channel_update {
6578 peer_state.pending_msg_events.push(upd);
6582 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6583 "Got a channel_reestablish message for an unfunded channel!".into())), chan_phase_entry);
6586 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))
6590 if let Some(forwards) = htlc_forwards {
6591 self.forward_htlcs(&mut [forwards][..]);
6594 if let Some(channel_ready_msg) = need_lnd_workaround {
6595 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
6600 /// Process pending events from the [`chain::Watch`], returning whether any events were processed.
6601 fn process_pending_monitor_events(&self) -> bool {
6602 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
6604 let mut failed_channels = Vec::new();
6605 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
6606 let has_pending_monitor_events = !pending_monitor_events.is_empty();
6607 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
6608 for monitor_event in monitor_events.drain(..) {
6609 match monitor_event {
6610 MonitorEvent::HTLCEvent(htlc_update) => {
6611 if let Some(preimage) = htlc_update.payment_preimage {
6612 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", preimage);
6613 self.claim_funds_internal(htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, counterparty_node_id, funding_outpoint);
6615 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", &htlc_update.payment_hash);
6616 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
6617 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
6618 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
6621 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
6622 MonitorEvent::UpdateFailed(funding_outpoint) => {
6623 let counterparty_node_id_opt = match counterparty_node_id {
6624 Some(cp_id) => Some(cp_id),
6626 // TODO: Once we can rely on the counterparty_node_id from the
6627 // monitor event, this and the id_to_peer map should be removed.
6628 let id_to_peer = self.id_to_peer.lock().unwrap();
6629 id_to_peer.get(&funding_outpoint.to_channel_id()).cloned()
6632 if let Some(counterparty_node_id) = counterparty_node_id_opt {
6633 let per_peer_state = self.per_peer_state.read().unwrap();
6634 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
6635 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6636 let peer_state = &mut *peer_state_lock;
6637 let pending_msg_events = &mut peer_state.pending_msg_events;
6638 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(funding_outpoint.to_channel_id()) {
6639 if let ChannelPhase::Funded(mut chan) = remove_channel_phase!(self, chan_phase_entry) {
6640 failed_channels.push(chan.context.force_shutdown(false));
6641 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6642 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6646 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
6647 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
6649 ClosureReason::CommitmentTxConfirmed
6651 self.issue_channel_close_events(&chan.context, reason);
6652 pending_msg_events.push(events::MessageSendEvent::HandleError {
6653 node_id: chan.context.get_counterparty_node_id(),
6654 action: msgs::ErrorAction::SendErrorMessage {
6655 msg: msgs::ErrorMessage { channel_id: chan.context.channel_id(), data: "Channel force-closed".to_owned() }
6663 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
6664 self.channel_monitor_updated(&funding_txo, monitor_update_id, counterparty_node_id.as_ref());
6670 for failure in failed_channels.drain(..) {
6671 self.finish_force_close_channel(failure);
6674 has_pending_monitor_events
6677 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
6678 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
6679 /// update events as a separate process method here.
6681 pub fn process_monitor_events(&self) {
6682 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6683 self.process_pending_monitor_events();
6686 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
6687 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
6688 /// update was applied.
6689 fn check_free_holding_cells(&self) -> bool {
6690 let mut has_monitor_update = false;
6691 let mut failed_htlcs = Vec::new();
6692 let mut handle_errors = Vec::new();
6694 // Walk our list of channels and find any that need to update. Note that when we do find an
6695 // update, if it includes actions that must be taken afterwards, we have to drop the
6696 // per-peer state lock as well as the top level per_peer_state lock. Thus, we loop until we
6697 // manage to go through all our peers without finding a single channel to update.
6699 let per_peer_state = self.per_peer_state.read().unwrap();
6700 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6702 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6703 let peer_state: &mut PeerState<_> = &mut *peer_state_lock;
6704 for (channel_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
6705 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
6707 let counterparty_node_id = chan.context.get_counterparty_node_id();
6708 let funding_txo = chan.context.get_funding_txo();
6709 let (monitor_opt, holding_cell_failed_htlcs) =
6710 chan.maybe_free_holding_cell_htlcs(&self.fee_estimator, &self.logger);
6711 if !holding_cell_failed_htlcs.is_empty() {
6712 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id, counterparty_node_id));
6714 if let Some(monitor_update) = monitor_opt {
6715 has_monitor_update = true;
6717 let channel_id: ChannelId = *channel_id;
6718 let res = handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update,
6719 peer_state_lock, peer_state, per_peer_state, chan, MANUALLY_REMOVING,
6720 peer_state.channel_by_id.remove(&channel_id));
6722 handle_errors.push((counterparty_node_id, res));
6724 continue 'peer_loop;
6733 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
6734 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
6735 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
6738 for (counterparty_node_id, err) in handle_errors.drain(..) {
6739 let _ = handle_error!(self, err, counterparty_node_id);
6745 /// Check whether any channels have finished removing all pending updates after a shutdown
6746 /// exchange and can now send a closing_signed.
6747 /// Returns whether any closing_signed messages were generated.
6748 fn maybe_generate_initial_closing_signed(&self) -> bool {
6749 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
6750 let mut has_update = false;
6752 let per_peer_state = self.per_peer_state.read().unwrap();
6754 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6755 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6756 let peer_state = &mut *peer_state_lock;
6757 let pending_msg_events = &mut peer_state.pending_msg_events;
6758 peer_state.channel_by_id.retain(|channel_id, phase| {
6760 ChannelPhase::Funded(chan) => {
6761 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
6762 Ok((msg_opt, tx_opt)) => {
6763 if let Some(msg) = msg_opt {
6765 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
6766 node_id: chan.context.get_counterparty_node_id(), msg,
6769 if let Some(tx) = tx_opt {
6770 // We're done with this channel. We got a closing_signed and sent back
6771 // a closing_signed with a closing transaction to broadcast.
6772 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6773 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6778 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
6780 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
6781 self.tx_broadcaster.broadcast_transactions(&[&tx]);
6782 update_maps_on_chan_removal!(self, &chan.context);
6788 let (close_channel, res) = convert_chan_phase_err!(self, e, chan, channel_id, FUNDED_CHANNEL);
6789 handle_errors.push((chan.context.get_counterparty_node_id(), Err(res)));
6794 _ => true, // Retain unfunded channels if present.
6800 for (counterparty_node_id, err) in handle_errors.drain(..) {
6801 let _ = handle_error!(self, err, counterparty_node_id);
6807 /// Handle a list of channel failures during a block_connected or block_disconnected call,
6808 /// pushing the channel monitor update (if any) to the background events queue and removing the
6810 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
6811 for mut failure in failed_channels.drain(..) {
6812 // Either a commitment transactions has been confirmed on-chain or
6813 // Channel::block_disconnected detected that the funding transaction has been
6814 // reorganized out of the main chain.
6815 // We cannot broadcast our latest local state via monitor update (as
6816 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
6817 // so we track the update internally and handle it when the user next calls
6818 // timer_tick_occurred, guaranteeing we're running normally.
6819 if let Some((counterparty_node_id, funding_txo, update)) = failure.0.take() {
6820 assert_eq!(update.updates.len(), 1);
6821 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
6822 assert!(should_broadcast);
6823 } else { unreachable!(); }
6824 self.pending_background_events.lock().unwrap().push(
6825 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
6826 counterparty_node_id, funding_txo, update
6829 self.finish_force_close_channel(failure);
6833 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
6836 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
6837 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
6839 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
6840 /// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
6841 /// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
6842 /// passed directly to [`claim_funds`].
6844 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
6846 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
6847 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
6851 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
6852 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
6854 /// Errors if `min_value_msat` is greater than total bitcoin supply.
6856 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
6857 /// on versions of LDK prior to 0.0.114.
6859 /// [`claim_funds`]: Self::claim_funds
6860 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
6861 /// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
6862 /// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
6863 /// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
6864 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
6865 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
6866 min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
6867 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs,
6868 &self.entropy_source, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
6869 min_final_cltv_expiry_delta)
6872 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
6873 /// stored external to LDK.
6875 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
6876 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
6877 /// the `min_value_msat` provided here, if one is provided.
6879 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
6880 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
6883 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
6884 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
6885 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
6886 /// sender "proof-of-payment" unless they have paid the required amount.
6888 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
6889 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
6890 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
6891 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
6892 /// invoices when no timeout is set.
6894 /// Note that we use block header time to time-out pending inbound payments (with some margin
6895 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
6896 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
6897 /// If you need exact expiry semantics, you should enforce them upon receipt of
6898 /// [`PaymentClaimable`].
6900 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
6901 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
6903 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
6904 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
6908 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
6909 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
6911 /// Errors if `min_value_msat` is greater than total bitcoin supply.
6913 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
6914 /// on versions of LDK prior to 0.0.114.
6916 /// [`create_inbound_payment`]: Self::create_inbound_payment
6917 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
6918 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>,
6919 invoice_expiry_delta_secs: u32, min_final_cltv_expiry: Option<u16>) -> Result<PaymentSecret, ()> {
6920 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash,
6921 invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
6922 min_final_cltv_expiry)
6925 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
6926 /// previously returned from [`create_inbound_payment`].
6928 /// [`create_inbound_payment`]: Self::create_inbound_payment
6929 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
6930 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
6933 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
6934 /// are used when constructing the phantom invoice's route hints.
6936 /// [phantom node payments]: crate::sign::PhantomKeysManager
6937 pub fn get_phantom_scid(&self) -> u64 {
6938 let best_block_height = self.best_block.read().unwrap().height();
6939 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
6941 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
6942 // Ensure the generated scid doesn't conflict with a real channel.
6943 match short_to_chan_info.get(&scid_candidate) {
6944 Some(_) => continue,
6945 None => return scid_candidate
6950 /// Gets route hints for use in receiving [phantom node payments].
6952 /// [phantom node payments]: crate::sign::PhantomKeysManager
6953 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
6955 channels: self.list_usable_channels(),
6956 phantom_scid: self.get_phantom_scid(),
6957 real_node_pubkey: self.get_our_node_id(),
6961 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
6962 /// used when constructing the route hints for HTLCs intended to be intercepted. See
6963 /// [`ChannelManager::forward_intercepted_htlc`].
6965 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
6966 /// times to get a unique scid.
6967 pub fn get_intercept_scid(&self) -> u64 {
6968 let best_block_height = self.best_block.read().unwrap().height();
6969 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
6971 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
6972 // Ensure the generated scid doesn't conflict with a real channel.
6973 if short_to_chan_info.contains_key(&scid_candidate) { continue }
6974 return scid_candidate
6978 /// Gets inflight HTLC information by processing pending outbound payments that are in
6979 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
6980 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
6981 let mut inflight_htlcs = InFlightHtlcs::new();
6983 let per_peer_state = self.per_peer_state.read().unwrap();
6984 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6985 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6986 let peer_state = &mut *peer_state_lock;
6987 for chan in peer_state.channel_by_id.values().filter_map(
6988 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
6990 for (htlc_source, _) in chan.inflight_htlc_sources() {
6991 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
6992 inflight_htlcs.process_path(path, self.get_our_node_id());
7001 #[cfg(any(test, feature = "_test_utils"))]
7002 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
7003 let events = core::cell::RefCell::new(Vec::new());
7004 let event_handler = |event: events::Event| events.borrow_mut().push(event);
7005 self.process_pending_events(&event_handler);
7009 #[cfg(feature = "_test_utils")]
7010 pub fn push_pending_event(&self, event: events::Event) {
7011 let mut events = self.pending_events.lock().unwrap();
7012 events.push_back((event, None));
7016 pub fn pop_pending_event(&self) -> Option<events::Event> {
7017 let mut events = self.pending_events.lock().unwrap();
7018 events.pop_front().map(|(e, _)| e)
7022 pub fn has_pending_payments(&self) -> bool {
7023 self.pending_outbound_payments.has_pending_payments()
7027 pub fn clear_pending_payments(&self) {
7028 self.pending_outbound_payments.clear_pending_payments()
7031 /// When something which was blocking a channel from updating its [`ChannelMonitor`] (e.g. an
7032 /// [`Event`] being handled) completes, this should be called to restore the channel to normal
7033 /// operation. It will double-check that nothing *else* is also blocking the same channel from
7034 /// making progress and then let any blocked [`ChannelMonitorUpdate`]s fly.
7035 fn handle_monitor_update_release(&self, counterparty_node_id: PublicKey, channel_funding_outpoint: OutPoint, mut completed_blocker: Option<RAAMonitorUpdateBlockingAction>) {
7036 let mut errors = Vec::new();
7038 let per_peer_state = self.per_peer_state.read().unwrap();
7039 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
7040 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
7041 let peer_state = &mut *peer_state_lck;
7043 if let Some(blocker) = completed_blocker.take() {
7044 // Only do this on the first iteration of the loop.
7045 if let Some(blockers) = peer_state.actions_blocking_raa_monitor_updates
7046 .get_mut(&channel_funding_outpoint.to_channel_id())
7048 blockers.retain(|iter| iter != &blocker);
7052 if self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
7053 channel_funding_outpoint, counterparty_node_id) {
7054 // Check that, while holding the peer lock, we don't have anything else
7055 // blocking monitor updates for this channel. If we do, release the monitor
7056 // update(s) when those blockers complete.
7057 log_trace!(self.logger, "Delaying monitor unlock for channel {} as another channel's mon update needs to complete first",
7058 &channel_funding_outpoint.to_channel_id());
7062 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(channel_funding_outpoint.to_channel_id()) {
7063 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
7064 debug_assert_eq!(chan.context.get_funding_txo().unwrap(), channel_funding_outpoint);
7065 if let Some((monitor_update, further_update_exists)) = chan.unblock_next_blocked_monitor_update() {
7066 log_debug!(self.logger, "Unlocking monitor updating for channel {} and updating monitor",
7067 channel_funding_outpoint.to_channel_id());
7068 if let Err(e) = handle_new_monitor_update!(self, channel_funding_outpoint, monitor_update,
7069 peer_state_lck, peer_state, per_peer_state, chan_phase_entry)
7071 errors.push((e, counterparty_node_id));
7073 if further_update_exists {
7074 // If there are more `ChannelMonitorUpdate`s to process, restart at the
7079 log_trace!(self.logger, "Unlocked monitor updating for channel {} without monitors to update",
7080 channel_funding_outpoint.to_channel_id());
7085 log_debug!(self.logger,
7086 "Got a release post-RAA monitor update for peer {} but the channel is gone",
7087 log_pubkey!(counterparty_node_id));
7091 for (err, counterparty_node_id) in errors {
7092 let res = Err::<(), _>(err);
7093 let _ = handle_error!(self, res, counterparty_node_id);
7097 fn handle_post_event_actions(&self, actions: Vec<EventCompletionAction>) {
7098 for action in actions {
7100 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
7101 channel_funding_outpoint, counterparty_node_id
7103 self.handle_monitor_update_release(counterparty_node_id, channel_funding_outpoint, None);
7109 /// Processes any events asynchronously in the order they were generated since the last call
7110 /// using the given event handler.
7112 /// See the trait-level documentation of [`EventsProvider`] for requirements.
7113 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
7117 process_events_body!(self, ev, { handler(ev).await });
7121 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>
7123 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7124 T::Target: BroadcasterInterface,
7125 ES::Target: EntropySource,
7126 NS::Target: NodeSigner,
7127 SP::Target: SignerProvider,
7128 F::Target: FeeEstimator,
7132 /// Returns `MessageSendEvent`s strictly ordered per-peer, in the order they were generated.
7133 /// The returned array will contain `MessageSendEvent`s for different peers if
7134 /// `MessageSendEvent`s to more than one peer exists, but `MessageSendEvent`s to the same peer
7135 /// is always placed next to each other.
7137 /// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
7138 /// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
7139 /// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
7140 /// will randomly be placed first or last in the returned array.
7142 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
7143 /// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
7144 /// the `MessageSendEvent`s to the specific peer they were generated under.
7145 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
7146 let events = RefCell::new(Vec::new());
7147 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
7148 let mut result = self.process_background_events();
7150 // TODO: This behavior should be documented. It's unintuitive that we query
7151 // ChannelMonitors when clearing other events.
7152 if self.process_pending_monitor_events() {
7153 result = NotifyOption::DoPersist;
7156 if self.check_free_holding_cells() {
7157 result = NotifyOption::DoPersist;
7159 if self.maybe_generate_initial_closing_signed() {
7160 result = NotifyOption::DoPersist;
7163 let mut pending_events = Vec::new();
7164 let per_peer_state = self.per_peer_state.read().unwrap();
7165 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7166 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7167 let peer_state = &mut *peer_state_lock;
7168 if peer_state.pending_msg_events.len() > 0 {
7169 pending_events.append(&mut peer_state.pending_msg_events);
7173 if !pending_events.is_empty() {
7174 events.replace(pending_events);
7183 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>
7185 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7186 T::Target: BroadcasterInterface,
7187 ES::Target: EntropySource,
7188 NS::Target: NodeSigner,
7189 SP::Target: SignerProvider,
7190 F::Target: FeeEstimator,
7194 /// Processes events that must be periodically handled.
7196 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
7197 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
7198 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
7200 process_events_body!(self, ev, handler.handle_event(ev));
7204 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>
7206 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7207 T::Target: BroadcasterInterface,
7208 ES::Target: EntropySource,
7209 NS::Target: NodeSigner,
7210 SP::Target: SignerProvider,
7211 F::Target: FeeEstimator,
7215 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
7217 let best_block = self.best_block.read().unwrap();
7218 assert_eq!(best_block.block_hash(), header.prev_blockhash,
7219 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
7220 assert_eq!(best_block.height(), height - 1,
7221 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
7224 self.transactions_confirmed(header, txdata, height);
7225 self.best_block_updated(header, height);
7228 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
7229 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
7230 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
7231 let new_height = height - 1;
7233 let mut best_block = self.best_block.write().unwrap();
7234 assert_eq!(best_block.block_hash(), header.block_hash(),
7235 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
7236 assert_eq!(best_block.height(), height,
7237 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
7238 *best_block = BestBlock::new(header.prev_blockhash, new_height)
7241 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));
7245 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>
7247 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7248 T::Target: BroadcasterInterface,
7249 ES::Target: EntropySource,
7250 NS::Target: NodeSigner,
7251 SP::Target: SignerProvider,
7252 F::Target: FeeEstimator,
7256 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
7257 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
7258 // during initialization prior to the chain_monitor being fully configured in some cases.
7259 // See the docs for `ChannelManagerReadArgs` for more.
7261 let block_hash = header.block_hash();
7262 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
7264 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
7265 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
7266 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)
7267 .map(|(a, b)| (a, Vec::new(), b)));
7269 let last_best_block_height = self.best_block.read().unwrap().height();
7270 if height < last_best_block_height {
7271 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
7272 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));
7276 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
7277 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
7278 // during initialization prior to the chain_monitor being fully configured in some cases.
7279 // See the docs for `ChannelManagerReadArgs` for more.
7281 let block_hash = header.block_hash();
7282 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
7284 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
7285 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
7286 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
7288 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));
7290 macro_rules! max_time {
7291 ($timestamp: expr) => {
7293 // Update $timestamp to be the max of its current value and the block
7294 // timestamp. This should keep us close to the current time without relying on
7295 // having an explicit local time source.
7296 // Just in case we end up in a race, we loop until we either successfully
7297 // update $timestamp or decide we don't need to.
7298 let old_serial = $timestamp.load(Ordering::Acquire);
7299 if old_serial >= header.time as usize { break; }
7300 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
7306 max_time!(self.highest_seen_timestamp);
7307 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
7308 payment_secrets.retain(|_, inbound_payment| {
7309 inbound_payment.expiry_time > header.time as u64
7313 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
7314 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
7315 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
7316 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7317 let peer_state = &mut *peer_state_lock;
7318 for chan in peer_state.channel_by_id.values().filter_map(|phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }) {
7319 if let (Some(funding_txo), Some(block_hash)) = (chan.context.get_funding_txo(), chan.context.get_funding_tx_confirmed_in()) {
7320 res.push((funding_txo.txid, Some(block_hash)));
7327 fn transaction_unconfirmed(&self, txid: &Txid) {
7328 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
7329 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
7330 self.do_chain_event(None, |channel| {
7331 if let Some(funding_txo) = channel.context.get_funding_txo() {
7332 if funding_txo.txid == *txid {
7333 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
7334 } else { Ok((None, Vec::new(), None)) }
7335 } else { Ok((None, Vec::new(), None)) }
7340 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>
7342 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7343 T::Target: BroadcasterInterface,
7344 ES::Target: EntropySource,
7345 NS::Target: NodeSigner,
7346 SP::Target: SignerProvider,
7347 F::Target: FeeEstimator,
7351 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
7352 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
7354 fn do_chain_event<FN: Fn(&mut Channel<SP>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
7355 (&self, height_opt: Option<u32>, f: FN) {
7356 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
7357 // during initialization prior to the chain_monitor being fully configured in some cases.
7358 // See the docs for `ChannelManagerReadArgs` for more.
7360 let mut failed_channels = Vec::new();
7361 let mut timed_out_htlcs = Vec::new();
7363 let per_peer_state = self.per_peer_state.read().unwrap();
7364 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7365 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7366 let peer_state = &mut *peer_state_lock;
7367 let pending_msg_events = &mut peer_state.pending_msg_events;
7368 peer_state.channel_by_id.retain(|_, phase| {
7370 // Retain unfunded channels.
7371 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => true,
7372 ChannelPhase::Funded(channel) => {
7373 let res = f(channel);
7374 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
7375 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
7376 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
7377 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
7378 HTLCDestination::NextHopChannel { node_id: Some(channel.context.get_counterparty_node_id()), channel_id: channel.context.channel_id() }));
7380 if let Some(channel_ready) = channel_ready_opt {
7381 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
7382 if channel.context.is_usable() {
7383 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", channel.context.channel_id());
7384 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
7385 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
7386 node_id: channel.context.get_counterparty_node_id(),
7391 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", channel.context.channel_id());
7396 let mut pending_events = self.pending_events.lock().unwrap();
7397 emit_channel_ready_event!(pending_events, channel);
7400 if let Some(announcement_sigs) = announcement_sigs {
7401 log_trace!(self.logger, "Sending announcement_signatures for channel {}", channel.context.channel_id());
7402 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
7403 node_id: channel.context.get_counterparty_node_id(),
7404 msg: announcement_sigs,
7406 if let Some(height) = height_opt {
7407 if let Some(announcement) = channel.get_signed_channel_announcement(&self.node_signer, self.genesis_hash, height, &self.default_configuration) {
7408 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
7410 // Note that announcement_signatures fails if the channel cannot be announced,
7411 // so get_channel_update_for_broadcast will never fail by the time we get here.
7412 update_msg: Some(self.get_channel_update_for_broadcast(channel).unwrap()),
7417 if channel.is_our_channel_ready() {
7418 if let Some(real_scid) = channel.context.get_short_channel_id() {
7419 // If we sent a 0conf channel_ready, and now have an SCID, we add it
7420 // to the short_to_chan_info map here. Note that we check whether we
7421 // can relay using the real SCID at relay-time (i.e.
7422 // enforce option_scid_alias then), and if the funding tx is ever
7423 // un-confirmed we force-close the channel, ensuring short_to_chan_info
7424 // is always consistent.
7425 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
7426 let scid_insert = short_to_chan_info.insert(real_scid, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
7427 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.context.get_counterparty_node_id(), channel.context.channel_id()),
7428 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
7429 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
7432 } else if let Err(reason) = res {
7433 update_maps_on_chan_removal!(self, &channel.context);
7434 // It looks like our counterparty went on-chain or funding transaction was
7435 // reorged out of the main chain. Close the channel.
7436 failed_channels.push(channel.context.force_shutdown(true));
7437 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
7438 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7442 let reason_message = format!("{}", reason);
7443 self.issue_channel_close_events(&channel.context, reason);
7444 pending_msg_events.push(events::MessageSendEvent::HandleError {
7445 node_id: channel.context.get_counterparty_node_id(),
7446 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
7447 channel_id: channel.context.channel_id(),
7448 data: reason_message,
7460 if let Some(height) = height_opt {
7461 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
7462 payment.htlcs.retain(|htlc| {
7463 // If height is approaching the number of blocks we think it takes us to get
7464 // our commitment transaction confirmed before the HTLC expires, plus the
7465 // number of blocks we generally consider it to take to do a commitment update,
7466 // just give up on it and fail the HTLC.
7467 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
7468 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
7469 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
7471 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
7472 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
7473 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
7477 !payment.htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
7480 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
7481 intercepted_htlcs.retain(|_, htlc| {
7482 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
7483 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
7484 short_channel_id: htlc.prev_short_channel_id,
7485 user_channel_id: Some(htlc.prev_user_channel_id),
7486 htlc_id: htlc.prev_htlc_id,
7487 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
7488 phantom_shared_secret: None,
7489 outpoint: htlc.prev_funding_outpoint,
7492 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
7493 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
7494 _ => unreachable!(),
7496 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
7497 HTLCFailReason::from_failure_code(0x2000 | 2),
7498 HTLCDestination::InvalidForward { requested_forward_scid }));
7499 log_trace!(self.logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
7505 self.handle_init_event_channel_failures(failed_channels);
7507 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
7508 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
7512 /// Gets a [`Future`] that completes when this [`ChannelManager`] needs to be persisted.
7514 /// Note that callbacks registered on the [`Future`] MUST NOT call back into this
7515 /// [`ChannelManager`] and should instead register actions to be taken later.
7517 pub fn get_persistable_update_future(&self) -> Future {
7518 self.persistence_notifier.get_future()
7521 #[cfg(any(test, feature = "_test_utils"))]
7522 pub fn get_persistence_condvar_value(&self) -> bool {
7523 self.persistence_notifier.notify_pending()
7526 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
7527 /// [`chain::Confirm`] interfaces.
7528 pub fn current_best_block(&self) -> BestBlock {
7529 self.best_block.read().unwrap().clone()
7532 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
7533 /// [`ChannelManager`].
7534 pub fn node_features(&self) -> NodeFeatures {
7535 provided_node_features(&self.default_configuration)
7538 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags which are provided by or required by
7539 /// [`ChannelManager`].
7541 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
7542 /// or not. Thus, this method is not public.
7543 #[cfg(any(feature = "_test_utils", test))]
7544 pub fn invoice_features(&self) -> Bolt11InvoiceFeatures {
7545 provided_invoice_features(&self.default_configuration)
7548 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
7549 /// [`ChannelManager`].
7550 pub fn channel_features(&self) -> ChannelFeatures {
7551 provided_channel_features(&self.default_configuration)
7554 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
7555 /// [`ChannelManager`].
7556 pub fn channel_type_features(&self) -> ChannelTypeFeatures {
7557 provided_channel_type_features(&self.default_configuration)
7560 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
7561 /// [`ChannelManager`].
7562 pub fn init_features(&self) -> InitFeatures {
7563 provided_init_features(&self.default_configuration)
7567 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7568 ChannelMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
7570 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7571 T::Target: BroadcasterInterface,
7572 ES::Target: EntropySource,
7573 NS::Target: NodeSigner,
7574 SP::Target: SignerProvider,
7575 F::Target: FeeEstimator,
7579 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) {
7580 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7581 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, msg), *counterparty_node_id);
7584 fn handle_open_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
7585 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7586 "Dual-funded channels not supported".to_owned(),
7587 msg.temporary_channel_id.clone())), *counterparty_node_id);
7590 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
7591 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7592 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, msg), *counterparty_node_id);
7595 fn handle_accept_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
7596 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7597 "Dual-funded channels not supported".to_owned(),
7598 msg.temporary_channel_id.clone())), *counterparty_node_id);
7601 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
7602 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7603 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
7606 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
7607 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7608 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
7611 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
7612 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7613 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
7616 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
7617 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7618 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
7621 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
7622 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7623 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
7626 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
7627 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7628 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
7631 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
7632 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7633 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
7636 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
7637 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7638 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
7641 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
7642 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7643 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
7646 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
7647 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7648 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
7651 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
7652 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7653 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
7656 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
7657 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7658 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
7661 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
7662 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7663 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
7666 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
7667 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
7668 let force_persist = self.process_background_events();
7669 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
7670 if force_persist == NotifyOption::DoPersist { NotifyOption::DoPersist } else { persist }
7672 NotifyOption::SkipPersist
7677 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
7678 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7679 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
7682 fn peer_disconnected(&self, counterparty_node_id: &PublicKey) {
7683 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7684 let mut failed_channels = Vec::new();
7685 let mut per_peer_state = self.per_peer_state.write().unwrap();
7687 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates.",
7688 log_pubkey!(counterparty_node_id));
7689 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
7690 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7691 let peer_state = &mut *peer_state_lock;
7692 let pending_msg_events = &mut peer_state.pending_msg_events;
7693 peer_state.channel_by_id.retain(|_, phase| {
7694 let context = match phase {
7695 ChannelPhase::Funded(chan) => {
7696 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
7697 // We only retain funded channels that are not shutdown.
7698 if !chan.is_shutdown() {
7703 // Unfunded channels will always be removed.
7704 ChannelPhase::UnfundedOutboundV1(chan) => {
7707 ChannelPhase::UnfundedInboundV1(chan) => {
7711 // Clean up for removal.
7712 update_maps_on_chan_removal!(self, &context);
7713 self.issue_channel_close_events(&context, ClosureReason::DisconnectedPeer);
7716 // Note that we don't bother generating any events for pre-accept channels -
7717 // they're not considered "channels" yet from the PoV of our events interface.
7718 peer_state.inbound_channel_request_by_id.clear();
7719 pending_msg_events.retain(|msg| {
7721 // V1 Channel Establishment
7722 &events::MessageSendEvent::SendAcceptChannel { .. } => false,
7723 &events::MessageSendEvent::SendOpenChannel { .. } => false,
7724 &events::MessageSendEvent::SendFundingCreated { .. } => false,
7725 &events::MessageSendEvent::SendFundingSigned { .. } => false,
7726 // V2 Channel Establishment
7727 &events::MessageSendEvent::SendAcceptChannelV2 { .. } => false,
7728 &events::MessageSendEvent::SendOpenChannelV2 { .. } => false,
7729 // Common Channel Establishment
7730 &events::MessageSendEvent::SendChannelReady { .. } => false,
7731 &events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
7732 // Interactive Transaction Construction
7733 &events::MessageSendEvent::SendTxAddInput { .. } => false,
7734 &events::MessageSendEvent::SendTxAddOutput { .. } => false,
7735 &events::MessageSendEvent::SendTxRemoveInput { .. } => false,
7736 &events::MessageSendEvent::SendTxRemoveOutput { .. } => false,
7737 &events::MessageSendEvent::SendTxComplete { .. } => false,
7738 &events::MessageSendEvent::SendTxSignatures { .. } => false,
7739 &events::MessageSendEvent::SendTxInitRbf { .. } => false,
7740 &events::MessageSendEvent::SendTxAckRbf { .. } => false,
7741 &events::MessageSendEvent::SendTxAbort { .. } => false,
7742 // Channel Operations
7743 &events::MessageSendEvent::UpdateHTLCs { .. } => false,
7744 &events::MessageSendEvent::SendRevokeAndACK { .. } => false,
7745 &events::MessageSendEvent::SendClosingSigned { .. } => false,
7746 &events::MessageSendEvent::SendShutdown { .. } => false,
7747 &events::MessageSendEvent::SendChannelReestablish { .. } => false,
7748 &events::MessageSendEvent::HandleError { .. } => false,
7750 &events::MessageSendEvent::SendChannelAnnouncement { .. } => false,
7751 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
7752 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
7753 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
7754 &events::MessageSendEvent::SendChannelUpdate { .. } => false,
7755 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
7756 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
7757 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
7758 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
7761 debug_assert!(peer_state.is_connected, "A disconnected peer cannot disconnect");
7762 peer_state.is_connected = false;
7763 peer_state.ok_to_remove(true)
7764 } else { debug_assert!(false, "Unconnected peer disconnected"); true }
7767 per_peer_state.remove(counterparty_node_id);
7769 mem::drop(per_peer_state);
7771 for failure in failed_channels.drain(..) {
7772 self.finish_force_close_channel(failure);
7776 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init, inbound: bool) -> Result<(), ()> {
7777 if !init_msg.features.supports_static_remote_key() {
7778 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting", log_pubkey!(counterparty_node_id));
7782 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7784 // If we have too many peers connected which don't have funded channels, disconnect the
7785 // peer immediately (as long as it doesn't have funded channels). If we have a bunch of
7786 // unfunded channels taking up space in memory for disconnected peers, we still let new
7787 // peers connect, but we'll reject new channels from them.
7788 let connected_peers_without_funded_channels = self.peers_without_funded_channels(|node| node.is_connected);
7789 let inbound_peer_limited = inbound && connected_peers_without_funded_channels >= MAX_NO_CHANNEL_PEERS;
7792 let mut peer_state_lock = self.per_peer_state.write().unwrap();
7793 match peer_state_lock.entry(counterparty_node_id.clone()) {
7794 hash_map::Entry::Vacant(e) => {
7795 if inbound_peer_limited {
7798 e.insert(Mutex::new(PeerState {
7799 channel_by_id: HashMap::new(),
7800 inbound_channel_request_by_id: HashMap::new(),
7801 latest_features: init_msg.features.clone(),
7802 pending_msg_events: Vec::new(),
7803 in_flight_monitor_updates: BTreeMap::new(),
7804 monitor_update_blocked_actions: BTreeMap::new(),
7805 actions_blocking_raa_monitor_updates: BTreeMap::new(),
7809 hash_map::Entry::Occupied(e) => {
7810 let mut peer_state = e.get().lock().unwrap();
7811 peer_state.latest_features = init_msg.features.clone();
7813 let best_block_height = self.best_block.read().unwrap().height();
7814 if inbound_peer_limited &&
7815 Self::unfunded_channel_count(&*peer_state, best_block_height) ==
7816 peer_state.channel_by_id.len()
7821 debug_assert!(!peer_state.is_connected, "A peer shouldn't be connected twice");
7822 peer_state.is_connected = true;
7827 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
7829 let per_peer_state = self.per_peer_state.read().unwrap();
7830 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
7831 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7832 let peer_state = &mut *peer_state_lock;
7833 let pending_msg_events = &mut peer_state.pending_msg_events;
7835 peer_state.channel_by_id.iter_mut().filter_map(|(_, phase)|
7836 if let ChannelPhase::Funded(chan) = phase { Some(chan) } else {
7837 // Since unfunded channel maps are cleared upon disconnecting a peer, and they're not persisted
7838 // (so won't be recovered after a crash), they shouldn't exist here and we would never need to
7839 // worry about closing and removing them.
7840 debug_assert!(false);
7844 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
7845 node_id: chan.context.get_counterparty_node_id(),
7846 msg: chan.get_channel_reestablish(&self.logger),
7850 //TODO: Also re-broadcast announcement_signatures
7854 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
7855 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7857 match &msg.data as &str {
7858 "cannot co-op close channel w/ active htlcs"|
7859 "link failed to shutdown" =>
7861 // LND hasn't properly handled shutdown messages ever, and force-closes any time we
7862 // send one while HTLCs are still present. The issue is tracked at
7863 // https://github.com/lightningnetwork/lnd/issues/6039 and has had multiple patches
7864 // to fix it but none so far have managed to land upstream. The issue appears to be
7865 // very low priority for the LND team despite being marked "P1".
7866 // We're not going to bother handling this in a sensible way, instead simply
7867 // repeating the Shutdown message on repeat until morale improves.
7868 if !msg.channel_id.is_zero() {
7869 let per_peer_state = self.per_peer_state.read().unwrap();
7870 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
7871 if peer_state_mutex_opt.is_none() { return; }
7872 let mut peer_state = peer_state_mutex_opt.unwrap().lock().unwrap();
7873 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get(&msg.channel_id) {
7874 if let Some(msg) = chan.get_outbound_shutdown() {
7875 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
7876 node_id: *counterparty_node_id,
7880 peer_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
7881 node_id: *counterparty_node_id,
7882 action: msgs::ErrorAction::SendWarningMessage {
7883 msg: msgs::WarningMessage {
7884 channel_id: msg.channel_id,
7885 data: "You appear to be exhibiting LND bug 6039, we'll keep sending you shutdown messages until you handle them correctly".to_owned()
7887 log_level: Level::Trace,
7897 if msg.channel_id.is_zero() {
7898 let channel_ids: Vec<ChannelId> = {
7899 let per_peer_state = self.per_peer_state.read().unwrap();
7900 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
7901 if peer_state_mutex_opt.is_none() { return; }
7902 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
7903 let peer_state = &mut *peer_state_lock;
7904 // Note that we don't bother generating any events for pre-accept channels -
7905 // they're not considered "channels" yet from the PoV of our events interface.
7906 peer_state.inbound_channel_request_by_id.clear();
7907 peer_state.channel_by_id.keys().cloned().collect()
7909 for channel_id in channel_ids {
7910 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
7911 let _ = self.force_close_channel_with_peer(&channel_id, counterparty_node_id, Some(&msg.data), true);
7915 // First check if we can advance the channel type and try again.
7916 let per_peer_state = self.per_peer_state.read().unwrap();
7917 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
7918 if peer_state_mutex_opt.is_none() { return; }
7919 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
7920 let peer_state = &mut *peer_state_lock;
7921 if let Some(ChannelPhase::UnfundedOutboundV1(chan)) = peer_state.channel_by_id.get_mut(&msg.channel_id) {
7922 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash, &self.fee_estimator) {
7923 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
7924 node_id: *counterparty_node_id,
7932 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
7933 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
7937 fn provided_node_features(&self) -> NodeFeatures {
7938 provided_node_features(&self.default_configuration)
7941 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
7942 provided_init_features(&self.default_configuration)
7945 fn get_genesis_hashes(&self) -> Option<Vec<ChainHash>> {
7946 Some(vec![ChainHash::from(&self.genesis_hash[..])])
7949 fn handle_tx_add_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddInput) {
7950 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7951 "Dual-funded channels not supported".to_owned(),
7952 msg.channel_id.clone())), *counterparty_node_id);
7955 fn handle_tx_add_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
7956 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7957 "Dual-funded channels not supported".to_owned(),
7958 msg.channel_id.clone())), *counterparty_node_id);
7961 fn handle_tx_remove_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
7962 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7963 "Dual-funded channels not supported".to_owned(),
7964 msg.channel_id.clone())), *counterparty_node_id);
7967 fn handle_tx_remove_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
7968 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7969 "Dual-funded channels not supported".to_owned(),
7970 msg.channel_id.clone())), *counterparty_node_id);
7973 fn handle_tx_complete(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxComplete) {
7974 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7975 "Dual-funded channels not supported".to_owned(),
7976 msg.channel_id.clone())), *counterparty_node_id);
7979 fn handle_tx_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxSignatures) {
7980 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7981 "Dual-funded channels not supported".to_owned(),
7982 msg.channel_id.clone())), *counterparty_node_id);
7985 fn handle_tx_init_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
7986 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7987 "Dual-funded channels not supported".to_owned(),
7988 msg.channel_id.clone())), *counterparty_node_id);
7991 fn handle_tx_ack_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
7992 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7993 "Dual-funded channels not supported".to_owned(),
7994 msg.channel_id.clone())), *counterparty_node_id);
7997 fn handle_tx_abort(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAbort) {
7998 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7999 "Dual-funded channels not supported".to_owned(),
8000 msg.channel_id.clone())), *counterparty_node_id);
8004 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
8005 /// [`ChannelManager`].
8006 pub(crate) fn provided_node_features(config: &UserConfig) -> NodeFeatures {
8007 let mut node_features = provided_init_features(config).to_context();
8008 node_features.set_keysend_optional();
8012 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags which are provided by or required by
8013 /// [`ChannelManager`].
8015 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
8016 /// or not. Thus, this method is not public.
8017 #[cfg(any(feature = "_test_utils", test))]
8018 pub(crate) fn provided_invoice_features(config: &UserConfig) -> Bolt11InvoiceFeatures {
8019 provided_init_features(config).to_context()
8022 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
8023 /// [`ChannelManager`].
8024 pub(crate) fn provided_channel_features(config: &UserConfig) -> ChannelFeatures {
8025 provided_init_features(config).to_context()
8028 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
8029 /// [`ChannelManager`].
8030 pub(crate) fn provided_channel_type_features(config: &UserConfig) -> ChannelTypeFeatures {
8031 ChannelTypeFeatures::from_init(&provided_init_features(config))
8034 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
8035 /// [`ChannelManager`].
8036 pub fn provided_init_features(config: &UserConfig) -> InitFeatures {
8037 // Note that if new features are added here which other peers may (eventually) require, we
8038 // should also add the corresponding (optional) bit to the [`ChannelMessageHandler`] impl for
8039 // [`ErroringMessageHandler`].
8040 let mut features = InitFeatures::empty();
8041 features.set_data_loss_protect_required();
8042 features.set_upfront_shutdown_script_optional();
8043 features.set_variable_length_onion_required();
8044 features.set_static_remote_key_required();
8045 features.set_payment_secret_required();
8046 features.set_basic_mpp_optional();
8047 features.set_wumbo_optional();
8048 features.set_shutdown_any_segwit_optional();
8049 features.set_channel_type_optional();
8050 features.set_scid_privacy_optional();
8051 features.set_zero_conf_optional();
8052 if config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx {
8053 features.set_anchors_zero_fee_htlc_tx_optional();
8058 const SERIALIZATION_VERSION: u8 = 1;
8059 const MIN_SERIALIZATION_VERSION: u8 = 1;
8061 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
8062 (2, fee_base_msat, required),
8063 (4, fee_proportional_millionths, required),
8064 (6, cltv_expiry_delta, required),
8067 impl_writeable_tlv_based!(ChannelCounterparty, {
8068 (2, node_id, required),
8069 (4, features, required),
8070 (6, unspendable_punishment_reserve, required),
8071 (8, forwarding_info, option),
8072 (9, outbound_htlc_minimum_msat, option),
8073 (11, outbound_htlc_maximum_msat, option),
8076 impl Writeable for ChannelDetails {
8077 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8078 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
8079 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
8080 let user_channel_id_low = self.user_channel_id as u64;
8081 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
8082 write_tlv_fields!(writer, {
8083 (1, self.inbound_scid_alias, option),
8084 (2, self.channel_id, required),
8085 (3, self.channel_type, option),
8086 (4, self.counterparty, required),
8087 (5, self.outbound_scid_alias, option),
8088 (6, self.funding_txo, option),
8089 (7, self.config, option),
8090 (8, self.short_channel_id, option),
8091 (9, self.confirmations, option),
8092 (10, self.channel_value_satoshis, required),
8093 (12, self.unspendable_punishment_reserve, option),
8094 (14, user_channel_id_low, required),
8095 (16, self.next_outbound_htlc_limit_msat, required), // Forwards compatibility for removed balance_msat field.
8096 (18, self.outbound_capacity_msat, required),
8097 (19, self.next_outbound_htlc_limit_msat, required),
8098 (20, self.inbound_capacity_msat, required),
8099 (21, self.next_outbound_htlc_minimum_msat, required),
8100 (22, self.confirmations_required, option),
8101 (24, self.force_close_spend_delay, option),
8102 (26, self.is_outbound, required),
8103 (28, self.is_channel_ready, required),
8104 (30, self.is_usable, required),
8105 (32, self.is_public, required),
8106 (33, self.inbound_htlc_minimum_msat, option),
8107 (35, self.inbound_htlc_maximum_msat, option),
8108 (37, user_channel_id_high_opt, option),
8109 (39, self.feerate_sat_per_1000_weight, option),
8110 (41, self.channel_shutdown_state, option),
8116 impl Readable for ChannelDetails {
8117 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8118 _init_and_read_len_prefixed_tlv_fields!(reader, {
8119 (1, inbound_scid_alias, option),
8120 (2, channel_id, required),
8121 (3, channel_type, option),
8122 (4, counterparty, required),
8123 (5, outbound_scid_alias, option),
8124 (6, funding_txo, option),
8125 (7, config, option),
8126 (8, short_channel_id, option),
8127 (9, confirmations, option),
8128 (10, channel_value_satoshis, required),
8129 (12, unspendable_punishment_reserve, option),
8130 (14, user_channel_id_low, required),
8131 (16, _balance_msat, option), // Backwards compatibility for removed balance_msat field.
8132 (18, outbound_capacity_msat, required),
8133 // Note that by the time we get past the required read above, outbound_capacity_msat will be
8134 // filled in, so we can safely unwrap it here.
8135 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
8136 (20, inbound_capacity_msat, required),
8137 (21, next_outbound_htlc_minimum_msat, (default_value, 0)),
8138 (22, confirmations_required, option),
8139 (24, force_close_spend_delay, option),
8140 (26, is_outbound, required),
8141 (28, is_channel_ready, required),
8142 (30, is_usable, required),
8143 (32, is_public, required),
8144 (33, inbound_htlc_minimum_msat, option),
8145 (35, inbound_htlc_maximum_msat, option),
8146 (37, user_channel_id_high_opt, option),
8147 (39, feerate_sat_per_1000_weight, option),
8148 (41, channel_shutdown_state, option),
8151 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
8152 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
8153 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
8154 let user_channel_id = user_channel_id_low as u128 +
8155 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
8157 let _balance_msat: Option<u64> = _balance_msat;
8161 channel_id: channel_id.0.unwrap(),
8163 counterparty: counterparty.0.unwrap(),
8164 outbound_scid_alias,
8168 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
8169 unspendable_punishment_reserve,
8171 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
8172 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
8173 next_outbound_htlc_minimum_msat: next_outbound_htlc_minimum_msat.0.unwrap(),
8174 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
8175 confirmations_required,
8177 force_close_spend_delay,
8178 is_outbound: is_outbound.0.unwrap(),
8179 is_channel_ready: is_channel_ready.0.unwrap(),
8180 is_usable: is_usable.0.unwrap(),
8181 is_public: is_public.0.unwrap(),
8182 inbound_htlc_minimum_msat,
8183 inbound_htlc_maximum_msat,
8184 feerate_sat_per_1000_weight,
8185 channel_shutdown_state,
8190 impl_writeable_tlv_based!(PhantomRouteHints, {
8191 (2, channels, required_vec),
8192 (4, phantom_scid, required),
8193 (6, real_node_pubkey, required),
8196 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
8198 (0, onion_packet, required),
8199 (2, short_channel_id, required),
8202 (0, payment_data, required),
8203 (1, phantom_shared_secret, option),
8204 (2, incoming_cltv_expiry, required),
8205 (3, payment_metadata, option),
8206 (5, custom_tlvs, optional_vec),
8208 (2, ReceiveKeysend) => {
8209 (0, payment_preimage, required),
8210 (2, incoming_cltv_expiry, required),
8211 (3, payment_metadata, option),
8212 (4, payment_data, option), // Added in 0.0.116
8213 (5, custom_tlvs, optional_vec),
8217 impl_writeable_tlv_based!(PendingHTLCInfo, {
8218 (0, routing, required),
8219 (2, incoming_shared_secret, required),
8220 (4, payment_hash, required),
8221 (6, outgoing_amt_msat, required),
8222 (8, outgoing_cltv_value, required),
8223 (9, incoming_amt_msat, option),
8224 (10, skimmed_fee_msat, option),
8228 impl Writeable for HTLCFailureMsg {
8229 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8231 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
8233 channel_id.write(writer)?;
8234 htlc_id.write(writer)?;
8235 reason.write(writer)?;
8237 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
8238 channel_id, htlc_id, sha256_of_onion, failure_code
8241 channel_id.write(writer)?;
8242 htlc_id.write(writer)?;
8243 sha256_of_onion.write(writer)?;
8244 failure_code.write(writer)?;
8251 impl Readable for HTLCFailureMsg {
8252 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8253 let id: u8 = Readable::read(reader)?;
8256 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
8257 channel_id: Readable::read(reader)?,
8258 htlc_id: Readable::read(reader)?,
8259 reason: Readable::read(reader)?,
8263 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
8264 channel_id: Readable::read(reader)?,
8265 htlc_id: Readable::read(reader)?,
8266 sha256_of_onion: Readable::read(reader)?,
8267 failure_code: Readable::read(reader)?,
8270 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
8271 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
8272 // messages contained in the variants.
8273 // In version 0.0.101, support for reading the variants with these types was added, and
8274 // we should migrate to writing these variants when UpdateFailHTLC or
8275 // UpdateFailMalformedHTLC get TLV fields.
8277 let length: BigSize = Readable::read(reader)?;
8278 let mut s = FixedLengthReader::new(reader, length.0);
8279 let res = Readable::read(&mut s)?;
8280 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
8281 Ok(HTLCFailureMsg::Relay(res))
8284 let length: BigSize = Readable::read(reader)?;
8285 let mut s = FixedLengthReader::new(reader, length.0);
8286 let res = Readable::read(&mut s)?;
8287 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
8288 Ok(HTLCFailureMsg::Malformed(res))
8290 _ => Err(DecodeError::UnknownRequiredFeature),
8295 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
8300 impl_writeable_tlv_based!(HTLCPreviousHopData, {
8301 (0, short_channel_id, required),
8302 (1, phantom_shared_secret, option),
8303 (2, outpoint, required),
8304 (4, htlc_id, required),
8305 (6, incoming_packet_shared_secret, required),
8306 (7, user_channel_id, option),
8309 impl Writeable for ClaimableHTLC {
8310 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8311 let (payment_data, keysend_preimage) = match &self.onion_payload {
8312 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
8313 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
8315 write_tlv_fields!(writer, {
8316 (0, self.prev_hop, required),
8317 (1, self.total_msat, required),
8318 (2, self.value, required),
8319 (3, self.sender_intended_value, required),
8320 (4, payment_data, option),
8321 (5, self.total_value_received, option),
8322 (6, self.cltv_expiry, required),
8323 (8, keysend_preimage, option),
8324 (10, self.counterparty_skimmed_fee_msat, option),
8330 impl Readable for ClaimableHTLC {
8331 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8332 _init_and_read_len_prefixed_tlv_fields!(reader, {
8333 (0, prev_hop, required),
8334 (1, total_msat, option),
8335 (2, value_ser, required),
8336 (3, sender_intended_value, option),
8337 (4, payment_data_opt, option),
8338 (5, total_value_received, option),
8339 (6, cltv_expiry, required),
8340 (8, keysend_preimage, option),
8341 (10, counterparty_skimmed_fee_msat, option),
8343 let payment_data: Option<msgs::FinalOnionHopData> = payment_data_opt;
8344 let value = value_ser.0.unwrap();
8345 let onion_payload = match keysend_preimage {
8347 if payment_data.is_some() {
8348 return Err(DecodeError::InvalidValue)
8350 if total_msat.is_none() {
8351 total_msat = Some(value);
8353 OnionPayload::Spontaneous(p)
8356 if total_msat.is_none() {
8357 if payment_data.is_none() {
8358 return Err(DecodeError::InvalidValue)
8360 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
8362 OnionPayload::Invoice { _legacy_hop_data: payment_data }
8366 prev_hop: prev_hop.0.unwrap(),
8369 sender_intended_value: sender_intended_value.unwrap_or(value),
8370 total_value_received,
8371 total_msat: total_msat.unwrap(),
8373 cltv_expiry: cltv_expiry.0.unwrap(),
8374 counterparty_skimmed_fee_msat,
8379 impl Readable for HTLCSource {
8380 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8381 let id: u8 = Readable::read(reader)?;
8384 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
8385 let mut first_hop_htlc_msat: u64 = 0;
8386 let mut path_hops = Vec::new();
8387 let mut payment_id = None;
8388 let mut payment_params: Option<PaymentParameters> = None;
8389 let mut blinded_tail: Option<BlindedTail> = None;
8390 read_tlv_fields!(reader, {
8391 (0, session_priv, required),
8392 (1, payment_id, option),
8393 (2, first_hop_htlc_msat, required),
8394 (4, path_hops, required_vec),
8395 (5, payment_params, (option: ReadableArgs, 0)),
8396 (6, blinded_tail, option),
8398 if payment_id.is_none() {
8399 // For backwards compat, if there was no payment_id written, use the session_priv bytes
8401 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
8403 let path = Path { hops: path_hops, blinded_tail };
8404 if path.hops.len() == 0 {
8405 return Err(DecodeError::InvalidValue);
8407 if let Some(params) = payment_params.as_mut() {
8408 if let Payee::Clear { ref mut final_cltv_expiry_delta, .. } = params.payee {
8409 if final_cltv_expiry_delta == &0 {
8410 *final_cltv_expiry_delta = path.final_cltv_expiry_delta().ok_or(DecodeError::InvalidValue)?;
8414 Ok(HTLCSource::OutboundRoute {
8415 session_priv: session_priv.0.unwrap(),
8416 first_hop_htlc_msat,
8418 payment_id: payment_id.unwrap(),
8421 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
8422 _ => Err(DecodeError::UnknownRequiredFeature),
8427 impl Writeable for HTLCSource {
8428 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
8430 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id } => {
8432 let payment_id_opt = Some(payment_id);
8433 write_tlv_fields!(writer, {
8434 (0, session_priv, required),
8435 (1, payment_id_opt, option),
8436 (2, first_hop_htlc_msat, required),
8437 // 3 was previously used to write a PaymentSecret for the payment.
8438 (4, path.hops, required_vec),
8439 (5, None::<PaymentParameters>, option), // payment_params in LDK versions prior to 0.0.115
8440 (6, path.blinded_tail, option),
8443 HTLCSource::PreviousHopData(ref field) => {
8445 field.write(writer)?;
8452 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
8453 (0, forward_info, required),
8454 (1, prev_user_channel_id, (default_value, 0)),
8455 (2, prev_short_channel_id, required),
8456 (4, prev_htlc_id, required),
8457 (6, prev_funding_outpoint, required),
8460 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
8462 (0, htlc_id, required),
8463 (2, err_packet, required),
8468 impl_writeable_tlv_based!(PendingInboundPayment, {
8469 (0, payment_secret, required),
8470 (2, expiry_time, required),
8471 (4, user_payment_id, required),
8472 (6, payment_preimage, required),
8473 (8, min_value_msat, required),
8476 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>
8478 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8479 T::Target: BroadcasterInterface,
8480 ES::Target: EntropySource,
8481 NS::Target: NodeSigner,
8482 SP::Target: SignerProvider,
8483 F::Target: FeeEstimator,
8487 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8488 let _consistency_lock = self.total_consistency_lock.write().unwrap();
8490 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
8492 self.genesis_hash.write(writer)?;
8494 let best_block = self.best_block.read().unwrap();
8495 best_block.height().write(writer)?;
8496 best_block.block_hash().write(writer)?;
8499 let mut serializable_peer_count: u64 = 0;
8501 let per_peer_state = self.per_peer_state.read().unwrap();
8502 let mut number_of_funded_channels = 0;
8503 for (_, peer_state_mutex) in per_peer_state.iter() {
8504 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8505 let peer_state = &mut *peer_state_lock;
8506 if !peer_state.ok_to_remove(false) {
8507 serializable_peer_count += 1;
8510 number_of_funded_channels += peer_state.channel_by_id.iter().filter(
8511 |(_, phase)| if let ChannelPhase::Funded(chan) = phase { chan.context.is_funding_initiated() } else { false }
8515 (number_of_funded_channels as u64).write(writer)?;
8517 for (_, peer_state_mutex) in per_peer_state.iter() {
8518 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8519 let peer_state = &mut *peer_state_lock;
8520 for channel in peer_state.channel_by_id.iter().filter_map(
8521 |(_, phase)| if let ChannelPhase::Funded(channel) = phase {
8522 if channel.context.is_funding_initiated() { Some(channel) } else { None }
8525 channel.write(writer)?;
8531 let forward_htlcs = self.forward_htlcs.lock().unwrap();
8532 (forward_htlcs.len() as u64).write(writer)?;
8533 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
8534 short_channel_id.write(writer)?;
8535 (pending_forwards.len() as u64).write(writer)?;
8536 for forward in pending_forwards {
8537 forward.write(writer)?;
8542 let per_peer_state = self.per_peer_state.write().unwrap();
8544 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
8545 let claimable_payments = self.claimable_payments.lock().unwrap();
8546 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
8548 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
8549 let mut htlc_onion_fields: Vec<&_> = Vec::new();
8550 (claimable_payments.claimable_payments.len() as u64).write(writer)?;
8551 for (payment_hash, payment) in claimable_payments.claimable_payments.iter() {
8552 payment_hash.write(writer)?;
8553 (payment.htlcs.len() as u64).write(writer)?;
8554 for htlc in payment.htlcs.iter() {
8555 htlc.write(writer)?;
8557 htlc_purposes.push(&payment.purpose);
8558 htlc_onion_fields.push(&payment.onion_fields);
8561 let mut monitor_update_blocked_actions_per_peer = None;
8562 let mut peer_states = Vec::new();
8563 for (_, peer_state_mutex) in per_peer_state.iter() {
8564 // Because we're holding the owning `per_peer_state` write lock here there's no chance
8565 // of a lockorder violation deadlock - no other thread can be holding any
8566 // per_peer_state lock at all.
8567 peer_states.push(peer_state_mutex.unsafe_well_ordered_double_lock_self());
8570 (serializable_peer_count).write(writer)?;
8571 for ((peer_pubkey, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
8572 // Peers which we have no channels to should be dropped once disconnected. As we
8573 // disconnect all peers when shutting down and serializing the ChannelManager, we
8574 // consider all peers as disconnected here. There's therefore no need write peers with
8576 if !peer_state.ok_to_remove(false) {
8577 peer_pubkey.write(writer)?;
8578 peer_state.latest_features.write(writer)?;
8579 if !peer_state.monitor_update_blocked_actions.is_empty() {
8580 monitor_update_blocked_actions_per_peer
8581 .get_or_insert_with(Vec::new)
8582 .push((*peer_pubkey, &peer_state.monitor_update_blocked_actions));
8587 let events = self.pending_events.lock().unwrap();
8588 // LDK versions prior to 0.0.115 don't support post-event actions, thus if there's no
8589 // actions at all, skip writing the required TLV. Otherwise, pre-0.0.115 versions will
8590 // refuse to read the new ChannelManager.
8591 let events_not_backwards_compatible = events.iter().any(|(_, action)| action.is_some());
8592 if events_not_backwards_compatible {
8593 // If we're gonna write a even TLV that will overwrite our events anyway we might as
8594 // well save the space and not write any events here.
8595 0u64.write(writer)?;
8597 (events.len() as u64).write(writer)?;
8598 for (event, _) in events.iter() {
8599 event.write(writer)?;
8603 // LDK versions prior to 0.0.116 wrote the `pending_background_events`
8604 // `MonitorUpdateRegeneratedOnStartup`s here, however there was never a reason to do so -
8605 // the closing monitor updates were always effectively replayed on startup (either directly
8606 // by calling `broadcast_latest_holder_commitment_txn` on a `ChannelMonitor` during
8607 // deserialization or, in 0.0.115, by regenerating the monitor update itself).
8608 0u64.write(writer)?;
8610 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
8611 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
8612 // likely to be identical.
8613 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
8614 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
8616 (pending_inbound_payments.len() as u64).write(writer)?;
8617 for (hash, pending_payment) in pending_inbound_payments.iter() {
8618 hash.write(writer)?;
8619 pending_payment.write(writer)?;
8622 // For backwards compat, write the session privs and their total length.
8623 let mut num_pending_outbounds_compat: u64 = 0;
8624 for (_, outbound) in pending_outbound_payments.iter() {
8625 if !outbound.is_fulfilled() && !outbound.abandoned() {
8626 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
8629 num_pending_outbounds_compat.write(writer)?;
8630 for (_, outbound) in pending_outbound_payments.iter() {
8632 PendingOutboundPayment::Legacy { session_privs } |
8633 PendingOutboundPayment::Retryable { session_privs, .. } => {
8634 for session_priv in session_privs.iter() {
8635 session_priv.write(writer)?;
8638 PendingOutboundPayment::AwaitingInvoice { .. } => {},
8639 PendingOutboundPayment::InvoiceReceived { .. } => {},
8640 PendingOutboundPayment::Fulfilled { .. } => {},
8641 PendingOutboundPayment::Abandoned { .. } => {},
8645 // Encode without retry info for 0.0.101 compatibility.
8646 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
8647 for (id, outbound) in pending_outbound_payments.iter() {
8649 PendingOutboundPayment::Legacy { session_privs } |
8650 PendingOutboundPayment::Retryable { session_privs, .. } => {
8651 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
8657 let mut pending_intercepted_htlcs = None;
8658 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
8659 if our_pending_intercepts.len() != 0 {
8660 pending_intercepted_htlcs = Some(our_pending_intercepts);
8663 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
8664 if pending_claiming_payments.as_ref().unwrap().is_empty() {
8665 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
8666 // map. Thus, if there are no entries we skip writing a TLV for it.
8667 pending_claiming_payments = None;
8670 let mut in_flight_monitor_updates: Option<HashMap<(&PublicKey, &OutPoint), &Vec<ChannelMonitorUpdate>>> = None;
8671 for ((counterparty_id, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
8672 for (funding_outpoint, updates) in peer_state.in_flight_monitor_updates.iter() {
8673 if !updates.is_empty() {
8674 if in_flight_monitor_updates.is_none() { in_flight_monitor_updates = Some(HashMap::new()); }
8675 in_flight_monitor_updates.as_mut().unwrap().insert((counterparty_id, funding_outpoint), updates);
8680 write_tlv_fields!(writer, {
8681 (1, pending_outbound_payments_no_retry, required),
8682 (2, pending_intercepted_htlcs, option),
8683 (3, pending_outbound_payments, required),
8684 (4, pending_claiming_payments, option),
8685 (5, self.our_network_pubkey, required),
8686 (6, monitor_update_blocked_actions_per_peer, option),
8687 (7, self.fake_scid_rand_bytes, required),
8688 (8, if events_not_backwards_compatible { Some(&*events) } else { None }, option),
8689 (9, htlc_purposes, required_vec),
8690 (10, in_flight_monitor_updates, option),
8691 (11, self.probing_cookie_secret, required),
8692 (13, htlc_onion_fields, optional_vec),
8699 impl Writeable for VecDeque<(Event, Option<EventCompletionAction>)> {
8700 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
8701 (self.len() as u64).write(w)?;
8702 for (event, action) in self.iter() {
8705 #[cfg(debug_assertions)] {
8706 // Events are MaybeReadable, in some cases indicating that they shouldn't actually
8707 // be persisted and are regenerated on restart. However, if such an event has a
8708 // post-event-handling action we'll write nothing for the event and would have to
8709 // either forget the action or fail on deserialization (which we do below). Thus,
8710 // check that the event is sane here.
8711 let event_encoded = event.encode();
8712 let event_read: Option<Event> =
8713 MaybeReadable::read(&mut &event_encoded[..]).unwrap();
8714 if action.is_some() { assert!(event_read.is_some()); }
8720 impl Readable for VecDeque<(Event, Option<EventCompletionAction>)> {
8721 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8722 let len: u64 = Readable::read(reader)?;
8723 const MAX_ALLOC_SIZE: u64 = 1024 * 16;
8724 let mut events: Self = VecDeque::with_capacity(cmp::min(
8725 MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>() as u64,
8728 let ev_opt = MaybeReadable::read(reader)?;
8729 let action = Readable::read(reader)?;
8730 if let Some(ev) = ev_opt {
8731 events.push_back((ev, action));
8732 } else if action.is_some() {
8733 return Err(DecodeError::InvalidValue);
8740 impl_writeable_tlv_based_enum!(ChannelShutdownState,
8741 (0, NotShuttingDown) => {},
8742 (2, ShutdownInitiated) => {},
8743 (4, ResolvingHTLCs) => {},
8744 (6, NegotiatingClosingFee) => {},
8745 (8, ShutdownComplete) => {}, ;
8748 /// Arguments for the creation of a ChannelManager that are not deserialized.
8750 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
8752 /// 1) Deserialize all stored [`ChannelMonitor`]s.
8753 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
8754 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
8755 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
8756 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
8757 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
8758 /// same way you would handle a [`chain::Filter`] call using
8759 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
8760 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
8761 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
8762 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
8763 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
8764 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
8766 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
8767 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
8769 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
8770 /// call any other methods on the newly-deserialized [`ChannelManager`].
8772 /// Note that because some channels may be closed during deserialization, it is critical that you
8773 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
8774 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
8775 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
8776 /// not force-close the same channels but consider them live), you may end up revoking a state for
8777 /// which you've already broadcasted the transaction.
8779 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
8780 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8782 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8783 T::Target: BroadcasterInterface,
8784 ES::Target: EntropySource,
8785 NS::Target: NodeSigner,
8786 SP::Target: SignerProvider,
8787 F::Target: FeeEstimator,
8791 /// A cryptographically secure source of entropy.
8792 pub entropy_source: ES,
8794 /// A signer that is able to perform node-scoped cryptographic operations.
8795 pub node_signer: NS,
8797 /// The keys provider which will give us relevant keys. Some keys will be loaded during
8798 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
8800 pub signer_provider: SP,
8802 /// The fee_estimator for use in the ChannelManager in the future.
8804 /// No calls to the FeeEstimator will be made during deserialization.
8805 pub fee_estimator: F,
8806 /// The chain::Watch for use in the ChannelManager in the future.
8808 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
8809 /// you have deserialized ChannelMonitors separately and will add them to your
8810 /// chain::Watch after deserializing this ChannelManager.
8811 pub chain_monitor: M,
8813 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
8814 /// used to broadcast the latest local commitment transactions of channels which must be
8815 /// force-closed during deserialization.
8816 pub tx_broadcaster: T,
8817 /// The router which will be used in the ChannelManager in the future for finding routes
8818 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
8820 /// No calls to the router will be made during deserialization.
8822 /// The Logger for use in the ChannelManager and which may be used to log information during
8823 /// deserialization.
8825 /// Default settings used for new channels. Any existing channels will continue to use the
8826 /// runtime settings which were stored when the ChannelManager was serialized.
8827 pub default_config: UserConfig,
8829 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
8830 /// value.context.get_funding_txo() should be the key).
8832 /// If a monitor is inconsistent with the channel state during deserialization the channel will
8833 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
8834 /// is true for missing channels as well. If there is a monitor missing for which we find
8835 /// channel data Err(DecodeError::InvalidValue) will be returned.
8837 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
8840 /// This is not exported to bindings users because we have no HashMap bindings
8841 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>,
8844 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8845 ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>
8847 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8848 T::Target: BroadcasterInterface,
8849 ES::Target: EntropySource,
8850 NS::Target: NodeSigner,
8851 SP::Target: SignerProvider,
8852 F::Target: FeeEstimator,
8856 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
8857 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
8858 /// populate a HashMap directly from C.
8859 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,
8860 mut channel_monitors: Vec<&'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>) -> Self {
8862 entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
8863 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
8868 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
8869 // SipmleArcChannelManager type:
8870 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8871 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, ES, NS, SP, F, R, L>>)
8873 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8874 T::Target: BroadcasterInterface,
8875 ES::Target: EntropySource,
8876 NS::Target: NodeSigner,
8877 SP::Target: SignerProvider,
8878 F::Target: FeeEstimator,
8882 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
8883 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)>::read(reader, args)?;
8884 Ok((blockhash, Arc::new(chan_manager)))
8888 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8889 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)
8891 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8892 T::Target: BroadcasterInterface,
8893 ES::Target: EntropySource,
8894 NS::Target: NodeSigner,
8895 SP::Target: SignerProvider,
8896 F::Target: FeeEstimator,
8900 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
8901 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
8903 let genesis_hash: BlockHash = Readable::read(reader)?;
8904 let best_block_height: u32 = Readable::read(reader)?;
8905 let best_block_hash: BlockHash = Readable::read(reader)?;
8907 let mut failed_htlcs = Vec::new();
8909 let channel_count: u64 = Readable::read(reader)?;
8910 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
8911 let mut funded_peer_channels: HashMap<PublicKey, HashMap<ChannelId, ChannelPhase<SP>>> = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8912 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8913 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8914 let mut channel_closures = VecDeque::new();
8915 let mut close_background_events = Vec::new();
8916 for _ in 0..channel_count {
8917 let mut channel: Channel<SP> = Channel::read(reader, (
8918 &args.entropy_source, &args.signer_provider, best_block_height, &provided_channel_type_features(&args.default_config)
8920 let funding_txo = channel.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
8921 funding_txo_set.insert(funding_txo.clone());
8922 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
8923 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
8924 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
8925 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
8926 channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
8927 // But if the channel is behind of the monitor, close the channel:
8928 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
8929 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
8930 if channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
8931 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
8932 &channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
8934 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() {
8935 log_error!(args.logger, " The ChannelMonitor for channel {} is at holder commitment number {} but the ChannelManager is at holder commitment number {}.",
8936 &channel.context.channel_id(), monitor.get_cur_holder_commitment_number(), channel.get_cur_holder_commitment_transaction_number());
8938 if channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() {
8939 log_error!(args.logger, " The ChannelMonitor for channel {} is at revoked counterparty transaction number {} but the ChannelManager is at revoked counterparty transaction number {}.",
8940 &channel.context.channel_id(), monitor.get_min_seen_secret(), channel.get_revoked_counterparty_commitment_transaction_number());
8942 if channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() {
8943 log_error!(args.logger, " The ChannelMonitor for channel {} is at counterparty commitment transaction number {} but the ChannelManager is at counterparty commitment transaction number {}.",
8944 &channel.context.channel_id(), monitor.get_cur_counterparty_commitment_number(), channel.get_cur_counterparty_commitment_transaction_number());
8946 let (monitor_update, mut new_failed_htlcs) = channel.context.force_shutdown(true);
8947 if let Some((counterparty_node_id, funding_txo, update)) = monitor_update {
8948 close_background_events.push(BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
8949 counterparty_node_id, funding_txo, update
8952 failed_htlcs.append(&mut new_failed_htlcs);
8953 channel_closures.push_back((events::Event::ChannelClosed {
8954 channel_id: channel.context.channel_id(),
8955 user_channel_id: channel.context.get_user_id(),
8956 reason: ClosureReason::OutdatedChannelManager,
8957 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
8958 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
8960 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
8961 let mut found_htlc = false;
8962 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
8963 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
8966 // If we have some HTLCs in the channel which are not present in the newer
8967 // ChannelMonitor, they have been removed and should be failed back to
8968 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
8969 // were actually claimed we'd have generated and ensured the previous-hop
8970 // claim update ChannelMonitor updates were persisted prior to persising
8971 // the ChannelMonitor update for the forward leg, so attempting to fail the
8972 // backwards leg of the HTLC will simply be rejected.
8973 log_info!(args.logger,
8974 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
8975 &channel.context.channel_id(), &payment_hash);
8976 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8980 log_info!(args.logger, "Successfully loaded channel {} at update_id {} against monitor at update id {}",
8981 &channel.context.channel_id(), channel.context.get_latest_monitor_update_id(),
8982 monitor.get_latest_update_id());
8983 if let Some(short_channel_id) = channel.context.get_short_channel_id() {
8984 short_to_chan_info.insert(short_channel_id, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8986 if channel.context.is_funding_initiated() {
8987 id_to_peer.insert(channel.context.channel_id(), channel.context.get_counterparty_node_id());
8989 match funded_peer_channels.entry(channel.context.get_counterparty_node_id()) {
8990 hash_map::Entry::Occupied(mut entry) => {
8991 let by_id_map = entry.get_mut();
8992 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
8994 hash_map::Entry::Vacant(entry) => {
8995 let mut by_id_map = HashMap::new();
8996 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
8997 entry.insert(by_id_map);
9001 } else if channel.is_awaiting_initial_mon_persist() {
9002 // If we were persisted and shut down while the initial ChannelMonitor persistence
9003 // was in-progress, we never broadcasted the funding transaction and can still
9004 // safely discard the channel.
9005 let _ = channel.context.force_shutdown(false);
9006 channel_closures.push_back((events::Event::ChannelClosed {
9007 channel_id: channel.context.channel_id(),
9008 user_channel_id: channel.context.get_user_id(),
9009 reason: ClosureReason::DisconnectedPeer,
9010 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
9011 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
9014 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
9015 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
9016 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
9017 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
9018 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");
9019 return Err(DecodeError::InvalidValue);
9023 for (funding_txo, _) in args.channel_monitors.iter() {
9024 if !funding_txo_set.contains(funding_txo) {
9025 log_info!(args.logger, "Queueing monitor update to ensure missing channel {} is force closed",
9026 &funding_txo.to_channel_id());
9027 let monitor_update = ChannelMonitorUpdate {
9028 update_id: CLOSED_CHANNEL_UPDATE_ID,
9029 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast: true }],
9031 close_background_events.push(BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((*funding_txo, monitor_update)));
9035 const MAX_ALLOC_SIZE: usize = 1024 * 64;
9036 let forward_htlcs_count: u64 = Readable::read(reader)?;
9037 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
9038 for _ in 0..forward_htlcs_count {
9039 let short_channel_id = Readable::read(reader)?;
9040 let pending_forwards_count: u64 = Readable::read(reader)?;
9041 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
9042 for _ in 0..pending_forwards_count {
9043 pending_forwards.push(Readable::read(reader)?);
9045 forward_htlcs.insert(short_channel_id, pending_forwards);
9048 let claimable_htlcs_count: u64 = Readable::read(reader)?;
9049 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
9050 for _ in 0..claimable_htlcs_count {
9051 let payment_hash = Readable::read(reader)?;
9052 let previous_hops_len: u64 = Readable::read(reader)?;
9053 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
9054 for _ in 0..previous_hops_len {
9055 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
9057 claimable_htlcs_list.push((payment_hash, previous_hops));
9060 let peer_state_from_chans = |channel_by_id| {
9063 inbound_channel_request_by_id: HashMap::new(),
9064 latest_features: InitFeatures::empty(),
9065 pending_msg_events: Vec::new(),
9066 in_flight_monitor_updates: BTreeMap::new(),
9067 monitor_update_blocked_actions: BTreeMap::new(),
9068 actions_blocking_raa_monitor_updates: BTreeMap::new(),
9069 is_connected: false,
9073 let peer_count: u64 = Readable::read(reader)?;
9074 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<SP>>)>()));
9075 for _ in 0..peer_count {
9076 let peer_pubkey = Readable::read(reader)?;
9077 let peer_chans = funded_peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new());
9078 let mut peer_state = peer_state_from_chans(peer_chans);
9079 peer_state.latest_features = Readable::read(reader)?;
9080 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
9083 let event_count: u64 = Readable::read(reader)?;
9084 let mut pending_events_read: VecDeque<(events::Event, Option<EventCompletionAction>)> =
9085 VecDeque::with_capacity(cmp::min(event_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>()));
9086 for _ in 0..event_count {
9087 match MaybeReadable::read(reader)? {
9088 Some(event) => pending_events_read.push_back((event, None)),
9093 let background_event_count: u64 = Readable::read(reader)?;
9094 for _ in 0..background_event_count {
9095 match <u8 as Readable>::read(reader)? {
9097 // LDK versions prior to 0.0.116 wrote pending `MonitorUpdateRegeneratedOnStartup`s here,
9098 // however we really don't (and never did) need them - we regenerate all
9099 // on-startup monitor updates.
9100 let _: OutPoint = Readable::read(reader)?;
9101 let _: ChannelMonitorUpdate = Readable::read(reader)?;
9103 _ => return Err(DecodeError::InvalidValue),
9107 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
9108 let highest_seen_timestamp: u32 = Readable::read(reader)?;
9110 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
9111 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
9112 for _ in 0..pending_inbound_payment_count {
9113 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
9114 return Err(DecodeError::InvalidValue);
9118 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
9119 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
9120 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
9121 for _ in 0..pending_outbound_payments_count_compat {
9122 let session_priv = Readable::read(reader)?;
9123 let payment = PendingOutboundPayment::Legacy {
9124 session_privs: [session_priv].iter().cloned().collect()
9126 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
9127 return Err(DecodeError::InvalidValue)
9131 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
9132 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
9133 let mut pending_outbound_payments = None;
9134 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
9135 let mut received_network_pubkey: Option<PublicKey> = None;
9136 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
9137 let mut probing_cookie_secret: Option<[u8; 32]> = None;
9138 let mut claimable_htlc_purposes = None;
9139 let mut claimable_htlc_onion_fields = None;
9140 let mut pending_claiming_payments = Some(HashMap::new());
9141 let mut monitor_update_blocked_actions_per_peer: Option<Vec<(_, BTreeMap<_, Vec<_>>)>> = Some(Vec::new());
9142 let mut events_override = None;
9143 let mut in_flight_monitor_updates: Option<HashMap<(PublicKey, OutPoint), Vec<ChannelMonitorUpdate>>> = None;
9144 read_tlv_fields!(reader, {
9145 (1, pending_outbound_payments_no_retry, option),
9146 (2, pending_intercepted_htlcs, option),
9147 (3, pending_outbound_payments, option),
9148 (4, pending_claiming_payments, option),
9149 (5, received_network_pubkey, option),
9150 (6, monitor_update_blocked_actions_per_peer, option),
9151 (7, fake_scid_rand_bytes, option),
9152 (8, events_override, option),
9153 (9, claimable_htlc_purposes, optional_vec),
9154 (10, in_flight_monitor_updates, option),
9155 (11, probing_cookie_secret, option),
9156 (13, claimable_htlc_onion_fields, optional_vec),
9158 if fake_scid_rand_bytes.is_none() {
9159 fake_scid_rand_bytes = Some(args.entropy_source.get_secure_random_bytes());
9162 if probing_cookie_secret.is_none() {
9163 probing_cookie_secret = Some(args.entropy_source.get_secure_random_bytes());
9166 if let Some(events) = events_override {
9167 pending_events_read = events;
9170 if !channel_closures.is_empty() {
9171 pending_events_read.append(&mut channel_closures);
9174 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
9175 pending_outbound_payments = Some(pending_outbound_payments_compat);
9176 } else if pending_outbound_payments.is_none() {
9177 let mut outbounds = HashMap::new();
9178 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
9179 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
9181 pending_outbound_payments = Some(outbounds);
9183 let pending_outbounds = OutboundPayments {
9184 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
9185 retry_lock: Mutex::new(())
9188 // We have to replay (or skip, if they were completed after we wrote the `ChannelManager`)
9189 // each `ChannelMonitorUpdate` in `in_flight_monitor_updates`. After doing so, we have to
9190 // check that each channel we have isn't newer than the latest `ChannelMonitorUpdate`(s) we
9191 // replayed, and for each monitor update we have to replay we have to ensure there's a
9192 // `ChannelMonitor` for it.
9194 // In order to do so we first walk all of our live channels (so that we can check their
9195 // state immediately after doing the update replays, when we have the `update_id`s
9196 // available) and then walk any remaining in-flight updates.
9198 // Because the actual handling of the in-flight updates is the same, it's macro'ized here:
9199 let mut pending_background_events = Vec::new();
9200 macro_rules! handle_in_flight_updates {
9201 ($counterparty_node_id: expr, $chan_in_flight_upds: expr, $funding_txo: expr,
9202 $monitor: expr, $peer_state: expr, $channel_info_log: expr
9204 let mut max_in_flight_update_id = 0;
9205 $chan_in_flight_upds.retain(|upd| upd.update_id > $monitor.get_latest_update_id());
9206 for update in $chan_in_flight_upds.iter() {
9207 log_trace!(args.logger, "Replaying ChannelMonitorUpdate {} for {}channel {}",
9208 update.update_id, $channel_info_log, &$funding_txo.to_channel_id());
9209 max_in_flight_update_id = cmp::max(max_in_flight_update_id, update.update_id);
9210 pending_background_events.push(
9211 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
9212 counterparty_node_id: $counterparty_node_id,
9213 funding_txo: $funding_txo,
9214 update: update.clone(),
9217 if $chan_in_flight_upds.is_empty() {
9218 // We had some updates to apply, but it turns out they had completed before we
9219 // were serialized, we just weren't notified of that. Thus, we may have to run
9220 // the completion actions for any monitor updates, but otherwise are done.
9221 pending_background_events.push(
9222 BackgroundEvent::MonitorUpdatesComplete {
9223 counterparty_node_id: $counterparty_node_id,
9224 channel_id: $funding_txo.to_channel_id(),
9227 if $peer_state.in_flight_monitor_updates.insert($funding_txo, $chan_in_flight_upds).is_some() {
9228 log_error!(args.logger, "Duplicate in-flight monitor update set for the same channel!");
9229 return Err(DecodeError::InvalidValue);
9231 max_in_flight_update_id
9235 for (counterparty_id, peer_state_mtx) in per_peer_state.iter_mut() {
9236 let mut peer_state_lock = peer_state_mtx.lock().unwrap();
9237 let peer_state = &mut *peer_state_lock;
9238 for phase in peer_state.channel_by_id.values() {
9239 if let ChannelPhase::Funded(chan) = phase {
9240 // Channels that were persisted have to be funded, otherwise they should have been
9242 let funding_txo = chan.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
9243 let monitor = args.channel_monitors.get(&funding_txo)
9244 .expect("We already checked for monitor presence when loading channels");
9245 let mut max_in_flight_update_id = monitor.get_latest_update_id();
9246 if let Some(in_flight_upds) = &mut in_flight_monitor_updates {
9247 if let Some(mut chan_in_flight_upds) = in_flight_upds.remove(&(*counterparty_id, funding_txo)) {
9248 max_in_flight_update_id = cmp::max(max_in_flight_update_id,
9249 handle_in_flight_updates!(*counterparty_id, chan_in_flight_upds,
9250 funding_txo, monitor, peer_state, ""));
9253 if chan.get_latest_unblocked_monitor_update_id() > max_in_flight_update_id {
9254 // If the channel is ahead of the monitor, return InvalidValue:
9255 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
9256 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} with update_id through {} in-flight",
9257 chan.context.channel_id(), monitor.get_latest_update_id(), max_in_flight_update_id);
9258 log_error!(args.logger, " but the ChannelManager is at update_id {}.", chan.get_latest_unblocked_monitor_update_id());
9259 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
9260 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
9261 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
9262 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");
9263 return Err(DecodeError::InvalidValue);
9266 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
9267 // created in this `channel_by_id` map.
9268 debug_assert!(false);
9269 return Err(DecodeError::InvalidValue);
9274 if let Some(in_flight_upds) = in_flight_monitor_updates {
9275 for ((counterparty_id, funding_txo), mut chan_in_flight_updates) in in_flight_upds {
9276 if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
9277 // Now that we've removed all the in-flight monitor updates for channels that are
9278 // still open, we need to replay any monitor updates that are for closed channels,
9279 // creating the neccessary peer_state entries as we go.
9280 let peer_state_mutex = per_peer_state.entry(counterparty_id).or_insert_with(|| {
9281 Mutex::new(peer_state_from_chans(HashMap::new()))
9283 let mut peer_state = peer_state_mutex.lock().unwrap();
9284 handle_in_flight_updates!(counterparty_id, chan_in_flight_updates,
9285 funding_txo, monitor, peer_state, "closed ");
9287 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!");
9288 log_error!(args.logger, " The ChannelMonitor for channel {} is missing.",
9289 &funding_txo.to_channel_id());
9290 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
9291 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
9292 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
9293 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");
9294 return Err(DecodeError::InvalidValue);
9299 // Note that we have to do the above replays before we push new monitor updates.
9300 pending_background_events.append(&mut close_background_events);
9302 // If there's any preimages for forwarded HTLCs hanging around in ChannelMonitors we
9303 // should ensure we try them again on the inbound edge. We put them here and do so after we
9304 // have a fully-constructed `ChannelManager` at the end.
9305 let mut pending_claims_to_replay = Vec::new();
9308 // If we're tracking pending payments, ensure we haven't lost any by looking at the
9309 // ChannelMonitor data for any channels for which we do not have authorative state
9310 // (i.e. those for which we just force-closed above or we otherwise don't have a
9311 // corresponding `Channel` at all).
9312 // This avoids several edge-cases where we would otherwise "forget" about pending
9313 // payments which are still in-flight via their on-chain state.
9314 // We only rebuild the pending payments map if we were most recently serialized by
9316 for (_, monitor) in args.channel_monitors.iter() {
9317 let counterparty_opt = id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id());
9318 if counterparty_opt.is_none() {
9319 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
9320 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
9321 if path.hops.is_empty() {
9322 log_error!(args.logger, "Got an empty path for a pending payment");
9323 return Err(DecodeError::InvalidValue);
9326 let path_amt = path.final_value_msat();
9327 let mut session_priv_bytes = [0; 32];
9328 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
9329 match pending_outbounds.pending_outbound_payments.lock().unwrap().entry(payment_id) {
9330 hash_map::Entry::Occupied(mut entry) => {
9331 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
9332 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
9333 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), &htlc.payment_hash);
9335 hash_map::Entry::Vacant(entry) => {
9336 let path_fee = path.fee_msat();
9337 entry.insert(PendingOutboundPayment::Retryable {
9338 retry_strategy: None,
9339 attempts: PaymentAttempts::new(),
9340 payment_params: None,
9341 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
9342 payment_hash: htlc.payment_hash,
9343 payment_secret: None, // only used for retries, and we'll never retry on startup
9344 payment_metadata: None, // only used for retries, and we'll never retry on startup
9345 keysend_preimage: None, // only used for retries, and we'll never retry on startup
9346 custom_tlvs: Vec::new(), // only used for retries, and we'll never retry on startup
9347 pending_amt_msat: path_amt,
9348 pending_fee_msat: Some(path_fee),
9349 total_msat: path_amt,
9350 starting_block_height: best_block_height,
9352 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
9353 path_amt, &htlc.payment_hash, log_bytes!(session_priv_bytes));
9358 for (htlc_source, (htlc, preimage_opt)) in monitor.get_all_current_outbound_htlcs() {
9360 HTLCSource::PreviousHopData(prev_hop_data) => {
9361 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
9362 info.prev_funding_outpoint == prev_hop_data.outpoint &&
9363 info.prev_htlc_id == prev_hop_data.htlc_id
9365 // The ChannelMonitor is now responsible for this HTLC's
9366 // failure/success and will let us know what its outcome is. If we
9367 // still have an entry for this HTLC in `forward_htlcs` or
9368 // `pending_intercepted_htlcs`, we were apparently not persisted after
9369 // the monitor was when forwarding the payment.
9370 forward_htlcs.retain(|_, forwards| {
9371 forwards.retain(|forward| {
9372 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
9373 if pending_forward_matches_htlc(&htlc_info) {
9374 log_info!(args.logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
9375 &htlc.payment_hash, &monitor.get_funding_txo().0.to_channel_id());
9380 !forwards.is_empty()
9382 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
9383 if pending_forward_matches_htlc(&htlc_info) {
9384 log_info!(args.logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
9385 &htlc.payment_hash, &monitor.get_funding_txo().0.to_channel_id());
9386 pending_events_read.retain(|(event, _)| {
9387 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
9388 intercepted_id != ev_id
9395 HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } => {
9396 if let Some(preimage) = preimage_opt {
9397 let pending_events = Mutex::new(pending_events_read);
9398 // Note that we set `from_onchain` to "false" here,
9399 // deliberately keeping the pending payment around forever.
9400 // Given it should only occur when we have a channel we're
9401 // force-closing for being stale that's okay.
9402 // The alternative would be to wipe the state when claiming,
9403 // generating a `PaymentPathSuccessful` event but regenerating
9404 // it and the `PaymentSent` on every restart until the
9405 // `ChannelMonitor` is removed.
9407 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
9408 channel_funding_outpoint: monitor.get_funding_txo().0,
9409 counterparty_node_id: path.hops[0].pubkey,
9411 pending_outbounds.claim_htlc(payment_id, preimage, session_priv,
9412 path, false, compl_action, &pending_events, &args.logger);
9413 pending_events_read = pending_events.into_inner().unwrap();
9420 // Whether the downstream channel was closed or not, try to re-apply any payment
9421 // preimages from it which may be needed in upstream channels for forwarded
9423 let outbound_claimed_htlcs_iter = monitor.get_all_current_outbound_htlcs()
9425 .filter_map(|(htlc_source, (htlc, preimage_opt))| {
9426 if let HTLCSource::PreviousHopData(_) = htlc_source {
9427 if let Some(payment_preimage) = preimage_opt {
9428 Some((htlc_source, payment_preimage, htlc.amount_msat,
9429 // Check if `counterparty_opt.is_none()` to see if the
9430 // downstream chan is closed (because we don't have a
9431 // channel_id -> peer map entry).
9432 counterparty_opt.is_none(),
9433 counterparty_opt.cloned().or(monitor.get_counterparty_node_id()),
9434 monitor.get_funding_txo().0))
9437 // If it was an outbound payment, we've handled it above - if a preimage
9438 // came in and we persisted the `ChannelManager` we either handled it and
9439 // are good to go or the channel force-closed - we don't have to handle the
9440 // channel still live case here.
9444 for tuple in outbound_claimed_htlcs_iter {
9445 pending_claims_to_replay.push(tuple);
9450 if !forward_htlcs.is_empty() || pending_outbounds.needs_abandon() {
9451 // If we have pending HTLCs to forward, assume we either dropped a
9452 // `PendingHTLCsForwardable` or the user received it but never processed it as they
9453 // shut down before the timer hit. Either way, set the time_forwardable to a small
9454 // constant as enough time has likely passed that we should simply handle the forwards
9455 // now, or at least after the user gets a chance to reconnect to our peers.
9456 pending_events_read.push_back((events::Event::PendingHTLCsForwardable {
9457 time_forwardable: Duration::from_secs(2),
9461 let inbound_pmt_key_material = args.node_signer.get_inbound_payment_key_material();
9462 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
9464 let mut claimable_payments = HashMap::with_capacity(claimable_htlcs_list.len());
9465 if let Some(purposes) = claimable_htlc_purposes {
9466 if purposes.len() != claimable_htlcs_list.len() {
9467 return Err(DecodeError::InvalidValue);
9469 if let Some(onion_fields) = claimable_htlc_onion_fields {
9470 if onion_fields.len() != claimable_htlcs_list.len() {
9471 return Err(DecodeError::InvalidValue);
9473 for (purpose, (onion, (payment_hash, htlcs))) in
9474 purposes.into_iter().zip(onion_fields.into_iter().zip(claimable_htlcs_list.into_iter()))
9476 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
9477 purpose, htlcs, onion_fields: onion,
9479 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
9482 for (purpose, (payment_hash, htlcs)) in purposes.into_iter().zip(claimable_htlcs_list.into_iter()) {
9483 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
9484 purpose, htlcs, onion_fields: None,
9486 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
9490 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
9491 // include a `_legacy_hop_data` in the `OnionPayload`.
9492 for (payment_hash, htlcs) in claimable_htlcs_list.drain(..) {
9493 if htlcs.is_empty() {
9494 return Err(DecodeError::InvalidValue);
9496 let purpose = match &htlcs[0].onion_payload {
9497 OnionPayload::Invoice { _legacy_hop_data } => {
9498 if let Some(hop_data) = _legacy_hop_data {
9499 events::PaymentPurpose::InvoicePayment {
9500 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
9501 Some(inbound_payment) => inbound_payment.payment_preimage,
9502 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
9503 Ok((payment_preimage, _)) => payment_preimage,
9505 log_error!(args.logger, "Failed to read claimable payment data for HTLC with payment hash {} - was not a pending inbound payment and didn't match our payment key", &payment_hash);
9506 return Err(DecodeError::InvalidValue);
9510 payment_secret: hop_data.payment_secret,
9512 } else { return Err(DecodeError::InvalidValue); }
9514 OnionPayload::Spontaneous(payment_preimage) =>
9515 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
9517 claimable_payments.insert(payment_hash, ClaimablePayment {
9518 purpose, htlcs, onion_fields: None,
9523 let mut secp_ctx = Secp256k1::new();
9524 secp_ctx.seeded_randomize(&args.entropy_source.get_secure_random_bytes());
9526 let our_network_pubkey = match args.node_signer.get_node_id(Recipient::Node) {
9528 Err(()) => return Err(DecodeError::InvalidValue)
9530 if let Some(network_pubkey) = received_network_pubkey {
9531 if network_pubkey != our_network_pubkey {
9532 log_error!(args.logger, "Key that was generated does not match the existing key.");
9533 return Err(DecodeError::InvalidValue);
9537 let mut outbound_scid_aliases = HashSet::new();
9538 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
9539 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9540 let peer_state = &mut *peer_state_lock;
9541 for (chan_id, phase) in peer_state.channel_by_id.iter_mut() {
9542 if let ChannelPhase::Funded(chan) = phase {
9543 if chan.context.outbound_scid_alias() == 0 {
9544 let mut outbound_scid_alias;
9546 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
9547 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.entropy_source);
9548 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
9550 chan.context.set_outbound_scid_alias(outbound_scid_alias);
9551 } else if !outbound_scid_aliases.insert(chan.context.outbound_scid_alias()) {
9552 // Note that in rare cases its possible to hit this while reading an older
9553 // channel if we just happened to pick a colliding outbound alias above.
9554 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
9555 return Err(DecodeError::InvalidValue);
9557 if chan.context.is_usable() {
9558 if short_to_chan_info.insert(chan.context.outbound_scid_alias(), (chan.context.get_counterparty_node_id(), *chan_id)).is_some() {
9559 // Note that in rare cases its possible to hit this while reading an older
9560 // channel if we just happened to pick a colliding outbound alias above.
9561 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
9562 return Err(DecodeError::InvalidValue);
9566 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
9567 // created in this `channel_by_id` map.
9568 debug_assert!(false);
9569 return Err(DecodeError::InvalidValue);
9574 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
9576 for (_, monitor) in args.channel_monitors.iter() {
9577 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
9578 if let Some(payment) = claimable_payments.remove(&payment_hash) {
9579 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", &payment_hash);
9580 let mut claimable_amt_msat = 0;
9581 let mut receiver_node_id = Some(our_network_pubkey);
9582 let phantom_shared_secret = payment.htlcs[0].prev_hop.phantom_shared_secret;
9583 if phantom_shared_secret.is_some() {
9584 let phantom_pubkey = args.node_signer.get_node_id(Recipient::PhantomNode)
9585 .expect("Failed to get node_id for phantom node recipient");
9586 receiver_node_id = Some(phantom_pubkey)
9588 for claimable_htlc in &payment.htlcs {
9589 claimable_amt_msat += claimable_htlc.value;
9591 // Add a holding-cell claim of the payment to the Channel, which should be
9592 // applied ~immediately on peer reconnection. Because it won't generate a
9593 // new commitment transaction we can just provide the payment preimage to
9594 // the corresponding ChannelMonitor and nothing else.
9596 // We do so directly instead of via the normal ChannelMonitor update
9597 // procedure as the ChainMonitor hasn't yet been initialized, implying
9598 // we're not allowed to call it directly yet. Further, we do the update
9599 // without incrementing the ChannelMonitor update ID as there isn't any
9601 // If we were to generate a new ChannelMonitor update ID here and then
9602 // crash before the user finishes block connect we'd end up force-closing
9603 // this channel as well. On the flip side, there's no harm in restarting
9604 // without the new monitor persisted - we'll end up right back here on
9606 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
9607 if let Some(peer_node_id) = id_to_peer.get(&previous_channel_id){
9608 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
9609 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9610 let peer_state = &mut *peer_state_lock;
9611 if let Some(ChannelPhase::Funded(channel)) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
9612 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
9615 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
9616 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
9619 pending_events_read.push_back((events::Event::PaymentClaimed {
9622 purpose: payment.purpose,
9623 amount_msat: claimable_amt_msat,
9624 htlcs: payment.htlcs.iter().map(events::ClaimedHTLC::from).collect(),
9625 sender_intended_total_msat: payment.htlcs.first().map(|htlc| htlc.total_msat),
9631 for (node_id, monitor_update_blocked_actions) in monitor_update_blocked_actions_per_peer.unwrap() {
9632 if let Some(peer_state) = per_peer_state.get(&node_id) {
9633 for (_, actions) in monitor_update_blocked_actions.iter() {
9634 for action in actions.iter() {
9635 if let MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
9636 downstream_counterparty_and_funding_outpoint:
9637 Some((blocked_node_id, blocked_channel_outpoint, blocking_action)), ..
9639 if let Some(blocked_peer_state) = per_peer_state.get(&blocked_node_id) {
9640 blocked_peer_state.lock().unwrap().actions_blocking_raa_monitor_updates
9641 .entry(blocked_channel_outpoint.to_channel_id())
9642 .or_insert_with(Vec::new).push(blocking_action.clone());
9644 // If the channel we were blocking has closed, we don't need to
9645 // worry about it - the blocked monitor update should never have
9646 // been released from the `Channel` object so it can't have
9647 // completed, and if the channel closed there's no reason to bother
9653 peer_state.lock().unwrap().monitor_update_blocked_actions = monitor_update_blocked_actions;
9655 log_error!(args.logger, "Got blocked actions without a per-peer-state for {}", node_id);
9656 return Err(DecodeError::InvalidValue);
9660 let channel_manager = ChannelManager {
9662 fee_estimator: bounded_fee_estimator,
9663 chain_monitor: args.chain_monitor,
9664 tx_broadcaster: args.tx_broadcaster,
9665 router: args.router,
9667 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
9669 inbound_payment_key: expanded_inbound_key,
9670 pending_inbound_payments: Mutex::new(pending_inbound_payments),
9671 pending_outbound_payments: pending_outbounds,
9672 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
9674 forward_htlcs: Mutex::new(forward_htlcs),
9675 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments, pending_claiming_payments: pending_claiming_payments.unwrap() }),
9676 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
9677 id_to_peer: Mutex::new(id_to_peer),
9678 short_to_chan_info: FairRwLock::new(short_to_chan_info),
9679 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
9681 probing_cookie_secret: probing_cookie_secret.unwrap(),
9686 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
9688 per_peer_state: FairRwLock::new(per_peer_state),
9690 pending_events: Mutex::new(pending_events_read),
9691 pending_events_processor: AtomicBool::new(false),
9692 pending_background_events: Mutex::new(pending_background_events),
9693 total_consistency_lock: RwLock::new(()),
9694 background_events_processed_since_startup: AtomicBool::new(false),
9695 persistence_notifier: Notifier::new(),
9697 entropy_source: args.entropy_source,
9698 node_signer: args.node_signer,
9699 signer_provider: args.signer_provider,
9701 logger: args.logger,
9702 default_configuration: args.default_config,
9705 for htlc_source in failed_htlcs.drain(..) {
9706 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
9707 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
9708 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
9709 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
9712 for (source, preimage, downstream_value, downstream_closed, downstream_node_id, downstream_funding) in pending_claims_to_replay {
9713 // We use `downstream_closed` in place of `from_onchain` here just as a guess - we
9714 // don't remember in the `ChannelMonitor` where we got a preimage from, but if the
9715 // channel is closed we just assume that it probably came from an on-chain claim.
9716 channel_manager.claim_funds_internal(source, preimage, Some(downstream_value),
9717 downstream_closed, downstream_node_id, downstream_funding);
9720 //TODO: Broadcast channel update for closed channels, but only after we've made a
9721 //connection or two.
9723 Ok((best_block_hash.clone(), channel_manager))
9729 use bitcoin::hashes::Hash;
9730 use bitcoin::hashes::sha256::Hash as Sha256;
9731 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
9732 use core::sync::atomic::Ordering;
9733 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
9734 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
9735 use crate::ln::ChannelId;
9736 use crate::ln::channelmanager::{inbound_payment, PaymentId, PaymentSendFailure, RecipientOnionFields, InterceptId};
9737 use crate::ln::functional_test_utils::*;
9738 use crate::ln::msgs::{self, ErrorAction};
9739 use crate::ln::msgs::ChannelMessageHandler;
9740 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
9741 use crate::util::errors::APIError;
9742 use crate::util::test_utils;
9743 use crate::util::config::{ChannelConfig, ChannelConfigUpdate};
9744 use crate::sign::EntropySource;
9747 fn test_notify_limits() {
9748 // Check that a few cases which don't require the persistence of a new ChannelManager,
9749 // indeed, do not cause the persistence of a new ChannelManager.
9750 let chanmon_cfgs = create_chanmon_cfgs(3);
9751 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9752 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9753 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9755 // All nodes start with a persistable update pending as `create_network` connects each node
9756 // with all other nodes to make most tests simpler.
9757 assert!(nodes[0].node.get_persistable_update_future().poll_is_complete());
9758 assert!(nodes[1].node.get_persistable_update_future().poll_is_complete());
9759 assert!(nodes[2].node.get_persistable_update_future().poll_is_complete());
9761 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1);
9763 // We check that the channel info nodes have doesn't change too early, even though we try
9764 // to connect messages with new values
9765 chan.0.contents.fee_base_msat *= 2;
9766 chan.1.contents.fee_base_msat *= 2;
9767 let node_a_chan_info = nodes[0].node.list_channels_with_counterparty(
9768 &nodes[1].node.get_our_node_id()).pop().unwrap();
9769 let node_b_chan_info = nodes[1].node.list_channels_with_counterparty(
9770 &nodes[0].node.get_our_node_id()).pop().unwrap();
9772 // The first two nodes (which opened a channel) should now require fresh persistence
9773 assert!(nodes[0].node.get_persistable_update_future().poll_is_complete());
9774 assert!(nodes[1].node.get_persistable_update_future().poll_is_complete());
9775 // ... but the last node should not.
9776 assert!(!nodes[2].node.get_persistable_update_future().poll_is_complete());
9777 // After persisting the first two nodes they should no longer need fresh persistence.
9778 assert!(!nodes[0].node.get_persistable_update_future().poll_is_complete());
9779 assert!(!nodes[1].node.get_persistable_update_future().poll_is_complete());
9781 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
9782 // about the channel.
9783 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
9784 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
9785 assert!(!nodes[2].node.get_persistable_update_future().poll_is_complete());
9787 // The nodes which are a party to the channel should also ignore messages from unrelated
9789 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
9790 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
9791 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
9792 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
9793 assert!(!nodes[0].node.get_persistable_update_future().poll_is_complete());
9794 assert!(!nodes[1].node.get_persistable_update_future().poll_is_complete());
9796 // At this point the channel info given by peers should still be the same.
9797 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
9798 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
9800 // An earlier version of handle_channel_update didn't check the directionality of the
9801 // update message and would always update the local fee info, even if our peer was
9802 // (spuriously) forwarding us our own channel_update.
9803 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
9804 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
9805 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
9807 // First deliver each peers' own message, checking that the node doesn't need to be
9808 // persisted and that its channel info remains the same.
9809 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
9810 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
9811 assert!(!nodes[0].node.get_persistable_update_future().poll_is_complete());
9812 assert!(!nodes[1].node.get_persistable_update_future().poll_is_complete());
9813 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
9814 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
9816 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
9817 // the channel info has updated.
9818 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
9819 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
9820 assert!(nodes[0].node.get_persistable_update_future().poll_is_complete());
9821 assert!(nodes[1].node.get_persistable_update_future().poll_is_complete());
9822 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
9823 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
9827 fn test_keysend_dup_hash_partial_mpp() {
9828 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
9830 let chanmon_cfgs = create_chanmon_cfgs(2);
9831 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9832 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9833 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9834 create_announced_chan_between_nodes(&nodes, 0, 1);
9836 // First, send a partial MPP payment.
9837 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
9838 let mut mpp_route = route.clone();
9839 mpp_route.paths.push(mpp_route.paths[0].clone());
9841 let payment_id = PaymentId([42; 32]);
9842 // Use the utility function send_payment_along_path to send the payment with MPP data which
9843 // indicates there are more HTLCs coming.
9844 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.
9845 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
9846 RecipientOnionFields::secret_only(payment_secret), payment_id, &mpp_route).unwrap();
9847 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[0], &our_payment_hash,
9848 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
9849 check_added_monitors!(nodes[0], 1);
9850 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9851 assert_eq!(events.len(), 1);
9852 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
9854 // Next, send a keysend payment with the same payment_hash and make sure it fails.
9855 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9856 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9857 check_added_monitors!(nodes[0], 1);
9858 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9859 assert_eq!(events.len(), 1);
9860 let ev = events.drain(..).next().unwrap();
9861 let payment_event = SendEvent::from_event(ev);
9862 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9863 check_added_monitors!(nodes[1], 0);
9864 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9865 expect_pending_htlcs_forwardable!(nodes[1]);
9866 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
9867 check_added_monitors!(nodes[1], 1);
9868 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9869 assert!(updates.update_add_htlcs.is_empty());
9870 assert!(updates.update_fulfill_htlcs.is_empty());
9871 assert_eq!(updates.update_fail_htlcs.len(), 1);
9872 assert!(updates.update_fail_malformed_htlcs.is_empty());
9873 assert!(updates.update_fee.is_none());
9874 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9875 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9876 expect_payment_failed!(nodes[0], our_payment_hash, true);
9878 // Send the second half of the original MPP payment.
9879 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[1], &our_payment_hash,
9880 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
9881 check_added_monitors!(nodes[0], 1);
9882 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9883 assert_eq!(events.len(), 1);
9884 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
9886 // Claim the full MPP payment. Note that we can't use a test utility like
9887 // claim_funds_along_route because the ordering of the messages causes the second half of the
9888 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
9889 // lightning messages manually.
9890 nodes[1].node.claim_funds(payment_preimage);
9891 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
9892 check_added_monitors!(nodes[1], 2);
9894 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9895 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
9896 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
9897 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
9898 check_added_monitors!(nodes[0], 1);
9899 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9900 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
9901 check_added_monitors!(nodes[1], 1);
9902 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9903 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
9904 check_added_monitors!(nodes[1], 1);
9905 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
9906 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
9907 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
9908 check_added_monitors!(nodes[0], 1);
9909 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
9910 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
9911 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9912 check_added_monitors!(nodes[0], 1);
9913 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
9914 check_added_monitors!(nodes[1], 1);
9915 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
9916 check_added_monitors!(nodes[1], 1);
9917 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
9918 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
9919 check_added_monitors!(nodes[0], 1);
9921 // Note that successful MPP payments will generate a single PaymentSent event upon the first
9922 // path's success and a PaymentPathSuccessful event for each path's success.
9923 let events = nodes[0].node.get_and_clear_pending_events();
9924 assert_eq!(events.len(), 2);
9926 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
9927 assert_eq!(payment_id, *actual_payment_id);
9928 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
9929 assert_eq!(route.paths[0], *path);
9931 _ => panic!("Unexpected event"),
9934 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
9935 assert_eq!(payment_id, *actual_payment_id);
9936 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
9937 assert_eq!(route.paths[0], *path);
9939 _ => panic!("Unexpected event"),
9944 fn test_keysend_dup_payment_hash() {
9945 do_test_keysend_dup_payment_hash(false);
9946 do_test_keysend_dup_payment_hash(true);
9949 fn do_test_keysend_dup_payment_hash(accept_mpp_keysend: bool) {
9950 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
9951 // outbound regular payment fails as expected.
9952 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
9953 // fails as expected.
9954 // (3): Test that a keysend payment with a duplicate payment hash to an existing keysend
9955 // payment fails as expected. When `accept_mpp_keysend` is false, this tests that we
9956 // reject MPP keysend payments, since in this case where the payment has no payment
9957 // secret, a keysend payment with a duplicate hash is basically an MPP keysend. If
9958 // `accept_mpp_keysend` is true, this tests that we only accept MPP keysends with
9959 // payment secrets and reject otherwise.
9960 let chanmon_cfgs = create_chanmon_cfgs(2);
9961 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9962 let mut mpp_keysend_cfg = test_default_channel_config();
9963 mpp_keysend_cfg.accept_mpp_keysend = accept_mpp_keysend;
9964 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(mpp_keysend_cfg)]);
9965 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9966 create_announced_chan_between_nodes(&nodes, 0, 1);
9967 let scorer = test_utils::TestScorer::new();
9968 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9970 // To start (1), send a regular payment but don't claim it.
9971 let expected_route = [&nodes[1]];
9972 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &expected_route, 100_000);
9974 // Next, attempt a keysend payment and make sure it fails.
9975 let route_params = RouteParameters::from_payment_params_and_value(
9976 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(),
9977 TEST_FINAL_CLTV, false), 100_000);
9978 let route = find_route(
9979 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
9980 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
9982 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9983 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9984 check_added_monitors!(nodes[0], 1);
9985 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9986 assert_eq!(events.len(), 1);
9987 let ev = events.drain(..).next().unwrap();
9988 let payment_event = SendEvent::from_event(ev);
9989 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9990 check_added_monitors!(nodes[1], 0);
9991 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9992 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
9993 // fails), the second will process the resulting failure and fail the HTLC backward
9994 expect_pending_htlcs_forwardable!(nodes[1]);
9995 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9996 check_added_monitors!(nodes[1], 1);
9997 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9998 assert!(updates.update_add_htlcs.is_empty());
9999 assert!(updates.update_fulfill_htlcs.is_empty());
10000 assert_eq!(updates.update_fail_htlcs.len(), 1);
10001 assert!(updates.update_fail_malformed_htlcs.is_empty());
10002 assert!(updates.update_fee.is_none());
10003 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
10004 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
10005 expect_payment_failed!(nodes[0], payment_hash, true);
10007 // Finally, claim the original payment.
10008 claim_payment(&nodes[0], &expected_route, payment_preimage);
10010 // To start (2), send a keysend payment but don't claim it.
10011 let payment_preimage = PaymentPreimage([42; 32]);
10012 let route = find_route(
10013 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
10014 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
10016 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
10017 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
10018 check_added_monitors!(nodes[0], 1);
10019 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10020 assert_eq!(events.len(), 1);
10021 let event = events.pop().unwrap();
10022 let path = vec![&nodes[1]];
10023 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
10025 // Next, attempt a regular payment and make sure it fails.
10026 let payment_secret = PaymentSecret([43; 32]);
10027 nodes[0].node.send_payment_with_route(&route, payment_hash,
10028 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
10029 check_added_monitors!(nodes[0], 1);
10030 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10031 assert_eq!(events.len(), 1);
10032 let ev = events.drain(..).next().unwrap();
10033 let payment_event = SendEvent::from_event(ev);
10034 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
10035 check_added_monitors!(nodes[1], 0);
10036 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
10037 expect_pending_htlcs_forwardable!(nodes[1]);
10038 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
10039 check_added_monitors!(nodes[1], 1);
10040 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
10041 assert!(updates.update_add_htlcs.is_empty());
10042 assert!(updates.update_fulfill_htlcs.is_empty());
10043 assert_eq!(updates.update_fail_htlcs.len(), 1);
10044 assert!(updates.update_fail_malformed_htlcs.is_empty());
10045 assert!(updates.update_fee.is_none());
10046 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
10047 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
10048 expect_payment_failed!(nodes[0], payment_hash, true);
10050 // Finally, succeed the keysend payment.
10051 claim_payment(&nodes[0], &expected_route, payment_preimage);
10053 // To start (3), send a keysend payment but don't claim it.
10054 let payment_id_1 = PaymentId([44; 32]);
10055 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
10056 RecipientOnionFields::spontaneous_empty(), payment_id_1).unwrap();
10057 check_added_monitors!(nodes[0], 1);
10058 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10059 assert_eq!(events.len(), 1);
10060 let event = events.pop().unwrap();
10061 let path = vec![&nodes[1]];
10062 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
10064 // Next, attempt a keysend payment and make sure it fails.
10065 let route_params = RouteParameters::from_payment_params_and_value(
10066 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
10069 let route = find_route(
10070 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
10071 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
10073 let payment_id_2 = PaymentId([45; 32]);
10074 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
10075 RecipientOnionFields::spontaneous_empty(), payment_id_2).unwrap();
10076 check_added_monitors!(nodes[0], 1);
10077 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
10078 assert_eq!(events.len(), 1);
10079 let ev = events.drain(..).next().unwrap();
10080 let payment_event = SendEvent::from_event(ev);
10081 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
10082 check_added_monitors!(nodes[1], 0);
10083 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
10084 expect_pending_htlcs_forwardable!(nodes[1]);
10085 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
10086 check_added_monitors!(nodes[1], 1);
10087 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
10088 assert!(updates.update_add_htlcs.is_empty());
10089 assert!(updates.update_fulfill_htlcs.is_empty());
10090 assert_eq!(updates.update_fail_htlcs.len(), 1);
10091 assert!(updates.update_fail_malformed_htlcs.is_empty());
10092 assert!(updates.update_fee.is_none());
10093 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
10094 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
10095 expect_payment_failed!(nodes[0], payment_hash, true);
10097 // Finally, claim the original payment.
10098 claim_payment(&nodes[0], &expected_route, payment_preimage);
10102 fn test_keysend_hash_mismatch() {
10103 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
10104 // preimage doesn't match the msg's payment hash.
10105 let chanmon_cfgs = create_chanmon_cfgs(2);
10106 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10107 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10108 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10110 let payer_pubkey = nodes[0].node.get_our_node_id();
10111 let payee_pubkey = nodes[1].node.get_our_node_id();
10113 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
10114 let route_params = RouteParameters::from_payment_params_and_value(
10115 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
10116 let network_graph = nodes[0].network_graph.clone();
10117 let first_hops = nodes[0].node.list_usable_channels();
10118 let scorer = test_utils::TestScorer::new();
10119 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
10120 let route = find_route(
10121 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
10122 nodes[0].logger, &scorer, &(), &random_seed_bytes
10125 let test_preimage = PaymentPreimage([42; 32]);
10126 let mismatch_payment_hash = PaymentHash([43; 32]);
10127 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash,
10128 RecipientOnionFields::spontaneous_empty(), PaymentId(mismatch_payment_hash.0), &route).unwrap();
10129 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash,
10130 RecipientOnionFields::spontaneous_empty(), Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
10131 check_added_monitors!(nodes[0], 1);
10133 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
10134 assert_eq!(updates.update_add_htlcs.len(), 1);
10135 assert!(updates.update_fulfill_htlcs.is_empty());
10136 assert!(updates.update_fail_htlcs.is_empty());
10137 assert!(updates.update_fail_malformed_htlcs.is_empty());
10138 assert!(updates.update_fee.is_none());
10139 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
10141 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "Payment preimage didn't match payment hash", 1);
10145 fn test_keysend_msg_with_secret_err() {
10146 // Test that we error as expected if we receive a keysend payment that includes a payment
10147 // secret when we don't support MPP keysend.
10148 let mut reject_mpp_keysend_cfg = test_default_channel_config();
10149 reject_mpp_keysend_cfg.accept_mpp_keysend = false;
10150 let chanmon_cfgs = create_chanmon_cfgs(2);
10151 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10152 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(reject_mpp_keysend_cfg)]);
10153 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10155 let payer_pubkey = nodes[0].node.get_our_node_id();
10156 let payee_pubkey = nodes[1].node.get_our_node_id();
10158 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
10159 let route_params = RouteParameters::from_payment_params_and_value(
10160 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
10161 let network_graph = nodes[0].network_graph.clone();
10162 let first_hops = nodes[0].node.list_usable_channels();
10163 let scorer = test_utils::TestScorer::new();
10164 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
10165 let route = find_route(
10166 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
10167 nodes[0].logger, &scorer, &(), &random_seed_bytes
10170 let test_preimage = PaymentPreimage([42; 32]);
10171 let test_secret = PaymentSecret([43; 32]);
10172 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
10173 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash,
10174 RecipientOnionFields::secret_only(test_secret), PaymentId(payment_hash.0), &route).unwrap();
10175 nodes[0].node.test_send_payment_internal(&route, payment_hash,
10176 RecipientOnionFields::secret_only(test_secret), Some(test_preimage),
10177 PaymentId(payment_hash.0), None, session_privs).unwrap();
10178 check_added_monitors!(nodes[0], 1);
10180 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
10181 assert_eq!(updates.update_add_htlcs.len(), 1);
10182 assert!(updates.update_fulfill_htlcs.is_empty());
10183 assert!(updates.update_fail_htlcs.is_empty());
10184 assert!(updates.update_fail_malformed_htlcs.is_empty());
10185 assert!(updates.update_fee.is_none());
10186 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
10188 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "We don't support MPP keysend payments", 1);
10192 fn test_multi_hop_missing_secret() {
10193 let chanmon_cfgs = create_chanmon_cfgs(4);
10194 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
10195 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
10196 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
10198 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
10199 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
10200 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
10201 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
10203 // Marshall an MPP route.
10204 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
10205 let path = route.paths[0].clone();
10206 route.paths.push(path);
10207 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
10208 route.paths[0].hops[0].short_channel_id = chan_1_id;
10209 route.paths[0].hops[1].short_channel_id = chan_3_id;
10210 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
10211 route.paths[1].hops[0].short_channel_id = chan_2_id;
10212 route.paths[1].hops[1].short_channel_id = chan_4_id;
10214 match nodes[0].node.send_payment_with_route(&route, payment_hash,
10215 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0))
10217 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
10218 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err))
10220 _ => panic!("unexpected error")
10225 fn test_drop_disconnected_peers_when_removing_channels() {
10226 let chanmon_cfgs = create_chanmon_cfgs(2);
10227 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10228 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10229 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10231 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
10233 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
10234 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10236 nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
10237 check_closed_broadcast!(nodes[0], true);
10238 check_added_monitors!(nodes[0], 1);
10239 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
10242 // Assert that nodes[1] is awaiting removal for nodes[0] once nodes[1] has been
10243 // disconnected and the channel between has been force closed.
10244 let nodes_0_per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
10245 // Assert that nodes[1] isn't removed before `timer_tick_occurred` has been executed.
10246 assert_eq!(nodes_0_per_peer_state.len(), 1);
10247 assert!(nodes_0_per_peer_state.get(&nodes[1].node.get_our_node_id()).is_some());
10250 nodes[0].node.timer_tick_occurred();
10253 // Assert that nodes[1] has now been removed.
10254 assert_eq!(nodes[0].node.per_peer_state.read().unwrap().len(), 0);
10259 fn bad_inbound_payment_hash() {
10260 // Add coverage for checking that a user-provided payment hash matches the payment secret.
10261 let chanmon_cfgs = create_chanmon_cfgs(2);
10262 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10263 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10264 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10266 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
10267 let payment_data = msgs::FinalOnionHopData {
10269 total_msat: 100_000,
10272 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
10273 // payment verification fails as expected.
10274 let mut bad_payment_hash = payment_hash.clone();
10275 bad_payment_hash.0[0] += 1;
10276 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) {
10277 Ok(_) => panic!("Unexpected ok"),
10279 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment", "Failing HTLC with user-generated payment_hash", 1);
10283 // Check that using the original payment hash succeeds.
10284 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());
10288 fn test_id_to_peer_coverage() {
10289 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
10290 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
10291 // the channel is successfully closed.
10292 let chanmon_cfgs = create_chanmon_cfgs(2);
10293 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10294 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10295 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10297 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
10298 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10299 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
10300 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10301 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
10303 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
10304 let channel_id = ChannelId::from_bytes(tx.txid().into_inner());
10306 // Ensure that the `id_to_peer` map is empty until either party has received the
10307 // funding transaction, and have the real `channel_id`.
10308 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
10309 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
10312 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
10314 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
10315 // as it has the funding transaction.
10316 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
10317 assert_eq!(nodes_0_lock.len(), 1);
10318 assert!(nodes_0_lock.contains_key(&channel_id));
10321 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
10323 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
10325 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
10327 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
10328 assert_eq!(nodes_0_lock.len(), 1);
10329 assert!(nodes_0_lock.contains_key(&channel_id));
10331 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
10334 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
10335 // as it has the funding transaction.
10336 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
10337 assert_eq!(nodes_1_lock.len(), 1);
10338 assert!(nodes_1_lock.contains_key(&channel_id));
10340 check_added_monitors!(nodes[1], 1);
10341 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
10342 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
10343 check_added_monitors!(nodes[0], 1);
10344 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
10345 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
10346 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
10347 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
10349 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
10350 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()));
10351 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
10352 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &nodes_1_shutdown);
10354 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
10355 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
10357 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
10358 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
10359 // fee for the closing transaction has been negotiated and the parties has the other
10360 // party's signature for the fee negotiated closing transaction.)
10361 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
10362 assert_eq!(nodes_0_lock.len(), 1);
10363 assert!(nodes_0_lock.contains_key(&channel_id));
10367 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
10368 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
10369 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
10370 // kept in the `nodes[1]`'s `id_to_peer` map.
10371 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
10372 assert_eq!(nodes_1_lock.len(), 1);
10373 assert!(nodes_1_lock.contains_key(&channel_id));
10376 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()));
10378 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
10379 // therefore has all it needs to fully close the channel (both signatures for the
10380 // closing transaction).
10381 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
10382 // fully closed by `nodes[0]`.
10383 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
10385 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
10386 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
10387 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
10388 assert_eq!(nodes_1_lock.len(), 1);
10389 assert!(nodes_1_lock.contains_key(&channel_id));
10392 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
10394 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
10396 // Assert that the channel has now been removed from both parties `id_to_peer` map once
10397 // they both have everything required to fully close the channel.
10398 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
10400 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
10402 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
10403 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
10406 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
10407 let expected_message = format!("Not connected to node: {}", expected_public_key);
10408 check_api_error_message(expected_message, res_err)
10411 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
10412 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
10413 check_api_error_message(expected_message, res_err)
10416 fn check_api_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
10418 Err(APIError::APIMisuseError { err }) => {
10419 assert_eq!(err, expected_err_message);
10421 Err(APIError::ChannelUnavailable { err }) => {
10422 assert_eq!(err, expected_err_message);
10424 Ok(_) => panic!("Unexpected Ok"),
10425 Err(_) => panic!("Unexpected Error"),
10430 fn test_api_calls_with_unkown_counterparty_node() {
10431 // Tests that our API functions that expects a `counterparty_node_id` as input, behaves as
10432 // expected if the `counterparty_node_id` is an unkown peer in the
10433 // `ChannelManager::per_peer_state` map.
10434 let chanmon_cfg = create_chanmon_cfgs(2);
10435 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
10436 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
10437 let nodes = create_network(2, &node_cfg, &node_chanmgr);
10440 let channel_id = ChannelId::from_bytes([4; 32]);
10441 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
10442 let intercept_id = InterceptId([0; 32]);
10444 // Test the API functions.
10445 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);
10447 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&channel_id, &unkown_public_key, 42), unkown_public_key);
10449 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
10451 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
10453 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
10455 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
10457 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
10461 fn test_connection_limiting() {
10462 // Test that we limit un-channel'd peers and un-funded channels properly.
10463 let chanmon_cfgs = create_chanmon_cfgs(2);
10464 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10465 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10466 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10468 // Note that create_network connects the nodes together for us
10470 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10471 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10473 let mut funding_tx = None;
10474 for idx in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
10475 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10476 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10479 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
10480 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
10481 funding_tx = Some(tx.clone());
10482 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx).unwrap();
10483 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
10485 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
10486 check_added_monitors!(nodes[1], 1);
10487 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
10489 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
10491 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
10492 check_added_monitors!(nodes[0], 1);
10493 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
10495 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10498 // A MAX_UNFUNDED_CHANS_PER_PEER + 1 channel will be summarily rejected
10499 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10500 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10501 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
10502 open_channel_msg.temporary_channel_id);
10504 // Further, because all of our channels with nodes[0] are inbound, and none of them funded,
10505 // it doesn't count as a "protected" peer, i.e. it counts towards the MAX_NO_CHANNEL_PEERS
10507 let mut peer_pks = Vec::with_capacity(super::MAX_NO_CHANNEL_PEERS);
10508 for _ in 1..super::MAX_NO_CHANNEL_PEERS {
10509 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10510 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10511 peer_pks.push(random_pk);
10512 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
10513 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10516 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10517 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10518 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10519 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10520 }, true).unwrap_err();
10522 // Also importantly, because nodes[0] isn't "protected", we will refuse a reconnection from
10523 // them if we have too many un-channel'd peers.
10524 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10525 let chan_closed_events = nodes[1].node.get_and_clear_pending_events();
10526 assert_eq!(chan_closed_events.len(), super::MAX_UNFUNDED_CHANS_PER_PEER - 1);
10527 for ev in chan_closed_events {
10528 if let Event::ChannelClosed { .. } = ev { } else { panic!(); }
10530 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10531 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10533 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10534 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10535 }, true).unwrap_err();
10537 // but of course if the connection is outbound its allowed...
10538 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10539 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10540 }, false).unwrap();
10541 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10543 // Now nodes[0] is disconnected but still has a pending, un-funded channel lying around.
10544 // Even though we accept one more connection from new peers, we won't actually let them
10546 assert!(peer_pks.len() > super::MAX_UNFUNDED_CHANNEL_PEERS - 1);
10547 for i in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
10548 nodes[1].node.handle_open_channel(&peer_pks[i], &open_channel_msg);
10549 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, peer_pks[i]);
10550 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10552 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10553 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
10554 open_channel_msg.temporary_channel_id);
10556 // Of course, however, outbound channels are always allowed
10557 nodes[1].node.create_channel(last_random_pk, 100_000, 0, 42, None).unwrap();
10558 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, last_random_pk);
10560 // If we fund the first channel, nodes[0] has a live on-chain channel with us, it is now
10561 // "protected" and can connect again.
10562 mine_transaction(&nodes[1], funding_tx.as_ref().unwrap());
10563 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10564 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10566 get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
10568 // Further, because the first channel was funded, we can open another channel with
10570 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10571 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
10575 fn test_outbound_chans_unlimited() {
10576 // Test that we never refuse an outbound channel even if a peer is unfuned-channel-limited
10577 let chanmon_cfgs = create_chanmon_cfgs(2);
10578 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10579 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10580 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10582 // Note that create_network connects the nodes together for us
10584 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10585 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10587 for _ in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
10588 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10589 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10590 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10593 // Once we have MAX_UNFUNDED_CHANS_PER_PEER unfunded channels, new inbound channels will be
10595 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10596 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
10597 open_channel_msg.temporary_channel_id);
10599 // but we can still open an outbound channel.
10600 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10601 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
10603 // but even with such an outbound channel, additional inbound channels will still fail.
10604 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10605 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
10606 open_channel_msg.temporary_channel_id);
10610 fn test_0conf_limiting() {
10611 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
10612 // flag set and (sometimes) accept channels as 0conf.
10613 let chanmon_cfgs = create_chanmon_cfgs(2);
10614 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10615 let mut settings = test_default_channel_config();
10616 settings.manually_accept_inbound_channels = true;
10617 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(settings)]);
10618 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10620 // Note that create_network connects the nodes together for us
10622 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10623 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10625 // First, get us up to MAX_UNFUNDED_CHANNEL_PEERS so we can test at the edge
10626 for _ in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
10627 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10628 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10629 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
10630 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10633 nodes[1].node.handle_open_channel(&random_pk, &open_channel_msg);
10634 let events = nodes[1].node.get_and_clear_pending_events();
10636 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10637 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23).unwrap();
10639 _ => panic!("Unexpected event"),
10641 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, random_pk);
10642 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10645 // If we try to accept a channel from another peer non-0conf it will fail.
10646 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10647 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10648 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10649 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10651 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10652 let events = nodes[1].node.get_and_clear_pending_events();
10654 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10655 match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23) {
10656 Err(APIError::APIMisuseError { err }) =>
10657 assert_eq!(err, "Too many peers with unfunded channels, refusing to accept new ones"),
10661 _ => panic!("Unexpected event"),
10663 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
10664 open_channel_msg.temporary_channel_id);
10666 // ...however if we accept the same channel 0conf it should work just fine.
10667 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10668 let events = nodes[1].node.get_and_clear_pending_events();
10670 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10671 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23).unwrap();
10673 _ => panic!("Unexpected event"),
10675 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
10679 fn reject_excessively_underpaying_htlcs() {
10680 let chanmon_cfg = create_chanmon_cfgs(1);
10681 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
10682 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
10683 let node = create_network(1, &node_cfg, &node_chanmgr);
10684 let sender_intended_amt_msat = 100;
10685 let extra_fee_msat = 10;
10686 let hop_data = msgs::InboundOnionPayload::Receive {
10688 outgoing_cltv_value: 42,
10689 payment_metadata: None,
10690 keysend_preimage: None,
10691 payment_data: Some(msgs::FinalOnionHopData {
10692 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
10694 custom_tlvs: Vec::new(),
10696 // Check that if the amount we received + the penultimate hop extra fee is less than the sender
10697 // intended amount, we fail the payment.
10698 if let Err(crate::ln::channelmanager::InboundOnionErr { err_code, .. }) =
10699 node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
10700 sender_intended_amt_msat - extra_fee_msat - 1, 42, None, true, Some(extra_fee_msat))
10702 assert_eq!(err_code, 19);
10703 } else { panic!(); }
10705 // If amt_received + extra_fee is equal to the sender intended amount, we're fine.
10706 let hop_data = msgs::InboundOnionPayload::Receive { // This is the same payload as above, InboundOnionPayload doesn't implement Clone
10708 outgoing_cltv_value: 42,
10709 payment_metadata: None,
10710 keysend_preimage: None,
10711 payment_data: Some(msgs::FinalOnionHopData {
10712 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
10714 custom_tlvs: Vec::new(),
10716 assert!(node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
10717 sender_intended_amt_msat - extra_fee_msat, 42, None, true, Some(extra_fee_msat)).is_ok());
10721 fn test_inbound_anchors_manual_acceptance() {
10722 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
10723 // flag set and (sometimes) accept channels as 0conf.
10724 let mut anchors_cfg = test_default_channel_config();
10725 anchors_cfg.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
10727 let mut anchors_manual_accept_cfg = anchors_cfg.clone();
10728 anchors_manual_accept_cfg.manually_accept_inbound_channels = true;
10730 let chanmon_cfgs = create_chanmon_cfgs(3);
10731 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
10732 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs,
10733 &[Some(anchors_cfg.clone()), Some(anchors_cfg.clone()), Some(anchors_manual_accept_cfg.clone())]);
10734 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
10736 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10737 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10739 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10740 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
10741 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
10742 match &msg_events[0] {
10743 MessageSendEvent::HandleError { node_id, action } => {
10744 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
10746 ErrorAction::SendErrorMessage { msg } =>
10747 assert_eq!(msg.data, "No channels with anchor outputs accepted".to_owned()),
10748 _ => panic!("Unexpected error action"),
10751 _ => panic!("Unexpected event"),
10754 nodes[2].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10755 let events = nodes[2].node.get_and_clear_pending_events();
10757 Event::OpenChannelRequest { temporary_channel_id, .. } =>
10758 nodes[2].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap(),
10759 _ => panic!("Unexpected event"),
10761 get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10765 fn test_anchors_zero_fee_htlc_tx_fallback() {
10766 // Tests that if both nodes support anchors, but the remote node does not want to accept
10767 // anchor channels at the moment, an error it sent to the local node such that it can retry
10768 // the channel without the anchors feature.
10769 let chanmon_cfgs = create_chanmon_cfgs(2);
10770 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10771 let mut anchors_config = test_default_channel_config();
10772 anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
10773 anchors_config.manually_accept_inbound_channels = true;
10774 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config.clone()), Some(anchors_config.clone())]);
10775 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10777 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 0, None).unwrap();
10778 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10779 assert!(open_channel_msg.channel_type.as_ref().unwrap().supports_anchors_zero_fee_htlc_tx());
10781 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10782 let events = nodes[1].node.get_and_clear_pending_events();
10784 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10785 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
10787 _ => panic!("Unexpected event"),
10790 let error_msg = get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id());
10791 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &error_msg);
10793 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10794 assert!(!open_channel_msg.channel_type.unwrap().supports_anchors_zero_fee_htlc_tx());
10796 // Since nodes[1] should not have accepted the channel, it should
10797 // not have generated any events.
10798 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
10802 fn test_update_channel_config() {
10803 let chanmon_cfg = create_chanmon_cfgs(2);
10804 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
10805 let mut user_config = test_default_channel_config();
10806 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
10807 let nodes = create_network(2, &node_cfg, &node_chanmgr);
10808 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
10809 let channel = &nodes[0].node.list_channels()[0];
10811 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
10812 let events = nodes[0].node.get_and_clear_pending_msg_events();
10813 assert_eq!(events.len(), 0);
10815 user_config.channel_config.forwarding_fee_base_msat += 10;
10816 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
10817 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_base_msat, user_config.channel_config.forwarding_fee_base_msat);
10818 let events = nodes[0].node.get_and_clear_pending_msg_events();
10819 assert_eq!(events.len(), 1);
10821 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10822 _ => panic!("expected BroadcastChannelUpdate event"),
10825 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate::default()).unwrap();
10826 let events = nodes[0].node.get_and_clear_pending_msg_events();
10827 assert_eq!(events.len(), 0);
10829 let new_cltv_expiry_delta = user_config.channel_config.cltv_expiry_delta + 6;
10830 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
10831 cltv_expiry_delta: Some(new_cltv_expiry_delta),
10832 ..Default::default()
10834 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
10835 let events = nodes[0].node.get_and_clear_pending_msg_events();
10836 assert_eq!(events.len(), 1);
10838 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10839 _ => panic!("expected BroadcastChannelUpdate event"),
10842 let new_fee = user_config.channel_config.forwarding_fee_proportional_millionths + 100;
10843 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
10844 forwarding_fee_proportional_millionths: Some(new_fee),
10845 ..Default::default()
10847 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
10848 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, new_fee);
10849 let events = nodes[0].node.get_and_clear_pending_msg_events();
10850 assert_eq!(events.len(), 1);
10852 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10853 _ => panic!("expected BroadcastChannelUpdate event"),
10856 // If we provide a channel_id not associated with the peer, we should get an error and no updates
10857 // should be applied to ensure update atomicity as specified in the API docs.
10858 let bad_channel_id = ChannelId::v1_from_funding_txid(&[10; 32], 10);
10859 let current_fee = nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths;
10860 let new_fee = current_fee + 100;
10863 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id, bad_channel_id], &ChannelConfigUpdate {
10864 forwarding_fee_proportional_millionths: Some(new_fee),
10865 ..Default::default()
10867 Err(APIError::ChannelUnavailable { err: _ }),
10870 // Check that the fee hasn't changed for the channel that exists.
10871 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, current_fee);
10872 let events = nodes[0].node.get_and_clear_pending_msg_events();
10873 assert_eq!(events.len(), 0);
10877 fn test_payment_display() {
10878 let payment_id = PaymentId([42; 32]);
10879 assert_eq!(format!("{}", &payment_id), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
10880 let payment_hash = PaymentHash([42; 32]);
10881 assert_eq!(format!("{}", &payment_hash), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
10882 let payment_preimage = PaymentPreimage([42; 32]);
10883 assert_eq!(format!("{}", &payment_preimage), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
10889 use crate::chain::Listen;
10890 use crate::chain::chainmonitor::{ChainMonitor, Persist};
10891 use crate::sign::{KeysManager, InMemorySigner};
10892 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider};
10893 use crate::ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId, RecipientOnionFields, Retry};
10894 use crate::ln::functional_test_utils::*;
10895 use crate::ln::msgs::{ChannelMessageHandler, Init};
10896 use crate::routing::gossip::NetworkGraph;
10897 use crate::routing::router::{PaymentParameters, RouteParameters};
10898 use crate::util::test_utils;
10899 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
10901 use bitcoin::hashes::Hash;
10902 use bitcoin::hashes::sha256::Hash as Sha256;
10903 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
10905 use crate::sync::{Arc, Mutex, RwLock};
10907 use criterion::Criterion;
10909 type Manager<'a, P> = ChannelManager<
10910 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
10911 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
10912 &'a test_utils::TestLogger, &'a P>,
10913 &'a test_utils::TestBroadcaster, &'a KeysManager, &'a KeysManager, &'a KeysManager,
10914 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
10915 &'a test_utils::TestLogger>;
10917 struct ANodeHolder<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> {
10918 node: &'node_cfg Manager<'chan_mon_cfg, P>,
10920 impl<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> NodeHolder for ANodeHolder<'node_cfg, 'chan_mon_cfg, P> {
10921 type CM = Manager<'chan_mon_cfg, P>;
10923 fn node(&self) -> &Manager<'chan_mon_cfg, P> { self.node }
10925 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { None }
10928 pub fn bench_sends(bench: &mut Criterion) {
10929 bench_two_sends(bench, "bench_sends", test_utils::TestPersister::new(), test_utils::TestPersister::new());
10932 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Criterion, bench_name: &str, persister_a: P, persister_b: P) {
10933 // Do a simple benchmark of sending a payment back and forth between two nodes.
10934 // Note that this is unrealistic as each payment send will require at least two fsync
10936 let network = bitcoin::Network::Testnet;
10937 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
10939 let tx_broadcaster = test_utils::TestBroadcaster::new(network);
10940 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
10941 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
10942 let scorer = RwLock::new(test_utils::TestScorer::new());
10943 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(network, &logger_a)), &scorer);
10945 let mut config: UserConfig = Default::default();
10946 config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
10947 config.channel_handshake_config.minimum_depth = 1;
10949 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
10950 let seed_a = [1u8; 32];
10951 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
10952 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 {
10954 best_block: BestBlock::from_network(network),
10955 }, genesis_block.header.time);
10956 let node_a_holder = ANodeHolder { node: &node_a };
10958 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
10959 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
10960 let seed_b = [2u8; 32];
10961 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
10962 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 {
10964 best_block: BestBlock::from_network(network),
10965 }, genesis_block.header.time);
10966 let node_b_holder = ANodeHolder { node: &node_b };
10968 node_a.peer_connected(&node_b.get_our_node_id(), &Init {
10969 features: node_b.init_features(), networks: None, remote_network_address: None
10971 node_b.peer_connected(&node_a.get_our_node_id(), &Init {
10972 features: node_a.init_features(), networks: None, remote_network_address: None
10973 }, false).unwrap();
10974 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
10975 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()));
10976 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()));
10979 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
10980 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
10981 value: 8_000_000, script_pubkey: output_script,
10983 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
10984 } else { panic!(); }
10986 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()));
10987 let events_b = node_b.get_and_clear_pending_events();
10988 assert_eq!(events_b.len(), 1);
10989 match events_b[0] {
10990 Event::ChannelPending{ ref counterparty_node_id, .. } => {
10991 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
10993 _ => panic!("Unexpected event"),
10996 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()));
10997 let events_a = node_a.get_and_clear_pending_events();
10998 assert_eq!(events_a.len(), 1);
10999 match events_a[0] {
11000 Event::ChannelPending{ ref counterparty_node_id, .. } => {
11001 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
11003 _ => panic!("Unexpected event"),
11006 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
11008 let block = create_dummy_block(BestBlock::from_network(network).block_hash(), 42, vec![tx]);
11009 Listen::block_connected(&node_a, &block, 1);
11010 Listen::block_connected(&node_b, &block, 1);
11012 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()));
11013 let msg_events = node_a.get_and_clear_pending_msg_events();
11014 assert_eq!(msg_events.len(), 2);
11015 match msg_events[0] {
11016 MessageSendEvent::SendChannelReady { ref msg, .. } => {
11017 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
11018 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
11022 match msg_events[1] {
11023 MessageSendEvent::SendChannelUpdate { .. } => {},
11027 let events_a = node_a.get_and_clear_pending_events();
11028 assert_eq!(events_a.len(), 1);
11029 match events_a[0] {
11030 Event::ChannelReady{ ref counterparty_node_id, .. } => {
11031 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
11033 _ => panic!("Unexpected event"),
11036 let events_b = node_b.get_and_clear_pending_events();
11037 assert_eq!(events_b.len(), 1);
11038 match events_b[0] {
11039 Event::ChannelReady{ ref counterparty_node_id, .. } => {
11040 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
11042 _ => panic!("Unexpected event"),
11045 let mut payment_count: u64 = 0;
11046 macro_rules! send_payment {
11047 ($node_a: expr, $node_b: expr) => {
11048 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id(), TEST_FINAL_CLTV)
11049 .with_bolt11_features($node_b.invoice_features()).unwrap();
11050 let mut payment_preimage = PaymentPreimage([0; 32]);
11051 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
11052 payment_count += 1;
11053 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
11054 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
11056 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
11057 PaymentId(payment_hash.0),
11058 RouteParameters::from_payment_params_and_value(payment_params, 10_000),
11059 Retry::Attempts(0)).unwrap();
11060 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
11061 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
11062 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
11063 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_b }, &$node_a.get_our_node_id());
11064 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
11065 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
11066 $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()));
11068 expect_pending_htlcs_forwardable!(ANodeHolder { node: &$node_b });
11069 expect_payment_claimable!(ANodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
11070 $node_b.claim_funds(payment_preimage);
11071 expect_payment_claimed!(ANodeHolder { node: &$node_b }, payment_hash, 10_000);
11073 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
11074 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
11075 assert_eq!(node_id, $node_a.get_our_node_id());
11076 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
11077 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
11079 _ => panic!("Failed to generate claim event"),
11082 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_a }, &$node_b.get_our_node_id());
11083 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
11084 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
11085 $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()));
11087 expect_payment_sent!(ANodeHolder { node: &$node_a }, payment_preimage);
11091 bench.bench_function(bench_name, |b| b.iter(|| {
11092 send_payment!(node_a, node_b);
11093 send_payment!(node_b, node_a);