1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! The top-level channel management and payment tracking stuff lives here.
12 //! The [`ChannelManager`] is the main chunk of logic implementing the lightning protocol and is
13 //! responsible for tracking which channels are open, HTLCs are in flight and reestablishing those
14 //! upon reconnect to the relevant peer(s).
16 //! It does not manage routing logic (see [`Router`] for that) nor does it manage constructing
17 //! on-chain transactions (it only monitors the chain to watch for any force-closes that might
18 //! imply it needs to fail HTLCs/payments/channels it manages).
20 use bitcoin::blockdata::block::BlockHeader;
21 use bitcoin::blockdata::transaction::Transaction;
22 use bitcoin::blockdata::constants::{genesis_block, ChainHash};
23 use bitcoin::network::constants::Network;
25 use bitcoin::hashes::Hash;
26 use bitcoin::hashes::sha256::Hash as Sha256;
27 use bitcoin::hash_types::{BlockHash, Txid};
29 use bitcoin::secp256k1::{SecretKey,PublicKey};
30 use bitcoin::secp256k1::Secp256k1;
31 use bitcoin::{LockTime, secp256k1, Sequence};
34 use crate::chain::{Confirm, ChannelMonitorUpdateStatus, Watch, BestBlock};
35 use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator};
36 use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
37 use crate::chain::transaction::{OutPoint, TransactionData};
39 use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination, PaymentFailureReason};
40 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
41 // construct one themselves.
42 use crate::ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
43 use crate::ln::channel::{Channel, ChannelContext, ChannelError, ChannelUpdateStatus, ShutdownResult, 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, ChannelSigner, WriteableEcdsaChannelSigner};
59 use crate::util::config::{UserConfig, ChannelConfig, ChannelConfigUpdate};
60 use crate::util::wakers::{Future, Notifier};
61 use crate::util::scid_utils::fake_scid;
62 use crate::util::string::UntrustedString;
63 use crate::util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
64 use crate::util::logger::{Level, Logger};
65 use crate::util::errors::APIError;
67 use alloc::collections::BTreeMap;
70 use crate::prelude::*;
72 use core::cell::RefCell;
74 use crate::sync::{Arc, Mutex, RwLock, RwLockReadGuard, FairRwLock, LockTestExt, LockHeldState};
75 use core::sync::atomic::{AtomicUsize, AtomicBool, Ordering};
76 use core::time::Duration;
79 // Re-export this for use in the public API.
80 pub use crate::ln::outbound_payment::{PaymentSendFailure, Retry, RetryableSendFailure, RecipientOnionFields};
81 use crate::ln::script::ShutdownScript;
83 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
85 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
86 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
87 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
89 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
90 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
91 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
92 // before we forward it.
94 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
95 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
96 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
97 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
98 // our payment, which we can use to decode errors or inform the user that the payment was sent.
100 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
101 pub(super) enum PendingHTLCRouting {
103 onion_packet: msgs::OnionPacket,
104 /// The SCID from the onion that we should forward to. This could be a real SCID or a fake one
105 /// generated using `get_fake_scid` from the scid_utils::fake_scid module.
106 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
109 payment_data: msgs::FinalOnionHopData,
110 payment_metadata: Option<Vec<u8>>,
111 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
112 phantom_shared_secret: Option<[u8; 32]>,
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, 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,
185 incoming_packet_shared_secret: [u8; 32],
186 phantom_shared_secret: Option<[u8; 32]>,
188 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
189 // channel with a preimage provided by the forward channel.
194 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
196 /// This is only here for backwards-compatibility in serialization, in the future it can be
197 /// removed, breaking clients running 0.0.106 and earlier.
198 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
200 /// Contains the payer-provided preimage.
201 Spontaneous(PaymentPreimage),
204 /// HTLCs that are to us and can be failed/claimed by the user
205 struct ClaimableHTLC {
206 prev_hop: HTLCPreviousHopData,
208 /// The amount (in msats) of this MPP part
210 /// The amount (in msats) that the sender intended to be sent in this MPP
211 /// part (used for validating total MPP amount)
212 sender_intended_value: u64,
213 onion_payload: OnionPayload,
215 /// The total value received for a payment (sum of all MPP parts if the payment is a MPP).
216 /// Gets set to the amount reported when pushing [`Event::PaymentClaimable`].
217 total_value_received: Option<u64>,
218 /// The sender intended sum total of all MPP parts specified in the onion
220 /// The extra fee our counterparty skimmed off the top of this HTLC.
221 counterparty_skimmed_fee_msat: Option<u64>,
224 /// A payment identifier used to uniquely identify a payment to LDK.
226 /// This is not exported to bindings users as we just use [u8; 32] directly
227 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
228 pub struct PaymentId(pub [u8; 32]);
230 impl Writeable for PaymentId {
231 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
236 impl Readable for PaymentId {
237 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
238 let buf: [u8; 32] = Readable::read(r)?;
243 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
245 /// This is not exported to bindings users as we just use [u8; 32] directly
246 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
247 pub struct InterceptId(pub [u8; 32]);
249 impl Writeable for InterceptId {
250 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
255 impl Readable for InterceptId {
256 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
257 let buf: [u8; 32] = Readable::read(r)?;
262 #[derive(Clone, Copy, PartialEq, Eq, Hash)]
263 /// Uniquely describes an HTLC by its source. Just the guaranteed-unique subset of [`HTLCSource`].
264 pub(crate) enum SentHTLCId {
265 PreviousHopData { short_channel_id: u64, htlc_id: u64 },
266 OutboundRoute { session_priv: SecretKey },
269 pub(crate) fn from_source(source: &HTLCSource) -> Self {
271 HTLCSource::PreviousHopData(hop_data) => Self::PreviousHopData {
272 short_channel_id: hop_data.short_channel_id,
273 htlc_id: hop_data.htlc_id,
275 HTLCSource::OutboundRoute { session_priv, .. } =>
276 Self::OutboundRoute { session_priv: *session_priv },
280 impl_writeable_tlv_based_enum!(SentHTLCId,
281 (0, PreviousHopData) => {
282 (0, short_channel_id, required),
283 (2, htlc_id, required),
285 (2, OutboundRoute) => {
286 (0, session_priv, required),
291 /// Tracks the inbound corresponding to an outbound HTLC
292 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
293 #[derive(Clone, PartialEq, Eq)]
294 pub(crate) enum HTLCSource {
295 PreviousHopData(HTLCPreviousHopData),
298 session_priv: SecretKey,
299 /// Technically we can recalculate this from the route, but we cache it here to avoid
300 /// doing a double-pass on route when we get a failure back
301 first_hop_htlc_msat: u64,
302 payment_id: PaymentId,
305 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
306 impl core::hash::Hash for HTLCSource {
307 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
309 HTLCSource::PreviousHopData(prev_hop_data) => {
311 prev_hop_data.hash(hasher);
313 HTLCSource::OutboundRoute { path, session_priv, payment_id, first_hop_htlc_msat } => {
316 session_priv[..].hash(hasher);
317 payment_id.hash(hasher);
318 first_hop_htlc_msat.hash(hasher);
324 #[cfg(all(feature = "_test_vectors", not(feature = "grind_signatures")))]
326 pub fn dummy() -> Self {
327 HTLCSource::OutboundRoute {
328 path: Path { hops: Vec::new(), blinded_tail: None },
329 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
330 first_hop_htlc_msat: 0,
331 payment_id: PaymentId([2; 32]),
335 #[cfg(debug_assertions)]
336 /// Checks whether this HTLCSource could possibly match the given HTLC output in a commitment
337 /// transaction. Useful to ensure different datastructures match up.
338 pub(crate) fn possibly_matches_output(&self, htlc: &super::chan_utils::HTLCOutputInCommitment) -> bool {
339 if let HTLCSource::OutboundRoute { first_hop_htlc_msat, .. } = self {
340 *first_hop_htlc_msat == htlc.amount_msat
342 // There's nothing we can check for forwarded HTLCs
348 struct InboundOnionErr {
354 /// This enum is used to specify which error data to send to peers when failing back an HTLC
355 /// using [`ChannelManager::fail_htlc_backwards_with_reason`].
357 /// For more info on failure codes, see <https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages>.
358 #[derive(Clone, Copy)]
359 pub enum FailureCode {
360 /// We had a temporary error processing the payment. Useful if no other error codes fit
361 /// and you want to indicate that the payer may want to retry.
362 TemporaryNodeFailure,
363 /// We have a required feature which was not in this onion. For example, you may require
364 /// some additional metadata that was not provided with this payment.
365 RequiredNodeFeatureMissing,
366 /// You may wish to use this when a `payment_preimage` is unknown, or the CLTV expiry of
367 /// the HTLC is too close to the current block height for safe handling.
368 /// Using this failure code in [`ChannelManager::fail_htlc_backwards_with_reason`] is
369 /// equivalent to calling [`ChannelManager::fail_htlc_backwards`].
370 IncorrectOrUnknownPaymentDetails,
371 /// We failed to process the payload after the onion was decrypted. You may wish to
372 /// use this when receiving custom HTLC TLVs with even type numbers that you don't recognize.
374 /// If available, the tuple data may include the type number and byte offset in the
375 /// decrypted byte stream where the failure occurred.
376 InvalidOnionPayload(Option<(u64, u16)>),
379 impl Into<u16> for FailureCode {
380 fn into(self) -> u16 {
382 FailureCode::TemporaryNodeFailure => 0x2000 | 2,
383 FailureCode::RequiredNodeFeatureMissing => 0x4000 | 0x2000 | 3,
384 FailureCode::IncorrectOrUnknownPaymentDetails => 0x4000 | 15,
385 FailureCode::InvalidOnionPayload(_) => 0x4000 | 22,
390 /// Error type returned across the peer_state mutex boundary. When an Err is generated for a
391 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
392 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
393 /// peer_state lock. We then return the set of things that need to be done outside the lock in
394 /// this struct and call handle_error!() on it.
396 struct MsgHandleErrInternal {
397 err: msgs::LightningError,
398 chan_id: Option<([u8; 32], u128)>, // If Some a channel of ours has been closed
399 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
400 channel_capacity: Option<u64>,
402 impl MsgHandleErrInternal {
404 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
406 err: LightningError {
408 action: msgs::ErrorAction::SendErrorMessage {
409 msg: msgs::ErrorMessage {
416 shutdown_finish: None,
417 channel_capacity: None,
421 fn from_no_close(err: msgs::LightningError) -> Self {
422 Self { err, chan_id: None, shutdown_finish: None, channel_capacity: None }
425 fn from_finish_shutdown(err: String, channel_id: [u8; 32], user_channel_id: u128, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>, channel_capacity: u64) -> Self {
427 err: LightningError {
429 action: msgs::ErrorAction::SendErrorMessage {
430 msg: msgs::ErrorMessage {
436 chan_id: Some((channel_id, user_channel_id)),
437 shutdown_finish: Some((shutdown_res, channel_update)),
438 channel_capacity: Some(channel_capacity)
442 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
445 ChannelError::Warn(msg) => LightningError {
447 action: msgs::ErrorAction::SendWarningMessage {
448 msg: msgs::WarningMessage {
452 log_level: Level::Warn,
455 ChannelError::Ignore(msg) => LightningError {
457 action: msgs::ErrorAction::IgnoreError,
459 ChannelError::Close(msg) => LightningError {
461 action: msgs::ErrorAction::SendErrorMessage {
462 msg: msgs::ErrorMessage {
470 shutdown_finish: None,
471 channel_capacity: None,
476 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
477 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
478 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
479 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
480 pub(super) const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
482 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
483 /// be sent in the order they appear in the return value, however sometimes the order needs to be
484 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
485 /// they were originally sent). In those cases, this enum is also returned.
486 #[derive(Clone, PartialEq)]
487 pub(super) enum RAACommitmentOrder {
488 /// Send the CommitmentUpdate messages first
490 /// Send the RevokeAndACK message first
494 /// Information about a payment which is currently being claimed.
495 struct ClaimingPayment {
497 payment_purpose: events::PaymentPurpose,
498 receiver_node_id: PublicKey,
500 impl_writeable_tlv_based!(ClaimingPayment, {
501 (0, amount_msat, required),
502 (2, payment_purpose, required),
503 (4, receiver_node_id, required),
506 struct ClaimablePayment {
507 purpose: events::PaymentPurpose,
508 onion_fields: Option<RecipientOnionFields>,
509 htlcs: Vec<ClaimableHTLC>,
512 /// Information about claimable or being-claimed payments
513 struct ClaimablePayments {
514 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
515 /// failed/claimed by the user.
517 /// Note that, no consistency guarantees are made about the channels given here actually
518 /// existing anymore by the time you go to read them!
520 /// When adding to the map, [`Self::pending_claiming_payments`] must also be checked to ensure
521 /// we don't get a duplicate payment.
522 claimable_payments: HashMap<PaymentHash, ClaimablePayment>,
524 /// Map from payment hash to the payment data for HTLCs which we have begun claiming, but which
525 /// are waiting on a [`ChannelMonitorUpdate`] to complete in order to be surfaced to the user
526 /// as an [`events::Event::PaymentClaimed`].
527 pending_claiming_payments: HashMap<PaymentHash, ClaimingPayment>,
530 /// Events which we process internally but cannot be processed immediately at the generation site
531 /// usually because we're running pre-full-init. They are handled immediately once we detect we are
532 /// running normally, and specifically must be processed before any other non-background
533 /// [`ChannelMonitorUpdate`]s are applied.
534 enum BackgroundEvent {
535 /// Handle a ChannelMonitorUpdate which closes the channel or for an already-closed channel.
536 /// This is only separated from [`Self::MonitorUpdateRegeneratedOnStartup`] as the
537 /// maybe-non-closing variant needs a public key to handle channel resumption, whereas if the
538 /// channel has been force-closed we do not need the counterparty node_id.
540 /// Note that any such events are lost on shutdown, so in general they must be updates which
541 /// are regenerated on startup.
542 ClosedMonitorUpdateRegeneratedOnStartup((OutPoint, ChannelMonitorUpdate)),
543 /// Handle a ChannelMonitorUpdate which may or may not close the channel and may unblock the
544 /// channel to continue normal operation.
546 /// In general this should be used rather than
547 /// [`Self::ClosedMonitorUpdateRegeneratedOnStartup`], however in cases where the
548 /// `counterparty_node_id` is not available as the channel has closed from a [`ChannelMonitor`]
549 /// error the other variant is acceptable.
551 /// Note that any such events are lost on shutdown, so in general they must be updates which
552 /// are regenerated on startup.
553 MonitorUpdateRegeneratedOnStartup {
554 counterparty_node_id: PublicKey,
555 funding_txo: OutPoint,
556 update: ChannelMonitorUpdate
558 /// Some [`ChannelMonitorUpdate`] (s) completed before we were serialized but we still have
559 /// them marked pending, thus we need to run any [`MonitorUpdateCompletionAction`] (s) pending
561 MonitorUpdatesComplete {
562 counterparty_node_id: PublicKey,
563 channel_id: [u8; 32],
568 pub(crate) enum MonitorUpdateCompletionAction {
569 /// Indicates that a payment ultimately destined for us was claimed and we should emit an
570 /// [`events::Event::PaymentClaimed`] to the user if we haven't yet generated such an event for
571 /// this payment. Note that this is only best-effort. On restart it's possible such a duplicate
572 /// event can be generated.
573 PaymentClaimed { payment_hash: PaymentHash },
574 /// Indicates an [`events::Event`] should be surfaced to the user and possibly resume the
575 /// operation of another channel.
577 /// This is usually generated when we've forwarded an HTLC and want to block the outbound edge
578 /// from completing a monitor update which removes the payment preimage until the inbound edge
579 /// completes a monitor update containing the payment preimage. In that case, after the inbound
580 /// edge completes, we will surface an [`Event::PaymentForwarded`] as well as unblock the
582 EmitEventAndFreeOtherChannel {
583 event: events::Event,
584 downstream_counterparty_and_funding_outpoint: Option<(PublicKey, OutPoint, RAAMonitorUpdateBlockingAction)>,
588 impl_writeable_tlv_based_enum_upgradable!(MonitorUpdateCompletionAction,
589 (0, PaymentClaimed) => { (0, payment_hash, required) },
590 (2, EmitEventAndFreeOtherChannel) => {
591 (0, event, upgradable_required),
592 // LDK prior to 0.0.116 did not have this field as the monitor update application order was
593 // required by clients. If we downgrade to something prior to 0.0.116 this may result in
594 // monitor updates which aren't properly blocked or resumed, however that's fine - we don't
595 // support async monitor updates even in LDK 0.0.116 and once we do we'll require no
596 // downgrades to prior versions.
597 (1, downstream_counterparty_and_funding_outpoint, option),
601 #[derive(Clone, Debug, PartialEq, Eq)]
602 pub(crate) enum EventCompletionAction {
603 ReleaseRAAChannelMonitorUpdate {
604 counterparty_node_id: PublicKey,
605 channel_funding_outpoint: OutPoint,
608 impl_writeable_tlv_based_enum!(EventCompletionAction,
609 (0, ReleaseRAAChannelMonitorUpdate) => {
610 (0, channel_funding_outpoint, required),
611 (2, counterparty_node_id, required),
615 #[derive(Clone, PartialEq, Eq, Debug)]
616 /// If something is blocked on the completion of an RAA-generated [`ChannelMonitorUpdate`] we track
617 /// the blocked action here. See enum variants for more info.
618 pub(crate) enum RAAMonitorUpdateBlockingAction {
619 /// A forwarded payment was claimed. We block the downstream channel completing its monitor
620 /// update which removes the HTLC preimage until the upstream channel has gotten the preimage
622 ForwardedPaymentInboundClaim {
623 /// The upstream channel ID (i.e. the inbound edge).
624 channel_id: [u8; 32],
625 /// The HTLC ID on the inbound edge.
630 impl RAAMonitorUpdateBlockingAction {
632 fn from_prev_hop_data(prev_hop: &HTLCPreviousHopData) -> Self {
633 Self::ForwardedPaymentInboundClaim {
634 channel_id: prev_hop.outpoint.to_channel_id(),
635 htlc_id: prev_hop.htlc_id,
640 impl_writeable_tlv_based_enum!(RAAMonitorUpdateBlockingAction,
641 (0, ForwardedPaymentInboundClaim) => { (0, channel_id, required), (2, htlc_id, required) }
645 /// State we hold per-peer.
646 pub(super) struct PeerState<Signer: ChannelSigner> {
647 /// `channel_id` -> `Channel`.
649 /// Holds all funded channels where the peer is the counterparty.
650 pub(super) channel_by_id: HashMap<[u8; 32], Channel<Signer>>,
651 /// `temporary_channel_id` -> `OutboundV1Channel`.
653 /// Holds all outbound V1 channels where the peer is the counterparty. Once an outbound channel has
654 /// been assigned a `channel_id`, the entry in this map is removed and one is created in
656 pub(super) outbound_v1_channel_by_id: HashMap<[u8; 32], OutboundV1Channel<Signer>>,
657 /// `temporary_channel_id` -> `InboundV1Channel`.
659 /// Holds all inbound V1 channels where the peer is the counterparty. Once an inbound channel has
660 /// been assigned a `channel_id`, the entry in this map is removed and one is created in
662 pub(super) inbound_v1_channel_by_id: HashMap<[u8; 32], InboundV1Channel<Signer>>,
663 /// The latest `InitFeatures` we heard from the peer.
664 latest_features: InitFeatures,
665 /// Messages to send to the peer - pushed to in the same lock that they are generated in (except
666 /// for broadcast messages, where ordering isn't as strict).
667 pub(super) pending_msg_events: Vec<MessageSendEvent>,
668 /// Map from Channel IDs to pending [`ChannelMonitorUpdate`]s which have been passed to the
669 /// user but which have not yet completed.
671 /// Note that the channel may no longer exist. For example if the channel was closed but we
672 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
673 /// for a missing channel.
674 in_flight_monitor_updates: BTreeMap<OutPoint, Vec<ChannelMonitorUpdate>>,
675 /// Map from a specific channel to some action(s) that should be taken when all pending
676 /// [`ChannelMonitorUpdate`]s for the channel complete updating.
678 /// Note that because we generally only have one entry here a HashMap is pretty overkill. A
679 /// BTreeMap currently stores more than ten elements per leaf node, so even up to a few
680 /// channels with a peer this will just be one allocation and will amount to a linear list of
681 /// channels to walk, avoiding the whole hashing rigmarole.
683 /// Note that the channel may no longer exist. For example, if a channel was closed but we
684 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
685 /// for a missing channel. While a malicious peer could construct a second channel with the
686 /// same `temporary_channel_id` (or final `channel_id` in the case of 0conf channels or prior
687 /// to funding appearing on-chain), the downstream `ChannelMonitor` set is required to ensure
688 /// duplicates do not occur, so such channels should fail without a monitor update completing.
689 monitor_update_blocked_actions: BTreeMap<[u8; 32], Vec<MonitorUpdateCompletionAction>>,
690 /// If another channel's [`ChannelMonitorUpdate`] needs to complete before a channel we have
691 /// with this peer can complete an RAA [`ChannelMonitorUpdate`] (e.g. because the RAA update
692 /// will remove a preimage that needs to be durably in an upstream channel first), we put an
693 /// entry here to note that the channel with the key's ID is blocked on a set of actions.
694 actions_blocking_raa_monitor_updates: BTreeMap<[u8; 32], Vec<RAAMonitorUpdateBlockingAction>>,
695 /// The peer is currently connected (i.e. we've seen a
696 /// [`ChannelMessageHandler::peer_connected`] and no corresponding
697 /// [`ChannelMessageHandler::peer_disconnected`].
701 impl <Signer: ChannelSigner> PeerState<Signer> {
702 /// Indicates that a peer meets the criteria where we're ok to remove it from our storage.
703 /// If true is passed for `require_disconnected`, the function will return false if we haven't
704 /// disconnected from the node already, ie. `PeerState::is_connected` is set to `true`.
705 fn ok_to_remove(&self, require_disconnected: bool) -> bool {
706 if require_disconnected && self.is_connected {
709 self.channel_by_id.is_empty() && self.monitor_update_blocked_actions.is_empty()
710 && self.in_flight_monitor_updates.is_empty()
713 // Returns a count of all channels we have with this peer, including unfunded channels.
714 fn total_channel_count(&self) -> usize {
715 self.channel_by_id.len() +
716 self.outbound_v1_channel_by_id.len() +
717 self.inbound_v1_channel_by_id.len()
720 // Returns a bool indicating if the given `channel_id` matches a channel we have with this peer.
721 fn has_channel(&self, channel_id: &[u8; 32]) -> bool {
722 self.channel_by_id.contains_key(channel_id) ||
723 self.outbound_v1_channel_by_id.contains_key(channel_id) ||
724 self.inbound_v1_channel_by_id.contains_key(channel_id)
728 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
729 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
731 /// For users who don't want to bother doing their own payment preimage storage, we also store that
734 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
735 /// and instead encoding it in the payment secret.
736 struct PendingInboundPayment {
737 /// The payment secret that the sender must use for us to accept this payment
738 payment_secret: PaymentSecret,
739 /// Time at which this HTLC expires - blocks with a header time above this value will result in
740 /// this payment being removed.
742 /// Arbitrary identifier the user specifies (or not)
743 user_payment_id: u64,
744 // Other required attributes of the payment, optionally enforced:
745 payment_preimage: Option<PaymentPreimage>,
746 min_value_msat: Option<u64>,
749 /// [`SimpleArcChannelManager`] is useful when you need a [`ChannelManager`] with a static lifetime, e.g.
750 /// when you're using `lightning-net-tokio` (since `tokio::spawn` requires parameters with static
751 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
752 /// [`SimpleRefChannelManager`] is the more appropriate type. Defining these type aliases prevents
753 /// issues such as overly long function definitions. Note that the `ChannelManager` can take any type
754 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
755 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
756 /// of [`KeysManager`] and [`DefaultRouter`].
758 /// This is not exported to bindings users as Arcs don't make sense in bindings
759 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
767 Arc<NetworkGraph<Arc<L>>>,
769 Arc<Mutex<ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>>,
770 ProbabilisticScoringFeeParameters,
771 ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>,
776 /// [`SimpleRefChannelManager`] is a type alias for a ChannelManager reference, and is the reference
777 /// counterpart to the [`SimpleArcChannelManager`] type alias. Use this type by default when you don't
778 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
779 /// usage of lightning-net-tokio (since `tokio::spawn` requires parameters with static lifetimes).
780 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
781 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
782 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
783 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
784 /// of [`KeysManager`] and [`DefaultRouter`].
786 /// This is not exported to bindings users as Arcs don't make sense in bindings
787 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> =
796 &'f NetworkGraph<&'g L>,
798 &'h Mutex<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>,
799 ProbabilisticScoringFeeParameters,
800 ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>
805 macro_rules! define_test_pub_trait { ($vis: vis) => {
806 /// A trivial trait which describes any [`ChannelManager`] used in testing.
807 $vis trait AChannelManager {
808 type Watch: chain::Watch<Self::Signer> + ?Sized;
809 type M: Deref<Target = Self::Watch>;
810 type Broadcaster: BroadcasterInterface + ?Sized;
811 type T: Deref<Target = Self::Broadcaster>;
812 type EntropySource: EntropySource + ?Sized;
813 type ES: Deref<Target = Self::EntropySource>;
814 type NodeSigner: NodeSigner + ?Sized;
815 type NS: Deref<Target = Self::NodeSigner>;
816 type Signer: WriteableEcdsaChannelSigner + Sized;
817 type SignerProvider: SignerProvider<Signer = Self::Signer> + ?Sized;
818 type SP: Deref<Target = Self::SignerProvider>;
819 type FeeEstimator: FeeEstimator + ?Sized;
820 type F: Deref<Target = Self::FeeEstimator>;
821 type Router: Router + ?Sized;
822 type R: Deref<Target = Self::Router>;
823 type Logger: Logger + ?Sized;
824 type L: Deref<Target = Self::Logger>;
825 fn get_cm(&self) -> &ChannelManager<Self::M, Self::T, Self::ES, Self::NS, Self::SP, Self::F, Self::R, Self::L>;
828 #[cfg(any(test, feature = "_test_utils"))]
829 define_test_pub_trait!(pub);
830 #[cfg(not(any(test, feature = "_test_utils")))]
831 define_test_pub_trait!(pub(crate));
832 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> AChannelManager
833 for ChannelManager<M, T, ES, NS, SP, F, R, L>
835 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
836 T::Target: BroadcasterInterface,
837 ES::Target: EntropySource,
838 NS::Target: NodeSigner,
839 SP::Target: SignerProvider,
840 F::Target: FeeEstimator,
844 type Watch = M::Target;
846 type Broadcaster = T::Target;
848 type EntropySource = ES::Target;
850 type NodeSigner = NS::Target;
852 type Signer = <SP::Target as SignerProvider>::Signer;
853 type SignerProvider = SP::Target;
855 type FeeEstimator = F::Target;
857 type Router = R::Target;
859 type Logger = L::Target;
861 fn get_cm(&self) -> &ChannelManager<M, T, ES, NS, SP, F, R, L> { self }
864 /// Manager which keeps track of a number of channels and sends messages to the appropriate
865 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
867 /// Implements [`ChannelMessageHandler`], handling the multi-channel parts and passing things through
868 /// to individual Channels.
870 /// Implements [`Writeable`] to write out all channel state to disk. Implies [`peer_disconnected`] for
871 /// all peers during write/read (though does not modify this instance, only the instance being
872 /// serialized). This will result in any channels which have not yet exchanged [`funding_created`] (i.e.,
873 /// called [`funding_transaction_generated`] for outbound channels) being closed.
875 /// Note that you can be a bit lazier about writing out `ChannelManager` than you can be with
876 /// [`ChannelMonitor`]. With [`ChannelMonitor`] you MUST write each monitor update out to disk before
877 /// returning from [`chain::Watch::watch_channel`]/[`update_channel`], with ChannelManagers, writing updates
878 /// happens out-of-band (and will prevent any other `ChannelManager` operations from occurring during
879 /// the serialization process). If the deserialized version is out-of-date compared to the
880 /// [`ChannelMonitor`] passed by reference to [`read`], those channels will be force-closed based on the
881 /// `ChannelMonitor` state and no funds will be lost (mod on-chain transaction fees).
883 /// Note that the deserializer is only implemented for `(`[`BlockHash`]`, `[`ChannelManager`]`)`, which
884 /// tells you the last block hash which was connected. You should get the best block tip before using the manager.
885 /// See [`chain::Listen`] and [`chain::Confirm`] for more details.
887 /// Note that `ChannelManager` is responsible for tracking liveness of its channels and generating
888 /// [`ChannelUpdate`] messages informing peers that the channel is temporarily disabled. To avoid
889 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
890 /// offline for a full minute. In order to track this, you must call
891 /// [`timer_tick_occurred`] roughly once per minute, though it doesn't have to be perfect.
893 /// To avoid trivial DoS issues, `ChannelManager` limits the number of inbound connections and
894 /// inbound channels without confirmed funding transactions. This may result in nodes which we do
895 /// not have a channel with being unable to connect to us or open new channels with us if we have
896 /// many peers with unfunded channels.
898 /// Because it is an indication of trust, inbound channels which we've accepted as 0conf are
899 /// exempted from the count of unfunded channels. Similarly, outbound channels and connections are
900 /// never limited. Please ensure you limit the count of such channels yourself.
902 /// Rather than using a plain `ChannelManager`, it is preferable to use either a [`SimpleArcChannelManager`]
903 /// a [`SimpleRefChannelManager`], for conciseness. See their documentation for more details, but
904 /// essentially you should default to using a [`SimpleRefChannelManager`], and use a
905 /// [`SimpleArcChannelManager`] when you require a `ChannelManager` with a static lifetime, such as when
906 /// you're using lightning-net-tokio.
908 /// [`peer_disconnected`]: msgs::ChannelMessageHandler::peer_disconnected
909 /// [`funding_created`]: msgs::FundingCreated
910 /// [`funding_transaction_generated`]: Self::funding_transaction_generated
911 /// [`BlockHash`]: bitcoin::hash_types::BlockHash
912 /// [`update_channel`]: chain::Watch::update_channel
913 /// [`ChannelUpdate`]: msgs::ChannelUpdate
914 /// [`timer_tick_occurred`]: Self::timer_tick_occurred
915 /// [`read`]: ReadableArgs::read
918 // The tree structure below illustrates the lock order requirements for the different locks of the
919 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
920 // and should then be taken in the order of the lowest to the highest level in the tree.
921 // Note that locks on different branches shall not be taken at the same time, as doing so will
922 // create a new lock order for those specific locks in the order they were taken.
926 // `total_consistency_lock`
928 // |__`forward_htlcs`
930 // | |__`pending_intercepted_htlcs`
932 // |__`per_peer_state`
934 // | |__`pending_inbound_payments`
936 // | |__`claimable_payments`
938 // | |__`pending_outbound_payments` // This field's struct contains a map of pending outbounds
944 // | |__`short_to_chan_info`
946 // | |__`outbound_scid_aliases`
950 // | |__`pending_events`
952 // | |__`pending_background_events`
954 pub struct ChannelManager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
956 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
957 T::Target: BroadcasterInterface,
958 ES::Target: EntropySource,
959 NS::Target: NodeSigner,
960 SP::Target: SignerProvider,
961 F::Target: FeeEstimator,
965 default_configuration: UserConfig,
966 genesis_hash: BlockHash,
967 fee_estimator: LowerBoundedFeeEstimator<F>,
973 /// See `ChannelManager` struct-level documentation for lock order requirements.
975 pub(super) best_block: RwLock<BestBlock>,
977 best_block: RwLock<BestBlock>,
978 secp_ctx: Secp256k1<secp256k1::All>,
980 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
981 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
982 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
983 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
985 /// See `ChannelManager` struct-level documentation for lock order requirements.
986 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
988 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
989 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
990 /// (if the channel has been force-closed), however we track them here to prevent duplicative
991 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
992 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
993 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
994 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
995 /// after reloading from disk while replaying blocks against ChannelMonitors.
997 /// See `PendingOutboundPayment` documentation for more info.
999 /// See `ChannelManager` struct-level documentation for lock order requirements.
1000 pending_outbound_payments: OutboundPayments,
1002 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
1004 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
1005 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
1006 /// and via the classic SCID.
1008 /// Note that no consistency guarantees are made about the existence of a channel with the
1009 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
1011 /// See `ChannelManager` struct-level documentation for lock order requirements.
1013 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1015 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1016 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
1017 /// until the user tells us what we should do with them.
1019 /// See `ChannelManager` struct-level documentation for lock order requirements.
1020 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
1022 /// The sets of payments which are claimable or currently being claimed. See
1023 /// [`ClaimablePayments`]' individual field docs for more info.
1025 /// See `ChannelManager` struct-level documentation for lock order requirements.
1026 claimable_payments: Mutex<ClaimablePayments>,
1028 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
1029 /// and some closed channels which reached a usable state prior to being closed. This is used
1030 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
1031 /// active channel list on load.
1033 /// See `ChannelManager` struct-level documentation for lock order requirements.
1034 outbound_scid_aliases: Mutex<HashSet<u64>>,
1036 /// `channel_id` -> `counterparty_node_id`.
1038 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
1039 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
1040 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
1042 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
1043 /// the corresponding channel for the event, as we only have access to the `channel_id` during
1044 /// the handling of the events.
1046 /// Note that no consistency guarantees are made about the existence of a peer with the
1047 /// `counterparty_node_id` in our other maps.
1050 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
1051 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
1052 /// would break backwards compatability.
1053 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
1054 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
1055 /// required to access the channel with the `counterparty_node_id`.
1057 /// See `ChannelManager` struct-level documentation for lock order requirements.
1058 id_to_peer: Mutex<HashMap<[u8; 32], PublicKey>>,
1060 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
1062 /// Outbound SCID aliases are added here once the channel is available for normal use, with
1063 /// SCIDs being added once the funding transaction is confirmed at the channel's required
1064 /// confirmation depth.
1066 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
1067 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
1068 /// channel with the `channel_id` in our other maps.
1070 /// See `ChannelManager` struct-level documentation for lock order requirements.
1072 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
1074 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
1076 our_network_pubkey: PublicKey,
1078 inbound_payment_key: inbound_payment::ExpandedKey,
1080 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
1081 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
1082 /// we encrypt the namespace identifier using these bytes.
1084 /// [fake scids]: crate::util::scid_utils::fake_scid
1085 fake_scid_rand_bytes: [u8; 32],
1087 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
1088 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
1089 /// keeping additional state.
1090 probing_cookie_secret: [u8; 32],
1092 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
1093 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
1094 /// very far in the past, and can only ever be up to two hours in the future.
1095 highest_seen_timestamp: AtomicUsize,
1097 /// The bulk of our storage. Currently the `per_peer_state` stores our channels on a per-peer
1098 /// basis, as well as the peer's latest features.
1100 /// If we are connected to a peer we always at least have an entry here, even if no channels
1101 /// are currently open with that peer.
1103 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
1104 /// operate on the inner value freely. This opens up for parallel per-peer operation for
1107 /// Note that the same thread must never acquire two inner `PeerState` locks at the same time.
1109 /// See `ChannelManager` struct-level documentation for lock order requirements.
1110 #[cfg(not(any(test, feature = "_test_utils")))]
1111 per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>>>,
1112 #[cfg(any(test, feature = "_test_utils"))]
1113 pub(super) per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>>>,
1115 /// The set of events which we need to give to the user to handle. In some cases an event may
1116 /// require some further action after the user handles it (currently only blocking a monitor
1117 /// update from being handed to the user to ensure the included changes to the channel state
1118 /// are handled by the user before they're persisted durably to disk). In that case, the second
1119 /// element in the tuple is set to `Some` with further details of the action.
1121 /// Note that events MUST NOT be removed from pending_events after deserialization, as they
1122 /// could be in the middle of being processed without the direct mutex held.
1124 /// See `ChannelManager` struct-level documentation for lock order requirements.
1125 pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1126 /// A simple atomic flag to ensure only one task at a time can be processing events asynchronously.
1127 pending_events_processor: AtomicBool,
1129 /// If we are running during init (either directly during the deserialization method or in
1130 /// block connection methods which run after deserialization but before normal operation) we
1131 /// cannot provide the user with [`ChannelMonitorUpdate`]s through the normal update flow -
1132 /// prior to normal operation the user may not have loaded the [`ChannelMonitor`]s into their
1133 /// [`ChainMonitor`] and thus attempting to update it will fail or panic.
1135 /// Thus, we place them here to be handled as soon as possible once we are running normally.
1137 /// See `ChannelManager` struct-level documentation for lock order requirements.
1139 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
1140 pending_background_events: Mutex<Vec<BackgroundEvent>>,
1141 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
1142 /// Essentially just when we're serializing ourselves out.
1143 /// Taken first everywhere where we are making changes before any other locks.
1144 /// When acquiring this lock in read mode, rather than acquiring it directly, call
1145 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
1146 /// Notifier the lock contains sends out a notification when the lock is released.
1147 total_consistency_lock: RwLock<()>,
1149 background_events_processed_since_startup: AtomicBool,
1151 persistence_notifier: Notifier,
1155 signer_provider: SP,
1160 /// Chain-related parameters used to construct a new `ChannelManager`.
1162 /// Typically, the block-specific parameters are derived from the best block hash for the network,
1163 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
1164 /// are not needed when deserializing a previously constructed `ChannelManager`.
1165 #[derive(Clone, Copy, PartialEq)]
1166 pub struct ChainParameters {
1167 /// The network for determining the `chain_hash` in Lightning messages.
1168 pub network: Network,
1170 /// The hash and height of the latest block successfully connected.
1172 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
1173 pub best_block: BestBlock,
1176 #[derive(Copy, Clone, PartialEq)]
1183 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
1184 /// desirable to notify any listeners on `await_persistable_update_timeout`/
1185 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
1186 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
1187 /// sending the aforementioned notification (since the lock being released indicates that the
1188 /// updates are ready for persistence).
1190 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
1191 /// notify or not based on whether relevant changes have been made, providing a closure to
1192 /// `optionally_notify` which returns a `NotifyOption`.
1193 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
1194 persistence_notifier: &'a Notifier,
1196 // We hold onto this result so the lock doesn't get released immediately.
1197 _read_guard: RwLockReadGuard<'a, ()>,
1200 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
1201 fn notify_on_drop<C: AChannelManager>(cm: &'a C) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
1202 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1203 let _ = cm.get_cm().process_background_events(); // We always persist
1205 PersistenceNotifierGuard {
1206 persistence_notifier: &cm.get_cm().persistence_notifier,
1207 should_persist: || -> NotifyOption { NotifyOption::DoPersist },
1208 _read_guard: read_guard,
1213 /// Note that if any [`ChannelMonitorUpdate`]s are possibly generated,
1214 /// [`ChannelManager::process_background_events`] MUST be called first.
1215 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a Notifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
1216 let read_guard = lock.read().unwrap();
1218 PersistenceNotifierGuard {
1219 persistence_notifier: notifier,
1220 should_persist: persist_check,
1221 _read_guard: read_guard,
1226 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
1227 fn drop(&mut self) {
1228 if (self.should_persist)() == NotifyOption::DoPersist {
1229 self.persistence_notifier.notify();
1234 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
1235 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
1237 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
1239 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
1240 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
1241 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
1242 /// the maximum required amount in lnd as of March 2021.
1243 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
1245 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
1246 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
1248 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
1250 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
1251 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
1252 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
1253 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
1254 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
1255 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
1256 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
1257 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
1258 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
1259 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
1260 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
1261 // routing failure for any HTLC sender picking up an LDK node among the first hops.
1262 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
1264 /// Minimum CLTV difference between the current block height and received inbound payments.
1265 /// Invoices generated for payment to us must set their `min_final_cltv_expiry_delta` field to at least
1267 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
1268 // any payments to succeed. Further, we don't want payments to fail if a block was found while
1269 // a payment was being routed, so we add an extra block to be safe.
1270 pub const MIN_FINAL_CLTV_EXPIRY_DELTA: u16 = HTLC_FAIL_BACK_BUFFER as u16 + 3;
1272 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
1273 // ie that if the next-hop peer fails the HTLC within
1274 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
1275 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
1276 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
1277 // LATENCY_GRACE_PERIOD_BLOCKS.
1280 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;
1282 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
1283 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
1286 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
1288 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
1289 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
1291 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until we time-out the
1292 /// idempotency of payments by [`PaymentId`]. See
1293 /// [`OutboundPayments::remove_stale_resolved_payments`].
1294 pub(crate) const IDEMPOTENCY_TIMEOUT_TICKS: u8 = 7;
1296 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is disconnected
1297 /// until we mark the channel disabled and gossip the update.
1298 pub(crate) const DISABLE_GOSSIP_TICKS: u8 = 10;
1300 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is connected until
1301 /// we mark the channel enabled and gossip the update.
1302 pub(crate) const ENABLE_GOSSIP_TICKS: u8 = 5;
1304 /// The maximum number of unfunded channels we can have per-peer before we start rejecting new
1305 /// (inbound) ones. The number of peers with unfunded channels is limited separately in
1306 /// [`MAX_UNFUNDED_CHANNEL_PEERS`].
1307 const MAX_UNFUNDED_CHANS_PER_PEER: usize = 4;
1309 /// The maximum number of peers from which we will allow pending unfunded channels. Once we reach
1310 /// this many peers we reject new (inbound) channels from peers with which we don't have a channel.
1311 const MAX_UNFUNDED_CHANNEL_PEERS: usize = 50;
1313 /// The maximum number of peers which we do not have a (funded) channel with. Once we reach this
1314 /// many peers we reject new (inbound) connections.
1315 const MAX_NO_CHANNEL_PEERS: usize = 250;
1317 /// Information needed for constructing an invoice route hint for this channel.
1318 #[derive(Clone, Debug, PartialEq)]
1319 pub struct CounterpartyForwardingInfo {
1320 /// Base routing fee in millisatoshis.
1321 pub fee_base_msat: u32,
1322 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
1323 pub fee_proportional_millionths: u32,
1324 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
1325 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
1326 /// `cltv_expiry_delta` for more details.
1327 pub cltv_expiry_delta: u16,
1330 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
1331 /// to better separate parameters.
1332 #[derive(Clone, Debug, PartialEq)]
1333 pub struct ChannelCounterparty {
1334 /// The node_id of our counterparty
1335 pub node_id: PublicKey,
1336 /// The Features the channel counterparty provided upon last connection.
1337 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
1338 /// many routing-relevant features are present in the init context.
1339 pub features: InitFeatures,
1340 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
1341 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
1342 /// claiming at least this value on chain.
1344 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
1346 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
1347 pub unspendable_punishment_reserve: u64,
1348 /// Information on the fees and requirements that the counterparty requires when forwarding
1349 /// payments to us through this channel.
1350 pub forwarding_info: Option<CounterpartyForwardingInfo>,
1351 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
1352 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
1353 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
1354 pub outbound_htlc_minimum_msat: Option<u64>,
1355 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
1356 pub outbound_htlc_maximum_msat: Option<u64>,
1359 /// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
1360 #[derive(Clone, Debug, PartialEq)]
1361 pub struct ChannelDetails {
1362 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
1363 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
1364 /// Note that this means this value is *not* persistent - it can change once during the
1365 /// lifetime of the channel.
1366 pub channel_id: [u8; 32],
1367 /// Parameters which apply to our counterparty. See individual fields for more information.
1368 pub counterparty: ChannelCounterparty,
1369 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
1370 /// our counterparty already.
1372 /// Note that, if this has been set, `channel_id` will be equivalent to
1373 /// `funding_txo.unwrap().to_channel_id()`.
1374 pub funding_txo: Option<OutPoint>,
1375 /// The features which this channel operates with. See individual features for more info.
1377 /// `None` until negotiation completes and the channel type is finalized.
1378 pub channel_type: Option<ChannelTypeFeatures>,
1379 /// The position of the funding transaction in the chain. None if the funding transaction has
1380 /// not yet been confirmed and the channel fully opened.
1382 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1383 /// payments instead of this. See [`get_inbound_payment_scid`].
1385 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1386 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1388 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1389 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1390 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1391 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1392 /// [`confirmations_required`]: Self::confirmations_required
1393 pub short_channel_id: Option<u64>,
1394 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1395 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1396 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1399 /// This will be `None` as long as the channel is not available for routing outbound payments.
1401 /// [`short_channel_id`]: Self::short_channel_id
1402 /// [`confirmations_required`]: Self::confirmations_required
1403 pub outbound_scid_alias: Option<u64>,
1404 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1405 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1406 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1407 /// when they see a payment to be routed to us.
1409 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1410 /// previous values for inbound payment forwarding.
1412 /// [`short_channel_id`]: Self::short_channel_id
1413 pub inbound_scid_alias: Option<u64>,
1414 /// The value, in satoshis, of this channel as appears in the funding output
1415 pub channel_value_satoshis: u64,
1416 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1417 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1418 /// this value on chain.
1420 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1422 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1424 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1425 pub unspendable_punishment_reserve: Option<u64>,
1426 /// The `user_channel_id` passed in to create_channel, or a random value if the channel was
1427 /// inbound. This may be zero for inbound channels serialized with LDK versions prior to
1429 pub user_channel_id: u128,
1430 /// The currently negotiated fee rate denominated in satoshi per 1000 weight units,
1431 /// which is applied to commitment and HTLC transactions.
1433 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
1434 pub feerate_sat_per_1000_weight: Option<u32>,
1435 /// Our total balance. This is the amount we would get if we close the channel.
1436 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1437 /// amount is not likely to be recoverable on close.
1439 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1440 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1441 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1442 /// This does not consider any on-chain fees.
1444 /// See also [`ChannelDetails::outbound_capacity_msat`]
1445 pub balance_msat: u64,
1446 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1447 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1448 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1449 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1451 /// See also [`ChannelDetails::balance_msat`]
1453 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1454 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1455 /// should be able to spend nearly this amount.
1456 pub outbound_capacity_msat: u64,
1457 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1458 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1459 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1460 /// to use a limit as close as possible to the HTLC limit we can currently send.
1462 /// See also [`ChannelDetails::next_outbound_htlc_minimum_msat`],
1463 /// [`ChannelDetails::balance_msat`], and [`ChannelDetails::outbound_capacity_msat`].
1464 pub next_outbound_htlc_limit_msat: u64,
1465 /// The minimum value for sending a single HTLC to the remote peer. This is the equivalent of
1466 /// [`ChannelDetails::next_outbound_htlc_limit_msat`] but represents a lower-bound, rather than
1467 /// an upper-bound. This is intended for use when routing, allowing us to ensure we pick a
1468 /// route which is valid.
1469 pub next_outbound_htlc_minimum_msat: u64,
1470 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1471 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1472 /// available for inclusion in new inbound HTLCs).
1473 /// Note that there are some corner cases not fully handled here, so the actual available
1474 /// inbound capacity may be slightly higher than this.
1476 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1477 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1478 /// However, our counterparty should be able to spend nearly this amount.
1479 pub inbound_capacity_msat: u64,
1480 /// The number of required confirmations on the funding transaction before the funding will be
1481 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1482 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1483 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1484 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1486 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1488 /// [`is_outbound`]: ChannelDetails::is_outbound
1489 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1490 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1491 pub confirmations_required: Option<u32>,
1492 /// The current number of confirmations on the funding transaction.
1494 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1495 pub confirmations: Option<u32>,
1496 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1497 /// until we can claim our funds after we force-close the channel. During this time our
1498 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1499 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1500 /// time to claim our non-HTLC-encumbered funds.
1502 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1503 pub force_close_spend_delay: Option<u16>,
1504 /// True if the channel was initiated (and thus funded) by us.
1505 pub is_outbound: bool,
1506 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1507 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1508 /// required confirmation count has been reached (and we were connected to the peer at some
1509 /// point after the funding transaction received enough confirmations). The required
1510 /// confirmation count is provided in [`confirmations_required`].
1512 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1513 pub is_channel_ready: bool,
1514 /// The stage of the channel's shutdown.
1515 /// `None` for `ChannelDetails` serialized on LDK versions prior to 0.0.116.
1516 pub channel_shutdown_state: Option<ChannelShutdownState>,
1517 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1518 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1520 /// This is a strict superset of `is_channel_ready`.
1521 pub is_usable: bool,
1522 /// True if this channel is (or will be) publicly-announced.
1523 pub is_public: bool,
1524 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1525 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1526 pub inbound_htlc_minimum_msat: Option<u64>,
1527 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1528 pub inbound_htlc_maximum_msat: Option<u64>,
1529 /// Set of configurable parameters that affect channel operation.
1531 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1532 pub config: Option<ChannelConfig>,
1535 impl ChannelDetails {
1536 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1537 /// This should be used for providing invoice hints or in any other context where our
1538 /// counterparty will forward a payment to us.
1540 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1541 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1542 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1543 self.inbound_scid_alias.or(self.short_channel_id)
1546 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1547 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1548 /// we're sending or forwarding a payment outbound over this channel.
1550 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1551 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1552 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1553 self.short_channel_id.or(self.outbound_scid_alias)
1556 fn from_channel_context<Signer: WriteableEcdsaChannelSigner, F: Deref>(
1557 context: &ChannelContext<Signer>, best_block_height: u32, latest_features: InitFeatures,
1558 fee_estimator: &LowerBoundedFeeEstimator<F>
1560 where F::Target: FeeEstimator
1562 let balance = context.get_available_balances(fee_estimator);
1563 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1564 context.get_holder_counterparty_selected_channel_reserve_satoshis();
1566 channel_id: context.channel_id(),
1567 counterparty: ChannelCounterparty {
1568 node_id: context.get_counterparty_node_id(),
1569 features: latest_features,
1570 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1571 forwarding_info: context.counterparty_forwarding_info(),
1572 // Ensures that we have actually received the `htlc_minimum_msat` value
1573 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1574 // message (as they are always the first message from the counterparty).
1575 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1576 // default `0` value set by `Channel::new_outbound`.
1577 outbound_htlc_minimum_msat: if context.have_received_message() {
1578 Some(context.get_counterparty_htlc_minimum_msat()) } else { None },
1579 outbound_htlc_maximum_msat: context.get_counterparty_htlc_maximum_msat(),
1581 funding_txo: context.get_funding_txo(),
1582 // Note that accept_channel (or open_channel) is always the first message, so
1583 // `have_received_message` indicates that type negotiation has completed.
1584 channel_type: if context.have_received_message() { Some(context.get_channel_type().clone()) } else { None },
1585 short_channel_id: context.get_short_channel_id(),
1586 outbound_scid_alias: if context.is_usable() { Some(context.outbound_scid_alias()) } else { None },
1587 inbound_scid_alias: context.latest_inbound_scid_alias(),
1588 channel_value_satoshis: context.get_value_satoshis(),
1589 feerate_sat_per_1000_weight: Some(context.get_feerate_sat_per_1000_weight()),
1590 unspendable_punishment_reserve: to_self_reserve_satoshis,
1591 balance_msat: balance.balance_msat,
1592 inbound_capacity_msat: balance.inbound_capacity_msat,
1593 outbound_capacity_msat: balance.outbound_capacity_msat,
1594 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1595 next_outbound_htlc_minimum_msat: balance.next_outbound_htlc_minimum_msat,
1596 user_channel_id: context.get_user_id(),
1597 confirmations_required: context.minimum_depth(),
1598 confirmations: Some(context.get_funding_tx_confirmations(best_block_height)),
1599 force_close_spend_delay: context.get_counterparty_selected_contest_delay(),
1600 is_outbound: context.is_outbound(),
1601 is_channel_ready: context.is_usable(),
1602 is_usable: context.is_live(),
1603 is_public: context.should_announce(),
1604 inbound_htlc_minimum_msat: Some(context.get_holder_htlc_minimum_msat()),
1605 inbound_htlc_maximum_msat: context.get_holder_htlc_maximum_msat(),
1606 config: Some(context.config()),
1607 channel_shutdown_state: Some(context.shutdown_state()),
1612 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
1613 /// Further information on the details of the channel shutdown.
1614 /// Upon channels being forced closed (i.e. commitment transaction confirmation detected
1615 /// by `ChainMonitor`), ChannelShutdownState will be set to `ShutdownComplete` or
1616 /// the channel will be removed shortly.
1617 /// Also note, that in normal operation, peers could disconnect at any of these states
1618 /// and require peer re-connection before making progress onto other states
1619 pub enum ChannelShutdownState {
1620 /// Channel has not sent or received a shutdown message.
1622 /// Local node has sent a shutdown message for this channel.
1624 /// Shutdown message exchanges have concluded and the channels are in the midst of
1625 /// resolving all existing open HTLCs before closing can continue.
1627 /// All HTLCs have been resolved, nodes are currently negotiating channel close onchain fee rates.
1628 NegotiatingClosingFee,
1629 /// We've successfully negotiated a closing_signed dance. At this point `ChannelManager` is about
1630 /// to drop the channel.
1634 /// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
1635 /// These include payments that have yet to find a successful path, or have unresolved HTLCs.
1636 #[derive(Debug, PartialEq)]
1637 pub enum RecentPaymentDetails {
1638 /// When a payment is still being sent and awaiting successful delivery.
1640 /// Hash of the payment that is currently being sent but has yet to be fulfilled or
1642 payment_hash: PaymentHash,
1643 /// Total amount (in msat, excluding fees) across all paths for this payment,
1644 /// not just the amount currently inflight.
1647 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
1648 /// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
1649 /// payment is removed from tracking.
1651 /// Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
1652 /// made before LDK version 0.0.104.
1653 payment_hash: Option<PaymentHash>,
1655 /// After a payment's retries are exhausted per the provided [`Retry`], or it is explicitly
1656 /// abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
1657 /// pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
1659 /// Hash of the payment that we have given up trying to send.
1660 payment_hash: PaymentHash,
1664 /// Route hints used in constructing invoices for [phantom node payents].
1666 /// [phantom node payments]: crate::sign::PhantomKeysManager
1668 pub struct PhantomRouteHints {
1669 /// The list of channels to be included in the invoice route hints.
1670 pub channels: Vec<ChannelDetails>,
1671 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1673 pub phantom_scid: u64,
1674 /// The pubkey of the real backing node that would ultimately receive the payment.
1675 pub real_node_pubkey: PublicKey,
1678 macro_rules! handle_error {
1679 ($self: ident, $internal: expr, $counterparty_node_id: expr) => { {
1680 // In testing, ensure there are no deadlocks where the lock is already held upon
1681 // entering the macro.
1682 debug_assert_ne!($self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
1683 debug_assert_ne!($self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
1687 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish, channel_capacity }) => {
1688 let mut msg_events = Vec::with_capacity(2);
1690 if let Some((shutdown_res, update_option)) = shutdown_finish {
1691 $self.finish_force_close_channel(shutdown_res);
1692 if let Some(update) = update_option {
1693 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1697 if let Some((channel_id, user_channel_id)) = chan_id {
1698 $self.pending_events.lock().unwrap().push_back((events::Event::ChannelClosed {
1699 channel_id, user_channel_id,
1700 reason: ClosureReason::ProcessingError { err: err.err.clone() },
1701 counterparty_node_id: Some($counterparty_node_id),
1702 channel_capacity_sats: channel_capacity,
1707 log_error!($self.logger, "{}", err.err);
1708 if let msgs::ErrorAction::IgnoreError = err.action {
1710 msg_events.push(events::MessageSendEvent::HandleError {
1711 node_id: $counterparty_node_id,
1712 action: err.action.clone()
1716 if !msg_events.is_empty() {
1717 let per_peer_state = $self.per_peer_state.read().unwrap();
1718 if let Some(peer_state_mutex) = per_peer_state.get(&$counterparty_node_id) {
1719 let mut peer_state = peer_state_mutex.lock().unwrap();
1720 peer_state.pending_msg_events.append(&mut msg_events);
1724 // Return error in case higher-API need one
1729 ($self: ident, $internal: expr) => {
1732 Err((chan, msg_handle_err)) => {
1733 let counterparty_node_id = chan.get_counterparty_node_id();
1734 handle_error!($self, Err(msg_handle_err), counterparty_node_id).map_err(|err| (chan, err))
1740 macro_rules! update_maps_on_chan_removal {
1741 ($self: expr, $channel_context: expr) => {{
1742 $self.id_to_peer.lock().unwrap().remove(&$channel_context.channel_id());
1743 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1744 if let Some(short_id) = $channel_context.get_short_channel_id() {
1745 short_to_chan_info.remove(&short_id);
1747 // If the channel was never confirmed on-chain prior to its closure, remove the
1748 // outbound SCID alias we used for it from the collision-prevention set. While we
1749 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1750 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1751 // opening a million channels with us which are closed before we ever reach the funding
1753 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel_context.outbound_scid_alias());
1754 debug_assert!(alias_removed);
1756 short_to_chan_info.remove(&$channel_context.outbound_scid_alias());
1760 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1761 macro_rules! convert_chan_err {
1762 ($self: ident, $err: expr, $channel: expr, $channel_id: expr) => {
1764 ChannelError::Warn(msg) => {
1765 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), $channel_id.clone()))
1767 ChannelError::Ignore(msg) => {
1768 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
1770 ChannelError::Close(msg) => {
1771 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
1772 update_maps_on_chan_removal!($self, &$channel.context);
1773 let shutdown_res = $channel.context.force_shutdown(true);
1774 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.context.get_user_id(),
1775 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok(), $channel.context.get_value_satoshis()))
1779 ($self: ident, $err: expr, $channel_context: expr, $channel_id: expr, UNFUNDED) => {
1781 // We should only ever have `ChannelError::Close` when unfunded channels error.
1782 // In any case, just close the channel.
1783 ChannelError::Warn(msg) | ChannelError::Ignore(msg) | ChannelError::Close(msg) => {
1784 log_error!($self.logger, "Closing unfunded channel {} due to an error: {}", log_bytes!($channel_id[..]), msg);
1785 update_maps_on_chan_removal!($self, &$channel_context);
1786 let shutdown_res = $channel_context.force_shutdown(false);
1787 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel_context.get_user_id(),
1788 shutdown_res, None, $channel_context.get_value_satoshis()))
1794 macro_rules! break_chan_entry {
1795 ($self: ident, $res: expr, $entry: expr) => {
1799 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1801 $entry.remove_entry();
1809 macro_rules! try_v1_outbound_chan_entry {
1810 ($self: ident, $res: expr, $entry: expr) => {
1814 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut().context, $entry.key(), UNFUNDED);
1816 $entry.remove_entry();
1824 macro_rules! try_chan_entry {
1825 ($self: ident, $res: expr, $entry: expr) => {
1829 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1831 $entry.remove_entry();
1839 macro_rules! remove_channel {
1840 ($self: expr, $entry: expr) => {
1842 let channel = $entry.remove_entry().1;
1843 update_maps_on_chan_removal!($self, &channel.context);
1849 macro_rules! send_channel_ready {
1850 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
1851 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1852 node_id: $channel.context.get_counterparty_node_id(),
1853 msg: $channel_ready_msg,
1855 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1856 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1857 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1858 let outbound_alias_insert = short_to_chan_info.insert($channel.context.outbound_scid_alias(), ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
1859 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
1860 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1861 if let Some(real_scid) = $channel.context.get_short_channel_id() {
1862 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
1863 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
1864 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1869 macro_rules! emit_channel_pending_event {
1870 ($locked_events: expr, $channel: expr) => {
1871 if $channel.context.should_emit_channel_pending_event() {
1872 $locked_events.push_back((events::Event::ChannelPending {
1873 channel_id: $channel.context.channel_id(),
1874 former_temporary_channel_id: $channel.context.temporary_channel_id(),
1875 counterparty_node_id: $channel.context.get_counterparty_node_id(),
1876 user_channel_id: $channel.context.get_user_id(),
1877 funding_txo: $channel.context.get_funding_txo().unwrap().into_bitcoin_outpoint(),
1879 $channel.context.set_channel_pending_event_emitted();
1884 macro_rules! emit_channel_ready_event {
1885 ($locked_events: expr, $channel: expr) => {
1886 if $channel.context.should_emit_channel_ready_event() {
1887 debug_assert!($channel.context.channel_pending_event_emitted());
1888 $locked_events.push_back((events::Event::ChannelReady {
1889 channel_id: $channel.context.channel_id(),
1890 user_channel_id: $channel.context.get_user_id(),
1891 counterparty_node_id: $channel.context.get_counterparty_node_id(),
1892 channel_type: $channel.context.get_channel_type().clone(),
1894 $channel.context.set_channel_ready_event_emitted();
1899 macro_rules! handle_monitor_update_completion {
1900 ($self: ident, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
1901 let mut updates = $chan.monitor_updating_restored(&$self.logger,
1902 &$self.node_signer, $self.genesis_hash, &$self.default_configuration,
1903 $self.best_block.read().unwrap().height());
1904 let counterparty_node_id = $chan.context.get_counterparty_node_id();
1905 let channel_update = if updates.channel_ready.is_some() && $chan.context.is_usable() {
1906 // We only send a channel_update in the case where we are just now sending a
1907 // channel_ready and the channel is in a usable state. We may re-send a
1908 // channel_update later through the announcement_signatures process for public
1909 // channels, but there's no reason not to just inform our counterparty of our fees
1911 if let Ok(msg) = $self.get_channel_update_for_unicast($chan) {
1912 Some(events::MessageSendEvent::SendChannelUpdate {
1913 node_id: counterparty_node_id,
1919 let update_actions = $peer_state.monitor_update_blocked_actions
1920 .remove(&$chan.context.channel_id()).unwrap_or(Vec::new());
1922 let htlc_forwards = $self.handle_channel_resumption(
1923 &mut $peer_state.pending_msg_events, $chan, updates.raa,
1924 updates.commitment_update, updates.order, updates.accepted_htlcs,
1925 updates.funding_broadcastable, updates.channel_ready,
1926 updates.announcement_sigs);
1927 if let Some(upd) = channel_update {
1928 $peer_state.pending_msg_events.push(upd);
1931 let channel_id = $chan.context.channel_id();
1932 core::mem::drop($peer_state_lock);
1933 core::mem::drop($per_peer_state_lock);
1935 $self.handle_monitor_update_completion_actions(update_actions);
1937 if let Some(forwards) = htlc_forwards {
1938 $self.forward_htlcs(&mut [forwards][..]);
1940 $self.finalize_claims(updates.finalized_claimed_htlcs);
1941 for failure in updates.failed_htlcs.drain(..) {
1942 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
1943 $self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
1948 macro_rules! handle_new_monitor_update {
1949 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr, _internal, $remove: expr, $completed: expr) => { {
1950 // update_maps_on_chan_removal needs to be able to take id_to_peer, so make sure we can in
1951 // any case so that it won't deadlock.
1952 debug_assert_ne!($self.id_to_peer.held_by_thread(), LockHeldState::HeldByThread);
1953 debug_assert!($self.background_events_processed_since_startup.load(Ordering::Acquire));
1955 ChannelMonitorUpdateStatus::InProgress => {
1956 log_debug!($self.logger, "ChannelMonitor update for {} in flight, holding messages until the update completes.",
1957 log_bytes!($chan.context.channel_id()[..]));
1960 ChannelMonitorUpdateStatus::PermanentFailure => {
1961 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateStatus::PermanentFailure",
1962 log_bytes!($chan.context.channel_id()[..]));
1963 update_maps_on_chan_removal!($self, &$chan.context);
1964 let res = Err(MsgHandleErrInternal::from_finish_shutdown(
1965 "ChannelMonitor storage failure".to_owned(), $chan.context.channel_id(),
1966 $chan.context.get_user_id(), $chan.context.force_shutdown(false),
1967 $self.get_channel_update_for_broadcast(&$chan).ok(), $chan.context.get_value_satoshis()));
1971 ChannelMonitorUpdateStatus::Completed => {
1977 ($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) => {
1978 handle_new_monitor_update!($self, $update_res, $peer_state_lock, $peer_state,
1979 $per_peer_state_lock, $chan, _internal, $remove,
1980 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan))
1982 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan_entry: expr, INITIAL_MONITOR) => {
1983 handle_new_monitor_update!($self, $update_res, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan_entry.get_mut(), MANUALLY_REMOVING_INITIAL_MONITOR, $chan_entry.remove_entry())
1985 ($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) => { {
1986 let in_flight_updates = $peer_state.in_flight_monitor_updates.entry($funding_txo)
1987 .or_insert_with(Vec::new);
1988 // During startup, we push monitor updates as background events through to here in
1989 // order to replay updates that were in-flight when we shut down. Thus, we have to
1990 // filter for uniqueness here.
1991 let idx = in_flight_updates.iter().position(|upd| upd == &$update)
1992 .unwrap_or_else(|| {
1993 in_flight_updates.push($update);
1994 in_flight_updates.len() - 1
1996 let update_res = $self.chain_monitor.update_channel($funding_txo, &in_flight_updates[idx]);
1997 handle_new_monitor_update!($self, update_res, $peer_state_lock, $peer_state,
1998 $per_peer_state_lock, $chan, _internal, $remove,
2000 let _ = in_flight_updates.remove(idx);
2001 if in_flight_updates.is_empty() && $chan.blocked_monitor_updates_pending() == 0 {
2002 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan);
2006 ($self: ident, $funding_txo: expr, $update: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan_entry: expr) => {
2007 handle_new_monitor_update!($self, $funding_txo, $update, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan_entry.get_mut(), MANUALLY_REMOVING, $chan_entry.remove_entry())
2011 macro_rules! process_events_body {
2012 ($self: expr, $event_to_handle: expr, $handle_event: expr) => {
2013 let mut processed_all_events = false;
2014 while !processed_all_events {
2015 if $self.pending_events_processor.compare_exchange(false, true, Ordering::Acquire, Ordering::Relaxed).is_err() {
2019 let mut result = NotifyOption::SkipPersist;
2022 // We'll acquire our total consistency lock so that we can be sure no other
2023 // persists happen while processing monitor events.
2024 let _read_guard = $self.total_consistency_lock.read().unwrap();
2026 // Because `handle_post_event_actions` may send `ChannelMonitorUpdate`s to the user we must
2027 // ensure any startup-generated background events are handled first.
2028 if $self.process_background_events() == NotifyOption::DoPersist { result = NotifyOption::DoPersist; }
2030 // TODO: This behavior should be documented. It's unintuitive that we query
2031 // ChannelMonitors when clearing other events.
2032 if $self.process_pending_monitor_events() {
2033 result = NotifyOption::DoPersist;
2037 let pending_events = $self.pending_events.lock().unwrap().clone();
2038 let num_events = pending_events.len();
2039 if !pending_events.is_empty() {
2040 result = NotifyOption::DoPersist;
2043 let mut post_event_actions = Vec::new();
2045 for (event, action_opt) in pending_events {
2046 $event_to_handle = event;
2048 if let Some(action) = action_opt {
2049 post_event_actions.push(action);
2054 let mut pending_events = $self.pending_events.lock().unwrap();
2055 pending_events.drain(..num_events);
2056 processed_all_events = pending_events.is_empty();
2057 // Note that `push_pending_forwards_ev` relies on `pending_events_processor` being
2058 // updated here with the `pending_events` lock acquired.
2059 $self.pending_events_processor.store(false, Ordering::Release);
2062 if !post_event_actions.is_empty() {
2063 $self.handle_post_event_actions(post_event_actions);
2064 // If we had some actions, go around again as we may have more events now
2065 processed_all_events = false;
2068 if result == NotifyOption::DoPersist {
2069 $self.persistence_notifier.notify();
2075 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>
2077 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
2078 T::Target: BroadcasterInterface,
2079 ES::Target: EntropySource,
2080 NS::Target: NodeSigner,
2081 SP::Target: SignerProvider,
2082 F::Target: FeeEstimator,
2086 /// Constructs a new `ChannelManager` to hold several channels and route between them.
2088 /// The current time or latest block header time can be provided as the `current_timestamp`.
2090 /// This is the main "logic hub" for all channel-related actions, and implements
2091 /// [`ChannelMessageHandler`].
2093 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
2095 /// Users need to notify the new `ChannelManager` when a new block is connected or
2096 /// disconnected using its [`block_connected`] and [`block_disconnected`] methods, starting
2097 /// from after [`params.best_block.block_hash`]. See [`chain::Listen`] and [`chain::Confirm`] for
2100 /// [`block_connected`]: chain::Listen::block_connected
2101 /// [`block_disconnected`]: chain::Listen::block_disconnected
2102 /// [`params.best_block.block_hash`]: chain::BestBlock::block_hash
2104 fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, entropy_source: ES,
2105 node_signer: NS, signer_provider: SP, config: UserConfig, params: ChainParameters,
2106 current_timestamp: u32,
2108 let mut secp_ctx = Secp256k1::new();
2109 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
2110 let inbound_pmt_key_material = node_signer.get_inbound_payment_key_material();
2111 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
2113 default_configuration: config.clone(),
2114 genesis_hash: genesis_block(params.network).header.block_hash(),
2115 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
2120 best_block: RwLock::new(params.best_block),
2122 outbound_scid_aliases: Mutex::new(HashSet::new()),
2123 pending_inbound_payments: Mutex::new(HashMap::new()),
2124 pending_outbound_payments: OutboundPayments::new(),
2125 forward_htlcs: Mutex::new(HashMap::new()),
2126 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments: HashMap::new(), pending_claiming_payments: HashMap::new() }),
2127 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
2128 id_to_peer: Mutex::new(HashMap::new()),
2129 short_to_chan_info: FairRwLock::new(HashMap::new()),
2131 our_network_pubkey: node_signer.get_node_id(Recipient::Node).unwrap(),
2134 inbound_payment_key: expanded_inbound_key,
2135 fake_scid_rand_bytes: entropy_source.get_secure_random_bytes(),
2137 probing_cookie_secret: entropy_source.get_secure_random_bytes(),
2139 highest_seen_timestamp: AtomicUsize::new(current_timestamp as usize),
2141 per_peer_state: FairRwLock::new(HashMap::new()),
2143 pending_events: Mutex::new(VecDeque::new()),
2144 pending_events_processor: AtomicBool::new(false),
2145 pending_background_events: Mutex::new(Vec::new()),
2146 total_consistency_lock: RwLock::new(()),
2147 background_events_processed_since_startup: AtomicBool::new(false),
2148 persistence_notifier: Notifier::new(),
2158 /// Gets the current configuration applied to all new channels.
2159 pub fn get_current_default_configuration(&self) -> &UserConfig {
2160 &self.default_configuration
2163 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
2164 let height = self.best_block.read().unwrap().height();
2165 let mut outbound_scid_alias = 0;
2168 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
2169 outbound_scid_alias += 1;
2171 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
2173 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
2177 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"); }
2182 /// Creates a new outbound channel to the given remote node and with the given value.
2184 /// `user_channel_id` will be provided back as in
2185 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
2186 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
2187 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
2188 /// is simply copied to events and otherwise ignored.
2190 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
2191 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
2193 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be opened due to failing to
2194 /// generate a shutdown scriptpubkey or destination script set by
2195 /// [`SignerProvider::get_shutdown_scriptpubkey`] or [`SignerProvider::get_destination_script`].
2197 /// Note that we do not check if you are currently connected to the given peer. If no
2198 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
2199 /// the channel eventually being silently forgotten (dropped on reload).
2201 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
2202 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
2203 /// [`ChannelDetails::channel_id`] until after
2204 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
2205 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
2206 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
2208 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
2209 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
2210 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
2211 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_channel_id: u128, override_config: Option<UserConfig>) -> Result<[u8; 32], APIError> {
2212 if channel_value_satoshis < 1000 {
2213 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
2216 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2217 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
2218 debug_assert!(&self.total_consistency_lock.try_write().is_err());
2220 let per_peer_state = self.per_peer_state.read().unwrap();
2222 let peer_state_mutex = per_peer_state.get(&their_network_key)
2223 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Not connected to node: {}", their_network_key) })?;
2225 let mut peer_state = peer_state_mutex.lock().unwrap();
2227 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
2228 let their_features = &peer_state.latest_features;
2229 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
2230 match OutboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider, their_network_key,
2231 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
2232 self.best_block.read().unwrap().height(), outbound_scid_alias)
2236 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
2241 let res = channel.get_open_channel(self.genesis_hash.clone());
2243 let temporary_channel_id = channel.context.channel_id();
2244 match peer_state.outbound_v1_channel_by_id.entry(temporary_channel_id) {
2245 hash_map::Entry::Occupied(_) => {
2247 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
2249 panic!("RNG is bad???");
2252 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
2255 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
2256 node_id: their_network_key,
2259 Ok(temporary_channel_id)
2262 fn list_funded_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<<SP::Target as SignerProvider>::Signer>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
2263 // Allocate our best estimate of the number of channels we have in the `res`
2264 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2265 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2266 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2267 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2268 // the same channel.
2269 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2271 let best_block_height = self.best_block.read().unwrap().height();
2272 let per_peer_state = self.per_peer_state.read().unwrap();
2273 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2274 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2275 let peer_state = &mut *peer_state_lock;
2276 // Only `Channels` in the channel_by_id map can be considered funded.
2277 for (_channel_id, channel) in peer_state.channel_by_id.iter().filter(f) {
2278 let details = ChannelDetails::from_channel_context(&channel.context, best_block_height,
2279 peer_state.latest_features.clone(), &self.fee_estimator);
2287 /// Gets the list of open channels, in random order. See [`ChannelDetails`] field documentation for
2288 /// more information.
2289 pub fn list_channels(&self) -> Vec<ChannelDetails> {
2290 // Allocate our best estimate of the number of channels we have in the `res`
2291 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2292 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2293 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2294 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2295 // the same channel.
2296 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2298 let best_block_height = self.best_block.read().unwrap().height();
2299 let per_peer_state = self.per_peer_state.read().unwrap();
2300 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2301 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2302 let peer_state = &mut *peer_state_lock;
2303 for (_channel_id, channel) in peer_state.channel_by_id.iter() {
2304 let details = ChannelDetails::from_channel_context(&channel.context, best_block_height,
2305 peer_state.latest_features.clone(), &self.fee_estimator);
2308 for (_channel_id, channel) in peer_state.inbound_v1_channel_by_id.iter() {
2309 let details = ChannelDetails::from_channel_context(&channel.context, best_block_height,
2310 peer_state.latest_features.clone(), &self.fee_estimator);
2313 for (_channel_id, channel) in peer_state.outbound_v1_channel_by_id.iter() {
2314 let details = ChannelDetails::from_channel_context(&channel.context, best_block_height,
2315 peer_state.latest_features.clone(), &self.fee_estimator);
2323 /// Gets the list of usable channels, in random order. Useful as an argument to
2324 /// [`Router::find_route`] to ensure non-announced channels are used.
2326 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
2327 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
2329 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
2330 // Note we use is_live here instead of usable which leads to somewhat confused
2331 // internal/external nomenclature, but that's ok cause that's probably what the user
2332 // really wanted anyway.
2333 self.list_funded_channels_with_filter(|&(_, ref channel)| channel.context.is_live())
2336 /// Gets the list of channels we have with a given counterparty, in random order.
2337 pub fn list_channels_with_counterparty(&self, counterparty_node_id: &PublicKey) -> Vec<ChannelDetails> {
2338 let best_block_height = self.best_block.read().unwrap().height();
2339 let per_peer_state = self.per_peer_state.read().unwrap();
2341 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
2342 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2343 let peer_state = &mut *peer_state_lock;
2344 let features = &peer_state.latest_features;
2345 let chan_context_to_details = |context| {
2346 ChannelDetails::from_channel_context(context, best_block_height, features.clone(), &self.fee_estimator)
2348 return peer_state.channel_by_id
2350 .map(|(_, channel)| &channel.context)
2351 .chain(peer_state.outbound_v1_channel_by_id.iter().map(|(_, channel)| &channel.context))
2352 .chain(peer_state.inbound_v1_channel_by_id.iter().map(|(_, channel)| &channel.context))
2353 .map(chan_context_to_details)
2359 /// Returns in an undefined order recent payments that -- if not fulfilled -- have yet to find a
2360 /// successful path, or have unresolved HTLCs.
2362 /// This can be useful for payments that may have been prepared, but ultimately not sent, as a
2363 /// result of a crash. If such a payment exists, is not listed here, and an
2364 /// [`Event::PaymentSent`] has not been received, you may consider resending the payment.
2366 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2367 pub fn list_recent_payments(&self) -> Vec<RecentPaymentDetails> {
2368 self.pending_outbound_payments.pending_outbound_payments.lock().unwrap().iter()
2369 .filter_map(|(_, pending_outbound_payment)| match pending_outbound_payment {
2370 PendingOutboundPayment::Retryable { payment_hash, total_msat, .. } => {
2371 Some(RecentPaymentDetails::Pending {
2372 payment_hash: *payment_hash,
2373 total_msat: *total_msat,
2376 PendingOutboundPayment::Abandoned { payment_hash, .. } => {
2377 Some(RecentPaymentDetails::Abandoned { payment_hash: *payment_hash })
2379 PendingOutboundPayment::Fulfilled { payment_hash, .. } => {
2380 Some(RecentPaymentDetails::Fulfilled { payment_hash: *payment_hash })
2382 PendingOutboundPayment::Legacy { .. } => None
2387 /// Helper function that issues the channel close events
2388 fn issue_channel_close_events(&self, context: &ChannelContext<<SP::Target as SignerProvider>::Signer>, closure_reason: ClosureReason) {
2389 let mut pending_events_lock = self.pending_events.lock().unwrap();
2390 match context.unbroadcasted_funding() {
2391 Some(transaction) => {
2392 pending_events_lock.push_back((events::Event::DiscardFunding {
2393 channel_id: context.channel_id(), transaction
2398 pending_events_lock.push_back((events::Event::ChannelClosed {
2399 channel_id: context.channel_id(),
2400 user_channel_id: context.get_user_id(),
2401 reason: closure_reason,
2402 counterparty_node_id: Some(context.get_counterparty_node_id()),
2403 channel_capacity_sats: Some(context.get_value_satoshis()),
2407 fn close_channel_internal(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>, override_shutdown_script: Option<ShutdownScript>) -> Result<(), APIError> {
2408 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2410 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
2411 let result: Result<(), _> = loop {
2413 let per_peer_state = self.per_peer_state.read().unwrap();
2415 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2416 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2418 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2419 let peer_state = &mut *peer_state_lock;
2421 match peer_state.channel_by_id.entry(channel_id.clone()) {
2422 hash_map::Entry::Occupied(mut chan_entry) => {
2423 let funding_txo_opt = chan_entry.get().context.get_funding_txo();
2424 let their_features = &peer_state.latest_features;
2425 let (shutdown_msg, mut monitor_update_opt, htlcs) = chan_entry.get_mut()
2426 .get_shutdown(&self.signer_provider, their_features, target_feerate_sats_per_1000_weight, override_shutdown_script)?;
2427 failed_htlcs = htlcs;
2429 // We can send the `shutdown` message before updating the `ChannelMonitor`
2430 // here as we don't need the monitor update to complete until we send a
2431 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
2432 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2433 node_id: *counterparty_node_id,
2437 // Update the monitor with the shutdown script if necessary.
2438 if let Some(monitor_update) = monitor_update_opt.take() {
2439 break handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
2440 peer_state_lock, peer_state, per_peer_state, chan_entry).map(|_| ());
2443 if chan_entry.get().is_shutdown() {
2444 let channel = remove_channel!(self, chan_entry);
2445 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
2446 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2450 self.issue_channel_close_events(&channel.context, ClosureReason::HolderForceClosed);
2454 hash_map::Entry::Vacant(_) => (),
2457 // If we reach this point, it means that the channel_id either refers to an unfunded channel or
2458 // it does not exist for this peer. Either way, we can attempt to force-close it.
2460 // An appropriate error will be returned for non-existence of the channel if that's the case.
2461 return self.force_close_channel_with_peer(&channel_id, counterparty_node_id, None, false).map(|_| ())
2462 // TODO(dunxen): This is still not ideal as we're doing some extra lookups.
2463 // Fix this with https://github.com/lightningdevkit/rust-lightning/issues/2422
2466 for htlc_source in failed_htlcs.drain(..) {
2467 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2468 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
2469 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
2472 let _ = handle_error!(self, result, *counterparty_node_id);
2476 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2477 /// will be accepted on the given channel, and after additional timeout/the closing of all
2478 /// pending HTLCs, the channel will be closed on chain.
2480 /// * If we are the channel initiator, we will pay between our [`Background`] and
2481 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
2483 /// * If our counterparty is the channel initiator, we will require a channel closing
2484 /// transaction feerate of at least our [`Background`] feerate or the feerate which
2485 /// would appear on a force-closure transaction, whichever is lower. We will allow our
2486 /// counterparty to pay as much fee as they'd like, however.
2488 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2490 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2491 /// generate a shutdown scriptpubkey or destination script set by
2492 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2495 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2496 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
2497 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
2498 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2499 pub fn close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
2500 self.close_channel_internal(channel_id, counterparty_node_id, None, None)
2503 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2504 /// will be accepted on the given channel, and after additional timeout/the closing of all
2505 /// pending HTLCs, the channel will be closed on chain.
2507 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
2508 /// the channel being closed or not:
2509 /// * If we are the channel initiator, we will pay at least this feerate on the closing
2510 /// transaction. The upper-bound is set by
2511 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
2512 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
2513 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
2514 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
2515 /// will appear on a force-closure transaction, whichever is lower).
2517 /// The `shutdown_script` provided will be used as the `scriptPubKey` for the closing transaction.
2518 /// Will fail if a shutdown script has already been set for this channel by
2519 /// ['ChannelHandshakeConfig::commit_upfront_shutdown_pubkey`]. The given shutdown script must
2520 /// also be compatible with our and the counterparty's features.
2522 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2524 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2525 /// generate a shutdown scriptpubkey or destination script set by
2526 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2529 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2530 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
2531 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
2532 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2533 pub fn close_channel_with_feerate_and_script(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>, shutdown_script: Option<ShutdownScript>) -> Result<(), APIError> {
2534 self.close_channel_internal(channel_id, counterparty_node_id, target_feerate_sats_per_1000_weight, shutdown_script)
2538 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
2539 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
2540 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
2541 for htlc_source in failed_htlcs.drain(..) {
2542 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
2543 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2544 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2545 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
2547 if let Some((_, funding_txo, monitor_update)) = monitor_update_option {
2548 // There isn't anything we can do if we get an update failure - we're already
2549 // force-closing. The monitor update on the required in-memory copy should broadcast
2550 // the latest local state, which is the best we can do anyway. Thus, it is safe to
2551 // ignore the result here.
2552 let _ = self.chain_monitor.update_channel(funding_txo, &monitor_update);
2556 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
2557 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
2558 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
2559 -> Result<PublicKey, APIError> {
2560 let per_peer_state = self.per_peer_state.read().unwrap();
2561 let peer_state_mutex = per_peer_state.get(peer_node_id)
2562 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", peer_node_id) })?;
2563 let (update_opt, counterparty_node_id) = {
2564 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2565 let peer_state = &mut *peer_state_lock;
2566 let closure_reason = if let Some(peer_msg) = peer_msg {
2567 ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(peer_msg.to_string()) }
2569 ClosureReason::HolderForceClosed
2571 if let hash_map::Entry::Occupied(chan) = peer_state.channel_by_id.entry(channel_id.clone()) {
2572 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
2573 self.issue_channel_close_events(&chan.get().context, closure_reason);
2574 let mut chan = remove_channel!(self, chan);
2575 self.finish_force_close_channel(chan.context.force_shutdown(broadcast));
2576 (self.get_channel_update_for_broadcast(&chan).ok(), chan.context.get_counterparty_node_id())
2577 } else if let hash_map::Entry::Occupied(chan) = peer_state.outbound_v1_channel_by_id.entry(channel_id.clone()) {
2578 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
2579 self.issue_channel_close_events(&chan.get().context, closure_reason);
2580 let mut chan = remove_channel!(self, chan);
2581 self.finish_force_close_channel(chan.context.force_shutdown(false));
2582 // Unfunded channel has no update
2583 (None, chan.context.get_counterparty_node_id())
2584 } else if let hash_map::Entry::Occupied(chan) = peer_state.inbound_v1_channel_by_id.entry(channel_id.clone()) {
2585 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
2586 self.issue_channel_close_events(&chan.get().context, closure_reason);
2587 let mut chan = remove_channel!(self, chan);
2588 self.finish_force_close_channel(chan.context.force_shutdown(false));
2589 // Unfunded channel has no update
2590 (None, chan.context.get_counterparty_node_id())
2592 return Err(APIError::ChannelUnavailable{ err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*channel_id), peer_node_id) });
2595 if let Some(update) = update_opt {
2596 let mut peer_state = peer_state_mutex.lock().unwrap();
2597 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2602 Ok(counterparty_node_id)
2605 fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
2606 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2607 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
2608 Ok(counterparty_node_id) => {
2609 let per_peer_state = self.per_peer_state.read().unwrap();
2610 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2611 let mut peer_state = peer_state_mutex.lock().unwrap();
2612 peer_state.pending_msg_events.push(
2613 events::MessageSendEvent::HandleError {
2614 node_id: counterparty_node_id,
2615 action: msgs::ErrorAction::SendErrorMessage {
2616 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
2627 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
2628 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
2629 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
2631 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
2632 -> Result<(), APIError> {
2633 self.force_close_sending_error(channel_id, counterparty_node_id, true)
2636 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
2637 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
2638 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
2640 /// You can always get the latest local transaction(s) to broadcast from
2641 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
2642 pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
2643 -> Result<(), APIError> {
2644 self.force_close_sending_error(channel_id, counterparty_node_id, false)
2647 /// Force close all channels, immediately broadcasting the latest local commitment transaction
2648 /// for each to the chain and rejecting new HTLCs on each.
2649 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
2650 for chan in self.list_channels() {
2651 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
2655 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
2656 /// local transaction(s).
2657 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
2658 for chan in self.list_channels() {
2659 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
2663 fn construct_fwd_pending_htlc_info(
2664 &self, msg: &msgs::UpdateAddHTLC, hop_data: msgs::InboundOnionPayload, hop_hmac: [u8; 32],
2665 new_packet_bytes: [u8; onion_utils::ONION_DATA_LEN], shared_secret: [u8; 32],
2666 next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
2667 ) -> Result<PendingHTLCInfo, InboundOnionErr> {
2668 debug_assert!(next_packet_pubkey_opt.is_some());
2669 let outgoing_packet = msgs::OnionPacket {
2671 public_key: next_packet_pubkey_opt.unwrap_or(Err(secp256k1::Error::InvalidPublicKey)),
2672 hop_data: new_packet_bytes,
2676 let (short_channel_id, amt_to_forward, outgoing_cltv_value) = match hop_data {
2677 msgs::InboundOnionPayload::Forward { short_channel_id, amt_to_forward, outgoing_cltv_value } =>
2678 (short_channel_id, amt_to_forward, outgoing_cltv_value),
2679 msgs::InboundOnionPayload::Receive { .. } =>
2680 return Err(InboundOnionErr {
2681 msg: "Final Node OnionHopData provided for us as an intermediary node",
2682 err_code: 0x4000 | 22,
2683 err_data: Vec::new(),
2687 Ok(PendingHTLCInfo {
2688 routing: PendingHTLCRouting::Forward {
2689 onion_packet: outgoing_packet,
2692 payment_hash: msg.payment_hash,
2693 incoming_shared_secret: shared_secret,
2694 incoming_amt_msat: Some(msg.amount_msat),
2695 outgoing_amt_msat: amt_to_forward,
2696 outgoing_cltv_value,
2697 skimmed_fee_msat: None,
2701 fn construct_recv_pending_htlc_info(
2702 &self, hop_data: msgs::InboundOnionPayload, shared_secret: [u8; 32], payment_hash: PaymentHash,
2703 amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>, allow_underpay: bool,
2704 counterparty_skimmed_fee_msat: Option<u64>,
2705 ) -> Result<PendingHTLCInfo, InboundOnionErr> {
2706 let (payment_data, keysend_preimage, custom_tlvs, onion_amt_msat, outgoing_cltv_value, payment_metadata) = match hop_data {
2707 msgs::InboundOnionPayload::Receive {
2708 payment_data, keysend_preimage, custom_tlvs, amt_msat, outgoing_cltv_value, payment_metadata, ..
2710 (payment_data, keysend_preimage, custom_tlvs, amt_msat, outgoing_cltv_value, payment_metadata),
2712 return Err(InboundOnionErr {
2713 err_code: 0x4000|22,
2714 err_data: Vec::new(),
2715 msg: "Got non final data with an HMAC of 0",
2718 // final_incorrect_cltv_expiry
2719 if outgoing_cltv_value > cltv_expiry {
2720 return Err(InboundOnionErr {
2721 msg: "Upstream node set CLTV to less than the CLTV set by the sender",
2723 err_data: cltv_expiry.to_be_bytes().to_vec()
2726 // final_expiry_too_soon
2727 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
2728 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
2730 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
2731 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
2732 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
2733 let current_height: u32 = self.best_block.read().unwrap().height();
2734 if (outgoing_cltv_value as u64) <= current_height as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
2735 let mut err_data = Vec::with_capacity(12);
2736 err_data.extend_from_slice(&amt_msat.to_be_bytes());
2737 err_data.extend_from_slice(¤t_height.to_be_bytes());
2738 return Err(InboundOnionErr {
2739 err_code: 0x4000 | 15, err_data,
2740 msg: "The final CLTV expiry is too soon to handle",
2743 if (!allow_underpay && onion_amt_msat > amt_msat) ||
2744 (allow_underpay && onion_amt_msat >
2745 amt_msat.saturating_add(counterparty_skimmed_fee_msat.unwrap_or(0)))
2747 return Err(InboundOnionErr {
2749 err_data: amt_msat.to_be_bytes().to_vec(),
2750 msg: "Upstream node sent less than we were supposed to receive in payment",
2754 let routing = if let Some(payment_preimage) = keysend_preimage {
2755 // We need to check that the sender knows the keysend preimage before processing this
2756 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
2757 // could discover the final destination of X, by probing the adjacent nodes on the route
2758 // with a keysend payment of identical payment hash to X and observing the processing
2759 // time discrepancies due to a hash collision with X.
2760 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2761 if hashed_preimage != payment_hash {
2762 return Err(InboundOnionErr {
2763 err_code: 0x4000|22,
2764 err_data: Vec::new(),
2765 msg: "Payment preimage didn't match payment hash",
2768 if !self.default_configuration.accept_mpp_keysend && payment_data.is_some() {
2769 return Err(InboundOnionErr {
2770 err_code: 0x4000|22,
2771 err_data: Vec::new(),
2772 msg: "We don't support MPP keysend payments",
2775 PendingHTLCRouting::ReceiveKeysend {
2779 incoming_cltv_expiry: outgoing_cltv_value,
2782 } else if let Some(data) = payment_data {
2783 PendingHTLCRouting::Receive {
2786 incoming_cltv_expiry: outgoing_cltv_value,
2787 phantom_shared_secret,
2791 return Err(InboundOnionErr {
2792 err_code: 0x4000|0x2000|3,
2793 err_data: Vec::new(),
2794 msg: "We require payment_secrets",
2797 Ok(PendingHTLCInfo {
2800 incoming_shared_secret: shared_secret,
2801 incoming_amt_msat: Some(amt_msat),
2802 outgoing_amt_msat: onion_amt_msat,
2803 outgoing_cltv_value,
2804 skimmed_fee_msat: counterparty_skimmed_fee_msat,
2808 fn decode_update_add_htlc_onion(
2809 &self, msg: &msgs::UpdateAddHTLC
2810 ) -> Result<(onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg> {
2811 macro_rules! return_malformed_err {
2812 ($msg: expr, $err_code: expr) => {
2814 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2815 return Err(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
2816 channel_id: msg.channel_id,
2817 htlc_id: msg.htlc_id,
2818 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
2819 failure_code: $err_code,
2825 if let Err(_) = msg.onion_routing_packet.public_key {
2826 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2829 let shared_secret = self.node_signer.ecdh(
2830 Recipient::Node, &msg.onion_routing_packet.public_key.unwrap(), None
2831 ).unwrap().secret_bytes();
2833 if msg.onion_routing_packet.version != 0 {
2834 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2835 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2836 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2837 //receiving node would have to brute force to figure out which version was put in the
2838 //packet by the node that send us the message, in the case of hashing the hop_data, the
2839 //node knows the HMAC matched, so they already know what is there...
2840 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2842 macro_rules! return_err {
2843 ($msg: expr, $err_code: expr, $data: expr) => {
2845 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2846 return Err(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2847 channel_id: msg.channel_id,
2848 htlc_id: msg.htlc_id,
2849 reason: HTLCFailReason::reason($err_code, $data.to_vec())
2850 .get_encrypted_failure_packet(&shared_secret, &None),
2856 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) {
2858 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2859 return_malformed_err!(err_msg, err_code);
2861 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2862 return_err!(err_msg, err_code, &[0; 0]);
2865 let (outgoing_scid, outgoing_amt_msat, outgoing_cltv_value, next_packet_pk_opt) = match next_hop {
2866 onion_utils::Hop::Forward {
2867 next_hop_data: msgs::InboundOnionPayload::Forward {
2868 short_channel_id, amt_to_forward, outgoing_cltv_value
2871 let next_packet_pk = onion_utils::next_hop_pubkey(&self.secp_ctx,
2872 msg.onion_routing_packet.public_key.unwrap(), &shared_secret);
2873 (short_channel_id, amt_to_forward, outgoing_cltv_value, Some(next_packet_pk))
2875 // We'll do receive checks in [`Self::construct_pending_htlc_info`] so we have access to the
2876 // inbound channel's state.
2877 onion_utils::Hop::Receive { .. } => return Ok((next_hop, shared_secret, None)),
2878 onion_utils::Hop::Forward { next_hop_data: msgs::InboundOnionPayload::Receive { .. }, .. } => {
2879 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0; 0]);
2883 // Perform outbound checks here instead of in [`Self::construct_pending_htlc_info`] because we
2884 // can't hold the outbound peer state lock at the same time as the inbound peer state lock.
2885 if let Some((err, mut code, chan_update)) = loop {
2886 let id_option = self.short_to_chan_info.read().unwrap().get(&outgoing_scid).cloned();
2887 let forwarding_chan_info_opt = match id_option {
2888 None => { // unknown_next_peer
2889 // Note that this is likely a timing oracle for detecting whether an scid is a
2890 // phantom or an intercept.
2891 if (self.default_configuration.accept_intercept_htlcs &&
2892 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, outgoing_scid, &self.genesis_hash)) ||
2893 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, outgoing_scid, &self.genesis_hash)
2897 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2900 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
2902 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
2903 let per_peer_state = self.per_peer_state.read().unwrap();
2904 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
2905 if peer_state_mutex_opt.is_none() {
2906 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2908 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
2909 let peer_state = &mut *peer_state_lock;
2910 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id) {
2912 // Channel was removed. The short_to_chan_info and channel_by_id maps
2913 // have no consistency guarantees.
2914 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2918 if !chan.context.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
2919 // Note that the behavior here should be identical to the above block - we
2920 // should NOT reveal the existence or non-existence of a private channel if
2921 // we don't allow forwards outbound over them.
2922 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
2924 if chan.context.get_channel_type().supports_scid_privacy() && outgoing_scid != chan.context.outbound_scid_alias() {
2925 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
2926 // "refuse to forward unless the SCID alias was used", so we pretend
2927 // we don't have the channel here.
2928 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
2930 let chan_update_opt = self.get_channel_update_for_onion(outgoing_scid, chan).ok();
2932 // Note that we could technically not return an error yet here and just hope
2933 // that the connection is reestablished or monitor updated by the time we get
2934 // around to doing the actual forward, but better to fail early if we can and
2935 // hopefully an attacker trying to path-trace payments cannot make this occur
2936 // on a small/per-node/per-channel scale.
2937 if !chan.context.is_live() { // channel_disabled
2938 // If the channel_update we're going to return is disabled (i.e. the
2939 // peer has been disabled for some time), return `channel_disabled`,
2940 // otherwise return `temporary_channel_failure`.
2941 if chan_update_opt.as_ref().map(|u| u.contents.flags & 2 == 2).unwrap_or(false) {
2942 break Some(("Forwarding channel has been disconnected for some time.", 0x1000 | 20, chan_update_opt));
2944 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 7, chan_update_opt));
2947 if outgoing_amt_msat < chan.context.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
2948 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
2950 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, outgoing_amt_msat, outgoing_cltv_value) {
2951 break Some((err, code, chan_update_opt));
2955 if (msg.cltv_expiry as u64) < (outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 {
2956 // We really should set `incorrect_cltv_expiry` here but as we're not
2957 // forwarding over a real channel we can't generate a channel_update
2958 // for it. Instead we just return a generic temporary_node_failure.
2960 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
2967 let cur_height = self.best_block.read().unwrap().height() + 1;
2968 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
2969 // but we want to be robust wrt to counterparty packet sanitization (see
2970 // HTLC_FAIL_BACK_BUFFER rationale).
2971 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
2972 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
2974 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
2975 break Some(("CLTV expiry is too far in the future", 21, None));
2977 // If the HTLC expires ~now, don't bother trying to forward it to our
2978 // counterparty. They should fail it anyway, but we don't want to bother with
2979 // the round-trips or risk them deciding they definitely want the HTLC and
2980 // force-closing to ensure they get it if we're offline.
2981 // We previously had a much more aggressive check here which tried to ensure
2982 // our counterparty receives an HTLC which has *our* risk threshold met on it,
2983 // but there is no need to do that, and since we're a bit conservative with our
2984 // risk threshold it just results in failing to forward payments.
2985 if (outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
2986 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
2992 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
2993 if let Some(chan_update) = chan_update {
2994 if code == 0x1000 | 11 || code == 0x1000 | 12 {
2995 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
2997 else if code == 0x1000 | 13 {
2998 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
3000 else if code == 0x1000 | 20 {
3001 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
3002 0u16.write(&mut res).expect("Writes cannot fail");
3004 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
3005 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
3006 chan_update.write(&mut res).expect("Writes cannot fail");
3007 } else if code & 0x1000 == 0x1000 {
3008 // If we're trying to return an error that requires a `channel_update` but
3009 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
3010 // generate an update), just use the generic "temporary_node_failure"
3014 return_err!(err, code, &res.0[..]);
3016 Ok((next_hop, shared_secret, next_packet_pk_opt))
3019 fn construct_pending_htlc_status<'a>(
3020 &self, msg: &msgs::UpdateAddHTLC, shared_secret: [u8; 32], decoded_hop: onion_utils::Hop,
3021 allow_underpay: bool, next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
3022 ) -> PendingHTLCStatus {
3023 macro_rules! return_err {
3024 ($msg: expr, $err_code: expr, $data: expr) => {
3026 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3027 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3028 channel_id: msg.channel_id,
3029 htlc_id: msg.htlc_id,
3030 reason: HTLCFailReason::reason($err_code, $data.to_vec())
3031 .get_encrypted_failure_packet(&shared_secret, &None),
3037 onion_utils::Hop::Receive(next_hop_data) => {
3039 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash,
3040 msg.amount_msat, msg.cltv_expiry, None, allow_underpay, msg.skimmed_fee_msat)
3043 // Note that we could obviously respond immediately with an update_fulfill_htlc
3044 // message, however that would leak that we are the recipient of this payment, so
3045 // instead we stay symmetric with the forwarding case, only responding (after a
3046 // delay) once they've send us a commitment_signed!
3047 PendingHTLCStatus::Forward(info)
3049 Err(InboundOnionErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3052 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
3053 match self.construct_fwd_pending_htlc_info(msg, next_hop_data, next_hop_hmac,
3054 new_packet_bytes, shared_secret, next_packet_pubkey_opt) {
3055 Ok(info) => PendingHTLCStatus::Forward(info),
3056 Err(InboundOnionErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3062 /// Gets the current [`channel_update`] for the given channel. This first checks if the channel is
3063 /// public, and thus should be called whenever the result is going to be passed out in a
3064 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
3066 /// Note that in [`internal_closing_signed`], this function is called without the `peer_state`
3067 /// corresponding to the channel's counterparty locked, as the channel been removed from the
3068 /// storage and the `peer_state` lock has been dropped.
3070 /// [`channel_update`]: msgs::ChannelUpdate
3071 /// [`internal_closing_signed`]: Self::internal_closing_signed
3072 fn get_channel_update_for_broadcast(&self, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
3073 if !chan.context.should_announce() {
3074 return Err(LightningError {
3075 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
3076 action: msgs::ErrorAction::IgnoreError
3079 if chan.context.get_short_channel_id().is_none() {
3080 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
3082 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.context.channel_id()));
3083 self.get_channel_update_for_unicast(chan)
3086 /// Gets the current [`channel_update`] for the given channel. This does not check if the channel
3087 /// is public (only returning an `Err` if the channel does not yet have an assigned SCID),
3088 /// and thus MUST NOT be called unless the recipient of the resulting message has already
3089 /// provided evidence that they know about the existence of the channel.
3091 /// Note that through [`internal_closing_signed`], this function is called without the
3092 /// `peer_state` corresponding to the channel's counterparty locked, as the channel been
3093 /// removed from the storage and the `peer_state` lock has been dropped.
3095 /// [`channel_update`]: msgs::ChannelUpdate
3096 /// [`internal_closing_signed`]: Self::internal_closing_signed
3097 fn get_channel_update_for_unicast(&self, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
3098 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.context.channel_id()));
3099 let short_channel_id = match chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias()) {
3100 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
3104 self.get_channel_update_for_onion(short_channel_id, chan)
3107 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
3108 log_trace!(self.logger, "Generating channel update for channel {}", log_bytes!(chan.context.channel_id()));
3109 let were_node_one = self.our_network_pubkey.serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
3111 let enabled = chan.context.is_usable() && match chan.channel_update_status() {
3112 ChannelUpdateStatus::Enabled => true,
3113 ChannelUpdateStatus::DisabledStaged(_) => true,
3114 ChannelUpdateStatus::Disabled => false,
3115 ChannelUpdateStatus::EnabledStaged(_) => false,
3118 let unsigned = msgs::UnsignedChannelUpdate {
3119 chain_hash: self.genesis_hash,
3121 timestamp: chan.context.get_update_time_counter(),
3122 flags: (!were_node_one) as u8 | ((!enabled as u8) << 1),
3123 cltv_expiry_delta: chan.context.get_cltv_expiry_delta(),
3124 htlc_minimum_msat: chan.context.get_counterparty_htlc_minimum_msat(),
3125 htlc_maximum_msat: chan.context.get_announced_htlc_max_msat(),
3126 fee_base_msat: chan.context.get_outbound_forwarding_fee_base_msat(),
3127 fee_proportional_millionths: chan.context.get_fee_proportional_millionths(),
3128 excess_data: Vec::new(),
3130 // Panic on failure to signal LDK should be restarted to retry signing the `ChannelUpdate`.
3131 // If we returned an error and the `node_signer` cannot provide a signature for whatever
3132 // reason`, we wouldn't be able to receive inbound payments through the corresponding
3134 let sig = self.node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelUpdate(&unsigned)).unwrap();
3136 Ok(msgs::ChannelUpdate {
3143 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> {
3144 let _lck = self.total_consistency_lock.read().unwrap();
3145 self.send_payment_along_path(SendAlongPathArgs {
3146 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3151 fn send_payment_along_path(&self, args: SendAlongPathArgs) -> Result<(), APIError> {
3152 let SendAlongPathArgs {
3153 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3156 // The top-level caller should hold the total_consistency_lock read lock.
3157 debug_assert!(self.total_consistency_lock.try_write().is_err());
3159 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.hops.first().unwrap().short_channel_id);
3160 let prng_seed = self.entropy_source.get_secure_random_bytes();
3161 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
3163 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
3164 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected".to_owned()})?;
3165 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, recipient_onion, cur_height, keysend_preimage)?;
3167 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash)
3168 .map_err(|_| APIError::InvalidRoute { err: "Route size too large considering onion data".to_owned()})?;
3170 let err: Result<(), _> = loop {
3171 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
3172 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
3173 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3176 let per_peer_state = self.per_peer_state.read().unwrap();
3177 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
3178 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
3179 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3180 let peer_state = &mut *peer_state_lock;
3181 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(id) {
3182 if !chan.get().context.is_live() {
3183 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected".to_owned()});
3185 let funding_txo = chan.get().context.get_funding_txo().unwrap();
3186 let send_res = chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(),
3187 htlc_cltv, HTLCSource::OutboundRoute {
3189 session_priv: session_priv.clone(),
3190 first_hop_htlc_msat: htlc_msat,
3192 }, onion_packet, None, &self.fee_estimator, &self.logger);
3193 match break_chan_entry!(self, send_res, chan) {
3194 Some(monitor_update) => {
3195 match handle_new_monitor_update!(self, funding_txo, monitor_update, peer_state_lock, peer_state, per_peer_state, chan) {
3196 Err(e) => break Err(e),
3198 // Note that MonitorUpdateInProgress here indicates (per function
3199 // docs) that we will resend the commitment update once monitor
3200 // updating completes. Therefore, we must return an error
3201 // indicating that it is unsafe to retry the payment wholesale,
3202 // which we do in the send_payment check for
3203 // MonitorUpdateInProgress, below.
3204 return Err(APIError::MonitorUpdateInProgress);
3212 // The channel was likely removed after we fetched the id from the
3213 // `short_to_chan_info` map, but before we successfully locked the
3214 // `channel_by_id` map.
3215 // This can occur as no consistency guarantees exists between the two maps.
3216 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
3221 match handle_error!(self, err, path.hops.first().unwrap().pubkey) {
3222 Ok(_) => unreachable!(),
3224 Err(APIError::ChannelUnavailable { err: e.err })
3229 /// Sends a payment along a given route.
3231 /// Value parameters are provided via the last hop in route, see documentation for [`RouteHop`]
3232 /// fields for more info.
3234 /// May generate [`UpdateHTLCs`] message(s) event on success, which should be relayed (e.g. via
3235 /// [`PeerManager::process_events`]).
3237 /// # Avoiding Duplicate Payments
3239 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
3240 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
3241 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
3242 /// [`Event::PaymentSent`] or [`Event::PaymentFailed`]) LDK will not stop you from sending a
3243 /// second payment with the same [`PaymentId`].
3245 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
3246 /// tracking of payments, including state to indicate once a payment has completed. Because you
3247 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
3248 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
3249 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
3251 /// Additionally, in the scenario where we begin the process of sending a payment, but crash
3252 /// before `send_payment` returns (or prior to [`ChannelMonitorUpdate`] persistence if you're
3253 /// using [`ChannelMonitorUpdateStatus::InProgress`]), the payment may be lost on restart. See
3254 /// [`ChannelManager::list_recent_payments`] for more information.
3256 /// # Possible Error States on [`PaymentSendFailure`]
3258 /// Each path may have a different return value, and [`PaymentSendFailure`] may return a `Vec` with
3259 /// each entry matching the corresponding-index entry in the route paths, see
3260 /// [`PaymentSendFailure`] for more info.
3262 /// In general, a path may raise:
3263 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
3264 /// node public key) is specified.
3265 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
3266 /// (including due to previous monitor update failure or new permanent monitor update
3268 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
3269 /// relevant updates.
3271 /// Note that depending on the type of the [`PaymentSendFailure`] the HTLC may have been
3272 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
3273 /// different route unless you intend to pay twice!
3275 /// [`RouteHop`]: crate::routing::router::RouteHop
3276 /// [`Event::PaymentSent`]: events::Event::PaymentSent
3277 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
3278 /// [`UpdateHTLCs`]: events::MessageSendEvent::UpdateHTLCs
3279 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
3280 /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
3281 pub fn send_payment_with_route(&self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
3282 let best_block_height = self.best_block.read().unwrap().height();
3283 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3284 self.pending_outbound_payments
3285 .send_payment_with_route(route, payment_hash, recipient_onion, payment_id,
3286 &self.entropy_source, &self.node_signer, best_block_height,
3287 |args| self.send_payment_along_path(args))
3290 /// Similar to [`ChannelManager::send_payment_with_route`], but will automatically find a route based on
3291 /// `route_params` and retry failed payment paths based on `retry_strategy`.
3292 pub fn send_payment(&self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<(), RetryableSendFailure> {
3293 let best_block_height = self.best_block.read().unwrap().height();
3294 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3295 self.pending_outbound_payments
3296 .send_payment(payment_hash, recipient_onion, payment_id, retry_strategy, route_params,
3297 &self.router, self.list_usable_channels(), || self.compute_inflight_htlcs(),
3298 &self.entropy_source, &self.node_signer, best_block_height, &self.logger,
3299 &self.pending_events, |args| self.send_payment_along_path(args))
3303 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> {
3304 let best_block_height = self.best_block.read().unwrap().height();
3305 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3306 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, recipient_onion,
3307 keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.node_signer,
3308 best_block_height, |args| self.send_payment_along_path(args))
3312 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> {
3313 let best_block_height = self.best_block.read().unwrap().height();
3314 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, recipient_onion, payment_id, route, None, &self.entropy_source, best_block_height)
3318 pub(crate) fn test_set_payment_metadata(&self, payment_id: PaymentId, new_payment_metadata: Option<Vec<u8>>) {
3319 self.pending_outbound_payments.test_set_payment_metadata(payment_id, new_payment_metadata);
3323 /// Signals that no further retries for the given payment should occur. Useful if you have a
3324 /// pending outbound payment with retries remaining, but wish to stop retrying the payment before
3325 /// retries are exhausted.
3327 /// If no [`Event::PaymentFailed`] event had been generated before, one will be generated as soon
3328 /// as there are no remaining pending HTLCs for this payment.
3330 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
3331 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
3332 /// determine the ultimate status of a payment.
3334 /// If an [`Event::PaymentFailed`] event is generated and we restart without this
3335 /// [`ChannelManager`] having been persisted, another [`Event::PaymentFailed`] may be generated.
3337 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
3338 /// [`Event::PaymentSent`]: events::Event::PaymentSent
3339 pub fn abandon_payment(&self, payment_id: PaymentId) {
3340 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3341 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
3344 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
3345 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
3346 /// the preimage, it must be a cryptographically secure random value that no intermediate node
3347 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
3348 /// never reach the recipient.
3350 /// See [`send_payment`] documentation for more details on the return value of this function
3351 /// and idempotency guarantees provided by the [`PaymentId`] key.
3353 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
3354 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
3356 /// [`send_payment`]: Self::send_payment
3357 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
3358 let best_block_height = self.best_block.read().unwrap().height();
3359 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3360 self.pending_outbound_payments.send_spontaneous_payment_with_route(
3361 route, payment_preimage, recipient_onion, payment_id, &self.entropy_source,
3362 &self.node_signer, best_block_height, |args| self.send_payment_along_path(args))
3365 /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
3366 /// based on `route_params` and retry failed payment paths based on `retry_strategy`.
3368 /// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous
3371 /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
3372 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> {
3373 let best_block_height = self.best_block.read().unwrap().height();
3374 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3375 self.pending_outbound_payments.send_spontaneous_payment(payment_preimage, recipient_onion,
3376 payment_id, retry_strategy, route_params, &self.router, self.list_usable_channels(),
3377 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
3378 &self.logger, &self.pending_events, |args| self.send_payment_along_path(args))
3381 /// Send a payment that is probing the given route for liquidity. We calculate the
3382 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
3383 /// us to easily discern them from real payments.
3384 pub fn send_probe(&self, path: Path) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
3385 let best_block_height = self.best_block.read().unwrap().height();
3386 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3387 self.pending_outbound_payments.send_probe(path, self.probing_cookie_secret,
3388 &self.entropy_source, &self.node_signer, best_block_height,
3389 |args| self.send_payment_along_path(args))
3392 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
3395 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
3396 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
3399 /// Handles the generation of a funding transaction, optionally (for tests) with a function
3400 /// which checks the correctness of the funding transaction given the associated channel.
3401 fn funding_transaction_generated_intern<FundingOutput: Fn(&OutboundV1Channel<<SP::Target as SignerProvider>::Signer>, &Transaction) -> Result<OutPoint, APIError>>(
3402 &self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
3403 ) -> Result<(), APIError> {
3404 let per_peer_state = self.per_peer_state.read().unwrap();
3405 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3406 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3408 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3409 let peer_state = &mut *peer_state_lock;
3410 let (chan, msg) = match peer_state.outbound_v1_channel_by_id.remove(temporary_channel_id) {
3412 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
3414 let funding_res = chan.get_funding_created(funding_transaction, funding_txo, &self.logger)
3415 .map_err(|(mut chan, e)| if let ChannelError::Close(msg) = e {
3416 let channel_id = chan.context.channel_id();
3417 let user_id = chan.context.get_user_id();
3418 let shutdown_res = chan.context.force_shutdown(false);
3419 let channel_capacity = chan.context.get_value_satoshis();
3420 (chan, MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, user_id, shutdown_res, None, channel_capacity))
3421 } else { unreachable!(); });
3423 Ok((chan, funding_msg)) => (chan, funding_msg),
3424 Err((chan, err)) => {
3425 mem::drop(peer_state_lock);
3426 mem::drop(per_peer_state);
3428 let _: Result<(), _> = handle_error!(self, Err(err), chan.context.get_counterparty_node_id());
3429 return Err(APIError::ChannelUnavailable {
3430 err: "Signer refused to sign the initial commitment transaction".to_owned()
3436 return Err(APIError::ChannelUnavailable {
3438 "Channel with id {} not found for the passed counterparty node_id {}",
3439 log_bytes!(*temporary_channel_id), counterparty_node_id),
3444 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
3445 node_id: chan.context.get_counterparty_node_id(),
3448 match peer_state.channel_by_id.entry(chan.context.channel_id()) {
3449 hash_map::Entry::Occupied(_) => {
3450 panic!("Generated duplicate funding txid?");
3452 hash_map::Entry::Vacant(e) => {
3453 let mut id_to_peer = self.id_to_peer.lock().unwrap();
3454 if id_to_peer.insert(chan.context.channel_id(), chan.context.get_counterparty_node_id()).is_some() {
3455 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
3464 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
3465 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
3466 Ok(OutPoint { txid: tx.txid(), index: output_index })
3470 /// Call this upon creation of a funding transaction for the given channel.
3472 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
3473 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
3475 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
3476 /// across the p2p network.
3478 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
3479 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
3481 /// May panic if the output found in the funding transaction is duplicative with some other
3482 /// channel (note that this should be trivially prevented by using unique funding transaction
3483 /// keys per-channel).
3485 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
3486 /// counterparty's signature the funding transaction will automatically be broadcast via the
3487 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
3489 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
3490 /// not currently support replacing a funding transaction on an existing channel. Instead,
3491 /// create a new channel with a conflicting funding transaction.
3493 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
3494 /// the wallet software generating the funding transaction to apply anti-fee sniping as
3495 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
3496 /// for more details.
3498 /// [`Event::FundingGenerationReady`]: crate::events::Event::FundingGenerationReady
3499 /// [`Event::ChannelClosed`]: crate::events::Event::ChannelClosed
3500 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
3501 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3503 for inp in funding_transaction.input.iter() {
3504 if inp.witness.is_empty() {
3505 return Err(APIError::APIMisuseError {
3506 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
3511 let height = self.best_block.read().unwrap().height();
3512 // Transactions are evaluated as final by network mempools if their locktime is strictly
3513 // lower than the next block height. However, the modules constituting our Lightning
3514 // node might not have perfect sync about their blockchain views. Thus, if the wallet
3515 // module is ahead of LDK, only allow one more block of headroom.
3516 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 {
3517 return Err(APIError::APIMisuseError {
3518 err: "Funding transaction absolute timelock is non-final".to_owned()
3522 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
3523 if tx.output.len() > u16::max_value() as usize {
3524 return Err(APIError::APIMisuseError {
3525 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
3529 let mut output_index = None;
3530 let expected_spk = chan.context.get_funding_redeemscript().to_v0_p2wsh();
3531 for (idx, outp) in tx.output.iter().enumerate() {
3532 if outp.script_pubkey == expected_spk && outp.value == chan.context.get_value_satoshis() {
3533 if output_index.is_some() {
3534 return Err(APIError::APIMisuseError {
3535 err: "Multiple outputs matched the expected script and value".to_owned()
3538 output_index = Some(idx as u16);
3541 if output_index.is_none() {
3542 return Err(APIError::APIMisuseError {
3543 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
3546 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
3550 /// Atomically applies partial updates to the [`ChannelConfig`] of the given channels.
3552 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3553 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3554 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3555 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3557 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3558 /// `counterparty_node_id` is provided.
3560 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3561 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3563 /// If an error is returned, none of the updates should be considered applied.
3565 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3566 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3567 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3568 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3569 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3570 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3571 /// [`APIMisuseError`]: APIError::APIMisuseError
3572 pub fn update_partial_channel_config(
3573 &self, counterparty_node_id: &PublicKey, channel_ids: &[[u8; 32]], config_update: &ChannelConfigUpdate,
3574 ) -> Result<(), APIError> {
3575 if config_update.cltv_expiry_delta.map(|delta| delta < MIN_CLTV_EXPIRY_DELTA).unwrap_or(false) {
3576 return Err(APIError::APIMisuseError {
3577 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
3581 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3582 let per_peer_state = self.per_peer_state.read().unwrap();
3583 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3584 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3585 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3586 let peer_state = &mut *peer_state_lock;
3587 for channel_id in channel_ids {
3588 if !peer_state.has_channel(channel_id) {
3589 return Err(APIError::ChannelUnavailable {
3590 err: format!("Channel with ID {} was not found for the passed counterparty_node_id {}", log_bytes!(*channel_id), counterparty_node_id),
3594 for channel_id in channel_ids {
3595 if let Some(channel) = peer_state.channel_by_id.get_mut(channel_id) {
3596 let mut config = channel.context.config();
3597 config.apply(config_update);
3598 if !channel.context.update_config(&config) {
3601 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
3602 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
3603 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
3604 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
3605 node_id: channel.context.get_counterparty_node_id(),
3612 let context = if let Some(channel) = peer_state.inbound_v1_channel_by_id.get_mut(channel_id) {
3613 &mut channel.context
3614 } else if let Some(channel) = peer_state.outbound_v1_channel_by_id.get_mut(channel_id) {
3615 &mut channel.context
3617 // This should not be reachable as we've already checked for non-existence in the previous channel_id loop.
3618 debug_assert!(false);
3619 return Err(APIError::ChannelUnavailable {
3621 "Channel with ID {} for passed counterparty_node_id {} disappeared after we confirmed its existence - this should not be reachable!",
3622 log_bytes!(*channel_id), counterparty_node_id),
3625 let mut config = context.config();
3626 config.apply(config_update);
3627 // We update the config, but we MUST NOT broadcast a `channel_update` before `channel_ready`
3628 // which would be the case for pending inbound/outbound channels.
3629 context.update_config(&config);
3634 /// Atomically updates the [`ChannelConfig`] for the given channels.
3636 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3637 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3638 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3639 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3641 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3642 /// `counterparty_node_id` is provided.
3644 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3645 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3647 /// If an error is returned, none of the updates should be considered applied.
3649 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3650 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3651 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3652 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3653 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3654 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3655 /// [`APIMisuseError`]: APIError::APIMisuseError
3656 pub fn update_channel_config(
3657 &self, counterparty_node_id: &PublicKey, channel_ids: &[[u8; 32]], config: &ChannelConfig,
3658 ) -> Result<(), APIError> {
3659 return self.update_partial_channel_config(counterparty_node_id, channel_ids, &(*config).into());
3662 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
3663 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
3665 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
3666 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
3668 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
3669 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
3670 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
3671 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
3672 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
3674 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
3675 /// you from forwarding more than you received. See
3676 /// [`HTLCIntercepted::expected_outbound_amount_msat`] for more on forwarding a different amount
3679 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
3682 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
3683 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
3684 /// [`HTLCIntercepted::expected_outbound_amount_msat`]: events::Event::HTLCIntercepted::expected_outbound_amount_msat
3685 // TODO: when we move to deciding the best outbound channel at forward time, only take
3686 // `next_node_id` and not `next_hop_channel_id`
3687 pub fn forward_intercepted_htlc(&self, intercept_id: InterceptId, next_hop_channel_id: &[u8; 32], next_node_id: PublicKey, amt_to_forward_msat: u64) -> Result<(), APIError> {
3688 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3690 let next_hop_scid = {
3691 let peer_state_lock = self.per_peer_state.read().unwrap();
3692 let peer_state_mutex = peer_state_lock.get(&next_node_id)
3693 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) })?;
3694 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3695 let peer_state = &mut *peer_state_lock;
3696 match peer_state.channel_by_id.get(next_hop_channel_id) {
3698 if !chan.context.is_usable() {
3699 return Err(APIError::ChannelUnavailable {
3700 err: format!("Channel with id {} not fully established", log_bytes!(*next_hop_channel_id))
3703 chan.context.get_short_channel_id().unwrap_or(chan.context.outbound_scid_alias())
3705 None => return Err(APIError::ChannelUnavailable {
3706 err: format!("Funded channel with id {} not found for the passed counterparty node_id {}. Channel may still be opening.",
3707 log_bytes!(*next_hop_channel_id), next_node_id)
3712 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
3713 .ok_or_else(|| APIError::APIMisuseError {
3714 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
3717 let routing = match payment.forward_info.routing {
3718 PendingHTLCRouting::Forward { onion_packet, .. } => {
3719 PendingHTLCRouting::Forward { onion_packet, short_channel_id: next_hop_scid }
3721 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
3723 let skimmed_fee_msat =
3724 payment.forward_info.outgoing_amt_msat.saturating_sub(amt_to_forward_msat);
3725 let pending_htlc_info = PendingHTLCInfo {
3726 skimmed_fee_msat: if skimmed_fee_msat == 0 { None } else { Some(skimmed_fee_msat) },
3727 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
3730 let mut per_source_pending_forward = [(
3731 payment.prev_short_channel_id,
3732 payment.prev_funding_outpoint,
3733 payment.prev_user_channel_id,
3734 vec![(pending_htlc_info, payment.prev_htlc_id)]
3736 self.forward_htlcs(&mut per_source_pending_forward);
3740 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
3741 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
3743 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
3746 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
3747 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
3748 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3750 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
3751 .ok_or_else(|| APIError::APIMisuseError {
3752 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
3755 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
3756 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3757 short_channel_id: payment.prev_short_channel_id,
3758 outpoint: payment.prev_funding_outpoint,
3759 htlc_id: payment.prev_htlc_id,
3760 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
3761 phantom_shared_secret: None,
3764 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
3765 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
3766 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
3767 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
3772 /// Processes HTLCs which are pending waiting on random forward delay.
3774 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
3775 /// Will likely generate further events.
3776 pub fn process_pending_htlc_forwards(&self) {
3777 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3779 let mut new_events = VecDeque::new();
3780 let mut failed_forwards = Vec::new();
3781 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
3783 let mut forward_htlcs = HashMap::new();
3784 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
3786 for (short_chan_id, mut pending_forwards) in forward_htlcs {
3787 if short_chan_id != 0 {
3788 macro_rules! forwarding_channel_not_found {
3790 for forward_info in pending_forwards.drain(..) {
3791 match forward_info {
3792 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3793 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3794 forward_info: PendingHTLCInfo {
3795 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
3796 outgoing_cltv_value, ..
3799 macro_rules! failure_handler {
3800 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
3801 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3803 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3804 short_channel_id: prev_short_channel_id,
3805 outpoint: prev_funding_outpoint,
3806 htlc_id: prev_htlc_id,
3807 incoming_packet_shared_secret: incoming_shared_secret,
3808 phantom_shared_secret: $phantom_ss,
3811 let reason = if $next_hop_unknown {
3812 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
3814 HTLCDestination::FailedPayment{ payment_hash }
3817 failed_forwards.push((htlc_source, payment_hash,
3818 HTLCFailReason::reason($err_code, $err_data),
3824 macro_rules! fail_forward {
3825 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3827 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
3831 macro_rules! failed_payment {
3832 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3834 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
3838 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
3839 let phantom_pubkey_res = self.node_signer.get_node_id(Recipient::PhantomNode);
3840 if phantom_pubkey_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.genesis_hash) {
3841 let phantom_shared_secret = self.node_signer.ecdh(Recipient::PhantomNode, &onion_packet.public_key.unwrap(), None).unwrap().secret_bytes();
3842 let next_hop = match onion_utils::decode_next_payment_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
3844 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
3845 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
3846 // In this scenario, the phantom would have sent us an
3847 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
3848 // if it came from us (the second-to-last hop) but contains the sha256
3850 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
3852 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3853 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
3857 onion_utils::Hop::Receive(hop_data) => {
3858 match self.construct_recv_pending_htlc_info(hop_data,
3859 incoming_shared_secret, payment_hash, outgoing_amt_msat,
3860 outgoing_cltv_value, Some(phantom_shared_secret), false, None)
3862 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
3863 Err(InboundOnionErr { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
3869 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3872 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3875 HTLCForwardInfo::FailHTLC { .. } => {
3876 // Channel went away before we could fail it. This implies
3877 // the channel is now on chain and our counterparty is
3878 // trying to broadcast the HTLC-Timeout, but that's their
3879 // problem, not ours.
3885 let (counterparty_node_id, forward_chan_id) = match self.short_to_chan_info.read().unwrap().get(&short_chan_id) {
3886 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3888 forwarding_channel_not_found!();
3892 let per_peer_state = self.per_peer_state.read().unwrap();
3893 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3894 if peer_state_mutex_opt.is_none() {
3895 forwarding_channel_not_found!();
3898 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
3899 let peer_state = &mut *peer_state_lock;
3900 match peer_state.channel_by_id.entry(forward_chan_id) {
3901 hash_map::Entry::Vacant(_) => {
3902 forwarding_channel_not_found!();
3905 hash_map::Entry::Occupied(mut chan) => {
3906 for forward_info in pending_forwards.drain(..) {
3907 match forward_info {
3908 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3909 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id: _,
3910 forward_info: PendingHTLCInfo {
3911 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
3912 routing: PendingHTLCRouting::Forward { onion_packet, .. }, skimmed_fee_msat, ..
3915 log_trace!(self.logger, "Adding HTLC from short id {} with payment_hash {} to channel with short id {} after delay", prev_short_channel_id, log_bytes!(payment_hash.0), short_chan_id);
3916 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3917 short_channel_id: prev_short_channel_id,
3918 outpoint: prev_funding_outpoint,
3919 htlc_id: prev_htlc_id,
3920 incoming_packet_shared_secret: incoming_shared_secret,
3921 // Phantom payments are only PendingHTLCRouting::Receive.
3922 phantom_shared_secret: None,
3924 if let Err(e) = chan.get_mut().queue_add_htlc(outgoing_amt_msat,
3925 payment_hash, outgoing_cltv_value, htlc_source.clone(),
3926 onion_packet, skimmed_fee_msat, &self.fee_estimator,
3929 if let ChannelError::Ignore(msg) = e {
3930 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
3932 panic!("Stated return value requirements in send_htlc() were not met");
3934 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan.get());
3935 failed_forwards.push((htlc_source, payment_hash,
3936 HTLCFailReason::reason(failure_code, data),
3937 HTLCDestination::NextHopChannel { node_id: Some(chan.get().context.get_counterparty_node_id()), channel_id: forward_chan_id }
3942 HTLCForwardInfo::AddHTLC { .. } => {
3943 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
3945 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
3946 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
3947 if let Err(e) = chan.get_mut().queue_fail_htlc(
3948 htlc_id, err_packet, &self.logger
3950 if let ChannelError::Ignore(msg) = e {
3951 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
3953 panic!("Stated return value requirements in queue_fail_htlc() were not met");
3955 // fail-backs are best-effort, we probably already have one
3956 // pending, and if not that's OK, if not, the channel is on
3957 // the chain and sending the HTLC-Timeout is their problem.
3966 'next_forwardable_htlc: for forward_info in pending_forwards.drain(..) {
3967 match forward_info {
3968 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3969 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3970 forward_info: PendingHTLCInfo {
3971 routing, incoming_shared_secret, payment_hash, incoming_amt_msat, outgoing_amt_msat,
3972 skimmed_fee_msat, ..
3975 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret, mut onion_fields) = match routing {
3976 PendingHTLCRouting::Receive { payment_data, payment_metadata, incoming_cltv_expiry, phantom_shared_secret, custom_tlvs } => {
3977 let _legacy_hop_data = Some(payment_data.clone());
3978 let onion_fields = RecipientOnionFields { payment_secret: Some(payment_data.payment_secret),
3979 payment_metadata, custom_tlvs };
3980 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data },
3981 Some(payment_data), phantom_shared_secret, onion_fields)
3983 PendingHTLCRouting::ReceiveKeysend { payment_data, payment_preimage, payment_metadata, incoming_cltv_expiry, custom_tlvs } => {
3984 let onion_fields = RecipientOnionFields {
3985 payment_secret: payment_data.as_ref().map(|data| data.payment_secret),
3989 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage),
3990 payment_data, None, onion_fields)
3993 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
3996 let claimable_htlc = ClaimableHTLC {
3997 prev_hop: HTLCPreviousHopData {
3998 short_channel_id: prev_short_channel_id,
3999 outpoint: prev_funding_outpoint,
4000 htlc_id: prev_htlc_id,
4001 incoming_packet_shared_secret: incoming_shared_secret,
4002 phantom_shared_secret,
4004 // We differentiate the received value from the sender intended value
4005 // if possible so that we don't prematurely mark MPP payments complete
4006 // if routing nodes overpay
4007 value: incoming_amt_msat.unwrap_or(outgoing_amt_msat),
4008 sender_intended_value: outgoing_amt_msat,
4010 total_value_received: None,
4011 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
4014 counterparty_skimmed_fee_msat: skimmed_fee_msat,
4017 let mut committed_to_claimable = false;
4019 macro_rules! fail_htlc {
4020 ($htlc: expr, $payment_hash: expr) => {
4021 debug_assert!(!committed_to_claimable);
4022 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
4023 htlc_msat_height_data.extend_from_slice(
4024 &self.best_block.read().unwrap().height().to_be_bytes(),
4026 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
4027 short_channel_id: $htlc.prev_hop.short_channel_id,
4028 outpoint: prev_funding_outpoint,
4029 htlc_id: $htlc.prev_hop.htlc_id,
4030 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
4031 phantom_shared_secret,
4033 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
4034 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
4036 continue 'next_forwardable_htlc;
4039 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
4040 let mut receiver_node_id = self.our_network_pubkey;
4041 if phantom_shared_secret.is_some() {
4042 receiver_node_id = self.node_signer.get_node_id(Recipient::PhantomNode)
4043 .expect("Failed to get node_id for phantom node recipient");
4046 macro_rules! check_total_value {
4047 ($purpose: expr) => {{
4048 let mut payment_claimable_generated = false;
4049 let is_keysend = match $purpose {
4050 events::PaymentPurpose::SpontaneousPayment(_) => true,
4051 events::PaymentPurpose::InvoicePayment { .. } => false,
4053 let mut claimable_payments = self.claimable_payments.lock().unwrap();
4054 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
4055 fail_htlc!(claimable_htlc, payment_hash);
4057 let ref mut claimable_payment = claimable_payments.claimable_payments
4058 .entry(payment_hash)
4059 // Note that if we insert here we MUST NOT fail_htlc!()
4060 .or_insert_with(|| {
4061 committed_to_claimable = true;
4063 purpose: $purpose.clone(), htlcs: Vec::new(), onion_fields: None,
4066 if $purpose != claimable_payment.purpose {
4067 let log_keysend = |keysend| if keysend { "keysend" } else { "non-keysend" };
4068 log_trace!(self.logger, "Failing new {} HTLC with payment_hash {} as we already had an existing {} HTLC with the same payment hash", log_keysend(is_keysend), log_bytes!(payment_hash.0), log_keysend(!is_keysend));
4069 fail_htlc!(claimable_htlc, payment_hash);
4071 if !self.default_configuration.accept_mpp_keysend && is_keysend && !claimable_payment.htlcs.is_empty() {
4072 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} as we already had an existing keysend HTLC with the same payment hash and our config states we don't accept MPP keysend", log_bytes!(payment_hash.0));
4073 fail_htlc!(claimable_htlc, payment_hash);
4075 if let Some(earlier_fields) = &mut claimable_payment.onion_fields {
4076 if earlier_fields.check_merge(&mut onion_fields).is_err() {
4077 fail_htlc!(claimable_htlc, payment_hash);
4080 claimable_payment.onion_fields = Some(onion_fields);
4082 let ref mut htlcs = &mut claimable_payment.htlcs;
4083 let mut total_value = claimable_htlc.sender_intended_value;
4084 let mut earliest_expiry = claimable_htlc.cltv_expiry;
4085 for htlc in htlcs.iter() {
4086 total_value += htlc.sender_intended_value;
4087 earliest_expiry = cmp::min(earliest_expiry, htlc.cltv_expiry);
4088 if htlc.total_msat != claimable_htlc.total_msat {
4089 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
4090 log_bytes!(payment_hash.0), claimable_htlc.total_msat, htlc.total_msat);
4091 total_value = msgs::MAX_VALUE_MSAT;
4093 if total_value >= msgs::MAX_VALUE_MSAT { break; }
4095 // The condition determining whether an MPP is complete must
4096 // match exactly the condition used in `timer_tick_occurred`
4097 if total_value >= msgs::MAX_VALUE_MSAT {
4098 fail_htlc!(claimable_htlc, payment_hash);
4099 } else if total_value - claimable_htlc.sender_intended_value >= claimable_htlc.total_msat {
4100 log_trace!(self.logger, "Failing HTLC with payment_hash {} as payment is already claimable",
4101 log_bytes!(payment_hash.0));
4102 fail_htlc!(claimable_htlc, payment_hash);
4103 } else if total_value >= claimable_htlc.total_msat {
4104 #[allow(unused_assignments)] {
4105 committed_to_claimable = true;
4107 let prev_channel_id = prev_funding_outpoint.to_channel_id();
4108 htlcs.push(claimable_htlc);
4109 let amount_msat = htlcs.iter().map(|htlc| htlc.value).sum();
4110 htlcs.iter_mut().for_each(|htlc| htlc.total_value_received = Some(amount_msat));
4111 let counterparty_skimmed_fee_msat = htlcs.iter()
4112 .map(|htlc| htlc.counterparty_skimmed_fee_msat.unwrap_or(0)).sum();
4113 debug_assert!(total_value.saturating_sub(amount_msat) <=
4114 counterparty_skimmed_fee_msat);
4115 new_events.push_back((events::Event::PaymentClaimable {
4116 receiver_node_id: Some(receiver_node_id),
4120 counterparty_skimmed_fee_msat,
4121 via_channel_id: Some(prev_channel_id),
4122 via_user_channel_id: Some(prev_user_channel_id),
4123 claim_deadline: Some(earliest_expiry - HTLC_FAIL_BACK_BUFFER),
4124 onion_fields: claimable_payment.onion_fields.clone(),
4126 payment_claimable_generated = true;
4128 // Nothing to do - we haven't reached the total
4129 // payment value yet, wait until we receive more
4131 htlcs.push(claimable_htlc);
4132 #[allow(unused_assignments)] {
4133 committed_to_claimable = true;
4136 payment_claimable_generated
4140 // Check that the payment hash and secret are known. Note that we
4141 // MUST take care to handle the "unknown payment hash" and
4142 // "incorrect payment secret" cases here identically or we'd expose
4143 // that we are the ultimate recipient of the given payment hash.
4144 // Further, we must not expose whether we have any other HTLCs
4145 // associated with the same payment_hash pending or not.
4146 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4147 match payment_secrets.entry(payment_hash) {
4148 hash_map::Entry::Vacant(_) => {
4149 match claimable_htlc.onion_payload {
4150 OnionPayload::Invoice { .. } => {
4151 let payment_data = payment_data.unwrap();
4152 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) {
4153 Ok(result) => result,
4155 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as payment verification failed", log_bytes!(payment_hash.0));
4156 fail_htlc!(claimable_htlc, payment_hash);
4159 if let Some(min_final_cltv_expiry_delta) = min_final_cltv_expiry_delta {
4160 let expected_min_expiry_height = (self.current_best_block().height() + min_final_cltv_expiry_delta as u32) as u64;
4161 if (cltv_expiry as u64) < expected_min_expiry_height {
4162 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as its CLTV expiry was too soon (had {}, earliest expected {})",
4163 log_bytes!(payment_hash.0), cltv_expiry, expected_min_expiry_height);
4164 fail_htlc!(claimable_htlc, payment_hash);
4167 let purpose = events::PaymentPurpose::InvoicePayment {
4168 payment_preimage: payment_preimage.clone(),
4169 payment_secret: payment_data.payment_secret,
4171 check_total_value!(purpose);
4173 OnionPayload::Spontaneous(preimage) => {
4174 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
4175 check_total_value!(purpose);
4179 hash_map::Entry::Occupied(inbound_payment) => {
4180 if let OnionPayload::Spontaneous(_) = claimable_htlc.onion_payload {
4181 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} because we already have an inbound payment with the same payment hash", log_bytes!(payment_hash.0));
4182 fail_htlc!(claimable_htlc, payment_hash);
4184 let payment_data = payment_data.unwrap();
4185 if inbound_payment.get().payment_secret != payment_data.payment_secret {
4186 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
4187 fail_htlc!(claimable_htlc, payment_hash);
4188 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
4189 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
4190 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
4191 fail_htlc!(claimable_htlc, payment_hash);
4193 let purpose = events::PaymentPurpose::InvoicePayment {
4194 payment_preimage: inbound_payment.get().payment_preimage,
4195 payment_secret: payment_data.payment_secret,
4197 let payment_claimable_generated = check_total_value!(purpose);
4198 if payment_claimable_generated {
4199 inbound_payment.remove_entry();
4205 HTLCForwardInfo::FailHTLC { .. } => {
4206 panic!("Got pending fail of our own HTLC");
4214 let best_block_height = self.best_block.read().unwrap().height();
4215 self.pending_outbound_payments.check_retry_payments(&self.router, || self.list_usable_channels(),
4216 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
4217 &self.pending_events, &self.logger, |args| self.send_payment_along_path(args));
4219 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
4220 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4222 self.forward_htlcs(&mut phantom_receives);
4224 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
4225 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
4226 // nice to do the work now if we can rather than while we're trying to get messages in the
4228 self.check_free_holding_cells();
4230 if new_events.is_empty() { return }
4231 let mut events = self.pending_events.lock().unwrap();
4232 events.append(&mut new_events);
4235 /// Free the background events, generally called from [`PersistenceNotifierGuard`] constructors.
4237 /// Expects the caller to have a total_consistency_lock read lock.
4238 fn process_background_events(&self) -> NotifyOption {
4239 debug_assert_ne!(self.total_consistency_lock.held_by_thread(), LockHeldState::NotHeldByThread);
4241 self.background_events_processed_since_startup.store(true, Ordering::Release);
4243 let mut background_events = Vec::new();
4244 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
4245 if background_events.is_empty() {
4246 return NotifyOption::SkipPersist;
4249 for event in background_events.drain(..) {
4251 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((funding_txo, update)) => {
4252 // The channel has already been closed, so no use bothering to care about the
4253 // monitor updating completing.
4254 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4256 BackgroundEvent::MonitorUpdateRegeneratedOnStartup { counterparty_node_id, funding_txo, update } => {
4257 let mut updated_chan = false;
4259 let per_peer_state = self.per_peer_state.read().unwrap();
4260 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4261 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4262 let peer_state = &mut *peer_state_lock;
4263 match peer_state.channel_by_id.entry(funding_txo.to_channel_id()) {
4264 hash_map::Entry::Occupied(mut chan) => {
4265 updated_chan = true;
4266 handle_new_monitor_update!(self, funding_txo, update.clone(),
4267 peer_state_lock, peer_state, per_peer_state, chan).map(|_| ())
4269 hash_map::Entry::Vacant(_) => Ok(()),
4274 // TODO: Track this as in-flight even though the channel is closed.
4275 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4277 // TODO: If this channel has since closed, we're likely providing a payment
4278 // preimage update, which we must ensure is durable! We currently don't,
4279 // however, ensure that.
4281 log_error!(self.logger,
4282 "Failed to provide ChannelMonitorUpdate to closed channel! This likely lost us a payment preimage!");
4284 let _ = handle_error!(self, res, counterparty_node_id);
4286 BackgroundEvent::MonitorUpdatesComplete { counterparty_node_id, channel_id } => {
4287 let per_peer_state = self.per_peer_state.read().unwrap();
4288 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4289 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4290 let peer_state = &mut *peer_state_lock;
4291 if let Some(chan) = peer_state.channel_by_id.get_mut(&channel_id) {
4292 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, chan);
4294 let update_actions = peer_state.monitor_update_blocked_actions
4295 .remove(&channel_id).unwrap_or(Vec::new());
4296 mem::drop(peer_state_lock);
4297 mem::drop(per_peer_state);
4298 self.handle_monitor_update_completion_actions(update_actions);
4304 NotifyOption::DoPersist
4307 #[cfg(any(test, feature = "_test_utils"))]
4308 /// Process background events, for functional testing
4309 pub fn test_process_background_events(&self) {
4310 let _lck = self.total_consistency_lock.read().unwrap();
4311 let _ = self.process_background_events();
4314 fn update_channel_fee(&self, chan_id: &[u8; 32], chan: &mut Channel<<SP::Target as SignerProvider>::Signer>, new_feerate: u32) -> NotifyOption {
4315 if !chan.context.is_outbound() { return NotifyOption::SkipPersist; }
4316 // If the feerate has decreased by less than half, don't bother
4317 if new_feerate <= chan.context.get_feerate_sat_per_1000_weight() && new_feerate * 2 > chan.context.get_feerate_sat_per_1000_weight() {
4318 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
4319 log_bytes!(chan_id[..]), chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4320 return NotifyOption::SkipPersist;
4322 if !chan.context.is_live() {
4323 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).",
4324 log_bytes!(chan_id[..]), chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4325 return NotifyOption::SkipPersist;
4327 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
4328 log_bytes!(chan_id[..]), chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4330 chan.queue_update_fee(new_feerate, &self.fee_estimator, &self.logger);
4331 NotifyOption::DoPersist
4335 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
4336 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
4337 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
4338 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
4339 pub fn maybe_update_chan_fees(&self) {
4340 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4341 let mut should_persist = self.process_background_events();
4343 let normal_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4344 let min_mempool_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::MempoolMinimum);
4346 let per_peer_state = self.per_peer_state.read().unwrap();
4347 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
4348 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4349 let peer_state = &mut *peer_state_lock;
4350 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
4351 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4356 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4357 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4365 /// Performs actions which should happen on startup and roughly once per minute thereafter.
4367 /// This currently includes:
4368 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
4369 /// * Broadcasting [`ChannelUpdate`] messages if we've been disconnected from our peer for more
4370 /// than a minute, informing the network that they should no longer attempt to route over
4372 /// * Expiring a channel's previous [`ChannelConfig`] if necessary to only allow forwarding HTLCs
4373 /// with the current [`ChannelConfig`].
4374 /// * Removing peers which have disconnected but and no longer have any channels.
4375 /// * Force-closing and removing channels which have not completed establishment in a timely manner.
4377 /// Note that this may cause reentrancy through [`chain::Watch::update_channel`] calls or feerate
4378 /// estimate fetches.
4380 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4381 /// [`ChannelConfig`]: crate::util::config::ChannelConfig
4382 pub fn timer_tick_occurred(&self) {
4383 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4384 let mut should_persist = self.process_background_events();
4386 let normal_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4387 let min_mempool_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::MempoolMinimum);
4389 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
4390 let mut timed_out_mpp_htlcs = Vec::new();
4391 let mut pending_peers_awaiting_removal = Vec::new();
4393 let per_peer_state = self.per_peer_state.read().unwrap();
4394 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
4395 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4396 let peer_state = &mut *peer_state_lock;
4397 let pending_msg_events = &mut peer_state.pending_msg_events;
4398 let counterparty_node_id = *counterparty_node_id;
4399 peer_state.channel_by_id.retain(|chan_id, chan| {
4400 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4405 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4406 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4408 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
4409 let (needs_close, err) = convert_chan_err!(self, e, chan, chan_id);
4410 handle_errors.push((Err(err), counterparty_node_id));
4411 if needs_close { return false; }
4414 match chan.channel_update_status() {
4415 ChannelUpdateStatus::Enabled if !chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(0)),
4416 ChannelUpdateStatus::Disabled if chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(0)),
4417 ChannelUpdateStatus::DisabledStaged(_) if chan.context.is_live()
4418 => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
4419 ChannelUpdateStatus::EnabledStaged(_) if !chan.context.is_live()
4420 => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
4421 ChannelUpdateStatus::DisabledStaged(mut n) if !chan.context.is_live() => {
4423 if n >= DISABLE_GOSSIP_TICKS {
4424 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
4425 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4426 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4430 should_persist = NotifyOption::DoPersist;
4432 chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(n));
4435 ChannelUpdateStatus::EnabledStaged(mut n) if chan.context.is_live() => {
4437 if n >= ENABLE_GOSSIP_TICKS {
4438 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
4439 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4440 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4444 should_persist = NotifyOption::DoPersist;
4446 chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(n));
4452 chan.context.maybe_expire_prev_config();
4454 if chan.should_disconnect_peer_awaiting_response() {
4455 log_debug!(self.logger, "Disconnecting peer {} due to not making any progress on channel {}",
4456 counterparty_node_id, log_bytes!(*chan_id));
4457 pending_msg_events.push(MessageSendEvent::HandleError {
4458 node_id: counterparty_node_id,
4459 action: msgs::ErrorAction::DisconnectPeerWithWarning {
4460 msg: msgs::WarningMessage {
4461 channel_id: *chan_id,
4462 data: "Disconnecting due to timeout awaiting response".to_owned(),
4471 let process_unfunded_channel_tick = |
4473 chan_context: &mut ChannelContext<<SP::Target as SignerProvider>::Signer>,
4474 unfunded_chan_context: &mut UnfundedChannelContext,
4476 chan_context.maybe_expire_prev_config();
4477 if unfunded_chan_context.should_expire_unfunded_channel() {
4478 log_error!(self.logger, "Force-closing pending outbound channel {} for not establishing in a timely manner", log_bytes!(&chan_id[..]));
4479 update_maps_on_chan_removal!(self, &chan_context);
4480 self.issue_channel_close_events(&chan_context, ClosureReason::HolderForceClosed);
4481 self.finish_force_close_channel(chan_context.force_shutdown(false));
4487 peer_state.outbound_v1_channel_by_id.retain(|chan_id, chan| process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context));
4488 peer_state.inbound_v1_channel_by_id.retain(|chan_id, chan| process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context));
4490 if peer_state.ok_to_remove(true) {
4491 pending_peers_awaiting_removal.push(counterparty_node_id);
4496 // When a peer disconnects but still has channels, the peer's `peer_state` entry in the
4497 // `per_peer_state` is not removed by the `peer_disconnected` function. If the channels
4498 // of to that peer is later closed while still being disconnected (i.e. force closed),
4499 // we therefore need to remove the peer from `peer_state` separately.
4500 // To avoid having to take the `per_peer_state` `write` lock once the channels are
4501 // closed, we instead remove such peers awaiting removal here on a timer, to limit the
4502 // negative effects on parallelism as much as possible.
4503 if pending_peers_awaiting_removal.len() > 0 {
4504 let mut per_peer_state = self.per_peer_state.write().unwrap();
4505 for counterparty_node_id in pending_peers_awaiting_removal {
4506 match per_peer_state.entry(counterparty_node_id) {
4507 hash_map::Entry::Occupied(entry) => {
4508 // Remove the entry if the peer is still disconnected and we still
4509 // have no channels to the peer.
4510 let remove_entry = {
4511 let peer_state = entry.get().lock().unwrap();
4512 peer_state.ok_to_remove(true)
4515 entry.remove_entry();
4518 hash_map::Entry::Vacant(_) => { /* The PeerState has already been removed */ }
4523 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
4524 if payment.htlcs.is_empty() {
4525 // This should be unreachable
4526 debug_assert!(false);
4529 if let OnionPayload::Invoice { .. } = payment.htlcs[0].onion_payload {
4530 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
4531 // In this case we're not going to handle any timeouts of the parts here.
4532 // This condition determining whether the MPP is complete here must match
4533 // exactly the condition used in `process_pending_htlc_forwards`.
4534 if payment.htlcs[0].total_msat <= payment.htlcs.iter()
4535 .fold(0, |total, htlc| total + htlc.sender_intended_value)
4538 } else if payment.htlcs.iter_mut().any(|htlc| {
4539 htlc.timer_ticks += 1;
4540 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
4542 timed_out_mpp_htlcs.extend(payment.htlcs.drain(..)
4543 .map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
4550 for htlc_source in timed_out_mpp_htlcs.drain(..) {
4551 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
4552 let reason = HTLCFailReason::from_failure_code(23);
4553 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
4554 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
4557 for (err, counterparty_node_id) in handle_errors.drain(..) {
4558 let _ = handle_error!(self, err, counterparty_node_id);
4561 self.pending_outbound_payments.remove_stale_resolved_payments(&self.pending_events);
4563 // Technically we don't need to do this here, but if we have holding cell entries in a
4564 // channel that need freeing, it's better to do that here and block a background task
4565 // than block the message queueing pipeline.
4566 if self.check_free_holding_cells() {
4567 should_persist = NotifyOption::DoPersist;
4574 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
4575 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
4576 /// along the path (including in our own channel on which we received it).
4578 /// Note that in some cases around unclean shutdown, it is possible the payment may have
4579 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
4580 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
4581 /// may have already been failed automatically by LDK if it was nearing its expiration time.
4583 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
4584 /// [`ChannelManager::claim_funds`]), you should still monitor for
4585 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
4586 /// startup during which time claims that were in-progress at shutdown may be replayed.
4587 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
4588 self.fail_htlc_backwards_with_reason(payment_hash, FailureCode::IncorrectOrUnknownPaymentDetails);
4591 /// This is a variant of [`ChannelManager::fail_htlc_backwards`] that allows you to specify the
4592 /// reason for the failure.
4594 /// See [`FailureCode`] for valid failure codes.
4595 pub fn fail_htlc_backwards_with_reason(&self, payment_hash: &PaymentHash, failure_code: FailureCode) {
4596 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4598 let removed_source = self.claimable_payments.lock().unwrap().claimable_payments.remove(payment_hash);
4599 if let Some(payment) = removed_source {
4600 for htlc in payment.htlcs {
4601 let reason = self.get_htlc_fail_reason_from_failure_code(failure_code, &htlc);
4602 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
4603 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
4604 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
4609 /// Gets error data to form an [`HTLCFailReason`] given a [`FailureCode`] and [`ClaimableHTLC`].
4610 fn get_htlc_fail_reason_from_failure_code(&self, failure_code: FailureCode, htlc: &ClaimableHTLC) -> HTLCFailReason {
4611 match failure_code {
4612 FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(failure_code.into()),
4613 FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(failure_code.into()),
4614 FailureCode::IncorrectOrUnknownPaymentDetails => {
4615 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
4616 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
4617 HTLCFailReason::reason(failure_code.into(), htlc_msat_height_data)
4619 FailureCode::InvalidOnionPayload(data) => {
4620 let fail_data = match data {
4621 Some((typ, offset)) => [BigSize(typ).encode(), offset.encode()].concat(),
4624 HTLCFailReason::reason(failure_code.into(), fail_data)
4629 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
4630 /// that we want to return and a channel.
4632 /// This is for failures on the channel on which the HTLC was *received*, not failures
4634 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> (u16, Vec<u8>) {
4635 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
4636 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
4637 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
4638 // an inbound SCID alias before the real SCID.
4639 let scid_pref = if chan.context.should_announce() {
4640 chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias())
4642 chan.context.latest_inbound_scid_alias().or(chan.context.get_short_channel_id())
4644 if let Some(scid) = scid_pref {
4645 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
4647 (0x4000|10, Vec::new())
4652 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
4653 /// that we want to return and a channel.
4654 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> (u16, Vec<u8>) {
4655 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
4656 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
4657 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
4658 if desired_err_code == 0x1000 | 20 {
4659 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
4660 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
4661 0u16.write(&mut enc).expect("Writes cannot fail");
4663 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
4664 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
4665 upd.write(&mut enc).expect("Writes cannot fail");
4666 (desired_err_code, enc.0)
4668 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
4669 // which means we really shouldn't have gotten a payment to be forwarded over this
4670 // channel yet, or if we did it's from a route hint. Either way, returning an error of
4671 // PERM|no_such_channel should be fine.
4672 (0x4000|10, Vec::new())
4676 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
4677 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
4678 // be surfaced to the user.
4679 fn fail_holding_cell_htlcs(
4680 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32],
4681 counterparty_node_id: &PublicKey
4683 let (failure_code, onion_failure_data) = {
4684 let per_peer_state = self.per_peer_state.read().unwrap();
4685 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4686 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4687 let peer_state = &mut *peer_state_lock;
4688 match peer_state.channel_by_id.entry(channel_id) {
4689 hash_map::Entry::Occupied(chan_entry) => {
4690 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan_entry.get())
4692 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
4694 } else { (0x4000|10, Vec::new()) }
4697 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
4698 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
4699 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
4700 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
4704 /// Fails an HTLC backwards to the sender of it to us.
4705 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
4706 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
4707 // Ensure that no peer state channel storage lock is held when calling this function.
4708 // This ensures that future code doesn't introduce a lock-order requirement for
4709 // `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
4710 // this function with any `per_peer_state` peer lock acquired would.
4711 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
4712 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
4715 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
4716 //identify whether we sent it or not based on the (I presume) very different runtime
4717 //between the branches here. We should make this async and move it into the forward HTLCs
4720 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4721 // from block_connected which may run during initialization prior to the chain_monitor
4722 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
4724 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, .. } => {
4725 if self.pending_outbound_payments.fail_htlc(source, payment_hash, onion_error, path,
4726 session_priv, payment_id, self.probing_cookie_secret, &self.secp_ctx,
4727 &self.pending_events, &self.logger)
4728 { self.push_pending_forwards_ev(); }
4730 HTLCSource::PreviousHopData(HTLCPreviousHopData { ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret, ref phantom_shared_secret, ref outpoint }) => {
4731 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with {:?}", log_bytes!(payment_hash.0), onion_error);
4732 let err_packet = onion_error.get_encrypted_failure_packet(incoming_packet_shared_secret, phantom_shared_secret);
4734 let mut push_forward_ev = false;
4735 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
4736 if forward_htlcs.is_empty() {
4737 push_forward_ev = true;
4739 match forward_htlcs.entry(*short_channel_id) {
4740 hash_map::Entry::Occupied(mut entry) => {
4741 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet });
4743 hash_map::Entry::Vacant(entry) => {
4744 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }));
4747 mem::drop(forward_htlcs);
4748 if push_forward_ev { self.push_pending_forwards_ev(); }
4749 let mut pending_events = self.pending_events.lock().unwrap();
4750 pending_events.push_back((events::Event::HTLCHandlingFailed {
4751 prev_channel_id: outpoint.to_channel_id(),
4752 failed_next_destination: destination,
4758 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
4759 /// [`MessageSendEvent`]s needed to claim the payment.
4761 /// This method is guaranteed to ensure the payment has been claimed but only if the current
4762 /// height is strictly below [`Event::PaymentClaimable::claim_deadline`]. To avoid race
4763 /// conditions, you should wait for an [`Event::PaymentClaimed`] before considering the payment
4764 /// successful. It will generally be available in the next [`process_pending_events`] call.
4766 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
4767 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
4768 /// event matches your expectation. If you fail to do so and call this method, you may provide
4769 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
4771 /// This function will fail the payment if it has custom TLVs with even type numbers, as we
4772 /// will assume they are unknown. If you intend to accept even custom TLVs, you should use
4773 /// [`claim_funds_with_known_custom_tlvs`].
4775 /// [`Event::PaymentClaimable`]: crate::events::Event::PaymentClaimable
4776 /// [`Event::PaymentClaimable::claim_deadline`]: crate::events::Event::PaymentClaimable::claim_deadline
4777 /// [`Event::PaymentClaimed`]: crate::events::Event::PaymentClaimed
4778 /// [`process_pending_events`]: EventsProvider::process_pending_events
4779 /// [`create_inbound_payment`]: Self::create_inbound_payment
4780 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
4781 /// [`claim_funds_with_known_custom_tlvs`]: Self::claim_funds_with_known_custom_tlvs
4782 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
4783 self.claim_payment_internal(payment_preimage, false);
4786 /// This is a variant of [`claim_funds`] that allows accepting a payment with custom TLVs with
4787 /// even type numbers.
4791 /// You MUST check you've understood all even TLVs before using this to
4792 /// claim, otherwise you may unintentionally agree to some protocol you do not understand.
4794 /// [`claim_funds`]: Self::claim_funds
4795 pub fn claim_funds_with_known_custom_tlvs(&self, payment_preimage: PaymentPreimage) {
4796 self.claim_payment_internal(payment_preimage, true);
4799 fn claim_payment_internal(&self, payment_preimage: PaymentPreimage, custom_tlvs_known: bool) {
4800 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4802 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4805 let mut claimable_payments = self.claimable_payments.lock().unwrap();
4806 if let Some(payment) = claimable_payments.claimable_payments.remove(&payment_hash) {
4807 let mut receiver_node_id = self.our_network_pubkey;
4808 for htlc in payment.htlcs.iter() {
4809 if htlc.prev_hop.phantom_shared_secret.is_some() {
4810 let phantom_pubkey = self.node_signer.get_node_id(Recipient::PhantomNode)
4811 .expect("Failed to get node_id for phantom node recipient");
4812 receiver_node_id = phantom_pubkey;
4817 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
4818 ClaimingPayment { amount_msat: payment.htlcs.iter().map(|source| source.value).sum(),
4819 payment_purpose: payment.purpose, receiver_node_id,
4821 if dup_purpose.is_some() {
4822 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
4823 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
4824 log_bytes!(payment_hash.0));
4827 if let Some(RecipientOnionFields { ref custom_tlvs, .. }) = payment.onion_fields {
4828 if !custom_tlvs_known && custom_tlvs.iter().any(|(typ, _)| typ % 2 == 0) {
4829 log_info!(self.logger, "Rejecting payment with payment hash {} as we cannot accept payment with unknown even TLVs: {}",
4830 log_bytes!(payment_hash.0), log_iter!(custom_tlvs.iter().map(|(typ, _)| typ).filter(|typ| *typ % 2 == 0)));
4831 claimable_payments.pending_claiming_payments.remove(&payment_hash);
4832 mem::drop(claimable_payments);
4833 for htlc in payment.htlcs {
4834 let reason = self.get_htlc_fail_reason_from_failure_code(FailureCode::InvalidOnionPayload(None), &htlc);
4835 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
4836 let receiver = HTLCDestination::FailedPayment { payment_hash };
4837 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
4846 debug_assert!(!sources.is_empty());
4848 // Just in case one HTLC has been failed between when we generated the `PaymentClaimable`
4849 // and when we got here we need to check that the amount we're about to claim matches the
4850 // amount we told the user in the last `PaymentClaimable`. We also do a sanity-check that
4851 // the MPP parts all have the same `total_msat`.
4852 let mut claimable_amt_msat = 0;
4853 let mut prev_total_msat = None;
4854 let mut expected_amt_msat = None;
4855 let mut valid_mpp = true;
4856 let mut errs = Vec::new();
4857 let per_peer_state = self.per_peer_state.read().unwrap();
4858 for htlc in sources.iter() {
4859 if prev_total_msat.is_some() && prev_total_msat != Some(htlc.total_msat) {
4860 log_error!(self.logger, "Somehow ended up with an MPP payment with different expected total amounts - this should not be reachable!");
4861 debug_assert!(false);
4865 prev_total_msat = Some(htlc.total_msat);
4867 if expected_amt_msat.is_some() && expected_amt_msat != htlc.total_value_received {
4868 log_error!(self.logger, "Somehow ended up with an MPP payment with different received total amounts - this should not be reachable!");
4869 debug_assert!(false);
4873 expected_amt_msat = htlc.total_value_received;
4874 claimable_amt_msat += htlc.value;
4876 mem::drop(per_peer_state);
4877 if sources.is_empty() || expected_amt_msat.is_none() {
4878 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4879 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
4882 if claimable_amt_msat != expected_amt_msat.unwrap() {
4883 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4884 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
4885 expected_amt_msat.unwrap(), claimable_amt_msat);
4889 for htlc in sources.drain(..) {
4890 if let Err((pk, err)) = self.claim_funds_from_hop(
4891 htlc.prev_hop, payment_preimage,
4892 |_| Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash }))
4894 if let msgs::ErrorAction::IgnoreError = err.err.action {
4895 // We got a temporary failure updating monitor, but will claim the
4896 // HTLC when the monitor updating is restored (or on chain).
4897 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
4898 } else { errs.push((pk, err)); }
4903 for htlc in sources.drain(..) {
4904 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
4905 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
4906 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
4907 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
4908 let receiver = HTLCDestination::FailedPayment { payment_hash };
4909 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
4911 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4914 // Now we can handle any errors which were generated.
4915 for (counterparty_node_id, err) in errs.drain(..) {
4916 let res: Result<(), _> = Err(err);
4917 let _ = handle_error!(self, res, counterparty_node_id);
4921 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>) -> Option<MonitorUpdateCompletionAction>>(&self,
4922 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
4923 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
4924 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
4926 // If we haven't yet run background events assume we're still deserializing and shouldn't
4927 // actually pass `ChannelMonitorUpdate`s to users yet. Instead, queue them up as
4928 // `BackgroundEvent`s.
4929 let during_init = !self.background_events_processed_since_startup.load(Ordering::Acquire);
4932 let per_peer_state = self.per_peer_state.read().unwrap();
4933 let chan_id = prev_hop.outpoint.to_channel_id();
4934 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
4935 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
4939 let peer_state_opt = counterparty_node_id_opt.as_ref().map(
4940 |counterparty_node_id| per_peer_state.get(counterparty_node_id)
4941 .map(|peer_mutex| peer_mutex.lock().unwrap())
4944 if peer_state_opt.is_some() {
4945 let mut peer_state_lock = peer_state_opt.unwrap();
4946 let peer_state = &mut *peer_state_lock;
4947 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(chan_id) {
4948 let counterparty_node_id = chan.get().context.get_counterparty_node_id();
4949 let fulfill_res = chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger);
4951 if let UpdateFulfillCommitFetch::NewClaim { htlc_value_msat, monitor_update } = fulfill_res {
4952 if let Some(action) = completion_action(Some(htlc_value_msat)) {
4953 log_trace!(self.logger, "Tracking monitor update completion action for channel {}: {:?}",
4954 log_bytes!(chan_id), action);
4955 peer_state.monitor_update_blocked_actions.entry(chan_id).or_insert(Vec::new()).push(action);
4958 let res = handle_new_monitor_update!(self, prev_hop.outpoint, monitor_update, peer_state_lock,
4959 peer_state, per_peer_state, chan);
4960 if let Err(e) = res {
4961 // TODO: This is a *critical* error - we probably updated the outbound edge
4962 // of the HTLC's monitor with a preimage. We should retry this monitor
4963 // update over and over again until morale improves.
4964 log_error!(self.logger, "Failed to update channel monitor with preimage {:?}", payment_preimage);
4965 return Err((counterparty_node_id, e));
4968 // If we're running during init we cannot update a monitor directly -
4969 // they probably haven't actually been loaded yet. Instead, push the
4970 // monitor update as a background event.
4971 self.pending_background_events.lock().unwrap().push(
4972 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
4973 counterparty_node_id,
4974 funding_txo: prev_hop.outpoint,
4975 update: monitor_update.clone(),
4983 let preimage_update = ChannelMonitorUpdate {
4984 update_id: CLOSED_CHANNEL_UPDATE_ID,
4985 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
4991 // We update the ChannelMonitor on the backward link, after
4992 // receiving an `update_fulfill_htlc` from the forward link.
4993 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, &preimage_update);
4994 if update_res != ChannelMonitorUpdateStatus::Completed {
4995 // TODO: This needs to be handled somehow - if we receive a monitor update
4996 // with a preimage we *must* somehow manage to propagate it to the upstream
4997 // channel, or we must have an ability to receive the same event and try
4998 // again on restart.
4999 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
5000 payment_preimage, update_res);
5003 // If we're running during init we cannot update a monitor directly - they probably
5004 // haven't actually been loaded yet. Instead, push the monitor update as a background
5006 // Note that while it's safe to use `ClosedMonitorUpdateRegeneratedOnStartup` here (the
5007 // channel is already closed) we need to ultimately handle the monitor update
5008 // completion action only after we've completed the monitor update. This is the only
5009 // way to guarantee this update *will* be regenerated on startup (otherwise if this was
5010 // from a forwarded HTLC the downstream preimage may be deleted before we claim
5011 // upstream). Thus, we need to transition to some new `BackgroundEvent` type which will
5012 // complete the monitor update completion action from `completion_action`.
5013 self.pending_background_events.lock().unwrap().push(
5014 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((
5015 prev_hop.outpoint, preimage_update,
5018 // Note that we do process the completion action here. This totally could be a
5019 // duplicate claim, but we have no way of knowing without interrogating the
5020 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
5021 // generally always allowed to be duplicative (and it's specifically noted in
5022 // `PaymentForwarded`).
5023 self.handle_monitor_update_completion_actions(completion_action(None));
5027 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
5028 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
5031 fn claim_funds_internal(&self, source: HTLCSource, payment_preimage: PaymentPreimage, forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, next_channel_id: [u8; 32]) {
5033 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
5034 debug_assert!(self.background_events_processed_since_startup.load(Ordering::Acquire),
5035 "We don't support claim_htlc claims during startup - monitors may not be available yet");
5036 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage, session_priv, path, from_onchain, &self.pending_events, &self.logger);
5038 HTLCSource::PreviousHopData(hop_data) => {
5039 let prev_outpoint = hop_data.outpoint;
5040 let res = self.claim_funds_from_hop(hop_data, payment_preimage,
5041 |htlc_claim_value_msat| {
5042 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
5043 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
5044 Some(claimed_htlc_value - forwarded_htlc_value)
5047 Some(MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5048 event: events::Event::PaymentForwarded {
5050 claim_from_onchain_tx: from_onchain,
5051 prev_channel_id: Some(prev_outpoint.to_channel_id()),
5052 next_channel_id: Some(next_channel_id),
5053 outbound_amount_forwarded_msat: forwarded_htlc_value_msat,
5055 downstream_counterparty_and_funding_outpoint: None,
5059 if let Err((pk, err)) = res {
5060 let result: Result<(), _> = Err(err);
5061 let _ = handle_error!(self, result, pk);
5067 /// Gets the node_id held by this ChannelManager
5068 pub fn get_our_node_id(&self) -> PublicKey {
5069 self.our_network_pubkey.clone()
5072 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
5073 for action in actions.into_iter() {
5075 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
5076 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5077 if let Some(ClaimingPayment { amount_msat, payment_purpose: purpose, receiver_node_id }) = payment {
5078 self.pending_events.lock().unwrap().push_back((events::Event::PaymentClaimed {
5079 payment_hash, purpose, amount_msat, receiver_node_id: Some(receiver_node_id),
5083 MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5084 event, downstream_counterparty_and_funding_outpoint
5086 self.pending_events.lock().unwrap().push_back((event, None));
5087 if let Some((node_id, funding_outpoint, blocker)) = downstream_counterparty_and_funding_outpoint {
5088 self.handle_monitor_update_release(node_id, funding_outpoint, Some(blocker));
5095 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
5096 /// update completion.
5097 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
5098 channel: &mut Channel<<SP::Target as SignerProvider>::Signer>, raa: Option<msgs::RevokeAndACK>,
5099 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
5100 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
5101 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
5102 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
5103 log_trace!(self.logger, "Handling channel resumption for channel {} with {} RAA, {} commitment update, {} pending forwards, {}broadcasting funding, {} channel ready, {} announcement",
5104 log_bytes!(channel.context.channel_id()),
5105 if raa.is_some() { "an" } else { "no" },
5106 if commitment_update.is_some() { "a" } else { "no" }, pending_forwards.len(),
5107 if funding_broadcastable.is_some() { "" } else { "not " },
5108 if channel_ready.is_some() { "sending" } else { "without" },
5109 if announcement_sigs.is_some() { "sending" } else { "without" });
5111 let mut htlc_forwards = None;
5113 let counterparty_node_id = channel.context.get_counterparty_node_id();
5114 if !pending_forwards.is_empty() {
5115 htlc_forwards = Some((channel.context.get_short_channel_id().unwrap_or(channel.context.outbound_scid_alias()),
5116 channel.context.get_funding_txo().unwrap(), channel.context.get_user_id(), pending_forwards));
5119 if let Some(msg) = channel_ready {
5120 send_channel_ready!(self, pending_msg_events, channel, msg);
5122 if let Some(msg) = announcement_sigs {
5123 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5124 node_id: counterparty_node_id,
5129 macro_rules! handle_cs { () => {
5130 if let Some(update) = commitment_update {
5131 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5132 node_id: counterparty_node_id,
5137 macro_rules! handle_raa { () => {
5138 if let Some(revoke_and_ack) = raa {
5139 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
5140 node_id: counterparty_node_id,
5141 msg: revoke_and_ack,
5146 RAACommitmentOrder::CommitmentFirst => {
5150 RAACommitmentOrder::RevokeAndACKFirst => {
5156 if let Some(tx) = funding_broadcastable {
5157 log_info!(self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
5158 self.tx_broadcaster.broadcast_transactions(&[&tx]);
5162 let mut pending_events = self.pending_events.lock().unwrap();
5163 emit_channel_pending_event!(pending_events, channel);
5164 emit_channel_ready_event!(pending_events, channel);
5170 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
5171 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
5173 let counterparty_node_id = match counterparty_node_id {
5174 Some(cp_id) => cp_id.clone(),
5176 // TODO: Once we can rely on the counterparty_node_id from the
5177 // monitor event, this and the id_to_peer map should be removed.
5178 let id_to_peer = self.id_to_peer.lock().unwrap();
5179 match id_to_peer.get(&funding_txo.to_channel_id()) {
5180 Some(cp_id) => cp_id.clone(),
5185 let per_peer_state = self.per_peer_state.read().unwrap();
5186 let mut peer_state_lock;
5187 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
5188 if peer_state_mutex_opt.is_none() { return }
5189 peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5190 let peer_state = &mut *peer_state_lock;
5192 if let Some(chan) = peer_state.channel_by_id.get_mut(&funding_txo.to_channel_id()) {
5195 let update_actions = peer_state.monitor_update_blocked_actions
5196 .remove(&funding_txo.to_channel_id()).unwrap_or(Vec::new());
5197 mem::drop(peer_state_lock);
5198 mem::drop(per_peer_state);
5199 self.handle_monitor_update_completion_actions(update_actions);
5202 let remaining_in_flight =
5203 if let Some(pending) = peer_state.in_flight_monitor_updates.get_mut(funding_txo) {
5204 pending.retain(|upd| upd.update_id > highest_applied_update_id);
5207 log_trace!(self.logger, "ChannelMonitor updated to {}. Current highest is {}. {} pending in-flight updates.",
5208 highest_applied_update_id, channel.context.get_latest_monitor_update_id(),
5209 remaining_in_flight);
5210 if !channel.is_awaiting_monitor_update() || channel.context.get_latest_monitor_update_id() != highest_applied_update_id {
5213 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, channel);
5216 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
5218 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
5219 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
5222 /// The `user_channel_id` parameter will be provided back in
5223 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5224 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5226 /// Note that this method will return an error and reject the channel, if it requires support
5227 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
5228 /// used to accept such channels.
5230 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5231 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5232 pub fn accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5233 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
5236 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
5237 /// it as confirmed immediately.
5239 /// The `user_channel_id` parameter will be provided back in
5240 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5241 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5243 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
5244 /// and (if the counterparty agrees), enables forwarding of payments immediately.
5246 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
5247 /// transaction and blindly assumes that it will eventually confirm.
5249 /// If it does not confirm before we decide to close the channel, or if the funding transaction
5250 /// does not pay to the correct script the correct amount, *you will lose funds*.
5252 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5253 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5254 pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5255 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
5258 fn do_accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
5259 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5261 let peers_without_funded_channels =
5262 self.peers_without_funded_channels(|peer| { peer.total_channel_count() > 0 });
5263 let per_peer_state = self.per_peer_state.read().unwrap();
5264 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5265 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
5266 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5267 let peer_state = &mut *peer_state_lock;
5268 let is_only_peer_channel = peer_state.total_channel_count() == 1;
5269 match peer_state.inbound_v1_channel_by_id.entry(temporary_channel_id.clone()) {
5270 hash_map::Entry::Occupied(mut channel) => {
5271 if !channel.get().is_awaiting_accept() {
5272 return Err(APIError::APIMisuseError { err: "The channel isn't currently awaiting to be accepted.".to_owned() });
5275 channel.get_mut().set_0conf();
5276 } else if channel.get().context.get_channel_type().requires_zero_conf() {
5277 let send_msg_err_event = events::MessageSendEvent::HandleError {
5278 node_id: channel.get().context.get_counterparty_node_id(),
5279 action: msgs::ErrorAction::SendErrorMessage{
5280 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
5283 peer_state.pending_msg_events.push(send_msg_err_event);
5284 let _ = remove_channel!(self, channel);
5285 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
5287 // If this peer already has some channels, a new channel won't increase our number of peers
5288 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
5289 // channels per-peer we can accept channels from a peer with existing ones.
5290 if is_only_peer_channel && peers_without_funded_channels >= MAX_UNFUNDED_CHANNEL_PEERS {
5291 let send_msg_err_event = events::MessageSendEvent::HandleError {
5292 node_id: channel.get().context.get_counterparty_node_id(),
5293 action: msgs::ErrorAction::SendErrorMessage{
5294 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "Have too many peers with unfunded channels, not accepting new ones".to_owned(), }
5297 peer_state.pending_msg_events.push(send_msg_err_event);
5298 let _ = remove_channel!(self, channel);
5299 return Err(APIError::APIMisuseError { err: "Too many peers with unfunded channels, refusing to accept new ones".to_owned() });
5303 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
5304 node_id: channel.get().context.get_counterparty_node_id(),
5305 msg: channel.get_mut().accept_inbound_channel(user_channel_id),
5308 hash_map::Entry::Vacant(_) => {
5309 return Err(APIError::ChannelUnavailable { err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*temporary_channel_id), counterparty_node_id) });
5315 /// Gets the number of peers which match the given filter and do not have any funded, outbound,
5316 /// or 0-conf channels.
5318 /// The filter is called for each peer and provided with the number of unfunded, inbound, and
5319 /// non-0-conf channels we have with the peer.
5320 fn peers_without_funded_channels<Filter>(&self, maybe_count_peer: Filter) -> usize
5321 where Filter: Fn(&PeerState<<SP::Target as SignerProvider>::Signer>) -> bool {
5322 let mut peers_without_funded_channels = 0;
5323 let best_block_height = self.best_block.read().unwrap().height();
5325 let peer_state_lock = self.per_peer_state.read().unwrap();
5326 for (_, peer_mtx) in peer_state_lock.iter() {
5327 let peer = peer_mtx.lock().unwrap();
5328 if !maybe_count_peer(&*peer) { continue; }
5329 let num_unfunded_channels = Self::unfunded_channel_count(&peer, best_block_height);
5330 if num_unfunded_channels == peer.total_channel_count() {
5331 peers_without_funded_channels += 1;
5335 return peers_without_funded_channels;
5338 fn unfunded_channel_count(
5339 peer: &PeerState<<SP::Target as SignerProvider>::Signer>, best_block_height: u32
5341 let mut num_unfunded_channels = 0;
5342 for (_, chan) in peer.channel_by_id.iter() {
5343 // This covers non-zero-conf inbound `Channel`s that we are currently monitoring, but those
5344 // which have not yet had any confirmations on-chain.
5345 if !chan.context.is_outbound() && chan.context.minimum_depth().unwrap_or(1) != 0 &&
5346 chan.context.get_funding_tx_confirmations(best_block_height) == 0
5348 num_unfunded_channels += 1;
5351 for (_, chan) in peer.inbound_v1_channel_by_id.iter() {
5352 if chan.context.minimum_depth().unwrap_or(1) != 0 {
5353 num_unfunded_channels += 1;
5356 num_unfunded_channels
5359 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
5360 if msg.chain_hash != self.genesis_hash {
5361 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
5364 if !self.default_configuration.accept_inbound_channels {
5365 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
5368 let mut random_bytes = [0u8; 16];
5369 random_bytes.copy_from_slice(&self.entropy_source.get_secure_random_bytes()[..16]);
5370 let user_channel_id = u128::from_be_bytes(random_bytes);
5371 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
5373 // Get the number of peers with channels, but without funded ones. We don't care too much
5374 // about peers that never open a channel, so we filter by peers that have at least one
5375 // channel, and then limit the number of those with unfunded channels.
5376 let channeled_peers_without_funding =
5377 self.peers_without_funded_channels(|node| node.total_channel_count() > 0);
5379 let per_peer_state = self.per_peer_state.read().unwrap();
5380 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5382 debug_assert!(false);
5383 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())
5385 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5386 let peer_state = &mut *peer_state_lock;
5388 // If this peer already has some channels, a new channel won't increase our number of peers
5389 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
5390 // channels per-peer we can accept channels from a peer with existing ones.
5391 if peer_state.total_channel_count() == 0 &&
5392 channeled_peers_without_funding >= MAX_UNFUNDED_CHANNEL_PEERS &&
5393 !self.default_configuration.manually_accept_inbound_channels
5395 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5396 "Have too many peers with unfunded channels, not accepting new ones".to_owned(),
5397 msg.temporary_channel_id.clone()));
5400 let best_block_height = self.best_block.read().unwrap().height();
5401 if Self::unfunded_channel_count(peer_state, best_block_height) >= MAX_UNFUNDED_CHANS_PER_PEER {
5402 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5403 format!("Refusing more than {} unfunded channels.", MAX_UNFUNDED_CHANS_PER_PEER),
5404 msg.temporary_channel_id.clone()));
5407 let mut channel = match InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
5408 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id,
5409 &self.default_configuration, best_block_height, &self.logger, outbound_scid_alias)
5412 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
5413 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
5417 let channel_id = channel.context.channel_id();
5418 let channel_exists = peer_state.has_channel(&channel_id);
5420 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
5421 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision for the same peer!".to_owned(), msg.temporary_channel_id.clone()))
5423 if !self.default_configuration.manually_accept_inbound_channels {
5424 let channel_type = channel.context.get_channel_type();
5425 if channel_type.requires_zero_conf() {
5426 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
5428 if channel_type.requires_anchors_zero_fee_htlc_tx() {
5429 return Err(MsgHandleErrInternal::send_err_msg_no_close("No channels with anchor outputs accepted".to_owned(), msg.temporary_channel_id.clone()));
5431 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
5432 node_id: counterparty_node_id.clone(),
5433 msg: channel.accept_inbound_channel(user_channel_id),
5436 let mut pending_events = self.pending_events.lock().unwrap();
5437 pending_events.push_back((events::Event::OpenChannelRequest {
5438 temporary_channel_id: msg.temporary_channel_id.clone(),
5439 counterparty_node_id: counterparty_node_id.clone(),
5440 funding_satoshis: msg.funding_satoshis,
5441 push_msat: msg.push_msat,
5442 channel_type: channel.context.get_channel_type().clone(),
5445 peer_state.inbound_v1_channel_by_id.insert(channel_id, channel);
5450 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
5451 let (value, output_script, user_id) = {
5452 let per_peer_state = self.per_peer_state.read().unwrap();
5453 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5455 debug_assert!(false);
5456 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)
5458 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5459 let peer_state = &mut *peer_state_lock;
5460 match peer_state.outbound_v1_channel_by_id.entry(msg.temporary_channel_id) {
5461 hash_map::Entry::Occupied(mut chan) => {
5462 try_v1_outbound_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &peer_state.latest_features), chan);
5463 (chan.get().context.get_value_satoshis(), chan.get().context.get_funding_redeemscript().to_v0_p2wsh(), chan.get().context.get_user_id())
5465 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))
5468 let mut pending_events = self.pending_events.lock().unwrap();
5469 pending_events.push_back((events::Event::FundingGenerationReady {
5470 temporary_channel_id: msg.temporary_channel_id,
5471 counterparty_node_id: *counterparty_node_id,
5472 channel_value_satoshis: value,
5474 user_channel_id: user_id,
5479 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
5480 let best_block = *self.best_block.read().unwrap();
5482 let per_peer_state = self.per_peer_state.read().unwrap();
5483 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5485 debug_assert!(false);
5486 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)
5489 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5490 let peer_state = &mut *peer_state_lock;
5491 let (chan, funding_msg, monitor) =
5492 match peer_state.inbound_v1_channel_by_id.remove(&msg.temporary_channel_id) {
5493 Some(inbound_chan) => {
5494 match inbound_chan.funding_created(msg, best_block, &self.signer_provider, &self.logger) {
5496 Err((mut inbound_chan, err)) => {
5497 // We've already removed this inbound channel from the map in `PeerState`
5498 // above so at this point we just need to clean up any lingering entries
5499 // concerning this channel as it is safe to do so.
5500 update_maps_on_chan_removal!(self, &inbound_chan.context);
5501 let user_id = inbound_chan.context.get_user_id();
5502 let shutdown_res = inbound_chan.context.force_shutdown(false);
5503 return Err(MsgHandleErrInternal::from_finish_shutdown(format!("{}", err),
5504 msg.temporary_channel_id, user_id, shutdown_res, None, inbound_chan.context.get_value_satoshis()));
5508 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))
5511 match peer_state.channel_by_id.entry(funding_msg.channel_id) {
5512 hash_map::Entry::Occupied(_) => {
5513 Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
5515 hash_map::Entry::Vacant(e) => {
5516 match self.id_to_peer.lock().unwrap().entry(chan.context.channel_id()) {
5517 hash_map::Entry::Occupied(_) => {
5518 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5519 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
5520 funding_msg.channel_id))
5522 hash_map::Entry::Vacant(i_e) => {
5523 i_e.insert(chan.context.get_counterparty_node_id());
5527 // There's no problem signing a counterparty's funding transaction if our monitor
5528 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
5529 // accepted payment from yet. We do, however, need to wait to send our channel_ready
5530 // until we have persisted our monitor.
5531 let new_channel_id = funding_msg.channel_id;
5532 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
5533 node_id: counterparty_node_id.clone(),
5537 let monitor_res = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
5539 let chan = e.insert(chan);
5540 let mut res = handle_new_monitor_update!(self, monitor_res, peer_state_lock, peer_state,
5541 per_peer_state, chan, MANUALLY_REMOVING_INITIAL_MONITOR,
5542 { peer_state.channel_by_id.remove(&new_channel_id) });
5544 // Note that we reply with the new channel_id in error messages if we gave up on the
5545 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
5546 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
5547 // any messages referencing a previously-closed channel anyway.
5548 // We do not propagate the monitor update to the user as it would be for a monitor
5549 // that we didn't manage to store (and that we don't care about - we don't respond
5550 // with the funding_signed so the channel can never go on chain).
5551 if let Err(MsgHandleErrInternal { shutdown_finish: Some((res, _)), .. }) = &mut res {
5559 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
5560 let best_block = *self.best_block.read().unwrap();
5561 let per_peer_state = self.per_peer_state.read().unwrap();
5562 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5564 debug_assert!(false);
5565 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5568 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5569 let peer_state = &mut *peer_state_lock;
5570 match peer_state.channel_by_id.entry(msg.channel_id) {
5571 hash_map::Entry::Occupied(mut chan) => {
5572 let monitor = try_chan_entry!(self,
5573 chan.get_mut().funding_signed(&msg, best_block, &self.signer_provider, &self.logger), chan);
5574 let update_res = self.chain_monitor.watch_channel(chan.get().context.get_funding_txo().unwrap(), monitor);
5575 let mut res = handle_new_monitor_update!(self, update_res, peer_state_lock, peer_state, per_peer_state, chan, INITIAL_MONITOR);
5576 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
5577 // We weren't able to watch the channel to begin with, so no updates should be made on
5578 // it. Previously, full_stack_target found an (unreachable) panic when the
5579 // monitor update contained within `shutdown_finish` was applied.
5580 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
5581 shutdown_finish.0.take();
5586 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5590 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
5591 let per_peer_state = self.per_peer_state.read().unwrap();
5592 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5594 debug_assert!(false);
5595 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5597 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5598 let peer_state = &mut *peer_state_lock;
5599 match peer_state.channel_by_id.entry(msg.channel_id) {
5600 hash_map::Entry::Occupied(mut chan) => {
5601 let announcement_sigs_opt = try_chan_entry!(self, chan.get_mut().channel_ready(&msg, &self.node_signer,
5602 self.genesis_hash.clone(), &self.default_configuration, &self.best_block.read().unwrap(), &self.logger), chan);
5603 if let Some(announcement_sigs) = announcement_sigs_opt {
5604 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(chan.get().context.channel_id()));
5605 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5606 node_id: counterparty_node_id.clone(),
5607 msg: announcement_sigs,
5609 } else if chan.get().context.is_usable() {
5610 // If we're sending an announcement_signatures, we'll send the (public)
5611 // channel_update after sending a channel_announcement when we receive our
5612 // counterparty's announcement_signatures. Thus, we only bother to send a
5613 // channel_update here if the channel is not public, i.e. we're not sending an
5614 // announcement_signatures.
5615 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", log_bytes!(chan.get().context.channel_id()));
5616 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
5617 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
5618 node_id: counterparty_node_id.clone(),
5625 let mut pending_events = self.pending_events.lock().unwrap();
5626 emit_channel_ready_event!(pending_events, chan.get_mut());
5631 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
5635 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
5636 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
5637 let result: Result<(), _> = loop {
5638 let per_peer_state = self.per_peer_state.read().unwrap();
5639 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5641 debug_assert!(false);
5642 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5644 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5645 let peer_state = &mut *peer_state_lock;
5646 // TODO(dunxen): Fix this duplication when we switch to a single map with enums as per
5647 // https://github.com/lightningdevkit/rust-lightning/issues/2422
5648 if let hash_map::Entry::Occupied(chan_entry) = peer_state.outbound_v1_channel_by_id.entry(msg.channel_id.clone()) {
5649 log_error!(self.logger, "Immediately closing unfunded channel {} as peer asked to cooperatively shut it down (which is unnecessary)", log_bytes!(&msg.channel_id[..]));
5650 self.issue_channel_close_events(&chan_entry.get().context, ClosureReason::CounterpartyCoopClosedUnfundedChannel);
5651 let mut chan = remove_channel!(self, chan_entry);
5652 self.finish_force_close_channel(chan.context.force_shutdown(false));
5654 } else if let hash_map::Entry::Occupied(chan_entry) = peer_state.inbound_v1_channel_by_id.entry(msg.channel_id.clone()) {
5655 log_error!(self.logger, "Immediately closing unfunded channel {} as peer asked to cooperatively shut it down (which is unnecessary)", log_bytes!(&msg.channel_id[..]));
5656 self.issue_channel_close_events(&chan_entry.get().context, ClosureReason::CounterpartyCoopClosedUnfundedChannel);
5657 let mut chan = remove_channel!(self, chan_entry);
5658 self.finish_force_close_channel(chan.context.force_shutdown(false));
5660 } else if let hash_map::Entry::Occupied(mut chan_entry) = peer_state.channel_by_id.entry(msg.channel_id.clone()) {
5661 if !chan_entry.get().received_shutdown() {
5662 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
5663 log_bytes!(msg.channel_id),
5664 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
5667 let funding_txo_opt = chan_entry.get().context.get_funding_txo();
5668 let (shutdown, monitor_update_opt, htlcs) = try_chan_entry!(self,
5669 chan_entry.get_mut().shutdown(&self.signer_provider, &peer_state.latest_features, &msg), chan_entry);
5670 dropped_htlcs = htlcs;
5672 if let Some(msg) = shutdown {
5673 // We can send the `shutdown` message before updating the `ChannelMonitor`
5674 // here as we don't need the monitor update to complete until we send a
5675 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
5676 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5677 node_id: *counterparty_node_id,
5682 // Update the monitor with the shutdown script if necessary.
5683 if let Some(monitor_update) = monitor_update_opt {
5684 break handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
5685 peer_state_lock, peer_state, per_peer_state, chan_entry).map(|_| ());
5689 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))
5692 for htlc_source in dropped_htlcs.drain(..) {
5693 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
5694 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
5695 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
5701 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
5702 let per_peer_state = self.per_peer_state.read().unwrap();
5703 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5705 debug_assert!(false);
5706 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5708 let (tx, chan_option) = {
5709 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5710 let peer_state = &mut *peer_state_lock;
5711 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
5712 hash_map::Entry::Occupied(mut chan_entry) => {
5713 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), chan_entry);
5714 if let Some(msg) = closing_signed {
5715 peer_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5716 node_id: counterparty_node_id.clone(),
5721 // We're done with this channel, we've got a signed closing transaction and
5722 // will send the closing_signed back to the remote peer upon return. This
5723 // also implies there are no pending HTLCs left on the channel, so we can
5724 // fully delete it from tracking (the channel monitor is still around to
5725 // watch for old state broadcasts)!
5726 (tx, Some(remove_channel!(self, chan_entry)))
5727 } else { (tx, None) }
5729 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
5732 if let Some(broadcast_tx) = tx {
5733 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
5734 self.tx_broadcaster.broadcast_transactions(&[&broadcast_tx]);
5736 if let Some(chan) = chan_option {
5737 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5738 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5739 let peer_state = &mut *peer_state_lock;
5740 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5744 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
5749 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
5750 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
5751 //determine the state of the payment based on our response/if we forward anything/the time
5752 //we take to respond. We should take care to avoid allowing such an attack.
5754 //TODO: There exists a further attack where a node may garble the onion data, forward it to
5755 //us repeatedly garbled in different ways, and compare our error messages, which are
5756 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
5757 //but we should prevent it anyway.
5759 let decoded_hop_res = self.decode_update_add_htlc_onion(msg);
5760 let per_peer_state = self.per_peer_state.read().unwrap();
5761 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5763 debug_assert!(false);
5764 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5766 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5767 let peer_state = &mut *peer_state_lock;
5768 match peer_state.channel_by_id.entry(msg.channel_id) {
5769 hash_map::Entry::Occupied(mut chan) => {
5771 let pending_forward_info = match decoded_hop_res {
5772 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
5773 self.construct_pending_htlc_status(msg, shared_secret, next_hop,
5774 chan.get().context.config().accept_underpaying_htlcs, next_packet_pk_opt),
5775 Err(e) => PendingHTLCStatus::Fail(e)
5777 let create_pending_htlc_status = |chan: &Channel<<SP::Target as SignerProvider>::Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
5778 // If the update_add is completely bogus, the call will Err and we will close,
5779 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
5780 // want to reject the new HTLC and fail it backwards instead of forwarding.
5781 match pending_forward_info {
5782 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
5783 let reason = if (error_code & 0x1000) != 0 {
5784 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
5785 HTLCFailReason::reason(real_code, error_data)
5787 HTLCFailReason::from_failure_code(error_code)
5788 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
5789 let msg = msgs::UpdateFailHTLC {
5790 channel_id: msg.channel_id,
5791 htlc_id: msg.htlc_id,
5794 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
5796 _ => pending_forward_info
5799 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.fee_estimator, &self.logger), chan);
5801 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))
5806 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
5807 let (htlc_source, forwarded_htlc_value) = {
5808 let per_peer_state = self.per_peer_state.read().unwrap();
5809 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5811 debug_assert!(false);
5812 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5814 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5815 let peer_state = &mut *peer_state_lock;
5816 match peer_state.channel_by_id.entry(msg.channel_id) {
5817 hash_map::Entry::Occupied(mut chan) => {
5818 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), chan)
5820 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))
5823 self.claim_funds_internal(htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, msg.channel_id);
5827 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
5828 let per_peer_state = self.per_peer_state.read().unwrap();
5829 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5831 debug_assert!(false);
5832 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5834 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5835 let peer_state = &mut *peer_state_lock;
5836 match peer_state.channel_by_id.entry(msg.channel_id) {
5837 hash_map::Entry::Occupied(mut chan) => {
5838 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan);
5840 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))
5845 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
5846 let per_peer_state = self.per_peer_state.read().unwrap();
5847 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5849 debug_assert!(false);
5850 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5852 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5853 let peer_state = &mut *peer_state_lock;
5854 match peer_state.channel_by_id.entry(msg.channel_id) {
5855 hash_map::Entry::Occupied(mut chan) => {
5856 if (msg.failure_code & 0x8000) == 0 {
5857 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
5858 try_chan_entry!(self, Err(chan_err), chan);
5860 try_chan_entry!(self, chan.get_mut().update_fail_malformed_htlc(&msg, HTLCFailReason::reason(msg.failure_code, msg.sha256_of_onion.to_vec())), chan);
5863 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))
5867 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
5868 let per_peer_state = self.per_peer_state.read().unwrap();
5869 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5871 debug_assert!(false);
5872 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5874 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5875 let peer_state = &mut *peer_state_lock;
5876 match peer_state.channel_by_id.entry(msg.channel_id) {
5877 hash_map::Entry::Occupied(mut chan) => {
5878 let funding_txo = chan.get().context.get_funding_txo();
5879 let monitor_update_opt = try_chan_entry!(self, chan.get_mut().commitment_signed(&msg, &self.logger), chan);
5880 if let Some(monitor_update) = monitor_update_opt {
5881 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update, peer_state_lock,
5882 peer_state, per_peer_state, chan).map(|_| ())
5885 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))
5890 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
5891 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
5892 let mut push_forward_event = false;
5893 let mut new_intercept_events = VecDeque::new();
5894 let mut failed_intercept_forwards = Vec::new();
5895 if !pending_forwards.is_empty() {
5896 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
5897 let scid = match forward_info.routing {
5898 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
5899 PendingHTLCRouting::Receive { .. } => 0,
5900 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
5902 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
5903 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
5905 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
5906 let forward_htlcs_empty = forward_htlcs.is_empty();
5907 match forward_htlcs.entry(scid) {
5908 hash_map::Entry::Occupied(mut entry) => {
5909 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
5910 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
5912 hash_map::Entry::Vacant(entry) => {
5913 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
5914 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.genesis_hash)
5916 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).into_inner());
5917 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
5918 match pending_intercepts.entry(intercept_id) {
5919 hash_map::Entry::Vacant(entry) => {
5920 new_intercept_events.push_back((events::Event::HTLCIntercepted {
5921 requested_next_hop_scid: scid,
5922 payment_hash: forward_info.payment_hash,
5923 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
5924 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
5927 entry.insert(PendingAddHTLCInfo {
5928 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
5930 hash_map::Entry::Occupied(_) => {
5931 log_info!(self.logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
5932 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
5933 short_channel_id: prev_short_channel_id,
5934 outpoint: prev_funding_outpoint,
5935 htlc_id: prev_htlc_id,
5936 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
5937 phantom_shared_secret: None,
5940 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
5941 HTLCFailReason::from_failure_code(0x4000 | 10),
5942 HTLCDestination::InvalidForward { requested_forward_scid: scid },
5947 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
5948 // payments are being processed.
5949 if forward_htlcs_empty {
5950 push_forward_event = true;
5952 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
5953 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
5960 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
5961 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
5964 if !new_intercept_events.is_empty() {
5965 let mut events = self.pending_events.lock().unwrap();
5966 events.append(&mut new_intercept_events);
5968 if push_forward_event { self.push_pending_forwards_ev() }
5972 fn push_pending_forwards_ev(&self) {
5973 let mut pending_events = self.pending_events.lock().unwrap();
5974 let is_processing_events = self.pending_events_processor.load(Ordering::Acquire);
5975 let num_forward_events = pending_events.iter().filter(|(ev, _)|
5976 if let events::Event::PendingHTLCsForwardable { .. } = ev { true } else { false }
5978 // We only want to push a PendingHTLCsForwardable event if no others are queued. Processing
5979 // events is done in batches and they are not removed until we're done processing each
5980 // batch. Since handling a `PendingHTLCsForwardable` event will call back into the
5981 // `ChannelManager`, we'll still see the original forwarding event not removed. Phantom
5982 // payments will need an additional forwarding event before being claimed to make them look
5983 // real by taking more time.
5984 if (is_processing_events && num_forward_events <= 1) || num_forward_events < 1 {
5985 pending_events.push_back((Event::PendingHTLCsForwardable {
5986 time_forwardable: Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
5991 /// Checks whether [`ChannelMonitorUpdate`]s generated by the receipt of a remote
5992 /// [`msgs::RevokeAndACK`] should be held for the given channel until some other action
5993 /// completes. Note that this needs to happen in the same [`PeerState`] mutex as any release of
5994 /// the [`ChannelMonitorUpdate`] in question.
5995 fn raa_monitor_updates_held(&self,
5996 actions_blocking_raa_monitor_updates: &BTreeMap<[u8; 32], Vec<RAAMonitorUpdateBlockingAction>>,
5997 channel_funding_outpoint: OutPoint, counterparty_node_id: PublicKey
5999 actions_blocking_raa_monitor_updates
6000 .get(&channel_funding_outpoint.to_channel_id()).map(|v| !v.is_empty()).unwrap_or(false)
6001 || self.pending_events.lock().unwrap().iter().any(|(_, action)| {
6002 action == &Some(EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
6003 channel_funding_outpoint,
6004 counterparty_node_id,
6009 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
6010 let (htlcs_to_fail, res) = {
6011 let per_peer_state = self.per_peer_state.read().unwrap();
6012 let mut peer_state_lock = per_peer_state.get(counterparty_node_id)
6014 debug_assert!(false);
6015 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6016 }).map(|mtx| mtx.lock().unwrap())?;
6017 let peer_state = &mut *peer_state_lock;
6018 match peer_state.channel_by_id.entry(msg.channel_id) {
6019 hash_map::Entry::Occupied(mut chan) => {
6020 let funding_txo = chan.get().context.get_funding_txo();
6021 let (htlcs_to_fail, monitor_update_opt) = try_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &self.fee_estimator, &self.logger), chan);
6022 let res = if let Some(monitor_update) = monitor_update_opt {
6023 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update,
6024 peer_state_lock, peer_state, per_peer_state, chan).map(|_| ())
6026 (htlcs_to_fail, res)
6028 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))
6031 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
6035 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
6036 let per_peer_state = self.per_peer_state.read().unwrap();
6037 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6039 debug_assert!(false);
6040 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6042 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6043 let peer_state = &mut *peer_state_lock;
6044 match peer_state.channel_by_id.entry(msg.channel_id) {
6045 hash_map::Entry::Occupied(mut chan) => {
6046 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg, &self.logger), chan);
6048 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))
6053 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
6054 let per_peer_state = self.per_peer_state.read().unwrap();
6055 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6057 debug_assert!(false);
6058 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6060 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6061 let peer_state = &mut *peer_state_lock;
6062 match peer_state.channel_by_id.entry(msg.channel_id) {
6063 hash_map::Entry::Occupied(mut chan) => {
6064 if !chan.get().context.is_usable() {
6065 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
6068 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
6069 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(
6070 &self.node_signer, self.genesis_hash.clone(), self.best_block.read().unwrap().height(),
6071 msg, &self.default_configuration
6073 // Note that announcement_signatures fails if the channel cannot be announced,
6074 // so get_channel_update_for_broadcast will never fail by the time we get here.
6075 update_msg: Some(self.get_channel_update_for_broadcast(chan.get()).unwrap()),
6078 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))
6083 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
6084 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
6085 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
6086 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
6088 // It's not a local channel
6089 return Ok(NotifyOption::SkipPersist)
6092 let per_peer_state = self.per_peer_state.read().unwrap();
6093 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
6094 if peer_state_mutex_opt.is_none() {
6095 return Ok(NotifyOption::SkipPersist)
6097 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
6098 let peer_state = &mut *peer_state_lock;
6099 match peer_state.channel_by_id.entry(chan_id) {
6100 hash_map::Entry::Occupied(mut chan) => {
6101 if chan.get().context.get_counterparty_node_id() != *counterparty_node_id {
6102 if chan.get().context.should_announce() {
6103 // If the announcement is about a channel of ours which is public, some
6104 // other peer may simply be forwarding all its gossip to us. Don't provide
6105 // a scary-looking error message and return Ok instead.
6106 return Ok(NotifyOption::SkipPersist);
6108 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));
6110 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().context.get_counterparty_node_id().serialize()[..];
6111 let msg_from_node_one = msg.contents.flags & 1 == 0;
6112 if were_node_one == msg_from_node_one {
6113 return Ok(NotifyOption::SkipPersist);
6115 log_debug!(self.logger, "Received channel_update for channel {}.", log_bytes!(chan_id));
6116 try_chan_entry!(self, chan.get_mut().channel_update(&msg), chan);
6119 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersist)
6121 Ok(NotifyOption::DoPersist)
6124 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
6126 let need_lnd_workaround = {
6127 let per_peer_state = self.per_peer_state.read().unwrap();
6129 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6131 debug_assert!(false);
6132 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6134 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6135 let peer_state = &mut *peer_state_lock;
6136 match peer_state.channel_by_id.entry(msg.channel_id) {
6137 hash_map::Entry::Occupied(mut chan) => {
6138 // Currently, we expect all holding cell update_adds to be dropped on peer
6139 // disconnect, so Channel's reestablish will never hand us any holding cell
6140 // freed HTLCs to fail backwards. If in the future we no longer drop pending
6141 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
6142 let responses = try_chan_entry!(self, chan.get_mut().channel_reestablish(
6143 msg, &self.logger, &self.node_signer, self.genesis_hash,
6144 &self.default_configuration, &*self.best_block.read().unwrap()), chan);
6145 let mut channel_update = None;
6146 if let Some(msg) = responses.shutdown_msg {
6147 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
6148 node_id: counterparty_node_id.clone(),
6151 } else if chan.get().context.is_usable() {
6152 // If the channel is in a usable state (ie the channel is not being shut
6153 // down), send a unicast channel_update to our counterparty to make sure
6154 // they have the latest channel parameters.
6155 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
6156 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
6157 node_id: chan.get().context.get_counterparty_node_id(),
6162 let need_lnd_workaround = chan.get_mut().context.workaround_lnd_bug_4006.take();
6163 htlc_forwards = self.handle_channel_resumption(
6164 &mut peer_state.pending_msg_events, chan.get_mut(), responses.raa, responses.commitment_update, responses.order,
6165 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
6166 if let Some(upd) = channel_update {
6167 peer_state.pending_msg_events.push(upd);
6171 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))
6175 if let Some(forwards) = htlc_forwards {
6176 self.forward_htlcs(&mut [forwards][..]);
6179 if let Some(channel_ready_msg) = need_lnd_workaround {
6180 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
6185 /// Process pending events from the [`chain::Watch`], returning whether any events were processed.
6186 fn process_pending_monitor_events(&self) -> bool {
6187 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
6189 let mut failed_channels = Vec::new();
6190 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
6191 let has_pending_monitor_events = !pending_monitor_events.is_empty();
6192 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
6193 for monitor_event in monitor_events.drain(..) {
6194 match monitor_event {
6195 MonitorEvent::HTLCEvent(htlc_update) => {
6196 if let Some(preimage) = htlc_update.payment_preimage {
6197 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
6198 self.claim_funds_internal(htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, funding_outpoint.to_channel_id());
6200 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
6201 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
6202 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
6203 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
6206 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
6207 MonitorEvent::UpdateFailed(funding_outpoint) => {
6208 let counterparty_node_id_opt = match counterparty_node_id {
6209 Some(cp_id) => Some(cp_id),
6211 // TODO: Once we can rely on the counterparty_node_id from the
6212 // monitor event, this and the id_to_peer map should be removed.
6213 let id_to_peer = self.id_to_peer.lock().unwrap();
6214 id_to_peer.get(&funding_outpoint.to_channel_id()).cloned()
6217 if let Some(counterparty_node_id) = counterparty_node_id_opt {
6218 let per_peer_state = self.per_peer_state.read().unwrap();
6219 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
6220 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6221 let peer_state = &mut *peer_state_lock;
6222 let pending_msg_events = &mut peer_state.pending_msg_events;
6223 if let hash_map::Entry::Occupied(chan_entry) = peer_state.channel_by_id.entry(funding_outpoint.to_channel_id()) {
6224 let mut chan = remove_channel!(self, chan_entry);
6225 failed_channels.push(chan.context.force_shutdown(false));
6226 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6227 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6231 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
6232 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
6234 ClosureReason::CommitmentTxConfirmed
6236 self.issue_channel_close_events(&chan.context, reason);
6237 pending_msg_events.push(events::MessageSendEvent::HandleError {
6238 node_id: chan.context.get_counterparty_node_id(),
6239 action: msgs::ErrorAction::SendErrorMessage {
6240 msg: msgs::ErrorMessage { channel_id: chan.context.channel_id(), data: "Channel force-closed".to_owned() }
6247 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
6248 self.channel_monitor_updated(&funding_txo, monitor_update_id, counterparty_node_id.as_ref());
6254 for failure in failed_channels.drain(..) {
6255 self.finish_force_close_channel(failure);
6258 has_pending_monitor_events
6261 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
6262 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
6263 /// update events as a separate process method here.
6265 pub fn process_monitor_events(&self) {
6266 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6267 self.process_pending_monitor_events();
6270 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
6271 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
6272 /// update was applied.
6273 fn check_free_holding_cells(&self) -> bool {
6274 let mut has_monitor_update = false;
6275 let mut failed_htlcs = Vec::new();
6276 let mut handle_errors = Vec::new();
6278 // Walk our list of channels and find any that need to update. Note that when we do find an
6279 // update, if it includes actions that must be taken afterwards, we have to drop the
6280 // per-peer state lock as well as the top level per_peer_state lock. Thus, we loop until we
6281 // manage to go through all our peers without finding a single channel to update.
6283 let per_peer_state = self.per_peer_state.read().unwrap();
6284 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6286 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6287 let peer_state: &mut PeerState<_> = &mut *peer_state_lock;
6288 for (channel_id, chan) in peer_state.channel_by_id.iter_mut() {
6289 let counterparty_node_id = chan.context.get_counterparty_node_id();
6290 let funding_txo = chan.context.get_funding_txo();
6291 let (monitor_opt, holding_cell_failed_htlcs) =
6292 chan.maybe_free_holding_cell_htlcs(&self.fee_estimator, &self.logger);
6293 if !holding_cell_failed_htlcs.is_empty() {
6294 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id, counterparty_node_id));
6296 if let Some(monitor_update) = monitor_opt {
6297 has_monitor_update = true;
6299 let channel_id: [u8; 32] = *channel_id;
6300 let res = handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update,
6301 peer_state_lock, peer_state, per_peer_state, chan, MANUALLY_REMOVING,
6302 peer_state.channel_by_id.remove(&channel_id));
6304 handle_errors.push((counterparty_node_id, res));
6306 continue 'peer_loop;
6315 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
6316 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
6317 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
6320 for (counterparty_node_id, err) in handle_errors.drain(..) {
6321 let _ = handle_error!(self, err, counterparty_node_id);
6327 /// Check whether any channels have finished removing all pending updates after a shutdown
6328 /// exchange and can now send a closing_signed.
6329 /// Returns whether any closing_signed messages were generated.
6330 fn maybe_generate_initial_closing_signed(&self) -> bool {
6331 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
6332 let mut has_update = false;
6334 let per_peer_state = self.per_peer_state.read().unwrap();
6336 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6337 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6338 let peer_state = &mut *peer_state_lock;
6339 let pending_msg_events = &mut peer_state.pending_msg_events;
6340 peer_state.channel_by_id.retain(|channel_id, chan| {
6341 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
6342 Ok((msg_opt, tx_opt)) => {
6343 if let Some(msg) = msg_opt {
6345 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
6346 node_id: chan.context.get_counterparty_node_id(), msg,
6349 if let Some(tx) = tx_opt {
6350 // We're done with this channel. We got a closing_signed and sent back
6351 // a closing_signed with a closing transaction to broadcast.
6352 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6353 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6358 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
6360 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
6361 self.tx_broadcaster.broadcast_transactions(&[&tx]);
6362 update_maps_on_chan_removal!(self, &chan.context);
6368 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
6369 handle_errors.push((chan.context.get_counterparty_node_id(), Err(res)));
6377 for (counterparty_node_id, err) in handle_errors.drain(..) {
6378 let _ = handle_error!(self, err, counterparty_node_id);
6384 /// Handle a list of channel failures during a block_connected or block_disconnected call,
6385 /// pushing the channel monitor update (if any) to the background events queue and removing the
6387 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
6388 for mut failure in failed_channels.drain(..) {
6389 // Either a commitment transactions has been confirmed on-chain or
6390 // Channel::block_disconnected detected that the funding transaction has been
6391 // reorganized out of the main chain.
6392 // We cannot broadcast our latest local state via monitor update (as
6393 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
6394 // so we track the update internally and handle it when the user next calls
6395 // timer_tick_occurred, guaranteeing we're running normally.
6396 if let Some((counterparty_node_id, funding_txo, update)) = failure.0.take() {
6397 assert_eq!(update.updates.len(), 1);
6398 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
6399 assert!(should_broadcast);
6400 } else { unreachable!(); }
6401 self.pending_background_events.lock().unwrap().push(
6402 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
6403 counterparty_node_id, funding_txo, update
6406 self.finish_force_close_channel(failure);
6410 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
6413 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
6414 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
6416 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
6417 /// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
6418 /// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
6419 /// passed directly to [`claim_funds`].
6421 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
6423 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
6424 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
6428 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
6429 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
6431 /// Errors if `min_value_msat` is greater than total bitcoin supply.
6433 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
6434 /// on versions of LDK prior to 0.0.114.
6436 /// [`claim_funds`]: Self::claim_funds
6437 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
6438 /// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
6439 /// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
6440 /// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
6441 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
6442 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
6443 min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
6444 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs,
6445 &self.entropy_source, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
6446 min_final_cltv_expiry_delta)
6449 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
6450 /// stored external to LDK.
6452 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
6453 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
6454 /// the `min_value_msat` provided here, if one is provided.
6456 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
6457 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
6460 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
6461 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
6462 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
6463 /// sender "proof-of-payment" unless they have paid the required amount.
6465 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
6466 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
6467 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
6468 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
6469 /// invoices when no timeout is set.
6471 /// Note that we use block header time to time-out pending inbound payments (with some margin
6472 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
6473 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
6474 /// If you need exact expiry semantics, you should enforce them upon receipt of
6475 /// [`PaymentClaimable`].
6477 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
6478 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
6480 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
6481 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
6485 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
6486 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
6488 /// Errors if `min_value_msat` is greater than total bitcoin supply.
6490 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
6491 /// on versions of LDK prior to 0.0.114.
6493 /// [`create_inbound_payment`]: Self::create_inbound_payment
6494 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
6495 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>,
6496 invoice_expiry_delta_secs: u32, min_final_cltv_expiry: Option<u16>) -> Result<PaymentSecret, ()> {
6497 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash,
6498 invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
6499 min_final_cltv_expiry)
6502 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
6503 /// previously returned from [`create_inbound_payment`].
6505 /// [`create_inbound_payment`]: Self::create_inbound_payment
6506 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
6507 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
6510 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
6511 /// are used when constructing the phantom invoice's route hints.
6513 /// [phantom node payments]: crate::sign::PhantomKeysManager
6514 pub fn get_phantom_scid(&self) -> u64 {
6515 let best_block_height = self.best_block.read().unwrap().height();
6516 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
6518 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
6519 // Ensure the generated scid doesn't conflict with a real channel.
6520 match short_to_chan_info.get(&scid_candidate) {
6521 Some(_) => continue,
6522 None => return scid_candidate
6527 /// Gets route hints for use in receiving [phantom node payments].
6529 /// [phantom node payments]: crate::sign::PhantomKeysManager
6530 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
6532 channels: self.list_usable_channels(),
6533 phantom_scid: self.get_phantom_scid(),
6534 real_node_pubkey: self.get_our_node_id(),
6538 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
6539 /// used when constructing the route hints for HTLCs intended to be intercepted. See
6540 /// [`ChannelManager::forward_intercepted_htlc`].
6542 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
6543 /// times to get a unique scid.
6544 pub fn get_intercept_scid(&self) -> u64 {
6545 let best_block_height = self.best_block.read().unwrap().height();
6546 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
6548 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
6549 // Ensure the generated scid doesn't conflict with a real channel.
6550 if short_to_chan_info.contains_key(&scid_candidate) { continue }
6551 return scid_candidate
6555 /// Gets inflight HTLC information by processing pending outbound payments that are in
6556 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
6557 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
6558 let mut inflight_htlcs = InFlightHtlcs::new();
6560 let per_peer_state = self.per_peer_state.read().unwrap();
6561 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6562 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6563 let peer_state = &mut *peer_state_lock;
6564 for chan in peer_state.channel_by_id.values() {
6565 for (htlc_source, _) in chan.inflight_htlc_sources() {
6566 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
6567 inflight_htlcs.process_path(path, self.get_our_node_id());
6576 #[cfg(any(test, feature = "_test_utils"))]
6577 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
6578 let events = core::cell::RefCell::new(Vec::new());
6579 let event_handler = |event: events::Event| events.borrow_mut().push(event);
6580 self.process_pending_events(&event_handler);
6584 #[cfg(feature = "_test_utils")]
6585 pub fn push_pending_event(&self, event: events::Event) {
6586 let mut events = self.pending_events.lock().unwrap();
6587 events.push_back((event, None));
6591 pub fn pop_pending_event(&self) -> Option<events::Event> {
6592 let mut events = self.pending_events.lock().unwrap();
6593 events.pop_front().map(|(e, _)| e)
6597 pub fn has_pending_payments(&self) -> bool {
6598 self.pending_outbound_payments.has_pending_payments()
6602 pub fn clear_pending_payments(&self) {
6603 self.pending_outbound_payments.clear_pending_payments()
6606 /// When something which was blocking a channel from updating its [`ChannelMonitor`] (e.g. an
6607 /// [`Event`] being handled) completes, this should be called to restore the channel to normal
6608 /// operation. It will double-check that nothing *else* is also blocking the same channel from
6609 /// making progress and then let any blocked [`ChannelMonitorUpdate`]s fly.
6610 fn handle_monitor_update_release(&self, counterparty_node_id: PublicKey, channel_funding_outpoint: OutPoint, mut completed_blocker: Option<RAAMonitorUpdateBlockingAction>) {
6611 let mut errors = Vec::new();
6613 let per_peer_state = self.per_peer_state.read().unwrap();
6614 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
6615 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
6616 let peer_state = &mut *peer_state_lck;
6618 if let Some(blocker) = completed_blocker.take() {
6619 // Only do this on the first iteration of the loop.
6620 if let Some(blockers) = peer_state.actions_blocking_raa_monitor_updates
6621 .get_mut(&channel_funding_outpoint.to_channel_id())
6623 blockers.retain(|iter| iter != &blocker);
6627 if self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
6628 channel_funding_outpoint, counterparty_node_id) {
6629 // Check that, while holding the peer lock, we don't have anything else
6630 // blocking monitor updates for this channel. If we do, release the monitor
6631 // update(s) when those blockers complete.
6632 log_trace!(self.logger, "Delaying monitor unlock for channel {} as another channel's mon update needs to complete first",
6633 log_bytes!(&channel_funding_outpoint.to_channel_id()[..]));
6637 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(channel_funding_outpoint.to_channel_id()) {
6638 debug_assert_eq!(chan.get().context.get_funding_txo().unwrap(), channel_funding_outpoint);
6639 if let Some((monitor_update, further_update_exists)) = chan.get_mut().unblock_next_blocked_monitor_update() {
6640 log_debug!(self.logger, "Unlocking monitor updating for channel {} and updating monitor",
6641 log_bytes!(&channel_funding_outpoint.to_channel_id()[..]));
6642 if let Err(e) = handle_new_monitor_update!(self, channel_funding_outpoint, monitor_update,
6643 peer_state_lck, peer_state, per_peer_state, chan)
6645 errors.push((e, counterparty_node_id));
6647 if further_update_exists {
6648 // If there are more `ChannelMonitorUpdate`s to process, restart at the
6653 log_trace!(self.logger, "Unlocked monitor updating for channel {} without monitors to update",
6654 log_bytes!(&channel_funding_outpoint.to_channel_id()[..]));
6658 log_debug!(self.logger,
6659 "Got a release post-RAA monitor update for peer {} but the channel is gone",
6660 log_pubkey!(counterparty_node_id));
6664 for (err, counterparty_node_id) in errors {
6665 let res = Err::<(), _>(err);
6666 let _ = handle_error!(self, res, counterparty_node_id);
6670 fn handle_post_event_actions(&self, actions: Vec<EventCompletionAction>) {
6671 for action in actions {
6673 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
6674 channel_funding_outpoint, counterparty_node_id
6676 self.handle_monitor_update_release(counterparty_node_id, channel_funding_outpoint, None);
6682 /// Processes any events asynchronously in the order they were generated since the last call
6683 /// using the given event handler.
6685 /// See the trait-level documentation of [`EventsProvider`] for requirements.
6686 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
6690 process_events_body!(self, ev, { handler(ev).await });
6694 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>
6696 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6697 T::Target: BroadcasterInterface,
6698 ES::Target: EntropySource,
6699 NS::Target: NodeSigner,
6700 SP::Target: SignerProvider,
6701 F::Target: FeeEstimator,
6705 /// Returns `MessageSendEvent`s strictly ordered per-peer, in the order they were generated.
6706 /// The returned array will contain `MessageSendEvent`s for different peers if
6707 /// `MessageSendEvent`s to more than one peer exists, but `MessageSendEvent`s to the same peer
6708 /// is always placed next to each other.
6710 /// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
6711 /// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
6712 /// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
6713 /// will randomly be placed first or last in the returned array.
6715 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
6716 /// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
6717 /// the `MessageSendEvent`s to the specific peer they were generated under.
6718 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
6719 let events = RefCell::new(Vec::new());
6720 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
6721 let mut result = self.process_background_events();
6723 // TODO: This behavior should be documented. It's unintuitive that we query
6724 // ChannelMonitors when clearing other events.
6725 if self.process_pending_monitor_events() {
6726 result = NotifyOption::DoPersist;
6729 if self.check_free_holding_cells() {
6730 result = NotifyOption::DoPersist;
6732 if self.maybe_generate_initial_closing_signed() {
6733 result = NotifyOption::DoPersist;
6736 let mut pending_events = Vec::new();
6737 let per_peer_state = self.per_peer_state.read().unwrap();
6738 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6739 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6740 let peer_state = &mut *peer_state_lock;
6741 if peer_state.pending_msg_events.len() > 0 {
6742 pending_events.append(&mut peer_state.pending_msg_events);
6746 if !pending_events.is_empty() {
6747 events.replace(pending_events);
6756 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>
6758 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6759 T::Target: BroadcasterInterface,
6760 ES::Target: EntropySource,
6761 NS::Target: NodeSigner,
6762 SP::Target: SignerProvider,
6763 F::Target: FeeEstimator,
6767 /// Processes events that must be periodically handled.
6769 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
6770 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
6771 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
6773 process_events_body!(self, ev, handler.handle_event(ev));
6777 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>
6779 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6780 T::Target: BroadcasterInterface,
6781 ES::Target: EntropySource,
6782 NS::Target: NodeSigner,
6783 SP::Target: SignerProvider,
6784 F::Target: FeeEstimator,
6788 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
6790 let best_block = self.best_block.read().unwrap();
6791 assert_eq!(best_block.block_hash(), header.prev_blockhash,
6792 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
6793 assert_eq!(best_block.height(), height - 1,
6794 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
6797 self.transactions_confirmed(header, txdata, height);
6798 self.best_block_updated(header, height);
6801 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
6802 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
6803 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
6804 let new_height = height - 1;
6806 let mut best_block = self.best_block.write().unwrap();
6807 assert_eq!(best_block.block_hash(), header.block_hash(),
6808 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
6809 assert_eq!(best_block.height(), height,
6810 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
6811 *best_block = BestBlock::new(header.prev_blockhash, new_height)
6814 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));
6818 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>
6820 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6821 T::Target: BroadcasterInterface,
6822 ES::Target: EntropySource,
6823 NS::Target: NodeSigner,
6824 SP::Target: SignerProvider,
6825 F::Target: FeeEstimator,
6829 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
6830 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
6831 // during initialization prior to the chain_monitor being fully configured in some cases.
6832 // See the docs for `ChannelManagerReadArgs` for more.
6834 let block_hash = header.block_hash();
6835 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
6837 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
6838 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
6839 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)
6840 .map(|(a, b)| (a, Vec::new(), b)));
6842 let last_best_block_height = self.best_block.read().unwrap().height();
6843 if height < last_best_block_height {
6844 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
6845 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));
6849 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
6850 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
6851 // during initialization prior to the chain_monitor being fully configured in some cases.
6852 // See the docs for `ChannelManagerReadArgs` for more.
6854 let block_hash = header.block_hash();
6855 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
6857 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
6858 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
6859 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
6861 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));
6863 macro_rules! max_time {
6864 ($timestamp: expr) => {
6866 // Update $timestamp to be the max of its current value and the block
6867 // timestamp. This should keep us close to the current time without relying on
6868 // having an explicit local time source.
6869 // Just in case we end up in a race, we loop until we either successfully
6870 // update $timestamp or decide we don't need to.
6871 let old_serial = $timestamp.load(Ordering::Acquire);
6872 if old_serial >= header.time as usize { break; }
6873 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
6879 max_time!(self.highest_seen_timestamp);
6880 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
6881 payment_secrets.retain(|_, inbound_payment| {
6882 inbound_payment.expiry_time > header.time as u64
6886 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
6887 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
6888 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
6889 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6890 let peer_state = &mut *peer_state_lock;
6891 for chan in peer_state.channel_by_id.values() {
6892 if let (Some(funding_txo), Some(block_hash)) = (chan.context.get_funding_txo(), chan.context.get_funding_tx_confirmed_in()) {
6893 res.push((funding_txo.txid, Some(block_hash)));
6900 fn transaction_unconfirmed(&self, txid: &Txid) {
6901 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
6902 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
6903 self.do_chain_event(None, |channel| {
6904 if let Some(funding_txo) = channel.context.get_funding_txo() {
6905 if funding_txo.txid == *txid {
6906 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
6907 } else { Ok((None, Vec::new(), None)) }
6908 } else { Ok((None, Vec::new(), None)) }
6913 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>
6915 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6916 T::Target: BroadcasterInterface,
6917 ES::Target: EntropySource,
6918 NS::Target: NodeSigner,
6919 SP::Target: SignerProvider,
6920 F::Target: FeeEstimator,
6924 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
6925 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
6927 fn do_chain_event<FN: Fn(&mut Channel<<SP::Target as SignerProvider>::Signer>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
6928 (&self, height_opt: Option<u32>, f: FN) {
6929 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
6930 // during initialization prior to the chain_monitor being fully configured in some cases.
6931 // See the docs for `ChannelManagerReadArgs` for more.
6933 let mut failed_channels = Vec::new();
6934 let mut timed_out_htlcs = Vec::new();
6936 let per_peer_state = self.per_peer_state.read().unwrap();
6937 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6938 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6939 let peer_state = &mut *peer_state_lock;
6940 let pending_msg_events = &mut peer_state.pending_msg_events;
6941 peer_state.channel_by_id.retain(|_, channel| {
6942 let res = f(channel);
6943 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
6944 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
6945 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
6946 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
6947 HTLCDestination::NextHopChannel { node_id: Some(channel.context.get_counterparty_node_id()), channel_id: channel.context.channel_id() }));
6949 if let Some(channel_ready) = channel_ready_opt {
6950 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
6951 if channel.context.is_usable() {
6952 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", log_bytes!(channel.context.channel_id()));
6953 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
6954 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
6955 node_id: channel.context.get_counterparty_node_id(),
6960 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", log_bytes!(channel.context.channel_id()));
6965 let mut pending_events = self.pending_events.lock().unwrap();
6966 emit_channel_ready_event!(pending_events, channel);
6969 if let Some(announcement_sigs) = announcement_sigs {
6970 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(channel.context.channel_id()));
6971 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
6972 node_id: channel.context.get_counterparty_node_id(),
6973 msg: announcement_sigs,
6975 if let Some(height) = height_opt {
6976 if let Some(announcement) = channel.get_signed_channel_announcement(&self.node_signer, self.genesis_hash, height, &self.default_configuration) {
6977 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
6979 // Note that announcement_signatures fails if the channel cannot be announced,
6980 // so get_channel_update_for_broadcast will never fail by the time we get here.
6981 update_msg: Some(self.get_channel_update_for_broadcast(channel).unwrap()),
6986 if channel.is_our_channel_ready() {
6987 if let Some(real_scid) = channel.context.get_short_channel_id() {
6988 // If we sent a 0conf channel_ready, and now have an SCID, we add it
6989 // to the short_to_chan_info map here. Note that we check whether we
6990 // can relay using the real SCID at relay-time (i.e.
6991 // enforce option_scid_alias then), and if the funding tx is ever
6992 // un-confirmed we force-close the channel, ensuring short_to_chan_info
6993 // is always consistent.
6994 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
6995 let scid_insert = short_to_chan_info.insert(real_scid, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
6996 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.context.get_counterparty_node_id(), channel.context.channel_id()),
6997 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
6998 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
7001 } else if let Err(reason) = res {
7002 update_maps_on_chan_removal!(self, &channel.context);
7003 // It looks like our counterparty went on-chain or funding transaction was
7004 // reorged out of the main chain. Close the channel.
7005 failed_channels.push(channel.context.force_shutdown(true));
7006 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
7007 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7011 let reason_message = format!("{}", reason);
7012 self.issue_channel_close_events(&channel.context, reason);
7013 pending_msg_events.push(events::MessageSendEvent::HandleError {
7014 node_id: channel.context.get_counterparty_node_id(),
7015 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
7016 channel_id: channel.context.channel_id(),
7017 data: reason_message,
7027 if let Some(height) = height_opt {
7028 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
7029 payment.htlcs.retain(|htlc| {
7030 // If height is approaching the number of blocks we think it takes us to get
7031 // our commitment transaction confirmed before the HTLC expires, plus the
7032 // number of blocks we generally consider it to take to do a commitment update,
7033 // just give up on it and fail the HTLC.
7034 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
7035 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
7036 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
7038 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
7039 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
7040 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
7044 !payment.htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
7047 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
7048 intercepted_htlcs.retain(|_, htlc| {
7049 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
7050 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
7051 short_channel_id: htlc.prev_short_channel_id,
7052 htlc_id: htlc.prev_htlc_id,
7053 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
7054 phantom_shared_secret: None,
7055 outpoint: htlc.prev_funding_outpoint,
7058 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
7059 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
7060 _ => unreachable!(),
7062 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
7063 HTLCFailReason::from_failure_code(0x2000 | 2),
7064 HTLCDestination::InvalidForward { requested_forward_scid }));
7065 log_trace!(self.logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
7071 self.handle_init_event_channel_failures(failed_channels);
7073 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
7074 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
7078 /// Gets a [`Future`] that completes when this [`ChannelManager`] needs to be persisted.
7080 /// Note that callbacks registered on the [`Future`] MUST NOT call back into this
7081 /// [`ChannelManager`] and should instead register actions to be taken later.
7083 pub fn get_persistable_update_future(&self) -> Future {
7084 self.persistence_notifier.get_future()
7087 #[cfg(any(test, feature = "_test_utils"))]
7088 pub fn get_persistence_condvar_value(&self) -> bool {
7089 self.persistence_notifier.notify_pending()
7092 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
7093 /// [`chain::Confirm`] interfaces.
7094 pub fn current_best_block(&self) -> BestBlock {
7095 self.best_block.read().unwrap().clone()
7098 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
7099 /// [`ChannelManager`].
7100 pub fn node_features(&self) -> NodeFeatures {
7101 provided_node_features(&self.default_configuration)
7104 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags which are provided by or required by
7105 /// [`ChannelManager`].
7107 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
7108 /// or not. Thus, this method is not public.
7109 #[cfg(any(feature = "_test_utils", test))]
7110 pub fn invoice_features(&self) -> Bolt11InvoiceFeatures {
7111 provided_invoice_features(&self.default_configuration)
7114 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
7115 /// [`ChannelManager`].
7116 pub fn channel_features(&self) -> ChannelFeatures {
7117 provided_channel_features(&self.default_configuration)
7120 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
7121 /// [`ChannelManager`].
7122 pub fn channel_type_features(&self) -> ChannelTypeFeatures {
7123 provided_channel_type_features(&self.default_configuration)
7126 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
7127 /// [`ChannelManager`].
7128 pub fn init_features(&self) -> InitFeatures {
7129 provided_init_features(&self.default_configuration)
7133 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7134 ChannelMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
7136 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7137 T::Target: BroadcasterInterface,
7138 ES::Target: EntropySource,
7139 NS::Target: NodeSigner,
7140 SP::Target: SignerProvider,
7141 F::Target: FeeEstimator,
7145 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) {
7146 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7147 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, msg), *counterparty_node_id);
7150 fn handle_open_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
7151 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7152 "Dual-funded channels not supported".to_owned(),
7153 msg.temporary_channel_id.clone())), *counterparty_node_id);
7156 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
7157 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7158 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, msg), *counterparty_node_id);
7161 fn handle_accept_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
7162 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7163 "Dual-funded channels not supported".to_owned(),
7164 msg.temporary_channel_id.clone())), *counterparty_node_id);
7167 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
7168 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7169 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
7172 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
7173 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7174 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
7177 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
7178 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7179 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
7182 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
7183 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7184 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
7187 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
7188 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7189 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
7192 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
7193 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7194 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
7197 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
7198 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7199 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
7202 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
7203 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7204 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
7207 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
7208 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7209 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
7212 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
7213 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7214 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
7217 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
7218 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7219 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
7222 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
7223 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7224 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
7227 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
7228 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7229 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
7232 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
7233 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
7234 let force_persist = self.process_background_events();
7235 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
7236 if force_persist == NotifyOption::DoPersist { NotifyOption::DoPersist } else { persist }
7238 NotifyOption::SkipPersist
7243 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
7244 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7245 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
7248 fn peer_disconnected(&self, counterparty_node_id: &PublicKey) {
7249 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7250 let mut failed_channels = Vec::new();
7251 let mut per_peer_state = self.per_peer_state.write().unwrap();
7253 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates.",
7254 log_pubkey!(counterparty_node_id));
7255 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
7256 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7257 let peer_state = &mut *peer_state_lock;
7258 let pending_msg_events = &mut peer_state.pending_msg_events;
7259 peer_state.channel_by_id.retain(|_, chan| {
7260 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
7261 if chan.is_shutdown() {
7262 update_maps_on_chan_removal!(self, &chan.context);
7263 self.issue_channel_close_events(&chan.context, ClosureReason::DisconnectedPeer);
7268 peer_state.inbound_v1_channel_by_id.retain(|_, chan| {
7269 update_maps_on_chan_removal!(self, &chan.context);
7270 self.issue_channel_close_events(&chan.context, ClosureReason::DisconnectedPeer);
7273 peer_state.outbound_v1_channel_by_id.retain(|_, chan| {
7274 update_maps_on_chan_removal!(self, &chan.context);
7275 self.issue_channel_close_events(&chan.context, ClosureReason::DisconnectedPeer);
7278 pending_msg_events.retain(|msg| {
7280 // V1 Channel Establishment
7281 &events::MessageSendEvent::SendAcceptChannel { .. } => false,
7282 &events::MessageSendEvent::SendOpenChannel { .. } => false,
7283 &events::MessageSendEvent::SendFundingCreated { .. } => false,
7284 &events::MessageSendEvent::SendFundingSigned { .. } => false,
7285 // V2 Channel Establishment
7286 &events::MessageSendEvent::SendAcceptChannelV2 { .. } => false,
7287 &events::MessageSendEvent::SendOpenChannelV2 { .. } => false,
7288 // Common Channel Establishment
7289 &events::MessageSendEvent::SendChannelReady { .. } => false,
7290 &events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
7291 // Interactive Transaction Construction
7292 &events::MessageSendEvent::SendTxAddInput { .. } => false,
7293 &events::MessageSendEvent::SendTxAddOutput { .. } => false,
7294 &events::MessageSendEvent::SendTxRemoveInput { .. } => false,
7295 &events::MessageSendEvent::SendTxRemoveOutput { .. } => false,
7296 &events::MessageSendEvent::SendTxComplete { .. } => false,
7297 &events::MessageSendEvent::SendTxSignatures { .. } => false,
7298 &events::MessageSendEvent::SendTxInitRbf { .. } => false,
7299 &events::MessageSendEvent::SendTxAckRbf { .. } => false,
7300 &events::MessageSendEvent::SendTxAbort { .. } => false,
7301 // Channel Operations
7302 &events::MessageSendEvent::UpdateHTLCs { .. } => false,
7303 &events::MessageSendEvent::SendRevokeAndACK { .. } => false,
7304 &events::MessageSendEvent::SendClosingSigned { .. } => false,
7305 &events::MessageSendEvent::SendShutdown { .. } => false,
7306 &events::MessageSendEvent::SendChannelReestablish { .. } => false,
7307 &events::MessageSendEvent::HandleError { .. } => false,
7309 &events::MessageSendEvent::SendChannelAnnouncement { .. } => false,
7310 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
7311 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
7312 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
7313 &events::MessageSendEvent::SendChannelUpdate { .. } => false,
7314 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
7315 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
7316 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
7317 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
7320 debug_assert!(peer_state.is_connected, "A disconnected peer cannot disconnect");
7321 peer_state.is_connected = false;
7322 peer_state.ok_to_remove(true)
7323 } else { debug_assert!(false, "Unconnected peer disconnected"); true }
7326 per_peer_state.remove(counterparty_node_id);
7328 mem::drop(per_peer_state);
7330 for failure in failed_channels.drain(..) {
7331 self.finish_force_close_channel(failure);
7335 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init, inbound: bool) -> Result<(), ()> {
7336 if !init_msg.features.supports_static_remote_key() {
7337 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting", log_pubkey!(counterparty_node_id));
7341 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7343 // If we have too many peers connected which don't have funded channels, disconnect the
7344 // peer immediately (as long as it doesn't have funded channels). If we have a bunch of
7345 // unfunded channels taking up space in memory for disconnected peers, we still let new
7346 // peers connect, but we'll reject new channels from them.
7347 let connected_peers_without_funded_channels = self.peers_without_funded_channels(|node| node.is_connected);
7348 let inbound_peer_limited = inbound && connected_peers_without_funded_channels >= MAX_NO_CHANNEL_PEERS;
7351 let mut peer_state_lock = self.per_peer_state.write().unwrap();
7352 match peer_state_lock.entry(counterparty_node_id.clone()) {
7353 hash_map::Entry::Vacant(e) => {
7354 if inbound_peer_limited {
7357 e.insert(Mutex::new(PeerState {
7358 channel_by_id: HashMap::new(),
7359 outbound_v1_channel_by_id: HashMap::new(),
7360 inbound_v1_channel_by_id: HashMap::new(),
7361 latest_features: init_msg.features.clone(),
7362 pending_msg_events: Vec::new(),
7363 in_flight_monitor_updates: BTreeMap::new(),
7364 monitor_update_blocked_actions: BTreeMap::new(),
7365 actions_blocking_raa_monitor_updates: BTreeMap::new(),
7369 hash_map::Entry::Occupied(e) => {
7370 let mut peer_state = e.get().lock().unwrap();
7371 peer_state.latest_features = init_msg.features.clone();
7373 let best_block_height = self.best_block.read().unwrap().height();
7374 if inbound_peer_limited &&
7375 Self::unfunded_channel_count(&*peer_state, best_block_height) ==
7376 peer_state.channel_by_id.len()
7381 debug_assert!(!peer_state.is_connected, "A peer shouldn't be connected twice");
7382 peer_state.is_connected = true;
7387 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
7389 let per_peer_state = self.per_peer_state.read().unwrap();
7390 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
7391 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7392 let peer_state = &mut *peer_state_lock;
7393 let pending_msg_events = &mut peer_state.pending_msg_events;
7395 // Since unfunded channel maps are cleared upon disconnecting a peer, and they're not persisted
7396 // (so won't be recovered after a crash) we don't need to bother closing unfunded channels and
7397 // clearing their maps here. Instead we can just send queue channel_reestablish messages for
7398 // channels in the channel_by_id map.
7399 peer_state.channel_by_id.iter_mut().for_each(|(_, chan)| {
7400 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
7401 node_id: chan.context.get_counterparty_node_id(),
7402 msg: chan.get_channel_reestablish(&self.logger),
7406 //TODO: Also re-broadcast announcement_signatures
7410 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
7411 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7413 if msg.channel_id == [0; 32] {
7414 let channel_ids: Vec<[u8; 32]> = {
7415 let per_peer_state = self.per_peer_state.read().unwrap();
7416 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
7417 if peer_state_mutex_opt.is_none() { return; }
7418 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
7419 let peer_state = &mut *peer_state_lock;
7420 peer_state.channel_by_id.keys().cloned()
7421 .chain(peer_state.outbound_v1_channel_by_id.keys().cloned())
7422 .chain(peer_state.inbound_v1_channel_by_id.keys().cloned()).collect()
7424 for channel_id in channel_ids {
7425 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
7426 let _ = self.force_close_channel_with_peer(&channel_id, counterparty_node_id, Some(&msg.data), true);
7430 // First check if we can advance the channel type and try again.
7431 let per_peer_state = self.per_peer_state.read().unwrap();
7432 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
7433 if peer_state_mutex_opt.is_none() { return; }
7434 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
7435 let peer_state = &mut *peer_state_lock;
7436 if let Some(chan) = peer_state.outbound_v1_channel_by_id.get_mut(&msg.channel_id) {
7437 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash, &self.fee_estimator) {
7438 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
7439 node_id: *counterparty_node_id,
7447 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
7448 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
7452 fn provided_node_features(&self) -> NodeFeatures {
7453 provided_node_features(&self.default_configuration)
7456 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
7457 provided_init_features(&self.default_configuration)
7460 fn get_genesis_hashes(&self) -> Option<Vec<ChainHash>> {
7461 Some(vec![ChainHash::from(&self.genesis_hash[..])])
7464 fn handle_tx_add_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddInput) {
7465 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7466 "Dual-funded channels not supported".to_owned(),
7467 msg.channel_id.clone())), *counterparty_node_id);
7470 fn handle_tx_add_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
7471 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7472 "Dual-funded channels not supported".to_owned(),
7473 msg.channel_id.clone())), *counterparty_node_id);
7476 fn handle_tx_remove_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
7477 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7478 "Dual-funded channels not supported".to_owned(),
7479 msg.channel_id.clone())), *counterparty_node_id);
7482 fn handle_tx_remove_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
7483 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7484 "Dual-funded channels not supported".to_owned(),
7485 msg.channel_id.clone())), *counterparty_node_id);
7488 fn handle_tx_complete(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxComplete) {
7489 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7490 "Dual-funded channels not supported".to_owned(),
7491 msg.channel_id.clone())), *counterparty_node_id);
7494 fn handle_tx_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxSignatures) {
7495 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7496 "Dual-funded channels not supported".to_owned(),
7497 msg.channel_id.clone())), *counterparty_node_id);
7500 fn handle_tx_init_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
7501 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7502 "Dual-funded channels not supported".to_owned(),
7503 msg.channel_id.clone())), *counterparty_node_id);
7506 fn handle_tx_ack_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
7507 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7508 "Dual-funded channels not supported".to_owned(),
7509 msg.channel_id.clone())), *counterparty_node_id);
7512 fn handle_tx_abort(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAbort) {
7513 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7514 "Dual-funded channels not supported".to_owned(),
7515 msg.channel_id.clone())), *counterparty_node_id);
7519 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
7520 /// [`ChannelManager`].
7521 pub(crate) fn provided_node_features(config: &UserConfig) -> NodeFeatures {
7522 let mut node_features = provided_init_features(config).to_context();
7523 node_features.set_keysend_optional();
7527 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags which are provided by or required by
7528 /// [`ChannelManager`].
7530 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
7531 /// or not. Thus, this method is not public.
7532 #[cfg(any(feature = "_test_utils", test))]
7533 pub(crate) fn provided_invoice_features(config: &UserConfig) -> Bolt11InvoiceFeatures {
7534 provided_init_features(config).to_context()
7537 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
7538 /// [`ChannelManager`].
7539 pub(crate) fn provided_channel_features(config: &UserConfig) -> ChannelFeatures {
7540 provided_init_features(config).to_context()
7543 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
7544 /// [`ChannelManager`].
7545 pub(crate) fn provided_channel_type_features(config: &UserConfig) -> ChannelTypeFeatures {
7546 ChannelTypeFeatures::from_init(&provided_init_features(config))
7549 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
7550 /// [`ChannelManager`].
7551 pub fn provided_init_features(config: &UserConfig) -> InitFeatures {
7552 // Note that if new features are added here which other peers may (eventually) require, we
7553 // should also add the corresponding (optional) bit to the [`ChannelMessageHandler`] impl for
7554 // [`ErroringMessageHandler`].
7555 let mut features = InitFeatures::empty();
7556 features.set_data_loss_protect_required();
7557 features.set_upfront_shutdown_script_optional();
7558 features.set_variable_length_onion_required();
7559 features.set_static_remote_key_required();
7560 features.set_payment_secret_required();
7561 features.set_basic_mpp_optional();
7562 features.set_wumbo_optional();
7563 features.set_shutdown_any_segwit_optional();
7564 features.set_channel_type_optional();
7565 features.set_scid_privacy_optional();
7566 features.set_zero_conf_optional();
7567 if config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx {
7568 features.set_anchors_zero_fee_htlc_tx_optional();
7573 const SERIALIZATION_VERSION: u8 = 1;
7574 const MIN_SERIALIZATION_VERSION: u8 = 1;
7576 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
7577 (2, fee_base_msat, required),
7578 (4, fee_proportional_millionths, required),
7579 (6, cltv_expiry_delta, required),
7582 impl_writeable_tlv_based!(ChannelCounterparty, {
7583 (2, node_id, required),
7584 (4, features, required),
7585 (6, unspendable_punishment_reserve, required),
7586 (8, forwarding_info, option),
7587 (9, outbound_htlc_minimum_msat, option),
7588 (11, outbound_htlc_maximum_msat, option),
7591 impl Writeable for ChannelDetails {
7592 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
7593 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
7594 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
7595 let user_channel_id_low = self.user_channel_id as u64;
7596 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
7597 write_tlv_fields!(writer, {
7598 (1, self.inbound_scid_alias, option),
7599 (2, self.channel_id, required),
7600 (3, self.channel_type, option),
7601 (4, self.counterparty, required),
7602 (5, self.outbound_scid_alias, option),
7603 (6, self.funding_txo, option),
7604 (7, self.config, option),
7605 (8, self.short_channel_id, option),
7606 (9, self.confirmations, option),
7607 (10, self.channel_value_satoshis, required),
7608 (12, self.unspendable_punishment_reserve, option),
7609 (14, user_channel_id_low, required),
7610 (16, self.balance_msat, required),
7611 (18, self.outbound_capacity_msat, required),
7612 (19, self.next_outbound_htlc_limit_msat, required),
7613 (20, self.inbound_capacity_msat, required),
7614 (21, self.next_outbound_htlc_minimum_msat, required),
7615 (22, self.confirmations_required, option),
7616 (24, self.force_close_spend_delay, option),
7617 (26, self.is_outbound, required),
7618 (28, self.is_channel_ready, required),
7619 (30, self.is_usable, required),
7620 (32, self.is_public, required),
7621 (33, self.inbound_htlc_minimum_msat, option),
7622 (35, self.inbound_htlc_maximum_msat, option),
7623 (37, user_channel_id_high_opt, option),
7624 (39, self.feerate_sat_per_1000_weight, option),
7625 (41, self.channel_shutdown_state, option),
7631 impl Readable for ChannelDetails {
7632 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
7633 _init_and_read_tlv_fields!(reader, {
7634 (1, inbound_scid_alias, option),
7635 (2, channel_id, required),
7636 (3, channel_type, option),
7637 (4, counterparty, required),
7638 (5, outbound_scid_alias, option),
7639 (6, funding_txo, option),
7640 (7, config, option),
7641 (8, short_channel_id, option),
7642 (9, confirmations, option),
7643 (10, channel_value_satoshis, required),
7644 (12, unspendable_punishment_reserve, option),
7645 (14, user_channel_id_low, required),
7646 (16, balance_msat, required),
7647 (18, outbound_capacity_msat, required),
7648 // Note that by the time we get past the required read above, outbound_capacity_msat will be
7649 // filled in, so we can safely unwrap it here.
7650 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
7651 (20, inbound_capacity_msat, required),
7652 (21, next_outbound_htlc_minimum_msat, (default_value, 0)),
7653 (22, confirmations_required, option),
7654 (24, force_close_spend_delay, option),
7655 (26, is_outbound, required),
7656 (28, is_channel_ready, required),
7657 (30, is_usable, required),
7658 (32, is_public, required),
7659 (33, inbound_htlc_minimum_msat, option),
7660 (35, inbound_htlc_maximum_msat, option),
7661 (37, user_channel_id_high_opt, option),
7662 (39, feerate_sat_per_1000_weight, option),
7663 (41, channel_shutdown_state, option),
7666 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
7667 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
7668 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
7669 let user_channel_id = user_channel_id_low as u128 +
7670 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
7674 channel_id: channel_id.0.unwrap(),
7676 counterparty: counterparty.0.unwrap(),
7677 outbound_scid_alias,
7681 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
7682 unspendable_punishment_reserve,
7684 balance_msat: balance_msat.0.unwrap(),
7685 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
7686 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
7687 next_outbound_htlc_minimum_msat: next_outbound_htlc_minimum_msat.0.unwrap(),
7688 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
7689 confirmations_required,
7691 force_close_spend_delay,
7692 is_outbound: is_outbound.0.unwrap(),
7693 is_channel_ready: is_channel_ready.0.unwrap(),
7694 is_usable: is_usable.0.unwrap(),
7695 is_public: is_public.0.unwrap(),
7696 inbound_htlc_minimum_msat,
7697 inbound_htlc_maximum_msat,
7698 feerate_sat_per_1000_weight,
7699 channel_shutdown_state,
7704 impl_writeable_tlv_based!(PhantomRouteHints, {
7705 (2, channels, required_vec),
7706 (4, phantom_scid, required),
7707 (6, real_node_pubkey, required),
7710 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
7712 (0, onion_packet, required),
7713 (2, short_channel_id, required),
7716 (0, payment_data, required),
7717 (1, phantom_shared_secret, option),
7718 (2, incoming_cltv_expiry, required),
7719 (3, payment_metadata, option),
7720 (5, custom_tlvs, optional_vec),
7722 (2, ReceiveKeysend) => {
7723 (0, payment_preimage, required),
7724 (2, incoming_cltv_expiry, required),
7725 (3, payment_metadata, option),
7726 (4, payment_data, option), // Added in 0.0.116
7727 (5, custom_tlvs, optional_vec),
7731 impl_writeable_tlv_based!(PendingHTLCInfo, {
7732 (0, routing, required),
7733 (2, incoming_shared_secret, required),
7734 (4, payment_hash, required),
7735 (6, outgoing_amt_msat, required),
7736 (8, outgoing_cltv_value, required),
7737 (9, incoming_amt_msat, option),
7738 (10, skimmed_fee_msat, option),
7742 impl Writeable for HTLCFailureMsg {
7743 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
7745 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
7747 channel_id.write(writer)?;
7748 htlc_id.write(writer)?;
7749 reason.write(writer)?;
7751 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
7752 channel_id, htlc_id, sha256_of_onion, failure_code
7755 channel_id.write(writer)?;
7756 htlc_id.write(writer)?;
7757 sha256_of_onion.write(writer)?;
7758 failure_code.write(writer)?;
7765 impl Readable for HTLCFailureMsg {
7766 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
7767 let id: u8 = Readable::read(reader)?;
7770 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
7771 channel_id: Readable::read(reader)?,
7772 htlc_id: Readable::read(reader)?,
7773 reason: Readable::read(reader)?,
7777 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
7778 channel_id: Readable::read(reader)?,
7779 htlc_id: Readable::read(reader)?,
7780 sha256_of_onion: Readable::read(reader)?,
7781 failure_code: Readable::read(reader)?,
7784 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
7785 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
7786 // messages contained in the variants.
7787 // In version 0.0.101, support for reading the variants with these types was added, and
7788 // we should migrate to writing these variants when UpdateFailHTLC or
7789 // UpdateFailMalformedHTLC get TLV fields.
7791 let length: BigSize = Readable::read(reader)?;
7792 let mut s = FixedLengthReader::new(reader, length.0);
7793 let res = Readable::read(&mut s)?;
7794 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
7795 Ok(HTLCFailureMsg::Relay(res))
7798 let length: BigSize = Readable::read(reader)?;
7799 let mut s = FixedLengthReader::new(reader, length.0);
7800 let res = Readable::read(&mut s)?;
7801 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
7802 Ok(HTLCFailureMsg::Malformed(res))
7804 _ => Err(DecodeError::UnknownRequiredFeature),
7809 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
7814 impl_writeable_tlv_based!(HTLCPreviousHopData, {
7815 (0, short_channel_id, required),
7816 (1, phantom_shared_secret, option),
7817 (2, outpoint, required),
7818 (4, htlc_id, required),
7819 (6, incoming_packet_shared_secret, required)
7822 impl Writeable for ClaimableHTLC {
7823 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
7824 let (payment_data, keysend_preimage) = match &self.onion_payload {
7825 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
7826 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
7828 write_tlv_fields!(writer, {
7829 (0, self.prev_hop, required),
7830 (1, self.total_msat, required),
7831 (2, self.value, required),
7832 (3, self.sender_intended_value, required),
7833 (4, payment_data, option),
7834 (5, self.total_value_received, option),
7835 (6, self.cltv_expiry, required),
7836 (8, keysend_preimage, option),
7837 (10, self.counterparty_skimmed_fee_msat, option),
7843 impl Readable for ClaimableHTLC {
7844 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
7845 _init_and_read_tlv_fields!(reader, {
7846 (0, prev_hop, required),
7847 (1, total_msat, option),
7848 (2, value_ser, required),
7849 (3, sender_intended_value, option),
7850 (4, payment_data_opt, option),
7851 (5, total_value_received, option),
7852 (6, cltv_expiry, required),
7853 (8, keysend_preimage, option),
7854 (10, counterparty_skimmed_fee_msat, option),
7856 let payment_data: Option<msgs::FinalOnionHopData> = payment_data_opt;
7857 let value = value_ser.0.unwrap();
7858 let onion_payload = match keysend_preimage {
7860 if payment_data.is_some() {
7861 return Err(DecodeError::InvalidValue)
7863 if total_msat.is_none() {
7864 total_msat = Some(value);
7866 OnionPayload::Spontaneous(p)
7869 if total_msat.is_none() {
7870 if payment_data.is_none() {
7871 return Err(DecodeError::InvalidValue)
7873 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
7875 OnionPayload::Invoice { _legacy_hop_data: payment_data }
7879 prev_hop: prev_hop.0.unwrap(),
7882 sender_intended_value: sender_intended_value.unwrap_or(value),
7883 total_value_received,
7884 total_msat: total_msat.unwrap(),
7886 cltv_expiry: cltv_expiry.0.unwrap(),
7887 counterparty_skimmed_fee_msat,
7892 impl Readable for HTLCSource {
7893 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
7894 let id: u8 = Readable::read(reader)?;
7897 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
7898 let mut first_hop_htlc_msat: u64 = 0;
7899 let mut path_hops = Vec::new();
7900 let mut payment_id = None;
7901 let mut payment_params: Option<PaymentParameters> = None;
7902 let mut blinded_tail: Option<BlindedTail> = None;
7903 read_tlv_fields!(reader, {
7904 (0, session_priv, required),
7905 (1, payment_id, option),
7906 (2, first_hop_htlc_msat, required),
7907 (4, path_hops, required_vec),
7908 (5, payment_params, (option: ReadableArgs, 0)),
7909 (6, blinded_tail, option),
7911 if payment_id.is_none() {
7912 // For backwards compat, if there was no payment_id written, use the session_priv bytes
7914 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
7916 let path = Path { hops: path_hops, blinded_tail };
7917 if path.hops.len() == 0 {
7918 return Err(DecodeError::InvalidValue);
7920 if let Some(params) = payment_params.as_mut() {
7921 if let Payee::Clear { ref mut final_cltv_expiry_delta, .. } = params.payee {
7922 if final_cltv_expiry_delta == &0 {
7923 *final_cltv_expiry_delta = path.final_cltv_expiry_delta().ok_or(DecodeError::InvalidValue)?;
7927 Ok(HTLCSource::OutboundRoute {
7928 session_priv: session_priv.0.unwrap(),
7929 first_hop_htlc_msat,
7931 payment_id: payment_id.unwrap(),
7934 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
7935 _ => Err(DecodeError::UnknownRequiredFeature),
7940 impl Writeable for HTLCSource {
7941 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
7943 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id } => {
7945 let payment_id_opt = Some(payment_id);
7946 write_tlv_fields!(writer, {
7947 (0, session_priv, required),
7948 (1, payment_id_opt, option),
7949 (2, first_hop_htlc_msat, required),
7950 // 3 was previously used to write a PaymentSecret for the payment.
7951 (4, path.hops, required_vec),
7952 (5, None::<PaymentParameters>, option), // payment_params in LDK versions prior to 0.0.115
7953 (6, path.blinded_tail, option),
7956 HTLCSource::PreviousHopData(ref field) => {
7958 field.write(writer)?;
7965 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
7966 (0, forward_info, required),
7967 (1, prev_user_channel_id, (default_value, 0)),
7968 (2, prev_short_channel_id, required),
7969 (4, prev_htlc_id, required),
7970 (6, prev_funding_outpoint, required),
7973 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
7975 (0, htlc_id, required),
7976 (2, err_packet, required),
7981 impl_writeable_tlv_based!(PendingInboundPayment, {
7982 (0, payment_secret, required),
7983 (2, expiry_time, required),
7984 (4, user_payment_id, required),
7985 (6, payment_preimage, required),
7986 (8, min_value_msat, required),
7989 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>
7991 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7992 T::Target: BroadcasterInterface,
7993 ES::Target: EntropySource,
7994 NS::Target: NodeSigner,
7995 SP::Target: SignerProvider,
7996 F::Target: FeeEstimator,
8000 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8001 let _consistency_lock = self.total_consistency_lock.write().unwrap();
8003 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
8005 self.genesis_hash.write(writer)?;
8007 let best_block = self.best_block.read().unwrap();
8008 best_block.height().write(writer)?;
8009 best_block.block_hash().write(writer)?;
8012 let mut serializable_peer_count: u64 = 0;
8014 let per_peer_state = self.per_peer_state.read().unwrap();
8015 let mut unfunded_channels = 0;
8016 let mut number_of_channels = 0;
8017 for (_, peer_state_mutex) in per_peer_state.iter() {
8018 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8019 let peer_state = &mut *peer_state_lock;
8020 if !peer_state.ok_to_remove(false) {
8021 serializable_peer_count += 1;
8023 number_of_channels += peer_state.channel_by_id.len();
8024 for (_, channel) in peer_state.channel_by_id.iter() {
8025 if !channel.context.is_funding_initiated() {
8026 unfunded_channels += 1;
8031 ((number_of_channels - unfunded_channels) as u64).write(writer)?;
8033 for (_, peer_state_mutex) in per_peer_state.iter() {
8034 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8035 let peer_state = &mut *peer_state_lock;
8036 for (_, channel) in peer_state.channel_by_id.iter() {
8037 if channel.context.is_funding_initiated() {
8038 channel.write(writer)?;
8045 let forward_htlcs = self.forward_htlcs.lock().unwrap();
8046 (forward_htlcs.len() as u64).write(writer)?;
8047 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
8048 short_channel_id.write(writer)?;
8049 (pending_forwards.len() as u64).write(writer)?;
8050 for forward in pending_forwards {
8051 forward.write(writer)?;
8056 let per_peer_state = self.per_peer_state.write().unwrap();
8058 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
8059 let claimable_payments = self.claimable_payments.lock().unwrap();
8060 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
8062 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
8063 let mut htlc_onion_fields: Vec<&_> = Vec::new();
8064 (claimable_payments.claimable_payments.len() as u64).write(writer)?;
8065 for (payment_hash, payment) in claimable_payments.claimable_payments.iter() {
8066 payment_hash.write(writer)?;
8067 (payment.htlcs.len() as u64).write(writer)?;
8068 for htlc in payment.htlcs.iter() {
8069 htlc.write(writer)?;
8071 htlc_purposes.push(&payment.purpose);
8072 htlc_onion_fields.push(&payment.onion_fields);
8075 let mut monitor_update_blocked_actions_per_peer = None;
8076 let mut peer_states = Vec::new();
8077 for (_, peer_state_mutex) in per_peer_state.iter() {
8078 // Because we're holding the owning `per_peer_state` write lock here there's no chance
8079 // of a lockorder violation deadlock - no other thread can be holding any
8080 // per_peer_state lock at all.
8081 peer_states.push(peer_state_mutex.unsafe_well_ordered_double_lock_self());
8084 (serializable_peer_count).write(writer)?;
8085 for ((peer_pubkey, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
8086 // Peers which we have no channels to should be dropped once disconnected. As we
8087 // disconnect all peers when shutting down and serializing the ChannelManager, we
8088 // consider all peers as disconnected here. There's therefore no need write peers with
8090 if !peer_state.ok_to_remove(false) {
8091 peer_pubkey.write(writer)?;
8092 peer_state.latest_features.write(writer)?;
8093 if !peer_state.monitor_update_blocked_actions.is_empty() {
8094 monitor_update_blocked_actions_per_peer
8095 .get_or_insert_with(Vec::new)
8096 .push((*peer_pubkey, &peer_state.monitor_update_blocked_actions));
8101 let events = self.pending_events.lock().unwrap();
8102 // LDK versions prior to 0.0.115 don't support post-event actions, thus if there's no
8103 // actions at all, skip writing the required TLV. Otherwise, pre-0.0.115 versions will
8104 // refuse to read the new ChannelManager.
8105 let events_not_backwards_compatible = events.iter().any(|(_, action)| action.is_some());
8106 if events_not_backwards_compatible {
8107 // If we're gonna write a even TLV that will overwrite our events anyway we might as
8108 // well save the space and not write any events here.
8109 0u64.write(writer)?;
8111 (events.len() as u64).write(writer)?;
8112 for (event, _) in events.iter() {
8113 event.write(writer)?;
8117 // LDK versions prior to 0.0.116 wrote the `pending_background_events`
8118 // `MonitorUpdateRegeneratedOnStartup`s here, however there was never a reason to do so -
8119 // the closing monitor updates were always effectively replayed on startup (either directly
8120 // by calling `broadcast_latest_holder_commitment_txn` on a `ChannelMonitor` during
8121 // deserialization or, in 0.0.115, by regenerating the monitor update itself).
8122 0u64.write(writer)?;
8124 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
8125 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
8126 // likely to be identical.
8127 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
8128 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
8130 (pending_inbound_payments.len() as u64).write(writer)?;
8131 for (hash, pending_payment) in pending_inbound_payments.iter() {
8132 hash.write(writer)?;
8133 pending_payment.write(writer)?;
8136 // For backwards compat, write the session privs and their total length.
8137 let mut num_pending_outbounds_compat: u64 = 0;
8138 for (_, outbound) in pending_outbound_payments.iter() {
8139 if !outbound.is_fulfilled() && !outbound.abandoned() {
8140 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
8143 num_pending_outbounds_compat.write(writer)?;
8144 for (_, outbound) in pending_outbound_payments.iter() {
8146 PendingOutboundPayment::Legacy { session_privs } |
8147 PendingOutboundPayment::Retryable { session_privs, .. } => {
8148 for session_priv in session_privs.iter() {
8149 session_priv.write(writer)?;
8152 PendingOutboundPayment::Fulfilled { .. } => {},
8153 PendingOutboundPayment::Abandoned { .. } => {},
8157 // Encode without retry info for 0.0.101 compatibility.
8158 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
8159 for (id, outbound) in pending_outbound_payments.iter() {
8161 PendingOutboundPayment::Legacy { session_privs } |
8162 PendingOutboundPayment::Retryable { session_privs, .. } => {
8163 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
8169 let mut pending_intercepted_htlcs = None;
8170 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
8171 if our_pending_intercepts.len() != 0 {
8172 pending_intercepted_htlcs = Some(our_pending_intercepts);
8175 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
8176 if pending_claiming_payments.as_ref().unwrap().is_empty() {
8177 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
8178 // map. Thus, if there are no entries we skip writing a TLV for it.
8179 pending_claiming_payments = None;
8182 let mut in_flight_monitor_updates: Option<HashMap<(&PublicKey, &OutPoint), &Vec<ChannelMonitorUpdate>>> = None;
8183 for ((counterparty_id, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
8184 for (funding_outpoint, updates) in peer_state.in_flight_monitor_updates.iter() {
8185 if !updates.is_empty() {
8186 if in_flight_monitor_updates.is_none() { in_flight_monitor_updates = Some(HashMap::new()); }
8187 in_flight_monitor_updates.as_mut().unwrap().insert((counterparty_id, funding_outpoint), updates);
8192 write_tlv_fields!(writer, {
8193 (1, pending_outbound_payments_no_retry, required),
8194 (2, pending_intercepted_htlcs, option),
8195 (3, pending_outbound_payments, required),
8196 (4, pending_claiming_payments, option),
8197 (5, self.our_network_pubkey, required),
8198 (6, monitor_update_blocked_actions_per_peer, option),
8199 (7, self.fake_scid_rand_bytes, required),
8200 (8, if events_not_backwards_compatible { Some(&*events) } else { None }, option),
8201 (9, htlc_purposes, required_vec),
8202 (10, in_flight_monitor_updates, option),
8203 (11, self.probing_cookie_secret, required),
8204 (13, htlc_onion_fields, optional_vec),
8211 impl Writeable for VecDeque<(Event, Option<EventCompletionAction>)> {
8212 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
8213 (self.len() as u64).write(w)?;
8214 for (event, action) in self.iter() {
8217 #[cfg(debug_assertions)] {
8218 // Events are MaybeReadable, in some cases indicating that they shouldn't actually
8219 // be persisted and are regenerated on restart. However, if such an event has a
8220 // post-event-handling action we'll write nothing for the event and would have to
8221 // either forget the action or fail on deserialization (which we do below). Thus,
8222 // check that the event is sane here.
8223 let event_encoded = event.encode();
8224 let event_read: Option<Event> =
8225 MaybeReadable::read(&mut &event_encoded[..]).unwrap();
8226 if action.is_some() { assert!(event_read.is_some()); }
8232 impl Readable for VecDeque<(Event, Option<EventCompletionAction>)> {
8233 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8234 let len: u64 = Readable::read(reader)?;
8235 const MAX_ALLOC_SIZE: u64 = 1024 * 16;
8236 let mut events: Self = VecDeque::with_capacity(cmp::min(
8237 MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>() as u64,
8240 let ev_opt = MaybeReadable::read(reader)?;
8241 let action = Readable::read(reader)?;
8242 if let Some(ev) = ev_opt {
8243 events.push_back((ev, action));
8244 } else if action.is_some() {
8245 return Err(DecodeError::InvalidValue);
8252 impl_writeable_tlv_based_enum!(ChannelShutdownState,
8253 (0, NotShuttingDown) => {},
8254 (2, ShutdownInitiated) => {},
8255 (4, ResolvingHTLCs) => {},
8256 (6, NegotiatingClosingFee) => {},
8257 (8, ShutdownComplete) => {}, ;
8260 /// Arguments for the creation of a ChannelManager that are not deserialized.
8262 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
8264 /// 1) Deserialize all stored [`ChannelMonitor`]s.
8265 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
8266 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
8267 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
8268 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
8269 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
8270 /// same way you would handle a [`chain::Filter`] call using
8271 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
8272 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
8273 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
8274 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
8275 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
8276 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
8278 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
8279 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
8281 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
8282 /// call any other methods on the newly-deserialized [`ChannelManager`].
8284 /// Note that because some channels may be closed during deserialization, it is critical that you
8285 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
8286 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
8287 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
8288 /// not force-close the same channels but consider them live), you may end up revoking a state for
8289 /// which you've already broadcasted the transaction.
8291 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
8292 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8294 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8295 T::Target: BroadcasterInterface,
8296 ES::Target: EntropySource,
8297 NS::Target: NodeSigner,
8298 SP::Target: SignerProvider,
8299 F::Target: FeeEstimator,
8303 /// A cryptographically secure source of entropy.
8304 pub entropy_source: ES,
8306 /// A signer that is able to perform node-scoped cryptographic operations.
8307 pub node_signer: NS,
8309 /// The keys provider which will give us relevant keys. Some keys will be loaded during
8310 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
8312 pub signer_provider: SP,
8314 /// The fee_estimator for use in the ChannelManager in the future.
8316 /// No calls to the FeeEstimator will be made during deserialization.
8317 pub fee_estimator: F,
8318 /// The chain::Watch for use in the ChannelManager in the future.
8320 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
8321 /// you have deserialized ChannelMonitors separately and will add them to your
8322 /// chain::Watch after deserializing this ChannelManager.
8323 pub chain_monitor: M,
8325 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
8326 /// used to broadcast the latest local commitment transactions of channels which must be
8327 /// force-closed during deserialization.
8328 pub tx_broadcaster: T,
8329 /// The router which will be used in the ChannelManager in the future for finding routes
8330 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
8332 /// No calls to the router will be made during deserialization.
8334 /// The Logger for use in the ChannelManager and which may be used to log information during
8335 /// deserialization.
8337 /// Default settings used for new channels. Any existing channels will continue to use the
8338 /// runtime settings which were stored when the ChannelManager was serialized.
8339 pub default_config: UserConfig,
8341 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
8342 /// value.context.get_funding_txo() should be the key).
8344 /// If a monitor is inconsistent with the channel state during deserialization the channel will
8345 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
8346 /// is true for missing channels as well. If there is a monitor missing for which we find
8347 /// channel data Err(DecodeError::InvalidValue) will be returned.
8349 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
8352 /// This is not exported to bindings users because we have no HashMap bindings
8353 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>,
8356 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8357 ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>
8359 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8360 T::Target: BroadcasterInterface,
8361 ES::Target: EntropySource,
8362 NS::Target: NodeSigner,
8363 SP::Target: SignerProvider,
8364 F::Target: FeeEstimator,
8368 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
8369 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
8370 /// populate a HashMap directly from C.
8371 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,
8372 mut channel_monitors: Vec<&'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>) -> Self {
8374 entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
8375 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
8380 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
8381 // SipmleArcChannelManager type:
8382 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8383 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, ES, NS, SP, F, R, L>>)
8385 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8386 T::Target: BroadcasterInterface,
8387 ES::Target: EntropySource,
8388 NS::Target: NodeSigner,
8389 SP::Target: SignerProvider,
8390 F::Target: FeeEstimator,
8394 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
8395 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)>::read(reader, args)?;
8396 Ok((blockhash, Arc::new(chan_manager)))
8400 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8401 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)
8403 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8404 T::Target: BroadcasterInterface,
8405 ES::Target: EntropySource,
8406 NS::Target: NodeSigner,
8407 SP::Target: SignerProvider,
8408 F::Target: FeeEstimator,
8412 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
8413 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
8415 let genesis_hash: BlockHash = Readable::read(reader)?;
8416 let best_block_height: u32 = Readable::read(reader)?;
8417 let best_block_hash: BlockHash = Readable::read(reader)?;
8419 let mut failed_htlcs = Vec::new();
8421 let channel_count: u64 = Readable::read(reader)?;
8422 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
8423 let mut peer_channels: HashMap<PublicKey, HashMap<[u8; 32], Channel<<SP::Target as SignerProvider>::Signer>>> = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8424 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8425 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8426 let mut channel_closures = VecDeque::new();
8427 let mut close_background_events = Vec::new();
8428 for _ in 0..channel_count {
8429 let mut channel: Channel<<SP::Target as SignerProvider>::Signer> = Channel::read(reader, (
8430 &args.entropy_source, &args.signer_provider, best_block_height, &provided_channel_type_features(&args.default_config)
8432 let funding_txo = channel.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
8433 funding_txo_set.insert(funding_txo.clone());
8434 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
8435 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
8436 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
8437 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
8438 channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
8439 // But if the channel is behind of the monitor, close the channel:
8440 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
8441 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
8442 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
8443 log_bytes!(channel.context.channel_id()), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
8444 let (monitor_update, mut new_failed_htlcs) = channel.context.force_shutdown(true);
8445 if let Some((counterparty_node_id, funding_txo, update)) = monitor_update {
8446 close_background_events.push(BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
8447 counterparty_node_id, funding_txo, update
8450 failed_htlcs.append(&mut new_failed_htlcs);
8451 channel_closures.push_back((events::Event::ChannelClosed {
8452 channel_id: channel.context.channel_id(),
8453 user_channel_id: channel.context.get_user_id(),
8454 reason: ClosureReason::OutdatedChannelManager,
8455 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
8456 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
8458 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
8459 let mut found_htlc = false;
8460 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
8461 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
8464 // If we have some HTLCs in the channel which are not present in the newer
8465 // ChannelMonitor, they have been removed and should be failed back to
8466 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
8467 // were actually claimed we'd have generated and ensured the previous-hop
8468 // claim update ChannelMonitor updates were persisted prior to persising
8469 // the ChannelMonitor update for the forward leg, so attempting to fail the
8470 // backwards leg of the HTLC will simply be rejected.
8471 log_info!(args.logger,
8472 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
8473 log_bytes!(channel.context.channel_id()), log_bytes!(payment_hash.0));
8474 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8478 log_info!(args.logger, "Successfully loaded channel {} at update_id {} against monitor at update id {}",
8479 log_bytes!(channel.context.channel_id()), channel.context.get_latest_monitor_update_id(),
8480 monitor.get_latest_update_id());
8481 if let Some(short_channel_id) = channel.context.get_short_channel_id() {
8482 short_to_chan_info.insert(short_channel_id, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8484 if channel.context.is_funding_initiated() {
8485 id_to_peer.insert(channel.context.channel_id(), channel.context.get_counterparty_node_id());
8487 match peer_channels.entry(channel.context.get_counterparty_node_id()) {
8488 hash_map::Entry::Occupied(mut entry) => {
8489 let by_id_map = entry.get_mut();
8490 by_id_map.insert(channel.context.channel_id(), channel);
8492 hash_map::Entry::Vacant(entry) => {
8493 let mut by_id_map = HashMap::new();
8494 by_id_map.insert(channel.context.channel_id(), channel);
8495 entry.insert(by_id_map);
8499 } else if channel.is_awaiting_initial_mon_persist() {
8500 // If we were persisted and shut down while the initial ChannelMonitor persistence
8501 // was in-progress, we never broadcasted the funding transaction and can still
8502 // safely discard the channel.
8503 let _ = channel.context.force_shutdown(false);
8504 channel_closures.push_back((events::Event::ChannelClosed {
8505 channel_id: channel.context.channel_id(),
8506 user_channel_id: channel.context.get_user_id(),
8507 reason: ClosureReason::DisconnectedPeer,
8508 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
8509 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
8512 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.context.channel_id()));
8513 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
8514 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
8515 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
8516 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");
8517 return Err(DecodeError::InvalidValue);
8521 for (funding_txo, _) in args.channel_monitors.iter() {
8522 if !funding_txo_set.contains(funding_txo) {
8523 log_info!(args.logger, "Queueing monitor update to ensure missing channel {} is force closed",
8524 log_bytes!(funding_txo.to_channel_id()));
8525 let monitor_update = ChannelMonitorUpdate {
8526 update_id: CLOSED_CHANNEL_UPDATE_ID,
8527 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast: true }],
8529 close_background_events.push(BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((*funding_txo, monitor_update)));
8533 const MAX_ALLOC_SIZE: usize = 1024 * 64;
8534 let forward_htlcs_count: u64 = Readable::read(reader)?;
8535 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
8536 for _ in 0..forward_htlcs_count {
8537 let short_channel_id = Readable::read(reader)?;
8538 let pending_forwards_count: u64 = Readable::read(reader)?;
8539 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
8540 for _ in 0..pending_forwards_count {
8541 pending_forwards.push(Readable::read(reader)?);
8543 forward_htlcs.insert(short_channel_id, pending_forwards);
8546 let claimable_htlcs_count: u64 = Readable::read(reader)?;
8547 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
8548 for _ in 0..claimable_htlcs_count {
8549 let payment_hash = Readable::read(reader)?;
8550 let previous_hops_len: u64 = Readable::read(reader)?;
8551 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
8552 for _ in 0..previous_hops_len {
8553 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
8555 claimable_htlcs_list.push((payment_hash, previous_hops));
8558 let peer_state_from_chans = |channel_by_id| {
8561 outbound_v1_channel_by_id: HashMap::new(),
8562 inbound_v1_channel_by_id: HashMap::new(),
8563 latest_features: InitFeatures::empty(),
8564 pending_msg_events: Vec::new(),
8565 in_flight_monitor_updates: BTreeMap::new(),
8566 monitor_update_blocked_actions: BTreeMap::new(),
8567 actions_blocking_raa_monitor_updates: BTreeMap::new(),
8568 is_connected: false,
8572 let peer_count: u64 = Readable::read(reader)?;
8573 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>)>()));
8574 for _ in 0..peer_count {
8575 let peer_pubkey = Readable::read(reader)?;
8576 let peer_chans = peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new());
8577 let mut peer_state = peer_state_from_chans(peer_chans);
8578 peer_state.latest_features = Readable::read(reader)?;
8579 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
8582 let event_count: u64 = Readable::read(reader)?;
8583 let mut pending_events_read: VecDeque<(events::Event, Option<EventCompletionAction>)> =
8584 VecDeque::with_capacity(cmp::min(event_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>()));
8585 for _ in 0..event_count {
8586 match MaybeReadable::read(reader)? {
8587 Some(event) => pending_events_read.push_back((event, None)),
8592 let background_event_count: u64 = Readable::read(reader)?;
8593 for _ in 0..background_event_count {
8594 match <u8 as Readable>::read(reader)? {
8596 // LDK versions prior to 0.0.116 wrote pending `MonitorUpdateRegeneratedOnStartup`s here,
8597 // however we really don't (and never did) need them - we regenerate all
8598 // on-startup monitor updates.
8599 let _: OutPoint = Readable::read(reader)?;
8600 let _: ChannelMonitorUpdate = Readable::read(reader)?;
8602 _ => return Err(DecodeError::InvalidValue),
8606 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
8607 let highest_seen_timestamp: u32 = Readable::read(reader)?;
8609 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
8610 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
8611 for _ in 0..pending_inbound_payment_count {
8612 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
8613 return Err(DecodeError::InvalidValue);
8617 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
8618 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
8619 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
8620 for _ in 0..pending_outbound_payments_count_compat {
8621 let session_priv = Readable::read(reader)?;
8622 let payment = PendingOutboundPayment::Legacy {
8623 session_privs: [session_priv].iter().cloned().collect()
8625 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
8626 return Err(DecodeError::InvalidValue)
8630 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
8631 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
8632 let mut pending_outbound_payments = None;
8633 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
8634 let mut received_network_pubkey: Option<PublicKey> = None;
8635 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
8636 let mut probing_cookie_secret: Option<[u8; 32]> = None;
8637 let mut claimable_htlc_purposes = None;
8638 let mut claimable_htlc_onion_fields = None;
8639 let mut pending_claiming_payments = Some(HashMap::new());
8640 let mut monitor_update_blocked_actions_per_peer: Option<Vec<(_, BTreeMap<_, Vec<_>>)>> = Some(Vec::new());
8641 let mut events_override = None;
8642 let mut in_flight_monitor_updates: Option<HashMap<(PublicKey, OutPoint), Vec<ChannelMonitorUpdate>>> = None;
8643 read_tlv_fields!(reader, {
8644 (1, pending_outbound_payments_no_retry, option),
8645 (2, pending_intercepted_htlcs, option),
8646 (3, pending_outbound_payments, option),
8647 (4, pending_claiming_payments, option),
8648 (5, received_network_pubkey, option),
8649 (6, monitor_update_blocked_actions_per_peer, option),
8650 (7, fake_scid_rand_bytes, option),
8651 (8, events_override, option),
8652 (9, claimable_htlc_purposes, optional_vec),
8653 (10, in_flight_monitor_updates, option),
8654 (11, probing_cookie_secret, option),
8655 (13, claimable_htlc_onion_fields, optional_vec),
8657 if fake_scid_rand_bytes.is_none() {
8658 fake_scid_rand_bytes = Some(args.entropy_source.get_secure_random_bytes());
8661 if probing_cookie_secret.is_none() {
8662 probing_cookie_secret = Some(args.entropy_source.get_secure_random_bytes());
8665 if let Some(events) = events_override {
8666 pending_events_read = events;
8669 if !channel_closures.is_empty() {
8670 pending_events_read.append(&mut channel_closures);
8673 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
8674 pending_outbound_payments = Some(pending_outbound_payments_compat);
8675 } else if pending_outbound_payments.is_none() {
8676 let mut outbounds = HashMap::new();
8677 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
8678 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
8680 pending_outbound_payments = Some(outbounds);
8682 let pending_outbounds = OutboundPayments {
8683 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
8684 retry_lock: Mutex::new(())
8687 // We have to replay (or skip, if they were completed after we wrote the `ChannelManager`)
8688 // each `ChannelMonitorUpdate` in `in_flight_monitor_updates`. After doing so, we have to
8689 // check that each channel we have isn't newer than the latest `ChannelMonitorUpdate`(s) we
8690 // replayed, and for each monitor update we have to replay we have to ensure there's a
8691 // `ChannelMonitor` for it.
8693 // In order to do so we first walk all of our live channels (so that we can check their
8694 // state immediately after doing the update replays, when we have the `update_id`s
8695 // available) and then walk any remaining in-flight updates.
8697 // Because the actual handling of the in-flight updates is the same, it's macro'ized here:
8698 let mut pending_background_events = Vec::new();
8699 macro_rules! handle_in_flight_updates {
8700 ($counterparty_node_id: expr, $chan_in_flight_upds: expr, $funding_txo: expr,
8701 $monitor: expr, $peer_state: expr, $channel_info_log: expr
8703 let mut max_in_flight_update_id = 0;
8704 $chan_in_flight_upds.retain(|upd| upd.update_id > $monitor.get_latest_update_id());
8705 for update in $chan_in_flight_upds.iter() {
8706 log_trace!(args.logger, "Replaying ChannelMonitorUpdate {} for {}channel {}",
8707 update.update_id, $channel_info_log, log_bytes!($funding_txo.to_channel_id()));
8708 max_in_flight_update_id = cmp::max(max_in_flight_update_id, update.update_id);
8709 pending_background_events.push(
8710 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
8711 counterparty_node_id: $counterparty_node_id,
8712 funding_txo: $funding_txo,
8713 update: update.clone(),
8716 if $chan_in_flight_upds.is_empty() {
8717 // We had some updates to apply, but it turns out they had completed before we
8718 // were serialized, we just weren't notified of that. Thus, we may have to run
8719 // the completion actions for any monitor updates, but otherwise are done.
8720 pending_background_events.push(
8721 BackgroundEvent::MonitorUpdatesComplete {
8722 counterparty_node_id: $counterparty_node_id,
8723 channel_id: $funding_txo.to_channel_id(),
8726 if $peer_state.in_flight_monitor_updates.insert($funding_txo, $chan_in_flight_upds).is_some() {
8727 log_error!(args.logger, "Duplicate in-flight monitor update set for the same channel!");
8728 return Err(DecodeError::InvalidValue);
8730 max_in_flight_update_id
8734 for (counterparty_id, peer_state_mtx) in per_peer_state.iter_mut() {
8735 let mut peer_state_lock = peer_state_mtx.lock().unwrap();
8736 let peer_state = &mut *peer_state_lock;
8737 for (_, chan) in peer_state.channel_by_id.iter() {
8738 // Channels that were persisted have to be funded, otherwise they should have been
8740 let funding_txo = chan.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
8741 let monitor = args.channel_monitors.get(&funding_txo)
8742 .expect("We already checked for monitor presence when loading channels");
8743 let mut max_in_flight_update_id = monitor.get_latest_update_id();
8744 if let Some(in_flight_upds) = &mut in_flight_monitor_updates {
8745 if let Some(mut chan_in_flight_upds) = in_flight_upds.remove(&(*counterparty_id, funding_txo)) {
8746 max_in_flight_update_id = cmp::max(max_in_flight_update_id,
8747 handle_in_flight_updates!(*counterparty_id, chan_in_flight_upds,
8748 funding_txo, monitor, peer_state, ""));
8751 if chan.get_latest_unblocked_monitor_update_id() > max_in_flight_update_id {
8752 // If the channel is ahead of the monitor, return InvalidValue:
8753 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
8754 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} with update_id through {} in-flight",
8755 log_bytes!(chan.context.channel_id()), monitor.get_latest_update_id(), max_in_flight_update_id);
8756 log_error!(args.logger, " but the ChannelManager is at update_id {}.", chan.get_latest_unblocked_monitor_update_id());
8757 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
8758 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
8759 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
8760 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");
8761 return Err(DecodeError::InvalidValue);
8766 if let Some(in_flight_upds) = in_flight_monitor_updates {
8767 for ((counterparty_id, funding_txo), mut chan_in_flight_updates) in in_flight_upds {
8768 if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
8769 // Now that we've removed all the in-flight monitor updates for channels that are
8770 // still open, we need to replay any monitor updates that are for closed channels,
8771 // creating the neccessary peer_state entries as we go.
8772 let peer_state_mutex = per_peer_state.entry(counterparty_id).or_insert_with(|| {
8773 Mutex::new(peer_state_from_chans(HashMap::new()))
8775 let mut peer_state = peer_state_mutex.lock().unwrap();
8776 handle_in_flight_updates!(counterparty_id, chan_in_flight_updates,
8777 funding_txo, monitor, peer_state, "closed ");
8779 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!");
8780 log_error!(args.logger, " The ChannelMonitor for channel {} is missing.",
8781 log_bytes!(funding_txo.to_channel_id()));
8782 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
8783 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
8784 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
8785 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");
8786 return Err(DecodeError::InvalidValue);
8791 // Note that we have to do the above replays before we push new monitor updates.
8792 pending_background_events.append(&mut close_background_events);
8794 // If there's any preimages for forwarded HTLCs hanging around in ChannelMonitors we
8795 // should ensure we try them again on the inbound edge. We put them here and do so after we
8796 // have a fully-constructed `ChannelManager` at the end.
8797 let mut pending_claims_to_replay = Vec::new();
8800 // If we're tracking pending payments, ensure we haven't lost any by looking at the
8801 // ChannelMonitor data for any channels for which we do not have authorative state
8802 // (i.e. those for which we just force-closed above or we otherwise don't have a
8803 // corresponding `Channel` at all).
8804 // This avoids several edge-cases where we would otherwise "forget" about pending
8805 // payments which are still in-flight via their on-chain state.
8806 // We only rebuild the pending payments map if we were most recently serialized by
8808 for (_, monitor) in args.channel_monitors.iter() {
8809 let counterparty_opt = id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id());
8810 if counterparty_opt.is_none() {
8811 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
8812 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
8813 if path.hops.is_empty() {
8814 log_error!(args.logger, "Got an empty path for a pending payment");
8815 return Err(DecodeError::InvalidValue);
8818 let path_amt = path.final_value_msat();
8819 let mut session_priv_bytes = [0; 32];
8820 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
8821 match pending_outbounds.pending_outbound_payments.lock().unwrap().entry(payment_id) {
8822 hash_map::Entry::Occupied(mut entry) => {
8823 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
8824 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
8825 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), log_bytes!(htlc.payment_hash.0));
8827 hash_map::Entry::Vacant(entry) => {
8828 let path_fee = path.fee_msat();
8829 entry.insert(PendingOutboundPayment::Retryable {
8830 retry_strategy: None,
8831 attempts: PaymentAttempts::new(),
8832 payment_params: None,
8833 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
8834 payment_hash: htlc.payment_hash,
8835 payment_secret: None, // only used for retries, and we'll never retry on startup
8836 payment_metadata: None, // only used for retries, and we'll never retry on startup
8837 keysend_preimage: None, // only used for retries, and we'll never retry on startup
8838 custom_tlvs: Vec::new(), // only used for retries, and we'll never retry on startup
8839 pending_amt_msat: path_amt,
8840 pending_fee_msat: Some(path_fee),
8841 total_msat: path_amt,
8842 starting_block_height: best_block_height,
8844 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
8845 path_amt, log_bytes!(htlc.payment_hash.0), log_bytes!(session_priv_bytes));
8850 for (htlc_source, (htlc, preimage_opt)) in monitor.get_all_current_outbound_htlcs() {
8852 HTLCSource::PreviousHopData(prev_hop_data) => {
8853 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
8854 info.prev_funding_outpoint == prev_hop_data.outpoint &&
8855 info.prev_htlc_id == prev_hop_data.htlc_id
8857 // The ChannelMonitor is now responsible for this HTLC's
8858 // failure/success and will let us know what its outcome is. If we
8859 // still have an entry for this HTLC in `forward_htlcs` or
8860 // `pending_intercepted_htlcs`, we were apparently not persisted after
8861 // the monitor was when forwarding the payment.
8862 forward_htlcs.retain(|_, forwards| {
8863 forwards.retain(|forward| {
8864 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
8865 if pending_forward_matches_htlc(&htlc_info) {
8866 log_info!(args.logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
8867 log_bytes!(htlc.payment_hash.0), log_bytes!(monitor.get_funding_txo().0.to_channel_id()));
8872 !forwards.is_empty()
8874 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
8875 if pending_forward_matches_htlc(&htlc_info) {
8876 log_info!(args.logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
8877 log_bytes!(htlc.payment_hash.0), log_bytes!(monitor.get_funding_txo().0.to_channel_id()));
8878 pending_events_read.retain(|(event, _)| {
8879 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
8880 intercepted_id != ev_id
8887 HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } => {
8888 if let Some(preimage) = preimage_opt {
8889 let pending_events = Mutex::new(pending_events_read);
8890 // Note that we set `from_onchain` to "false" here,
8891 // deliberately keeping the pending payment around forever.
8892 // Given it should only occur when we have a channel we're
8893 // force-closing for being stale that's okay.
8894 // The alternative would be to wipe the state when claiming,
8895 // generating a `PaymentPathSuccessful` event but regenerating
8896 // it and the `PaymentSent` on every restart until the
8897 // `ChannelMonitor` is removed.
8898 pending_outbounds.claim_htlc(payment_id, preimage, session_priv, path, false, &pending_events, &args.logger);
8899 pending_events_read = pending_events.into_inner().unwrap();
8906 // Whether the downstream channel was closed or not, try to re-apply any payment
8907 // preimages from it which may be needed in upstream channels for forwarded
8909 let outbound_claimed_htlcs_iter = monitor.get_all_current_outbound_htlcs()
8911 .filter_map(|(htlc_source, (htlc, preimage_opt))| {
8912 if let HTLCSource::PreviousHopData(_) = htlc_source {
8913 if let Some(payment_preimage) = preimage_opt {
8914 Some((htlc_source, payment_preimage, htlc.amount_msat,
8915 // Check if `counterparty_opt.is_none()` to see if the
8916 // downstream chan is closed (because we don't have a
8917 // channel_id -> peer map entry).
8918 counterparty_opt.is_none(),
8919 monitor.get_funding_txo().0.to_channel_id()))
8922 // If it was an outbound payment, we've handled it above - if a preimage
8923 // came in and we persisted the `ChannelManager` we either handled it and
8924 // are good to go or the channel force-closed - we don't have to handle the
8925 // channel still live case here.
8929 for tuple in outbound_claimed_htlcs_iter {
8930 pending_claims_to_replay.push(tuple);
8935 if !forward_htlcs.is_empty() || pending_outbounds.needs_abandon() {
8936 // If we have pending HTLCs to forward, assume we either dropped a
8937 // `PendingHTLCsForwardable` or the user received it but never processed it as they
8938 // shut down before the timer hit. Either way, set the time_forwardable to a small
8939 // constant as enough time has likely passed that we should simply handle the forwards
8940 // now, or at least after the user gets a chance to reconnect to our peers.
8941 pending_events_read.push_back((events::Event::PendingHTLCsForwardable {
8942 time_forwardable: Duration::from_secs(2),
8946 let inbound_pmt_key_material = args.node_signer.get_inbound_payment_key_material();
8947 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
8949 let mut claimable_payments = HashMap::with_capacity(claimable_htlcs_list.len());
8950 if let Some(purposes) = claimable_htlc_purposes {
8951 if purposes.len() != claimable_htlcs_list.len() {
8952 return Err(DecodeError::InvalidValue);
8954 if let Some(onion_fields) = claimable_htlc_onion_fields {
8955 if onion_fields.len() != claimable_htlcs_list.len() {
8956 return Err(DecodeError::InvalidValue);
8958 for (purpose, (onion, (payment_hash, htlcs))) in
8959 purposes.into_iter().zip(onion_fields.into_iter().zip(claimable_htlcs_list.into_iter()))
8961 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
8962 purpose, htlcs, onion_fields: onion,
8964 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
8967 for (purpose, (payment_hash, htlcs)) in purposes.into_iter().zip(claimable_htlcs_list.into_iter()) {
8968 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
8969 purpose, htlcs, onion_fields: None,
8971 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
8975 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
8976 // include a `_legacy_hop_data` in the `OnionPayload`.
8977 for (payment_hash, htlcs) in claimable_htlcs_list.drain(..) {
8978 if htlcs.is_empty() {
8979 return Err(DecodeError::InvalidValue);
8981 let purpose = match &htlcs[0].onion_payload {
8982 OnionPayload::Invoice { _legacy_hop_data } => {
8983 if let Some(hop_data) = _legacy_hop_data {
8984 events::PaymentPurpose::InvoicePayment {
8985 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
8986 Some(inbound_payment) => inbound_payment.payment_preimage,
8987 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
8988 Ok((payment_preimage, _)) => payment_preimage,
8990 log_error!(args.logger, "Failed to read claimable payment data for HTLC with payment hash {} - was not a pending inbound payment and didn't match our payment key", log_bytes!(payment_hash.0));
8991 return Err(DecodeError::InvalidValue);
8995 payment_secret: hop_data.payment_secret,
8997 } else { return Err(DecodeError::InvalidValue); }
8999 OnionPayload::Spontaneous(payment_preimage) =>
9000 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
9002 claimable_payments.insert(payment_hash, ClaimablePayment {
9003 purpose, htlcs, onion_fields: None,
9008 let mut secp_ctx = Secp256k1::new();
9009 secp_ctx.seeded_randomize(&args.entropy_source.get_secure_random_bytes());
9011 let our_network_pubkey = match args.node_signer.get_node_id(Recipient::Node) {
9013 Err(()) => return Err(DecodeError::InvalidValue)
9015 if let Some(network_pubkey) = received_network_pubkey {
9016 if network_pubkey != our_network_pubkey {
9017 log_error!(args.logger, "Key that was generated does not match the existing key.");
9018 return Err(DecodeError::InvalidValue);
9022 let mut outbound_scid_aliases = HashSet::new();
9023 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
9024 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9025 let peer_state = &mut *peer_state_lock;
9026 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
9027 if chan.context.outbound_scid_alias() == 0 {
9028 let mut outbound_scid_alias;
9030 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
9031 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.entropy_source);
9032 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
9034 chan.context.set_outbound_scid_alias(outbound_scid_alias);
9035 } else if !outbound_scid_aliases.insert(chan.context.outbound_scid_alias()) {
9036 // Note that in rare cases its possible to hit this while reading an older
9037 // channel if we just happened to pick a colliding outbound alias above.
9038 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
9039 return Err(DecodeError::InvalidValue);
9041 if chan.context.is_usable() {
9042 if short_to_chan_info.insert(chan.context.outbound_scid_alias(), (chan.context.get_counterparty_node_id(), *chan_id)).is_some() {
9043 // Note that in rare cases its possible to hit this while reading an older
9044 // channel if we just happened to pick a colliding outbound alias above.
9045 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
9046 return Err(DecodeError::InvalidValue);
9052 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
9054 for (_, monitor) in args.channel_monitors.iter() {
9055 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
9056 if let Some(payment) = claimable_payments.remove(&payment_hash) {
9057 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", log_bytes!(payment_hash.0));
9058 let mut claimable_amt_msat = 0;
9059 let mut receiver_node_id = Some(our_network_pubkey);
9060 let phantom_shared_secret = payment.htlcs[0].prev_hop.phantom_shared_secret;
9061 if phantom_shared_secret.is_some() {
9062 let phantom_pubkey = args.node_signer.get_node_id(Recipient::PhantomNode)
9063 .expect("Failed to get node_id for phantom node recipient");
9064 receiver_node_id = Some(phantom_pubkey)
9066 for claimable_htlc in payment.htlcs {
9067 claimable_amt_msat += claimable_htlc.value;
9069 // Add a holding-cell claim of the payment to the Channel, which should be
9070 // applied ~immediately on peer reconnection. Because it won't generate a
9071 // new commitment transaction we can just provide the payment preimage to
9072 // the corresponding ChannelMonitor and nothing else.
9074 // We do so directly instead of via the normal ChannelMonitor update
9075 // procedure as the ChainMonitor hasn't yet been initialized, implying
9076 // we're not allowed to call it directly yet. Further, we do the update
9077 // without incrementing the ChannelMonitor update ID as there isn't any
9079 // If we were to generate a new ChannelMonitor update ID here and then
9080 // crash before the user finishes block connect we'd end up force-closing
9081 // this channel as well. On the flip side, there's no harm in restarting
9082 // without the new monitor persisted - we'll end up right back here on
9084 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
9085 if let Some(peer_node_id) = id_to_peer.get(&previous_channel_id){
9086 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
9087 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9088 let peer_state = &mut *peer_state_lock;
9089 if let Some(channel) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
9090 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
9093 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
9094 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
9097 pending_events_read.push_back((events::Event::PaymentClaimed {
9100 purpose: payment.purpose,
9101 amount_msat: claimable_amt_msat,
9107 for (node_id, monitor_update_blocked_actions) in monitor_update_blocked_actions_per_peer.unwrap() {
9108 if let Some(peer_state) = per_peer_state.get(&node_id) {
9109 for (_, actions) in monitor_update_blocked_actions.iter() {
9110 for action in actions.iter() {
9111 if let MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
9112 downstream_counterparty_and_funding_outpoint:
9113 Some((blocked_node_id, blocked_channel_outpoint, blocking_action)), ..
9115 if let Some(blocked_peer_state) = per_peer_state.get(&blocked_node_id) {
9116 blocked_peer_state.lock().unwrap().actions_blocking_raa_monitor_updates
9117 .entry(blocked_channel_outpoint.to_channel_id())
9118 .or_insert_with(Vec::new).push(blocking_action.clone());
9120 // If the channel we were blocking has closed, we don't need to
9121 // worry about it - the blocked monitor update should never have
9122 // been released from the `Channel` object so it can't have
9123 // completed, and if the channel closed there's no reason to bother
9129 peer_state.lock().unwrap().monitor_update_blocked_actions = monitor_update_blocked_actions;
9131 log_error!(args.logger, "Got blocked actions without a per-peer-state for {}", node_id);
9132 return Err(DecodeError::InvalidValue);
9136 let channel_manager = ChannelManager {
9138 fee_estimator: bounded_fee_estimator,
9139 chain_monitor: args.chain_monitor,
9140 tx_broadcaster: args.tx_broadcaster,
9141 router: args.router,
9143 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
9145 inbound_payment_key: expanded_inbound_key,
9146 pending_inbound_payments: Mutex::new(pending_inbound_payments),
9147 pending_outbound_payments: pending_outbounds,
9148 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
9150 forward_htlcs: Mutex::new(forward_htlcs),
9151 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments, pending_claiming_payments: pending_claiming_payments.unwrap() }),
9152 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
9153 id_to_peer: Mutex::new(id_to_peer),
9154 short_to_chan_info: FairRwLock::new(short_to_chan_info),
9155 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
9157 probing_cookie_secret: probing_cookie_secret.unwrap(),
9162 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
9164 per_peer_state: FairRwLock::new(per_peer_state),
9166 pending_events: Mutex::new(pending_events_read),
9167 pending_events_processor: AtomicBool::new(false),
9168 pending_background_events: Mutex::new(pending_background_events),
9169 total_consistency_lock: RwLock::new(()),
9170 background_events_processed_since_startup: AtomicBool::new(false),
9171 persistence_notifier: Notifier::new(),
9173 entropy_source: args.entropy_source,
9174 node_signer: args.node_signer,
9175 signer_provider: args.signer_provider,
9177 logger: args.logger,
9178 default_configuration: args.default_config,
9181 for htlc_source in failed_htlcs.drain(..) {
9182 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
9183 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
9184 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
9185 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
9188 for (source, preimage, downstream_value, downstream_closed, downstream_chan_id) in pending_claims_to_replay {
9189 // We use `downstream_closed` in place of `from_onchain` here just as a guess - we
9190 // don't remember in the `ChannelMonitor` where we got a preimage from, but if the
9191 // channel is closed we just assume that it probably came from an on-chain claim.
9192 channel_manager.claim_funds_internal(source, preimage, Some(downstream_value),
9193 downstream_closed, downstream_chan_id);
9196 //TODO: Broadcast channel update for closed channels, but only after we've made a
9197 //connection or two.
9199 Ok((best_block_hash.clone(), channel_manager))
9205 use bitcoin::hashes::Hash;
9206 use bitcoin::hashes::sha256::Hash as Sha256;
9207 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
9208 use core::sync::atomic::Ordering;
9209 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
9210 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
9211 use crate::ln::channelmanager::{inbound_payment, PaymentId, PaymentSendFailure, RecipientOnionFields, InterceptId};
9212 use crate::ln::functional_test_utils::*;
9213 use crate::ln::msgs::{self, ErrorAction};
9214 use crate::ln::msgs::ChannelMessageHandler;
9215 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
9216 use crate::util::errors::APIError;
9217 use crate::util::test_utils;
9218 use crate::util::config::{ChannelConfig, ChannelConfigUpdate};
9219 use crate::sign::EntropySource;
9222 fn test_notify_limits() {
9223 // Check that a few cases which don't require the persistence of a new ChannelManager,
9224 // indeed, do not cause the persistence of a new ChannelManager.
9225 let chanmon_cfgs = create_chanmon_cfgs(3);
9226 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9227 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9228 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9230 // All nodes start with a persistable update pending as `create_network` connects each node
9231 // with all other nodes to make most tests simpler.
9232 assert!(nodes[0].node.get_persistable_update_future().poll_is_complete());
9233 assert!(nodes[1].node.get_persistable_update_future().poll_is_complete());
9234 assert!(nodes[2].node.get_persistable_update_future().poll_is_complete());
9236 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1);
9238 // We check that the channel info nodes have doesn't change too early, even though we try
9239 // to connect messages with new values
9240 chan.0.contents.fee_base_msat *= 2;
9241 chan.1.contents.fee_base_msat *= 2;
9242 let node_a_chan_info = nodes[0].node.list_channels_with_counterparty(
9243 &nodes[1].node.get_our_node_id()).pop().unwrap();
9244 let node_b_chan_info = nodes[1].node.list_channels_with_counterparty(
9245 &nodes[0].node.get_our_node_id()).pop().unwrap();
9247 // The first two nodes (which opened a channel) should now require fresh persistence
9248 assert!(nodes[0].node.get_persistable_update_future().poll_is_complete());
9249 assert!(nodes[1].node.get_persistable_update_future().poll_is_complete());
9250 // ... but the last node should not.
9251 assert!(!nodes[2].node.get_persistable_update_future().poll_is_complete());
9252 // After persisting the first two nodes they should no longer need fresh persistence.
9253 assert!(!nodes[0].node.get_persistable_update_future().poll_is_complete());
9254 assert!(!nodes[1].node.get_persistable_update_future().poll_is_complete());
9256 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
9257 // about the channel.
9258 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
9259 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
9260 assert!(!nodes[2].node.get_persistable_update_future().poll_is_complete());
9262 // The nodes which are a party to the channel should also ignore messages from unrelated
9264 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
9265 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
9266 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
9267 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
9268 assert!(!nodes[0].node.get_persistable_update_future().poll_is_complete());
9269 assert!(!nodes[1].node.get_persistable_update_future().poll_is_complete());
9271 // At this point the channel info given by peers should still be the same.
9272 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
9273 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
9275 // An earlier version of handle_channel_update didn't check the directionality of the
9276 // update message and would always update the local fee info, even if our peer was
9277 // (spuriously) forwarding us our own channel_update.
9278 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
9279 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
9280 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
9282 // First deliver each peers' own message, checking that the node doesn't need to be
9283 // persisted and that its channel info remains the same.
9284 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
9285 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
9286 assert!(!nodes[0].node.get_persistable_update_future().poll_is_complete());
9287 assert!(!nodes[1].node.get_persistable_update_future().poll_is_complete());
9288 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
9289 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
9291 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
9292 // the channel info has updated.
9293 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
9294 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
9295 assert!(nodes[0].node.get_persistable_update_future().poll_is_complete());
9296 assert!(nodes[1].node.get_persistable_update_future().poll_is_complete());
9297 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
9298 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
9302 fn test_keysend_dup_hash_partial_mpp() {
9303 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
9305 let chanmon_cfgs = create_chanmon_cfgs(2);
9306 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9307 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9308 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9309 create_announced_chan_between_nodes(&nodes, 0, 1);
9311 // First, send a partial MPP payment.
9312 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
9313 let mut mpp_route = route.clone();
9314 mpp_route.paths.push(mpp_route.paths[0].clone());
9316 let payment_id = PaymentId([42; 32]);
9317 // Use the utility function send_payment_along_path to send the payment with MPP data which
9318 // indicates there are more HTLCs coming.
9319 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.
9320 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
9321 RecipientOnionFields::secret_only(payment_secret), payment_id, &mpp_route).unwrap();
9322 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[0], &our_payment_hash,
9323 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
9324 check_added_monitors!(nodes[0], 1);
9325 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9326 assert_eq!(events.len(), 1);
9327 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
9329 // Next, send a keysend payment with the same payment_hash and make sure it fails.
9330 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9331 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9332 check_added_monitors!(nodes[0], 1);
9333 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9334 assert_eq!(events.len(), 1);
9335 let ev = events.drain(..).next().unwrap();
9336 let payment_event = SendEvent::from_event(ev);
9337 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9338 check_added_monitors!(nodes[1], 0);
9339 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9340 expect_pending_htlcs_forwardable!(nodes[1]);
9341 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
9342 check_added_monitors!(nodes[1], 1);
9343 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9344 assert!(updates.update_add_htlcs.is_empty());
9345 assert!(updates.update_fulfill_htlcs.is_empty());
9346 assert_eq!(updates.update_fail_htlcs.len(), 1);
9347 assert!(updates.update_fail_malformed_htlcs.is_empty());
9348 assert!(updates.update_fee.is_none());
9349 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9350 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9351 expect_payment_failed!(nodes[0], our_payment_hash, true);
9353 // Send the second half of the original MPP payment.
9354 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[1], &our_payment_hash,
9355 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
9356 check_added_monitors!(nodes[0], 1);
9357 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9358 assert_eq!(events.len(), 1);
9359 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
9361 // Claim the full MPP payment. Note that we can't use a test utility like
9362 // claim_funds_along_route because the ordering of the messages causes the second half of the
9363 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
9364 // lightning messages manually.
9365 nodes[1].node.claim_funds(payment_preimage);
9366 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
9367 check_added_monitors!(nodes[1], 2);
9369 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9370 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
9371 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
9372 check_added_monitors!(nodes[0], 1);
9373 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9374 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
9375 check_added_monitors!(nodes[1], 1);
9376 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9377 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
9378 check_added_monitors!(nodes[1], 1);
9379 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
9380 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
9381 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
9382 check_added_monitors!(nodes[0], 1);
9383 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
9384 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
9385 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9386 check_added_monitors!(nodes[0], 1);
9387 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
9388 check_added_monitors!(nodes[1], 1);
9389 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
9390 check_added_monitors!(nodes[1], 1);
9391 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
9392 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
9393 check_added_monitors!(nodes[0], 1);
9395 // Note that successful MPP payments will generate a single PaymentSent event upon the first
9396 // path's success and a PaymentPathSuccessful event for each path's success.
9397 let events = nodes[0].node.get_and_clear_pending_events();
9398 assert_eq!(events.len(), 3);
9400 Event::PaymentSent { payment_id: ref id, payment_preimage: ref preimage, payment_hash: ref hash, .. } => {
9401 assert_eq!(Some(payment_id), *id);
9402 assert_eq!(payment_preimage, *preimage);
9403 assert_eq!(our_payment_hash, *hash);
9405 _ => panic!("Unexpected event"),
9408 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
9409 assert_eq!(payment_id, *actual_payment_id);
9410 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
9411 assert_eq!(route.paths[0], *path);
9413 _ => panic!("Unexpected event"),
9416 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
9417 assert_eq!(payment_id, *actual_payment_id);
9418 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
9419 assert_eq!(route.paths[0], *path);
9421 _ => panic!("Unexpected event"),
9426 fn test_keysend_dup_payment_hash() {
9427 do_test_keysend_dup_payment_hash(false);
9428 do_test_keysend_dup_payment_hash(true);
9431 fn do_test_keysend_dup_payment_hash(accept_mpp_keysend: bool) {
9432 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
9433 // outbound regular payment fails as expected.
9434 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
9435 // fails as expected.
9436 // (3): Test that a keysend payment with a duplicate payment hash to an existing keysend
9437 // payment fails as expected. When `accept_mpp_keysend` is false, this tests that we
9438 // reject MPP keysend payments, since in this case where the payment has no payment
9439 // secret, a keysend payment with a duplicate hash is basically an MPP keysend. If
9440 // `accept_mpp_keysend` is true, this tests that we only accept MPP keysends with
9441 // payment secrets and reject otherwise.
9442 let chanmon_cfgs = create_chanmon_cfgs(2);
9443 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9444 let mut mpp_keysend_cfg = test_default_channel_config();
9445 mpp_keysend_cfg.accept_mpp_keysend = accept_mpp_keysend;
9446 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(mpp_keysend_cfg)]);
9447 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9448 create_announced_chan_between_nodes(&nodes, 0, 1);
9449 let scorer = test_utils::TestScorer::new();
9450 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9452 // To start (1), send a regular payment but don't claim it.
9453 let expected_route = [&nodes[1]];
9454 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
9456 // Next, attempt a keysend payment and make sure it fails.
9457 let route_params = RouteParameters {
9458 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
9459 final_value_msat: 100_000,
9461 let route = find_route(
9462 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
9463 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
9465 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9466 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9467 check_added_monitors!(nodes[0], 1);
9468 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9469 assert_eq!(events.len(), 1);
9470 let ev = events.drain(..).next().unwrap();
9471 let payment_event = SendEvent::from_event(ev);
9472 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9473 check_added_monitors!(nodes[1], 0);
9474 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9475 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
9476 // fails), the second will process the resulting failure and fail the HTLC backward
9477 expect_pending_htlcs_forwardable!(nodes[1]);
9478 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9479 check_added_monitors!(nodes[1], 1);
9480 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9481 assert!(updates.update_add_htlcs.is_empty());
9482 assert!(updates.update_fulfill_htlcs.is_empty());
9483 assert_eq!(updates.update_fail_htlcs.len(), 1);
9484 assert!(updates.update_fail_malformed_htlcs.is_empty());
9485 assert!(updates.update_fee.is_none());
9486 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9487 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9488 expect_payment_failed!(nodes[0], payment_hash, true);
9490 // Finally, claim the original payment.
9491 claim_payment(&nodes[0], &expected_route, payment_preimage);
9493 // To start (2), send a keysend payment but don't claim it.
9494 let payment_preimage = PaymentPreimage([42; 32]);
9495 let route = find_route(
9496 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
9497 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
9499 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9500 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9501 check_added_monitors!(nodes[0], 1);
9502 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9503 assert_eq!(events.len(), 1);
9504 let event = events.pop().unwrap();
9505 let path = vec![&nodes[1]];
9506 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
9508 // Next, attempt a regular payment and make sure it fails.
9509 let payment_secret = PaymentSecret([43; 32]);
9510 nodes[0].node.send_payment_with_route(&route, payment_hash,
9511 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
9512 check_added_monitors!(nodes[0], 1);
9513 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9514 assert_eq!(events.len(), 1);
9515 let ev = events.drain(..).next().unwrap();
9516 let payment_event = SendEvent::from_event(ev);
9517 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9518 check_added_monitors!(nodes[1], 0);
9519 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9520 expect_pending_htlcs_forwardable!(nodes[1]);
9521 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9522 check_added_monitors!(nodes[1], 1);
9523 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9524 assert!(updates.update_add_htlcs.is_empty());
9525 assert!(updates.update_fulfill_htlcs.is_empty());
9526 assert_eq!(updates.update_fail_htlcs.len(), 1);
9527 assert!(updates.update_fail_malformed_htlcs.is_empty());
9528 assert!(updates.update_fee.is_none());
9529 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9530 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9531 expect_payment_failed!(nodes[0], payment_hash, true);
9533 // Finally, succeed the keysend payment.
9534 claim_payment(&nodes[0], &expected_route, payment_preimage);
9536 // To start (3), send a keysend payment but don't claim it.
9537 let payment_id_1 = PaymentId([44; 32]);
9538 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9539 RecipientOnionFields::spontaneous_empty(), payment_id_1).unwrap();
9540 check_added_monitors!(nodes[0], 1);
9541 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9542 assert_eq!(events.len(), 1);
9543 let event = events.pop().unwrap();
9544 let path = vec![&nodes[1]];
9545 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
9547 // Next, attempt a keysend payment and make sure it fails.
9548 let route_params = RouteParameters {
9549 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
9550 final_value_msat: 100_000,
9552 let route = find_route(
9553 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
9554 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
9556 let payment_id_2 = PaymentId([45; 32]);
9557 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9558 RecipientOnionFields::spontaneous_empty(), payment_id_2).unwrap();
9559 check_added_monitors!(nodes[0], 1);
9560 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9561 assert_eq!(events.len(), 1);
9562 let ev = events.drain(..).next().unwrap();
9563 let payment_event = SendEvent::from_event(ev);
9564 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9565 check_added_monitors!(nodes[1], 0);
9566 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9567 expect_pending_htlcs_forwardable!(nodes[1]);
9568 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9569 check_added_monitors!(nodes[1], 1);
9570 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9571 assert!(updates.update_add_htlcs.is_empty());
9572 assert!(updates.update_fulfill_htlcs.is_empty());
9573 assert_eq!(updates.update_fail_htlcs.len(), 1);
9574 assert!(updates.update_fail_malformed_htlcs.is_empty());
9575 assert!(updates.update_fee.is_none());
9576 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9577 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9578 expect_payment_failed!(nodes[0], payment_hash, true);
9580 // Finally, claim the original payment.
9581 claim_payment(&nodes[0], &expected_route, payment_preimage);
9585 fn test_keysend_hash_mismatch() {
9586 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
9587 // preimage doesn't match the msg's payment hash.
9588 let chanmon_cfgs = create_chanmon_cfgs(2);
9589 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9590 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9591 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9593 let payer_pubkey = nodes[0].node.get_our_node_id();
9594 let payee_pubkey = nodes[1].node.get_our_node_id();
9596 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
9597 let route_params = RouteParameters {
9598 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
9599 final_value_msat: 10_000,
9601 let network_graph = nodes[0].network_graph.clone();
9602 let first_hops = nodes[0].node.list_usable_channels();
9603 let scorer = test_utils::TestScorer::new();
9604 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9605 let route = find_route(
9606 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
9607 nodes[0].logger, &scorer, &(), &random_seed_bytes
9610 let test_preimage = PaymentPreimage([42; 32]);
9611 let mismatch_payment_hash = PaymentHash([43; 32]);
9612 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash,
9613 RecipientOnionFields::spontaneous_empty(), PaymentId(mismatch_payment_hash.0), &route).unwrap();
9614 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash,
9615 RecipientOnionFields::spontaneous_empty(), Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
9616 check_added_monitors!(nodes[0], 1);
9618 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9619 assert_eq!(updates.update_add_htlcs.len(), 1);
9620 assert!(updates.update_fulfill_htlcs.is_empty());
9621 assert!(updates.update_fail_htlcs.is_empty());
9622 assert!(updates.update_fail_malformed_htlcs.is_empty());
9623 assert!(updates.update_fee.is_none());
9624 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
9626 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "Payment preimage didn't match payment hash", 1);
9630 fn test_keysend_msg_with_secret_err() {
9631 // Test that we error as expected if we receive a keysend payment that includes a payment
9632 // secret when we don't support MPP keysend.
9633 let mut reject_mpp_keysend_cfg = test_default_channel_config();
9634 reject_mpp_keysend_cfg.accept_mpp_keysend = false;
9635 let chanmon_cfgs = create_chanmon_cfgs(2);
9636 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9637 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(reject_mpp_keysend_cfg)]);
9638 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9640 let payer_pubkey = nodes[0].node.get_our_node_id();
9641 let payee_pubkey = nodes[1].node.get_our_node_id();
9643 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
9644 let route_params = RouteParameters {
9645 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
9646 final_value_msat: 10_000,
9648 let network_graph = nodes[0].network_graph.clone();
9649 let first_hops = nodes[0].node.list_usable_channels();
9650 let scorer = test_utils::TestScorer::new();
9651 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9652 let route = find_route(
9653 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
9654 nodes[0].logger, &scorer, &(), &random_seed_bytes
9657 let test_preimage = PaymentPreimage([42; 32]);
9658 let test_secret = PaymentSecret([43; 32]);
9659 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
9660 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash,
9661 RecipientOnionFields::secret_only(test_secret), PaymentId(payment_hash.0), &route).unwrap();
9662 nodes[0].node.test_send_payment_internal(&route, payment_hash,
9663 RecipientOnionFields::secret_only(test_secret), Some(test_preimage),
9664 PaymentId(payment_hash.0), None, session_privs).unwrap();
9665 check_added_monitors!(nodes[0], 1);
9667 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9668 assert_eq!(updates.update_add_htlcs.len(), 1);
9669 assert!(updates.update_fulfill_htlcs.is_empty());
9670 assert!(updates.update_fail_htlcs.is_empty());
9671 assert!(updates.update_fail_malformed_htlcs.is_empty());
9672 assert!(updates.update_fee.is_none());
9673 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
9675 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "We don't support MPP keysend payments", 1);
9679 fn test_multi_hop_missing_secret() {
9680 let chanmon_cfgs = create_chanmon_cfgs(4);
9681 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
9682 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
9683 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
9685 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
9686 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
9687 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
9688 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
9690 // Marshall an MPP route.
9691 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
9692 let path = route.paths[0].clone();
9693 route.paths.push(path);
9694 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
9695 route.paths[0].hops[0].short_channel_id = chan_1_id;
9696 route.paths[0].hops[1].short_channel_id = chan_3_id;
9697 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
9698 route.paths[1].hops[0].short_channel_id = chan_2_id;
9699 route.paths[1].hops[1].short_channel_id = chan_4_id;
9701 match nodes[0].node.send_payment_with_route(&route, payment_hash,
9702 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0))
9704 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
9705 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err))
9707 _ => panic!("unexpected error")
9712 fn test_drop_disconnected_peers_when_removing_channels() {
9713 let chanmon_cfgs = create_chanmon_cfgs(2);
9714 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9715 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9716 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9718 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
9720 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
9721 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
9723 nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
9724 check_closed_broadcast!(nodes[0], true);
9725 check_added_monitors!(nodes[0], 1);
9726 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
9729 // Assert that nodes[1] is awaiting removal for nodes[0] once nodes[1] has been
9730 // disconnected and the channel between has been force closed.
9731 let nodes_0_per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
9732 // Assert that nodes[1] isn't removed before `timer_tick_occurred` has been executed.
9733 assert_eq!(nodes_0_per_peer_state.len(), 1);
9734 assert!(nodes_0_per_peer_state.get(&nodes[1].node.get_our_node_id()).is_some());
9737 nodes[0].node.timer_tick_occurred();
9740 // Assert that nodes[1] has now been removed.
9741 assert_eq!(nodes[0].node.per_peer_state.read().unwrap().len(), 0);
9746 fn bad_inbound_payment_hash() {
9747 // Add coverage for checking that a user-provided payment hash matches the payment secret.
9748 let chanmon_cfgs = create_chanmon_cfgs(2);
9749 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9750 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9751 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9753 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
9754 let payment_data = msgs::FinalOnionHopData {
9756 total_msat: 100_000,
9759 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
9760 // payment verification fails as expected.
9761 let mut bad_payment_hash = payment_hash.clone();
9762 bad_payment_hash.0[0] += 1;
9763 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) {
9764 Ok(_) => panic!("Unexpected ok"),
9766 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment", "Failing HTLC with user-generated payment_hash", 1);
9770 // Check that using the original payment hash succeeds.
9771 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());
9775 fn test_id_to_peer_coverage() {
9776 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
9777 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
9778 // the channel is successfully closed.
9779 let chanmon_cfgs = create_chanmon_cfgs(2);
9780 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9781 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9782 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9784 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
9785 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9786 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
9787 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9788 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
9790 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
9791 let channel_id = &tx.txid().into_inner();
9793 // Ensure that the `id_to_peer` map is empty until either party has received the
9794 // funding transaction, and have the real `channel_id`.
9795 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
9796 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
9799 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
9801 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
9802 // as it has the funding transaction.
9803 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
9804 assert_eq!(nodes_0_lock.len(), 1);
9805 assert!(nodes_0_lock.contains_key(channel_id));
9808 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
9810 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9812 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9814 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
9815 assert_eq!(nodes_0_lock.len(), 1);
9816 assert!(nodes_0_lock.contains_key(channel_id));
9818 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
9821 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
9822 // as it has the funding transaction.
9823 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
9824 assert_eq!(nodes_1_lock.len(), 1);
9825 assert!(nodes_1_lock.contains_key(channel_id));
9827 check_added_monitors!(nodes[1], 1);
9828 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9829 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
9830 check_added_monitors!(nodes[0], 1);
9831 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
9832 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9833 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
9834 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
9836 nodes[0].node.close_channel(channel_id, &nodes[1].node.get_our_node_id()).unwrap();
9837 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()));
9838 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
9839 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &nodes_1_shutdown);
9841 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
9842 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
9844 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
9845 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
9846 // fee for the closing transaction has been negotiated and the parties has the other
9847 // party's signature for the fee negotiated closing transaction.)
9848 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
9849 assert_eq!(nodes_0_lock.len(), 1);
9850 assert!(nodes_0_lock.contains_key(channel_id));
9854 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
9855 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
9856 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
9857 // kept in the `nodes[1]`'s `id_to_peer` map.
9858 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
9859 assert_eq!(nodes_1_lock.len(), 1);
9860 assert!(nodes_1_lock.contains_key(channel_id));
9863 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()));
9865 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
9866 // therefore has all it needs to fully close the channel (both signatures for the
9867 // closing transaction).
9868 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
9869 // fully closed by `nodes[0]`.
9870 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
9872 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
9873 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
9874 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
9875 assert_eq!(nodes_1_lock.len(), 1);
9876 assert!(nodes_1_lock.contains_key(channel_id));
9879 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
9881 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
9883 // Assert that the channel has now been removed from both parties `id_to_peer` map once
9884 // they both have everything required to fully close the channel.
9885 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
9887 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
9889 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
9890 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
9893 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
9894 let expected_message = format!("Not connected to node: {}", expected_public_key);
9895 check_api_error_message(expected_message, res_err)
9898 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
9899 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
9900 check_api_error_message(expected_message, res_err)
9903 fn check_api_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
9905 Err(APIError::APIMisuseError { err }) => {
9906 assert_eq!(err, expected_err_message);
9908 Err(APIError::ChannelUnavailable { err }) => {
9909 assert_eq!(err, expected_err_message);
9911 Ok(_) => panic!("Unexpected Ok"),
9912 Err(_) => panic!("Unexpected Error"),
9917 fn test_api_calls_with_unkown_counterparty_node() {
9918 // Tests that our API functions that expects a `counterparty_node_id` as input, behaves as
9919 // expected if the `counterparty_node_id` is an unkown peer in the
9920 // `ChannelManager::per_peer_state` map.
9921 let chanmon_cfg = create_chanmon_cfgs(2);
9922 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
9923 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
9924 let nodes = create_network(2, &node_cfg, &node_chanmgr);
9927 let channel_id = [4; 32];
9928 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
9929 let intercept_id = InterceptId([0; 32]);
9931 // Test the API functions.
9932 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);
9934 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&channel_id, &unkown_public_key, 42), unkown_public_key);
9936 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
9938 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
9940 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
9942 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
9944 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
9948 fn test_connection_limiting() {
9949 // Test that we limit un-channel'd peers and un-funded channels properly.
9950 let chanmon_cfgs = create_chanmon_cfgs(2);
9951 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9952 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9953 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9955 // Note that create_network connects the nodes together for us
9957 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
9958 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9960 let mut funding_tx = None;
9961 for idx in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
9962 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
9963 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9966 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
9967 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
9968 funding_tx = Some(tx.clone());
9969 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx).unwrap();
9970 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9972 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9973 check_added_monitors!(nodes[1], 1);
9974 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
9976 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9978 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
9979 check_added_monitors!(nodes[0], 1);
9980 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
9982 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
9985 // A MAX_UNFUNDED_CHANS_PER_PEER + 1 channel will be summarily rejected
9986 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
9987 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
9988 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
9989 open_channel_msg.temporary_channel_id);
9991 // Further, because all of our channels with nodes[0] are inbound, and none of them funded,
9992 // it doesn't count as a "protected" peer, i.e. it counts towards the MAX_NO_CHANNEL_PEERS
9994 let mut peer_pks = Vec::with_capacity(super::MAX_NO_CHANNEL_PEERS);
9995 for _ in 1..super::MAX_NO_CHANNEL_PEERS {
9996 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
9997 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
9998 peer_pks.push(random_pk);
9999 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
10000 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10003 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10004 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10005 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10006 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10007 }, true).unwrap_err();
10009 // Also importantly, because nodes[0] isn't "protected", we will refuse a reconnection from
10010 // them if we have too many un-channel'd peers.
10011 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10012 let chan_closed_events = nodes[1].node.get_and_clear_pending_events();
10013 assert_eq!(chan_closed_events.len(), super::MAX_UNFUNDED_CHANS_PER_PEER - 1);
10014 for ev in chan_closed_events {
10015 if let Event::ChannelClosed { .. } = ev { } else { panic!(); }
10017 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10018 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10020 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10021 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10022 }, true).unwrap_err();
10024 // but of course if the connection is outbound its allowed...
10025 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10026 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10027 }, false).unwrap();
10028 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10030 // Now nodes[0] is disconnected but still has a pending, un-funded channel lying around.
10031 // Even though we accept one more connection from new peers, we won't actually let them
10033 assert!(peer_pks.len() > super::MAX_UNFUNDED_CHANNEL_PEERS - 1);
10034 for i in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
10035 nodes[1].node.handle_open_channel(&peer_pks[i], &open_channel_msg);
10036 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, peer_pks[i]);
10037 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
10039 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10040 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
10041 open_channel_msg.temporary_channel_id);
10043 // Of course, however, outbound channels are always allowed
10044 nodes[1].node.create_channel(last_random_pk, 100_000, 0, 42, None).unwrap();
10045 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, last_random_pk);
10047 // If we fund the first channel, nodes[0] has a live on-chain channel with us, it is now
10048 // "protected" and can connect again.
10049 mine_transaction(&nodes[1], funding_tx.as_ref().unwrap());
10050 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10051 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10053 get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
10055 // Further, because the first channel was funded, we can open another channel with
10057 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10058 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
10062 fn test_outbound_chans_unlimited() {
10063 // Test that we never refuse an outbound channel even if a peer is unfuned-channel-limited
10064 let chanmon_cfgs = create_chanmon_cfgs(2);
10065 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10066 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10067 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10069 // Note that create_network connects the nodes together for us
10071 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10072 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10074 for _ in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
10075 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10076 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10077 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
10080 // Once we have MAX_UNFUNDED_CHANS_PER_PEER unfunded channels, new inbound channels will be
10082 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10083 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
10084 open_channel_msg.temporary_channel_id);
10086 // but we can still open an outbound channel.
10087 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10088 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
10090 // but even with such an outbound channel, additional inbound channels will still fail.
10091 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10092 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
10093 open_channel_msg.temporary_channel_id);
10097 fn test_0conf_limiting() {
10098 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
10099 // flag set and (sometimes) accept channels as 0conf.
10100 let chanmon_cfgs = create_chanmon_cfgs(2);
10101 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10102 let mut settings = test_default_channel_config();
10103 settings.manually_accept_inbound_channels = true;
10104 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(settings)]);
10105 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10107 // Note that create_network connects the nodes together for us
10109 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10110 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10112 // First, get us up to MAX_UNFUNDED_CHANNEL_PEERS so we can test at the edge
10113 for _ in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
10114 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10115 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10116 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
10117 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10120 nodes[1].node.handle_open_channel(&random_pk, &open_channel_msg);
10121 let events = nodes[1].node.get_and_clear_pending_events();
10123 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10124 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23).unwrap();
10126 _ => panic!("Unexpected event"),
10128 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, random_pk);
10129 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
10132 // If we try to accept a channel from another peer non-0conf it will fail.
10133 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10134 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10135 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10136 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10138 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10139 let events = nodes[1].node.get_and_clear_pending_events();
10141 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10142 match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23) {
10143 Err(APIError::APIMisuseError { err }) =>
10144 assert_eq!(err, "Too many peers with unfunded channels, refusing to accept new ones"),
10148 _ => panic!("Unexpected event"),
10150 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
10151 open_channel_msg.temporary_channel_id);
10153 // ...however if we accept the same channel 0conf it should work just fine.
10154 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10155 let events = nodes[1].node.get_and_clear_pending_events();
10157 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10158 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23).unwrap();
10160 _ => panic!("Unexpected event"),
10162 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
10166 fn reject_excessively_underpaying_htlcs() {
10167 let chanmon_cfg = create_chanmon_cfgs(1);
10168 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
10169 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
10170 let node = create_network(1, &node_cfg, &node_chanmgr);
10171 let sender_intended_amt_msat = 100;
10172 let extra_fee_msat = 10;
10173 let hop_data = msgs::InboundOnionPayload::Receive {
10175 outgoing_cltv_value: 42,
10176 payment_metadata: None,
10177 keysend_preimage: None,
10178 payment_data: Some(msgs::FinalOnionHopData {
10179 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
10181 custom_tlvs: Vec::new(),
10183 // Check that if the amount we received + the penultimate hop extra fee is less than the sender
10184 // intended amount, we fail the payment.
10185 if let Err(crate::ln::channelmanager::InboundOnionErr { err_code, .. }) =
10186 node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
10187 sender_intended_amt_msat - extra_fee_msat - 1, 42, None, true, Some(extra_fee_msat))
10189 assert_eq!(err_code, 19);
10190 } else { panic!(); }
10192 // If amt_received + extra_fee is equal to the sender intended amount, we're fine.
10193 let hop_data = msgs::InboundOnionPayload::Receive { // This is the same payload as above, InboundOnionPayload doesn't implement Clone
10195 outgoing_cltv_value: 42,
10196 payment_metadata: None,
10197 keysend_preimage: None,
10198 payment_data: Some(msgs::FinalOnionHopData {
10199 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
10201 custom_tlvs: Vec::new(),
10203 assert!(node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
10204 sender_intended_amt_msat - extra_fee_msat, 42, None, true, Some(extra_fee_msat)).is_ok());
10208 fn test_inbound_anchors_manual_acceptance() {
10209 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
10210 // flag set and (sometimes) accept channels as 0conf.
10211 let mut anchors_cfg = test_default_channel_config();
10212 anchors_cfg.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
10214 let mut anchors_manual_accept_cfg = anchors_cfg.clone();
10215 anchors_manual_accept_cfg.manually_accept_inbound_channels = true;
10217 let chanmon_cfgs = create_chanmon_cfgs(3);
10218 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
10219 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs,
10220 &[Some(anchors_cfg.clone()), Some(anchors_cfg.clone()), Some(anchors_manual_accept_cfg.clone())]);
10221 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
10223 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10224 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10226 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10227 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
10228 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
10229 match &msg_events[0] {
10230 MessageSendEvent::HandleError { node_id, action } => {
10231 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
10233 ErrorAction::SendErrorMessage { msg } =>
10234 assert_eq!(msg.data, "No channels with anchor outputs accepted".to_owned()),
10235 _ => panic!("Unexpected error action"),
10238 _ => panic!("Unexpected event"),
10241 nodes[2].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10242 let events = nodes[2].node.get_and_clear_pending_events();
10244 Event::OpenChannelRequest { temporary_channel_id, .. } =>
10245 nodes[2].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap(),
10246 _ => panic!("Unexpected event"),
10248 get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10252 fn test_anchors_zero_fee_htlc_tx_fallback() {
10253 // Tests that if both nodes support anchors, but the remote node does not want to accept
10254 // anchor channels at the moment, an error it sent to the local node such that it can retry
10255 // the channel without the anchors feature.
10256 let chanmon_cfgs = create_chanmon_cfgs(2);
10257 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10258 let mut anchors_config = test_default_channel_config();
10259 anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
10260 anchors_config.manually_accept_inbound_channels = true;
10261 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config.clone()), Some(anchors_config.clone())]);
10262 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10264 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 0, None).unwrap();
10265 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10266 assert!(open_channel_msg.channel_type.as_ref().unwrap().supports_anchors_zero_fee_htlc_tx());
10268 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10269 let events = nodes[1].node.get_and_clear_pending_events();
10271 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10272 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
10274 _ => panic!("Unexpected event"),
10277 let error_msg = get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id());
10278 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &error_msg);
10280 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10281 assert!(!open_channel_msg.channel_type.unwrap().supports_anchors_zero_fee_htlc_tx());
10283 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[0].node.get_our_node_id()], 100000);
10287 fn test_update_channel_config() {
10288 let chanmon_cfg = create_chanmon_cfgs(2);
10289 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
10290 let mut user_config = test_default_channel_config();
10291 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
10292 let nodes = create_network(2, &node_cfg, &node_chanmgr);
10293 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
10294 let channel = &nodes[0].node.list_channels()[0];
10296 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
10297 let events = nodes[0].node.get_and_clear_pending_msg_events();
10298 assert_eq!(events.len(), 0);
10300 user_config.channel_config.forwarding_fee_base_msat += 10;
10301 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
10302 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_base_msat, user_config.channel_config.forwarding_fee_base_msat);
10303 let events = nodes[0].node.get_and_clear_pending_msg_events();
10304 assert_eq!(events.len(), 1);
10306 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10307 _ => panic!("expected BroadcastChannelUpdate event"),
10310 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate::default()).unwrap();
10311 let events = nodes[0].node.get_and_clear_pending_msg_events();
10312 assert_eq!(events.len(), 0);
10314 let new_cltv_expiry_delta = user_config.channel_config.cltv_expiry_delta + 6;
10315 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
10316 cltv_expiry_delta: Some(new_cltv_expiry_delta),
10317 ..Default::default()
10319 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
10320 let events = nodes[0].node.get_and_clear_pending_msg_events();
10321 assert_eq!(events.len(), 1);
10323 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10324 _ => panic!("expected BroadcastChannelUpdate event"),
10327 let new_fee = user_config.channel_config.forwarding_fee_proportional_millionths + 100;
10328 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
10329 forwarding_fee_proportional_millionths: Some(new_fee),
10330 ..Default::default()
10332 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
10333 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, new_fee);
10334 let events = nodes[0].node.get_and_clear_pending_msg_events();
10335 assert_eq!(events.len(), 1);
10337 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10338 _ => panic!("expected BroadcastChannelUpdate event"),
10341 // If we provide a channel_id not associated with the peer, we should get an error and no updates
10342 // should be applied to ensure update atomicity as specified in the API docs.
10343 let bad_channel_id = [10; 32];
10344 let current_fee = nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths;
10345 let new_fee = current_fee + 100;
10348 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id, bad_channel_id], &ChannelConfigUpdate {
10349 forwarding_fee_proportional_millionths: Some(new_fee),
10350 ..Default::default()
10352 Err(APIError::ChannelUnavailable { err: _ }),
10355 // Check that the fee hasn't changed for the channel that exists.
10356 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, current_fee);
10357 let events = nodes[0].node.get_and_clear_pending_msg_events();
10358 assert_eq!(events.len(), 0);
10364 use crate::chain::Listen;
10365 use crate::chain::chainmonitor::{ChainMonitor, Persist};
10366 use crate::sign::{KeysManager, InMemorySigner};
10367 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider};
10368 use crate::ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId, RecipientOnionFields, Retry};
10369 use crate::ln::functional_test_utils::*;
10370 use crate::ln::msgs::{ChannelMessageHandler, Init};
10371 use crate::routing::gossip::NetworkGraph;
10372 use crate::routing::router::{PaymentParameters, RouteParameters};
10373 use crate::util::test_utils;
10374 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
10376 use bitcoin::hashes::Hash;
10377 use bitcoin::hashes::sha256::Hash as Sha256;
10378 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
10380 use crate::sync::{Arc, Mutex};
10382 use criterion::Criterion;
10384 type Manager<'a, P> = ChannelManager<
10385 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
10386 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
10387 &'a test_utils::TestLogger, &'a P>,
10388 &'a test_utils::TestBroadcaster, &'a KeysManager, &'a KeysManager, &'a KeysManager,
10389 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
10390 &'a test_utils::TestLogger>;
10392 struct ANodeHolder<'a, P: Persist<InMemorySigner>> {
10393 node: &'a Manager<'a, P>,
10395 impl<'a, P: Persist<InMemorySigner>> NodeHolder for ANodeHolder<'a, P> {
10396 type CM = Manager<'a, P>;
10398 fn node(&self) -> &Manager<'a, P> { self.node }
10400 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { None }
10403 pub fn bench_sends(bench: &mut Criterion) {
10404 bench_two_sends(bench, "bench_sends", test_utils::TestPersister::new(), test_utils::TestPersister::new());
10407 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Criterion, bench_name: &str, persister_a: P, persister_b: P) {
10408 // Do a simple benchmark of sending a payment back and forth between two nodes.
10409 // Note that this is unrealistic as each payment send will require at least two fsync
10411 let network = bitcoin::Network::Testnet;
10412 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
10414 let tx_broadcaster = test_utils::TestBroadcaster::new(network);
10415 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
10416 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
10417 let scorer = Mutex::new(test_utils::TestScorer::new());
10418 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(network, &logger_a)), &scorer);
10420 let mut config: UserConfig = Default::default();
10421 config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
10422 config.channel_handshake_config.minimum_depth = 1;
10424 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
10425 let seed_a = [1u8; 32];
10426 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
10427 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 {
10429 best_block: BestBlock::from_network(network),
10430 }, genesis_block.header.time);
10431 let node_a_holder = ANodeHolder { node: &node_a };
10433 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
10434 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
10435 let seed_b = [2u8; 32];
10436 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
10437 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 {
10439 best_block: BestBlock::from_network(network),
10440 }, genesis_block.header.time);
10441 let node_b_holder = ANodeHolder { node: &node_b };
10443 node_a.peer_connected(&node_b.get_our_node_id(), &Init {
10444 features: node_b.init_features(), networks: None, remote_network_address: None
10446 node_b.peer_connected(&node_a.get_our_node_id(), &Init {
10447 features: node_a.init_features(), networks: None, remote_network_address: None
10448 }, false).unwrap();
10449 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
10450 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()));
10451 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()));
10454 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
10455 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
10456 value: 8_000_000, script_pubkey: output_script,
10458 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
10459 } else { panic!(); }
10461 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()));
10462 let events_b = node_b.get_and_clear_pending_events();
10463 assert_eq!(events_b.len(), 1);
10464 match events_b[0] {
10465 Event::ChannelPending{ ref counterparty_node_id, .. } => {
10466 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
10468 _ => panic!("Unexpected event"),
10471 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()));
10472 let events_a = node_a.get_and_clear_pending_events();
10473 assert_eq!(events_a.len(), 1);
10474 match events_a[0] {
10475 Event::ChannelPending{ ref counterparty_node_id, .. } => {
10476 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
10478 _ => panic!("Unexpected event"),
10481 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
10483 let block = create_dummy_block(BestBlock::from_network(network).block_hash(), 42, vec![tx]);
10484 Listen::block_connected(&node_a, &block, 1);
10485 Listen::block_connected(&node_b, &block, 1);
10487 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()));
10488 let msg_events = node_a.get_and_clear_pending_msg_events();
10489 assert_eq!(msg_events.len(), 2);
10490 match msg_events[0] {
10491 MessageSendEvent::SendChannelReady { ref msg, .. } => {
10492 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
10493 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
10497 match msg_events[1] {
10498 MessageSendEvent::SendChannelUpdate { .. } => {},
10502 let events_a = node_a.get_and_clear_pending_events();
10503 assert_eq!(events_a.len(), 1);
10504 match events_a[0] {
10505 Event::ChannelReady{ ref counterparty_node_id, .. } => {
10506 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
10508 _ => panic!("Unexpected event"),
10511 let events_b = node_b.get_and_clear_pending_events();
10512 assert_eq!(events_b.len(), 1);
10513 match events_b[0] {
10514 Event::ChannelReady{ ref counterparty_node_id, .. } => {
10515 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
10517 _ => panic!("Unexpected event"),
10520 let mut payment_count: u64 = 0;
10521 macro_rules! send_payment {
10522 ($node_a: expr, $node_b: expr) => {
10523 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id(), TEST_FINAL_CLTV)
10524 .with_bolt11_features($node_b.invoice_features()).unwrap();
10525 let mut payment_preimage = PaymentPreimage([0; 32]);
10526 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
10527 payment_count += 1;
10528 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
10529 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
10531 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
10532 PaymentId(payment_hash.0), RouteParameters {
10533 payment_params, final_value_msat: 10_000,
10534 }, Retry::Attempts(0)).unwrap();
10535 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
10536 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
10537 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
10538 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_b }, &$node_a.get_our_node_id());
10539 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
10540 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
10541 $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()));
10543 expect_pending_htlcs_forwardable!(ANodeHolder { node: &$node_b });
10544 expect_payment_claimable!(ANodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
10545 $node_b.claim_funds(payment_preimage);
10546 expect_payment_claimed!(ANodeHolder { node: &$node_b }, payment_hash, 10_000);
10548 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
10549 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
10550 assert_eq!(node_id, $node_a.get_our_node_id());
10551 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
10552 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
10554 _ => panic!("Failed to generate claim event"),
10557 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_a }, &$node_b.get_our_node_id());
10558 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
10559 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
10560 $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()));
10562 expect_payment_sent!(ANodeHolder { node: &$node_a }, payment_preimage);
10566 bench.bench_function(bench_name, |b| b.iter(|| {
10567 send_payment!(node_a, node_b);
10568 send_payment!(node_b, node_a);