1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! The top-level channel management and payment tracking stuff lives here.
12 //! The [`ChannelManager`] is the main chunk of logic implementing the lightning protocol and is
13 //! responsible for tracking which channels are open, HTLCs are in flight and reestablishing those
14 //! upon reconnect to the relevant peer(s).
16 //! It does not manage routing logic (see [`Router`] for that) nor does it manage constructing
17 //! on-chain transactions (it only monitors the chain to watch for any force-closes that might
18 //! imply it needs to fail HTLCs/payments/channels it manages).
20 use bitcoin::blockdata::block::BlockHeader;
21 use bitcoin::blockdata::transaction::Transaction;
22 use bitcoin::blockdata::constants::{genesis_block, ChainHash};
23 use bitcoin::network::constants::Network;
25 use bitcoin::hashes::Hash;
26 use bitcoin::hashes::sha256::Hash as Sha256;
27 use bitcoin::hash_types::{BlockHash, Txid};
29 use bitcoin::secp256k1::{SecretKey,PublicKey};
30 use bitcoin::secp256k1::Secp256k1;
31 use bitcoin::{LockTime, secp256k1, Sequence};
34 use crate::chain::{Confirm, ChannelMonitorUpdateStatus, Watch, BestBlock};
35 use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator};
36 use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
37 use crate::chain::transaction::{OutPoint, TransactionData};
39 use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination, PaymentFailureReason};
40 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
41 // construct one themselves.
42 use crate::ln::{inbound_payment, ChannelId, PaymentHash, PaymentPreimage, PaymentSecret};
43 use crate::ln::channel::{Channel, ChannelPhase, ChannelContext, ChannelError, ChannelUpdateStatus, ShutdownResult, UnfundedChannelContext, UpdateFulfillCommitFetch, OutboundV1Channel, InboundV1Channel};
44 use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
45 #[cfg(any(feature = "_test_utils", test))]
46 use crate::ln::features::Bolt11InvoiceFeatures;
47 use crate::routing::gossip::NetworkGraph;
48 use crate::routing::router::{BlindedTail, DefaultRouter, InFlightHtlcs, Path, Payee, PaymentParameters, Route, RouteParameters, Router};
49 use crate::routing::scoring::{ProbabilisticScorer, ProbabilisticScoringFeeParameters};
51 use crate::ln::onion_utils;
52 use crate::ln::onion_utils::HTLCFailReason;
53 use crate::ln::msgs::{ChannelMessageHandler, DecodeError, LightningError};
55 use crate::ln::outbound_payment;
56 use crate::ln::outbound_payment::{OutboundPayments, PaymentAttempts, PendingOutboundPayment, SendAlongPathArgs};
57 use crate::ln::wire::Encode;
58 use crate::sign::{EntropySource, KeysManager, NodeSigner, Recipient, SignerProvider, WriteableEcdsaChannelSigner};
59 use crate::util::config::{UserConfig, ChannelConfig, ChannelConfigUpdate};
60 use crate::util::wakers::{Future, Notifier};
61 use crate::util::scid_utils::fake_scid;
62 use crate::util::string::UntrustedString;
63 use crate::util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
64 use crate::util::logger::{Level, Logger};
65 use crate::util::errors::APIError;
67 use alloc::collections::BTreeMap;
70 use crate::prelude::*;
72 use core::cell::RefCell;
74 use crate::sync::{Arc, Mutex, RwLock, RwLockReadGuard, FairRwLock, LockTestExt, LockHeldState};
75 use core::sync::atomic::{AtomicUsize, AtomicBool, Ordering};
76 use core::time::Duration;
79 // Re-export this for use in the public API.
80 pub use crate::ln::outbound_payment::{PaymentSendFailure, 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,
184 user_channel_id: Option<u128>,
186 incoming_packet_shared_secret: [u8; 32],
187 phantom_shared_secret: Option<[u8; 32]>,
189 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
190 // channel with a preimage provided by the forward channel.
195 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
197 /// This is only here for backwards-compatibility in serialization, in the future it can be
198 /// removed, breaking clients running 0.0.106 and earlier.
199 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
201 /// Contains the payer-provided preimage.
202 Spontaneous(PaymentPreimage),
205 /// HTLCs that are to us and can be failed/claimed by the user
206 struct ClaimableHTLC {
207 prev_hop: HTLCPreviousHopData,
209 /// The amount (in msats) of this MPP part
211 /// The amount (in msats) that the sender intended to be sent in this MPP
212 /// part (used for validating total MPP amount)
213 sender_intended_value: u64,
214 onion_payload: OnionPayload,
216 /// The total value received for a payment (sum of all MPP parts if the payment is a MPP).
217 /// Gets set to the amount reported when pushing [`Event::PaymentClaimable`].
218 total_value_received: Option<u64>,
219 /// The sender intended sum total of all MPP parts specified in the onion
221 /// The extra fee our counterparty skimmed off the top of this HTLC.
222 counterparty_skimmed_fee_msat: Option<u64>,
225 impl From<&ClaimableHTLC> for events::ClaimedHTLC {
226 fn from(val: &ClaimableHTLC) -> Self {
227 events::ClaimedHTLC {
228 channel_id: val.prev_hop.outpoint.to_channel_id(),
229 user_channel_id: val.prev_hop.user_channel_id.unwrap_or(0),
230 cltv_expiry: val.cltv_expiry,
231 value_msat: val.value,
236 /// A payment identifier used to uniquely identify a payment to LDK.
238 /// This is not exported to bindings users as we just use [u8; 32] directly
239 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
240 pub struct PaymentId(pub [u8; Self::LENGTH]);
243 /// Number of bytes in the id.
244 pub const LENGTH: usize = 32;
247 impl Writeable for PaymentId {
248 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
253 impl Readable for PaymentId {
254 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
255 let buf: [u8; 32] = Readable::read(r)?;
260 impl core::fmt::Display for PaymentId {
261 fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
262 crate::util::logger::DebugBytes(&self.0).fmt(f)
266 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
268 /// This is not exported to bindings users as we just use [u8; 32] directly
269 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
270 pub struct InterceptId(pub [u8; 32]);
272 impl Writeable for InterceptId {
273 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
278 impl Readable for InterceptId {
279 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
280 let buf: [u8; 32] = Readable::read(r)?;
285 #[derive(Clone, Copy, PartialEq, Eq, Hash)]
286 /// Uniquely describes an HTLC by its source. Just the guaranteed-unique subset of [`HTLCSource`].
287 pub(crate) enum SentHTLCId {
288 PreviousHopData { short_channel_id: u64, htlc_id: u64 },
289 OutboundRoute { session_priv: SecretKey },
292 pub(crate) fn from_source(source: &HTLCSource) -> Self {
294 HTLCSource::PreviousHopData(hop_data) => Self::PreviousHopData {
295 short_channel_id: hop_data.short_channel_id,
296 htlc_id: hop_data.htlc_id,
298 HTLCSource::OutboundRoute { session_priv, .. } =>
299 Self::OutboundRoute { session_priv: *session_priv },
303 impl_writeable_tlv_based_enum!(SentHTLCId,
304 (0, PreviousHopData) => {
305 (0, short_channel_id, required),
306 (2, htlc_id, required),
308 (2, OutboundRoute) => {
309 (0, session_priv, required),
314 /// Tracks the inbound corresponding to an outbound HTLC
315 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
316 #[derive(Clone, PartialEq, Eq)]
317 pub(crate) enum HTLCSource {
318 PreviousHopData(HTLCPreviousHopData),
321 session_priv: SecretKey,
322 /// Technically we can recalculate this from the route, but we cache it here to avoid
323 /// doing a double-pass on route when we get a failure back
324 first_hop_htlc_msat: u64,
325 payment_id: PaymentId,
328 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
329 impl core::hash::Hash for HTLCSource {
330 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
332 HTLCSource::PreviousHopData(prev_hop_data) => {
334 prev_hop_data.hash(hasher);
336 HTLCSource::OutboundRoute { path, session_priv, payment_id, first_hop_htlc_msat } => {
339 session_priv[..].hash(hasher);
340 payment_id.hash(hasher);
341 first_hop_htlc_msat.hash(hasher);
347 #[cfg(all(feature = "_test_vectors", not(feature = "grind_signatures")))]
349 pub fn dummy() -> Self {
350 HTLCSource::OutboundRoute {
351 path: Path { hops: Vec::new(), blinded_tail: None },
352 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
353 first_hop_htlc_msat: 0,
354 payment_id: PaymentId([2; 32]),
358 #[cfg(debug_assertions)]
359 /// Checks whether this HTLCSource could possibly match the given HTLC output in a commitment
360 /// transaction. Useful to ensure different datastructures match up.
361 pub(crate) fn possibly_matches_output(&self, htlc: &super::chan_utils::HTLCOutputInCommitment) -> bool {
362 if let HTLCSource::OutboundRoute { first_hop_htlc_msat, .. } = self {
363 *first_hop_htlc_msat == htlc.amount_msat
365 // There's nothing we can check for forwarded HTLCs
371 struct InboundOnionErr {
377 /// This enum is used to specify which error data to send to peers when failing back an HTLC
378 /// using [`ChannelManager::fail_htlc_backwards_with_reason`].
380 /// For more info on failure codes, see <https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages>.
381 #[derive(Clone, Copy)]
382 pub enum FailureCode {
383 /// We had a temporary error processing the payment. Useful if no other error codes fit
384 /// and you want to indicate that the payer may want to retry.
385 TemporaryNodeFailure,
386 /// We have a required feature which was not in this onion. For example, you may require
387 /// some additional metadata that was not provided with this payment.
388 RequiredNodeFeatureMissing,
389 /// You may wish to use this when a `payment_preimage` is unknown, or the CLTV expiry of
390 /// the HTLC is too close to the current block height for safe handling.
391 /// Using this failure code in [`ChannelManager::fail_htlc_backwards_with_reason`] is
392 /// equivalent to calling [`ChannelManager::fail_htlc_backwards`].
393 IncorrectOrUnknownPaymentDetails,
394 /// We failed to process the payload after the onion was decrypted. You may wish to
395 /// use this when receiving custom HTLC TLVs with even type numbers that you don't recognize.
397 /// If available, the tuple data may include the type number and byte offset in the
398 /// decrypted byte stream where the failure occurred.
399 InvalidOnionPayload(Option<(u64, u16)>),
402 impl Into<u16> for FailureCode {
403 fn into(self) -> u16 {
405 FailureCode::TemporaryNodeFailure => 0x2000 | 2,
406 FailureCode::RequiredNodeFeatureMissing => 0x4000 | 0x2000 | 3,
407 FailureCode::IncorrectOrUnknownPaymentDetails => 0x4000 | 15,
408 FailureCode::InvalidOnionPayload(_) => 0x4000 | 22,
413 /// Error type returned across the peer_state mutex boundary. When an Err is generated for a
414 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
415 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
416 /// peer_state lock. We then return the set of things that need to be done outside the lock in
417 /// this struct and call handle_error!() on it.
419 struct MsgHandleErrInternal {
420 err: msgs::LightningError,
421 chan_id: Option<(ChannelId, u128)>, // If Some a channel of ours has been closed
422 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
423 channel_capacity: Option<u64>,
425 impl MsgHandleErrInternal {
427 fn send_err_msg_no_close(err: String, channel_id: ChannelId) -> Self {
429 err: LightningError {
431 action: msgs::ErrorAction::SendErrorMessage {
432 msg: msgs::ErrorMessage {
439 shutdown_finish: None,
440 channel_capacity: None,
444 fn from_no_close(err: msgs::LightningError) -> Self {
445 Self { err, chan_id: None, shutdown_finish: None, channel_capacity: None }
448 fn from_finish_shutdown(err: String, channel_id: ChannelId, user_channel_id: u128, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>, channel_capacity: u64) -> Self {
450 err: LightningError {
452 action: msgs::ErrorAction::SendErrorMessage {
453 msg: msgs::ErrorMessage {
459 chan_id: Some((channel_id, user_channel_id)),
460 shutdown_finish: Some((shutdown_res, channel_update)),
461 channel_capacity: Some(channel_capacity)
465 fn from_chan_no_close(err: ChannelError, channel_id: ChannelId) -> Self {
468 ChannelError::Warn(msg) => LightningError {
470 action: msgs::ErrorAction::SendWarningMessage {
471 msg: msgs::WarningMessage {
475 log_level: Level::Warn,
478 ChannelError::Ignore(msg) => LightningError {
480 action: msgs::ErrorAction::IgnoreError,
482 ChannelError::Close(msg) => LightningError {
484 action: msgs::ErrorAction::SendErrorMessage {
485 msg: msgs::ErrorMessage {
493 shutdown_finish: None,
494 channel_capacity: None,
499 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
500 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
501 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
502 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
503 pub(super) const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
505 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
506 /// be sent in the order they appear in the return value, however sometimes the order needs to be
507 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
508 /// they were originally sent). In those cases, this enum is also returned.
509 #[derive(Clone, PartialEq)]
510 pub(super) enum RAACommitmentOrder {
511 /// Send the CommitmentUpdate messages first
513 /// Send the RevokeAndACK message first
517 /// Information about a payment which is currently being claimed.
518 struct ClaimingPayment {
520 payment_purpose: events::PaymentPurpose,
521 receiver_node_id: PublicKey,
522 htlcs: Vec<events::ClaimedHTLC>,
523 sender_intended_value: Option<u64>,
525 impl_writeable_tlv_based!(ClaimingPayment, {
526 (0, amount_msat, required),
527 (2, payment_purpose, required),
528 (4, receiver_node_id, required),
529 (5, htlcs, optional_vec),
530 (7, sender_intended_value, option),
533 struct ClaimablePayment {
534 purpose: events::PaymentPurpose,
535 onion_fields: Option<RecipientOnionFields>,
536 htlcs: Vec<ClaimableHTLC>,
539 /// Information about claimable or being-claimed payments
540 struct ClaimablePayments {
541 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
542 /// failed/claimed by the user.
544 /// Note that, no consistency guarantees are made about the channels given here actually
545 /// existing anymore by the time you go to read them!
547 /// When adding to the map, [`Self::pending_claiming_payments`] must also be checked to ensure
548 /// we don't get a duplicate payment.
549 claimable_payments: HashMap<PaymentHash, ClaimablePayment>,
551 /// Map from payment hash to the payment data for HTLCs which we have begun claiming, but which
552 /// are waiting on a [`ChannelMonitorUpdate`] to complete in order to be surfaced to the user
553 /// as an [`events::Event::PaymentClaimed`].
554 pending_claiming_payments: HashMap<PaymentHash, ClaimingPayment>,
557 /// Events which we process internally but cannot be processed immediately at the generation site
558 /// usually because we're running pre-full-init. They are handled immediately once we detect we are
559 /// running normally, and specifically must be processed before any other non-background
560 /// [`ChannelMonitorUpdate`]s are applied.
561 enum BackgroundEvent {
562 /// Handle a ChannelMonitorUpdate which closes the channel or for an already-closed channel.
563 /// This is only separated from [`Self::MonitorUpdateRegeneratedOnStartup`] as the
564 /// maybe-non-closing variant needs a public key to handle channel resumption, whereas if the
565 /// channel has been force-closed we do not need the counterparty node_id.
567 /// Note that any such events are lost on shutdown, so in general they must be updates which
568 /// are regenerated on startup.
569 ClosedMonitorUpdateRegeneratedOnStartup((OutPoint, ChannelMonitorUpdate)),
570 /// Handle a ChannelMonitorUpdate which may or may not close the channel and may unblock the
571 /// channel to continue normal operation.
573 /// In general this should be used rather than
574 /// [`Self::ClosedMonitorUpdateRegeneratedOnStartup`], however in cases where the
575 /// `counterparty_node_id` is not available as the channel has closed from a [`ChannelMonitor`]
576 /// error the other variant is acceptable.
578 /// Note that any such events are lost on shutdown, so in general they must be updates which
579 /// are regenerated on startup.
580 MonitorUpdateRegeneratedOnStartup {
581 counterparty_node_id: PublicKey,
582 funding_txo: OutPoint,
583 update: ChannelMonitorUpdate
585 /// Some [`ChannelMonitorUpdate`] (s) completed before we were serialized but we still have
586 /// them marked pending, thus we need to run any [`MonitorUpdateCompletionAction`] (s) pending
588 MonitorUpdatesComplete {
589 counterparty_node_id: PublicKey,
590 channel_id: ChannelId,
595 pub(crate) enum MonitorUpdateCompletionAction {
596 /// Indicates that a payment ultimately destined for us was claimed and we should emit an
597 /// [`events::Event::PaymentClaimed`] to the user if we haven't yet generated such an event for
598 /// this payment. Note that this is only best-effort. On restart it's possible such a duplicate
599 /// event can be generated.
600 PaymentClaimed { payment_hash: PaymentHash },
601 /// Indicates an [`events::Event`] should be surfaced to the user and possibly resume the
602 /// operation of another channel.
604 /// This is usually generated when we've forwarded an HTLC and want to block the outbound edge
605 /// from completing a monitor update which removes the payment preimage until the inbound edge
606 /// completes a monitor update containing the payment preimage. In that case, after the inbound
607 /// edge completes, we will surface an [`Event::PaymentForwarded`] as well as unblock the
609 EmitEventAndFreeOtherChannel {
610 event: events::Event,
611 downstream_counterparty_and_funding_outpoint: Option<(PublicKey, OutPoint, RAAMonitorUpdateBlockingAction)>,
615 impl_writeable_tlv_based_enum_upgradable!(MonitorUpdateCompletionAction,
616 (0, PaymentClaimed) => { (0, payment_hash, required) },
617 (2, EmitEventAndFreeOtherChannel) => {
618 (0, event, upgradable_required),
619 // LDK prior to 0.0.116 did not have this field as the monitor update application order was
620 // required by clients. If we downgrade to something prior to 0.0.116 this may result in
621 // monitor updates which aren't properly blocked or resumed, however that's fine - we don't
622 // support async monitor updates even in LDK 0.0.116 and once we do we'll require no
623 // downgrades to prior versions.
624 (1, downstream_counterparty_and_funding_outpoint, option),
628 #[derive(Clone, Debug, PartialEq, Eq)]
629 pub(crate) enum EventCompletionAction {
630 ReleaseRAAChannelMonitorUpdate {
631 counterparty_node_id: PublicKey,
632 channel_funding_outpoint: OutPoint,
635 impl_writeable_tlv_based_enum!(EventCompletionAction,
636 (0, ReleaseRAAChannelMonitorUpdate) => {
637 (0, channel_funding_outpoint, required),
638 (2, counterparty_node_id, required),
642 #[derive(Clone, PartialEq, Eq, Debug)]
643 /// If something is blocked on the completion of an RAA-generated [`ChannelMonitorUpdate`] we track
644 /// the blocked action here. See enum variants for more info.
645 pub(crate) enum RAAMonitorUpdateBlockingAction {
646 /// A forwarded payment was claimed. We block the downstream channel completing its monitor
647 /// update which removes the HTLC preimage until the upstream channel has gotten the preimage
649 ForwardedPaymentInboundClaim {
650 /// The upstream channel ID (i.e. the inbound edge).
651 channel_id: ChannelId,
652 /// The HTLC ID on the inbound edge.
657 impl RAAMonitorUpdateBlockingAction {
659 fn from_prev_hop_data(prev_hop: &HTLCPreviousHopData) -> Self {
660 Self::ForwardedPaymentInboundClaim {
661 channel_id: prev_hop.outpoint.to_channel_id(),
662 htlc_id: prev_hop.htlc_id,
667 impl_writeable_tlv_based_enum!(RAAMonitorUpdateBlockingAction,
668 (0, ForwardedPaymentInboundClaim) => { (0, channel_id, required), (2, htlc_id, required) }
672 /// State we hold per-peer.
673 pub(super) struct PeerState<SP: Deref> where SP::Target: SignerProvider {
674 /// `channel_id` -> `ChannelPhase`
676 /// Holds all channels within corresponding `ChannelPhase`s where the peer is the counterparty.
677 pub(super) channel_by_id: HashMap<ChannelId, ChannelPhase<SP>>,
678 /// `temporary_channel_id` -> `InboundChannelRequest`.
680 /// When manual channel acceptance is enabled, this holds all unaccepted inbound channels where
681 /// the peer is the counterparty. If the channel is accepted, then the entry in this table is
682 /// removed, and an InboundV1Channel is created and placed in the `inbound_v1_channel_by_id` table. If
683 /// the channel is rejected, then the entry is simply removed.
684 pub(super) inbound_channel_request_by_id: HashMap<ChannelId, InboundChannelRequest>,
685 /// The latest `InitFeatures` we heard from the peer.
686 latest_features: InitFeatures,
687 /// Messages to send to the peer - pushed to in the same lock that they are generated in (except
688 /// for broadcast messages, where ordering isn't as strict).
689 pub(super) pending_msg_events: Vec<MessageSendEvent>,
690 /// Map from Channel IDs to pending [`ChannelMonitorUpdate`]s which have been passed to the
691 /// user but which have not yet completed.
693 /// Note that the channel may no longer exist. For example if the channel was closed but we
694 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
695 /// for a missing channel.
696 in_flight_monitor_updates: BTreeMap<OutPoint, Vec<ChannelMonitorUpdate>>,
697 /// Map from a specific channel to some action(s) that should be taken when all pending
698 /// [`ChannelMonitorUpdate`]s for the channel complete updating.
700 /// Note that because we generally only have one entry here a HashMap is pretty overkill. A
701 /// BTreeMap currently stores more than ten elements per leaf node, so even up to a few
702 /// channels with a peer this will just be one allocation and will amount to a linear list of
703 /// channels to walk, avoiding the whole hashing rigmarole.
705 /// Note that the channel may no longer exist. For example, if a channel was closed but we
706 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
707 /// for a missing channel. While a malicious peer could construct a second channel with the
708 /// same `temporary_channel_id` (or final `channel_id` in the case of 0conf channels or prior
709 /// to funding appearing on-chain), the downstream `ChannelMonitor` set is required to ensure
710 /// duplicates do not occur, so such channels should fail without a monitor update completing.
711 monitor_update_blocked_actions: BTreeMap<ChannelId, Vec<MonitorUpdateCompletionAction>>,
712 /// If another channel's [`ChannelMonitorUpdate`] needs to complete before a channel we have
713 /// with this peer can complete an RAA [`ChannelMonitorUpdate`] (e.g. because the RAA update
714 /// will remove a preimage that needs to be durably in an upstream channel first), we put an
715 /// entry here to note that the channel with the key's ID is blocked on a set of actions.
716 actions_blocking_raa_monitor_updates: BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
717 /// The peer is currently connected (i.e. we've seen a
718 /// [`ChannelMessageHandler::peer_connected`] and no corresponding
719 /// [`ChannelMessageHandler::peer_disconnected`].
723 impl <SP: Deref> PeerState<SP> where SP::Target: SignerProvider {
724 /// Indicates that a peer meets the criteria where we're ok to remove it from our storage.
725 /// If true is passed for `require_disconnected`, the function will return false if we haven't
726 /// disconnected from the node already, ie. `PeerState::is_connected` is set to `true`.
727 fn ok_to_remove(&self, require_disconnected: bool) -> bool {
728 if require_disconnected && self.is_connected {
731 self.channel_by_id.iter().filter(|(_, phase)| matches!(phase, ChannelPhase::Funded(_))).count() == 0
732 && self.monitor_update_blocked_actions.is_empty()
733 && self.in_flight_monitor_updates.is_empty()
736 // Returns a count of all channels we have with this peer, including unfunded channels.
737 fn total_channel_count(&self) -> usize {
738 self.channel_by_id.len() + self.inbound_channel_request_by_id.len()
741 // Returns a bool indicating if the given `channel_id` matches a channel we have with this peer.
742 fn has_channel(&self, channel_id: &ChannelId) -> bool {
743 self.channel_by_id.contains_key(channel_id) ||
744 self.inbound_channel_request_by_id.contains_key(channel_id)
748 /// A not-yet-accepted inbound (from counterparty) channel. Once
749 /// accepted, the parameters will be used to construct a channel.
750 pub(super) struct InboundChannelRequest {
751 /// The original OpenChannel message.
752 pub open_channel_msg: msgs::OpenChannel,
753 /// The number of ticks remaining before the request expires.
754 pub ticks_remaining: i32,
757 /// The number of ticks that may elapse while we're waiting for an unaccepted inbound channel to be
758 /// accepted. An unaccepted channel that exceeds this limit will be abandoned.
759 const UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS: i32 = 2;
761 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
762 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
764 /// For users who don't want to bother doing their own payment preimage storage, we also store that
767 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
768 /// and instead encoding it in the payment secret.
769 struct PendingInboundPayment {
770 /// The payment secret that the sender must use for us to accept this payment
771 payment_secret: PaymentSecret,
772 /// Time at which this HTLC expires - blocks with a header time above this value will result in
773 /// this payment being removed.
775 /// Arbitrary identifier the user specifies (or not)
776 user_payment_id: u64,
777 // Other required attributes of the payment, optionally enforced:
778 payment_preimage: Option<PaymentPreimage>,
779 min_value_msat: Option<u64>,
782 /// [`SimpleArcChannelManager`] is useful when you need a [`ChannelManager`] with a static lifetime, e.g.
783 /// when you're using `lightning-net-tokio` (since `tokio::spawn` requires parameters with static
784 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
785 /// [`SimpleRefChannelManager`] is the more appropriate type. Defining these type aliases prevents
786 /// issues such as overly long function definitions. Note that the `ChannelManager` can take any type
787 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
788 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
789 /// of [`KeysManager`] and [`DefaultRouter`].
791 /// This is not exported to bindings users as Arcs don't make sense in bindings
792 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
800 Arc<NetworkGraph<Arc<L>>>,
802 Arc<Mutex<ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>>,
803 ProbabilisticScoringFeeParameters,
804 ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>,
809 /// [`SimpleRefChannelManager`] is a type alias for a ChannelManager reference, and is the reference
810 /// counterpart to the [`SimpleArcChannelManager`] type alias. Use this type by default when you don't
811 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
812 /// usage of lightning-net-tokio (since `tokio::spawn` requires parameters with static lifetimes).
813 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
814 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
815 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
816 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
817 /// of [`KeysManager`] and [`DefaultRouter`].
819 /// This is not exported to bindings users as Arcs don't make sense in bindings
820 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> =
829 &'f NetworkGraph<&'g L>,
831 &'h Mutex<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>,
832 ProbabilisticScoringFeeParameters,
833 ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>
838 macro_rules! define_test_pub_trait { ($vis: vis) => {
839 /// A trivial trait which describes any [`ChannelManager`] used in testing.
840 $vis trait AChannelManager {
841 type Watch: chain::Watch<Self::Signer> + ?Sized;
842 type M: Deref<Target = Self::Watch>;
843 type Broadcaster: BroadcasterInterface + ?Sized;
844 type T: Deref<Target = Self::Broadcaster>;
845 type EntropySource: EntropySource + ?Sized;
846 type ES: Deref<Target = Self::EntropySource>;
847 type NodeSigner: NodeSigner + ?Sized;
848 type NS: Deref<Target = Self::NodeSigner>;
849 type Signer: WriteableEcdsaChannelSigner + Sized;
850 type SignerProvider: SignerProvider<Signer = Self::Signer> + ?Sized;
851 type SP: Deref<Target = Self::SignerProvider>;
852 type FeeEstimator: FeeEstimator + ?Sized;
853 type F: Deref<Target = Self::FeeEstimator>;
854 type Router: Router + ?Sized;
855 type R: Deref<Target = Self::Router>;
856 type Logger: Logger + ?Sized;
857 type L: Deref<Target = Self::Logger>;
858 fn get_cm(&self) -> &ChannelManager<Self::M, Self::T, Self::ES, Self::NS, Self::SP, Self::F, Self::R, Self::L>;
861 #[cfg(any(test, feature = "_test_utils"))]
862 define_test_pub_trait!(pub);
863 #[cfg(not(any(test, feature = "_test_utils")))]
864 define_test_pub_trait!(pub(crate));
865 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> AChannelManager
866 for ChannelManager<M, T, ES, NS, SP, F, R, L>
868 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
869 T::Target: BroadcasterInterface,
870 ES::Target: EntropySource,
871 NS::Target: NodeSigner,
872 SP::Target: SignerProvider,
873 F::Target: FeeEstimator,
877 type Watch = M::Target;
879 type Broadcaster = T::Target;
881 type EntropySource = ES::Target;
883 type NodeSigner = NS::Target;
885 type Signer = <SP::Target as SignerProvider>::Signer;
886 type SignerProvider = SP::Target;
888 type FeeEstimator = F::Target;
890 type Router = R::Target;
892 type Logger = L::Target;
894 fn get_cm(&self) -> &ChannelManager<M, T, ES, NS, SP, F, R, L> { self }
897 /// Manager which keeps track of a number of channels and sends messages to the appropriate
898 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
900 /// Implements [`ChannelMessageHandler`], handling the multi-channel parts and passing things through
901 /// to individual Channels.
903 /// Implements [`Writeable`] to write out all channel state to disk. Implies [`peer_disconnected`] for
904 /// all peers during write/read (though does not modify this instance, only the instance being
905 /// serialized). This will result in any channels which have not yet exchanged [`funding_created`] (i.e.,
906 /// called [`funding_transaction_generated`] for outbound channels) being closed.
908 /// Note that you can be a bit lazier about writing out `ChannelManager` than you can be with
909 /// [`ChannelMonitor`]. With [`ChannelMonitor`] you MUST write each monitor update out to disk before
910 /// returning from [`chain::Watch::watch_channel`]/[`update_channel`], with ChannelManagers, writing updates
911 /// happens out-of-band (and will prevent any other `ChannelManager` operations from occurring during
912 /// the serialization process). If the deserialized version is out-of-date compared to the
913 /// [`ChannelMonitor`] passed by reference to [`read`], those channels will be force-closed based on the
914 /// `ChannelMonitor` state and no funds will be lost (mod on-chain transaction fees).
916 /// Note that the deserializer is only implemented for `(`[`BlockHash`]`, `[`ChannelManager`]`)`, which
917 /// tells you the last block hash which was connected. You should get the best block tip before using the manager.
918 /// See [`chain::Listen`] and [`chain::Confirm`] for more details.
920 /// Note that `ChannelManager` is responsible for tracking liveness of its channels and generating
921 /// [`ChannelUpdate`] messages informing peers that the channel is temporarily disabled. To avoid
922 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
923 /// offline for a full minute. In order to track this, you must call
924 /// [`timer_tick_occurred`] roughly once per minute, though it doesn't have to be perfect.
926 /// To avoid trivial DoS issues, `ChannelManager` limits the number of inbound connections and
927 /// inbound channels without confirmed funding transactions. This may result in nodes which we do
928 /// not have a channel with being unable to connect to us or open new channels with us if we have
929 /// many peers with unfunded channels.
931 /// Because it is an indication of trust, inbound channels which we've accepted as 0conf are
932 /// exempted from the count of unfunded channels. Similarly, outbound channels and connections are
933 /// never limited. Please ensure you limit the count of such channels yourself.
935 /// Rather than using a plain `ChannelManager`, it is preferable to use either a [`SimpleArcChannelManager`]
936 /// a [`SimpleRefChannelManager`], for conciseness. See their documentation for more details, but
937 /// essentially you should default to using a [`SimpleRefChannelManager`], and use a
938 /// [`SimpleArcChannelManager`] when you require a `ChannelManager` with a static lifetime, such as when
939 /// you're using lightning-net-tokio.
941 /// [`peer_disconnected`]: msgs::ChannelMessageHandler::peer_disconnected
942 /// [`funding_created`]: msgs::FundingCreated
943 /// [`funding_transaction_generated`]: Self::funding_transaction_generated
944 /// [`BlockHash`]: bitcoin::hash_types::BlockHash
945 /// [`update_channel`]: chain::Watch::update_channel
946 /// [`ChannelUpdate`]: msgs::ChannelUpdate
947 /// [`timer_tick_occurred`]: Self::timer_tick_occurred
948 /// [`read`]: ReadableArgs::read
951 // The tree structure below illustrates the lock order requirements for the different locks of the
952 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
953 // and should then be taken in the order of the lowest to the highest level in the tree.
954 // Note that locks on different branches shall not be taken at the same time, as doing so will
955 // create a new lock order for those specific locks in the order they were taken.
959 // `total_consistency_lock`
961 // |__`forward_htlcs`
963 // | |__`pending_intercepted_htlcs`
965 // |__`per_peer_state`
967 // | |__`pending_inbound_payments`
969 // | |__`claimable_payments`
971 // | |__`pending_outbound_payments` // This field's struct contains a map of pending outbounds
977 // | |__`short_to_chan_info`
979 // | |__`outbound_scid_aliases`
983 // | |__`pending_events`
985 // | |__`pending_background_events`
987 pub struct ChannelManager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
989 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
990 T::Target: BroadcasterInterface,
991 ES::Target: EntropySource,
992 NS::Target: NodeSigner,
993 SP::Target: SignerProvider,
994 F::Target: FeeEstimator,
998 default_configuration: UserConfig,
999 genesis_hash: BlockHash,
1000 fee_estimator: LowerBoundedFeeEstimator<F>,
1006 /// See `ChannelManager` struct-level documentation for lock order requirements.
1008 pub(super) best_block: RwLock<BestBlock>,
1010 best_block: RwLock<BestBlock>,
1011 secp_ctx: Secp256k1<secp256k1::All>,
1013 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
1014 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
1015 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
1016 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
1018 /// See `ChannelManager` struct-level documentation for lock order requirements.
1019 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
1021 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
1022 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
1023 /// (if the channel has been force-closed), however we track them here to prevent duplicative
1024 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
1025 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
1026 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
1027 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
1028 /// after reloading from disk while replaying blocks against ChannelMonitors.
1030 /// See `PendingOutboundPayment` documentation for more info.
1032 /// See `ChannelManager` struct-level documentation for lock order requirements.
1033 pending_outbound_payments: OutboundPayments,
1035 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
1037 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
1038 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
1039 /// and via the classic SCID.
1041 /// Note that no consistency guarantees are made about the existence of a channel with the
1042 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
1044 /// See `ChannelManager` struct-level documentation for lock order requirements.
1046 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1048 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1049 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
1050 /// until the user tells us what we should do with them.
1052 /// See `ChannelManager` struct-level documentation for lock order requirements.
1053 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
1055 /// The sets of payments which are claimable or currently being claimed. See
1056 /// [`ClaimablePayments`]' individual field docs for more info.
1058 /// See `ChannelManager` struct-level documentation for lock order requirements.
1059 claimable_payments: Mutex<ClaimablePayments>,
1061 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
1062 /// and some closed channels which reached a usable state prior to being closed. This is used
1063 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
1064 /// active channel list on load.
1066 /// See `ChannelManager` struct-level documentation for lock order requirements.
1067 outbound_scid_aliases: Mutex<HashSet<u64>>,
1069 /// `channel_id` -> `counterparty_node_id`.
1071 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
1072 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
1073 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
1075 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
1076 /// the corresponding channel for the event, as we only have access to the `channel_id` during
1077 /// the handling of the events.
1079 /// Note that no consistency guarantees are made about the existence of a peer with the
1080 /// `counterparty_node_id` in our other maps.
1083 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
1084 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
1085 /// would break backwards compatability.
1086 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
1087 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
1088 /// required to access the channel with the `counterparty_node_id`.
1090 /// See `ChannelManager` struct-level documentation for lock order requirements.
1091 id_to_peer: Mutex<HashMap<ChannelId, PublicKey>>,
1093 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
1095 /// Outbound SCID aliases are added here once the channel is available for normal use, with
1096 /// SCIDs being added once the funding transaction is confirmed at the channel's required
1097 /// confirmation depth.
1099 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
1100 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
1101 /// channel with the `channel_id` in our other maps.
1103 /// See `ChannelManager` struct-level documentation for lock order requirements.
1105 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1107 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1109 our_network_pubkey: PublicKey,
1111 inbound_payment_key: inbound_payment::ExpandedKey,
1113 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
1114 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
1115 /// we encrypt the namespace identifier using these bytes.
1117 /// [fake scids]: crate::util::scid_utils::fake_scid
1118 fake_scid_rand_bytes: [u8; 32],
1120 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
1121 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
1122 /// keeping additional state.
1123 probing_cookie_secret: [u8; 32],
1125 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
1126 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
1127 /// very far in the past, and can only ever be up to two hours in the future.
1128 highest_seen_timestamp: AtomicUsize,
1130 /// The bulk of our storage. Currently the `per_peer_state` stores our channels on a per-peer
1131 /// basis, as well as the peer's latest features.
1133 /// If we are connected to a peer we always at least have an entry here, even if no channels
1134 /// are currently open with that peer.
1136 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
1137 /// operate on the inner value freely. This opens up for parallel per-peer operation for
1140 /// Note that the same thread must never acquire two inner `PeerState` locks at the same time.
1142 /// See `ChannelManager` struct-level documentation for lock order requirements.
1143 #[cfg(not(any(test, feature = "_test_utils")))]
1144 per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1145 #[cfg(any(test, feature = "_test_utils"))]
1146 pub(super) per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1148 /// The set of events which we need to give to the user to handle. In some cases an event may
1149 /// require some further action after the user handles it (currently only blocking a monitor
1150 /// update from being handed to the user to ensure the included changes to the channel state
1151 /// are handled by the user before they're persisted durably to disk). In that case, the second
1152 /// element in the tuple is set to `Some` with further details of the action.
1154 /// Note that events MUST NOT be removed from pending_events after deserialization, as they
1155 /// could be in the middle of being processed without the direct mutex held.
1157 /// See `ChannelManager` struct-level documentation for lock order requirements.
1158 #[cfg(not(any(test, feature = "_test_utils")))]
1159 pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1160 #[cfg(any(test, feature = "_test_utils"))]
1161 pub(crate) pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1163 /// A simple atomic flag to ensure only one task at a time can be processing events asynchronously.
1164 pending_events_processor: AtomicBool,
1166 /// If we are running during init (either directly during the deserialization method or in
1167 /// block connection methods which run after deserialization but before normal operation) we
1168 /// cannot provide the user with [`ChannelMonitorUpdate`]s through the normal update flow -
1169 /// prior to normal operation the user may not have loaded the [`ChannelMonitor`]s into their
1170 /// [`ChainMonitor`] and thus attempting to update it will fail or panic.
1172 /// Thus, we place them here to be handled as soon as possible once we are running normally.
1174 /// See `ChannelManager` struct-level documentation for lock order requirements.
1176 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
1177 pending_background_events: Mutex<Vec<BackgroundEvent>>,
1178 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
1179 /// Essentially just when we're serializing ourselves out.
1180 /// Taken first everywhere where we are making changes before any other locks.
1181 /// When acquiring this lock in read mode, rather than acquiring it directly, call
1182 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
1183 /// Notifier the lock contains sends out a notification when the lock is released.
1184 total_consistency_lock: RwLock<()>,
1186 background_events_processed_since_startup: AtomicBool,
1188 event_persist_notifier: Notifier,
1189 needs_persist_flag: AtomicBool,
1193 signer_provider: SP,
1198 /// Chain-related parameters used to construct a new `ChannelManager`.
1200 /// Typically, the block-specific parameters are derived from the best block hash for the network,
1201 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
1202 /// are not needed when deserializing a previously constructed `ChannelManager`.
1203 #[derive(Clone, Copy, PartialEq)]
1204 pub struct ChainParameters {
1205 /// The network for determining the `chain_hash` in Lightning messages.
1206 pub network: Network,
1208 /// The hash and height of the latest block successfully connected.
1210 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
1211 pub best_block: BestBlock,
1214 #[derive(Copy, Clone, PartialEq)]
1221 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
1222 /// desirable to notify any listeners on `await_persistable_update_timeout`/
1223 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
1224 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
1225 /// sending the aforementioned notification (since the lock being released indicates that the
1226 /// updates are ready for persistence).
1228 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
1229 /// notify or not based on whether relevant changes have been made, providing a closure to
1230 /// `optionally_notify` which returns a `NotifyOption`.
1231 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
1232 event_persist_notifier: &'a Notifier,
1233 needs_persist_flag: &'a AtomicBool,
1235 // We hold onto this result so the lock doesn't get released immediately.
1236 _read_guard: RwLockReadGuard<'a, ()>,
1239 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
1240 fn notify_on_drop<C: AChannelManager>(cm: &'a C) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
1241 Self::optionally_notify(cm, || -> NotifyOption { NotifyOption::DoPersist })
1244 fn optionally_notify<F: Fn() -> NotifyOption, C: AChannelManager>(cm: &'a C, persist_check: F)
1245 -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
1246 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1247 let force_notify = cm.get_cm().process_background_events();
1249 PersistenceNotifierGuard {
1250 event_persist_notifier: &cm.get_cm().event_persist_notifier,
1251 needs_persist_flag: &cm.get_cm().needs_persist_flag,
1252 should_persist: move || {
1253 // Pick the "most" action between `persist_check` and the background events
1254 // processing and return that.
1255 let notify = persist_check();
1256 if force_notify == NotifyOption::DoPersist { NotifyOption::DoPersist }
1259 _read_guard: read_guard,
1263 /// Note that if any [`ChannelMonitorUpdate`]s are possibly generated,
1264 /// [`ChannelManager::process_background_events`] MUST be called first (or
1265 /// [`Self::optionally_notify`] used).
1266 fn optionally_notify_skipping_background_events<F: Fn() -> NotifyOption, C: AChannelManager>
1267 (cm: &'a C, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
1268 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1270 PersistenceNotifierGuard {
1271 event_persist_notifier: &cm.get_cm().event_persist_notifier,
1272 needs_persist_flag: &cm.get_cm().needs_persist_flag,
1273 should_persist: persist_check,
1274 _read_guard: read_guard,
1279 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
1280 fn drop(&mut self) {
1281 if (self.should_persist)() == NotifyOption::DoPersist {
1282 self.needs_persist_flag.store(true, Ordering::Release);
1283 self.event_persist_notifier.notify();
1288 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
1289 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
1291 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
1293 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
1294 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
1295 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
1296 /// the maximum required amount in lnd as of March 2021.
1297 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
1299 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
1300 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
1302 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
1304 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
1305 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
1306 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
1307 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
1308 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
1309 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
1310 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
1311 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
1312 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
1313 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
1314 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
1315 // routing failure for any HTLC sender picking up an LDK node among the first hops.
1316 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
1318 /// Minimum CLTV difference between the current block height and received inbound payments.
1319 /// Invoices generated for payment to us must set their `min_final_cltv_expiry_delta` field to at least
1321 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
1322 // any payments to succeed. Further, we don't want payments to fail if a block was found while
1323 // a payment was being routed, so we add an extra block to be safe.
1324 pub const MIN_FINAL_CLTV_EXPIRY_DELTA: u16 = HTLC_FAIL_BACK_BUFFER as u16 + 3;
1326 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
1327 // ie that if the next-hop peer fails the HTLC within
1328 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
1329 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
1330 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
1331 // LATENCY_GRACE_PERIOD_BLOCKS.
1334 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;
1336 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
1337 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
1340 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
1342 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
1343 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
1345 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is disconnected
1346 /// until we mark the channel disabled and gossip the update.
1347 pub(crate) const DISABLE_GOSSIP_TICKS: u8 = 10;
1349 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is connected until
1350 /// we mark the channel enabled and gossip the update.
1351 pub(crate) const ENABLE_GOSSIP_TICKS: u8 = 5;
1353 /// The maximum number of unfunded channels we can have per-peer before we start rejecting new
1354 /// (inbound) ones. The number of peers with unfunded channels is limited separately in
1355 /// [`MAX_UNFUNDED_CHANNEL_PEERS`].
1356 const MAX_UNFUNDED_CHANS_PER_PEER: usize = 4;
1358 /// The maximum number of peers from which we will allow pending unfunded channels. Once we reach
1359 /// this many peers we reject new (inbound) channels from peers with which we don't have a channel.
1360 const MAX_UNFUNDED_CHANNEL_PEERS: usize = 50;
1362 /// The maximum number of peers which we do not have a (funded) channel with. Once we reach this
1363 /// many peers we reject new (inbound) connections.
1364 const MAX_NO_CHANNEL_PEERS: usize = 250;
1366 /// Information needed for constructing an invoice route hint for this channel.
1367 #[derive(Clone, Debug, PartialEq)]
1368 pub struct CounterpartyForwardingInfo {
1369 /// Base routing fee in millisatoshis.
1370 pub fee_base_msat: u32,
1371 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
1372 pub fee_proportional_millionths: u32,
1373 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
1374 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
1375 /// `cltv_expiry_delta` for more details.
1376 pub cltv_expiry_delta: u16,
1379 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
1380 /// to better separate parameters.
1381 #[derive(Clone, Debug, PartialEq)]
1382 pub struct ChannelCounterparty {
1383 /// The node_id of our counterparty
1384 pub node_id: PublicKey,
1385 /// The Features the channel counterparty provided upon last connection.
1386 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
1387 /// many routing-relevant features are present in the init context.
1388 pub features: InitFeatures,
1389 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
1390 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
1391 /// claiming at least this value on chain.
1393 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
1395 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
1396 pub unspendable_punishment_reserve: u64,
1397 /// Information on the fees and requirements that the counterparty requires when forwarding
1398 /// payments to us through this channel.
1399 pub forwarding_info: Option<CounterpartyForwardingInfo>,
1400 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
1401 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
1402 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
1403 pub outbound_htlc_minimum_msat: Option<u64>,
1404 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
1405 pub outbound_htlc_maximum_msat: Option<u64>,
1408 /// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
1410 /// Balances of a channel are available through [`ChainMonitor::get_claimable_balances`] and
1411 /// [`ChannelMonitor::get_claimable_balances`], calculated with respect to the corresponding on-chain
1414 /// [`ChainMonitor::get_claimable_balances`]: crate::chain::chainmonitor::ChainMonitor::get_claimable_balances
1415 #[derive(Clone, Debug, PartialEq)]
1416 pub struct ChannelDetails {
1417 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
1418 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
1419 /// Note that this means this value is *not* persistent - it can change once during the
1420 /// lifetime of the channel.
1421 pub channel_id: ChannelId,
1422 /// Parameters which apply to our counterparty. See individual fields for more information.
1423 pub counterparty: ChannelCounterparty,
1424 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
1425 /// our counterparty already.
1427 /// Note that, if this has been set, `channel_id` will be equivalent to
1428 /// `funding_txo.unwrap().to_channel_id()`.
1429 pub funding_txo: Option<OutPoint>,
1430 /// The features which this channel operates with. See individual features for more info.
1432 /// `None` until negotiation completes and the channel type is finalized.
1433 pub channel_type: Option<ChannelTypeFeatures>,
1434 /// The position of the funding transaction in the chain. None if the funding transaction has
1435 /// not yet been confirmed and the channel fully opened.
1437 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1438 /// payments instead of this. See [`get_inbound_payment_scid`].
1440 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1441 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1443 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1444 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1445 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1446 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1447 /// [`confirmations_required`]: Self::confirmations_required
1448 pub short_channel_id: Option<u64>,
1449 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1450 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1451 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1454 /// This will be `None` as long as the channel is not available for routing outbound payments.
1456 /// [`short_channel_id`]: Self::short_channel_id
1457 /// [`confirmations_required`]: Self::confirmations_required
1458 pub outbound_scid_alias: Option<u64>,
1459 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1460 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1461 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1462 /// when they see a payment to be routed to us.
1464 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1465 /// previous values for inbound payment forwarding.
1467 /// [`short_channel_id`]: Self::short_channel_id
1468 pub inbound_scid_alias: Option<u64>,
1469 /// The value, in satoshis, of this channel as appears in the funding output
1470 pub channel_value_satoshis: u64,
1471 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1472 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1473 /// this value on chain.
1475 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1477 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1479 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1480 pub unspendable_punishment_reserve: Option<u64>,
1481 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
1482 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
1483 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
1484 /// `user_channel_id` will be randomized for an inbound channel. This may be zero for objects
1485 /// serialized with LDK versions prior to 0.0.113.
1487 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
1488 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
1489 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
1490 pub user_channel_id: u128,
1491 /// The currently negotiated fee rate denominated in satoshi per 1000 weight units,
1492 /// which is applied to commitment and HTLC transactions.
1494 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
1495 pub feerate_sat_per_1000_weight: Option<u32>,
1496 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1497 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1498 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1499 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1501 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1502 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1503 /// should be able to spend nearly this amount.
1504 pub outbound_capacity_msat: u64,
1505 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1506 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1507 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1508 /// to use a limit as close as possible to the HTLC limit we can currently send.
1510 /// See also [`ChannelDetails::next_outbound_htlc_minimum_msat`] and
1511 /// [`ChannelDetails::outbound_capacity_msat`].
1512 pub next_outbound_htlc_limit_msat: u64,
1513 /// The minimum value for sending a single HTLC to the remote peer. This is the equivalent of
1514 /// [`ChannelDetails::next_outbound_htlc_limit_msat`] but represents a lower-bound, rather than
1515 /// an upper-bound. This is intended for use when routing, allowing us to ensure we pick a
1516 /// route which is valid.
1517 pub next_outbound_htlc_minimum_msat: u64,
1518 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1519 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1520 /// available for inclusion in new inbound HTLCs).
1521 /// Note that there are some corner cases not fully handled here, so the actual available
1522 /// inbound capacity may be slightly higher than this.
1524 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1525 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1526 /// However, our counterparty should be able to spend nearly this amount.
1527 pub inbound_capacity_msat: u64,
1528 /// The number of required confirmations on the funding transaction before the funding will be
1529 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1530 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1531 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1532 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1534 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1536 /// [`is_outbound`]: ChannelDetails::is_outbound
1537 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1538 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1539 pub confirmations_required: Option<u32>,
1540 /// The current number of confirmations on the funding transaction.
1542 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1543 pub confirmations: Option<u32>,
1544 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1545 /// until we can claim our funds after we force-close the channel. During this time our
1546 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1547 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1548 /// time to claim our non-HTLC-encumbered funds.
1550 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1551 pub force_close_spend_delay: Option<u16>,
1552 /// True if the channel was initiated (and thus funded) by us.
1553 pub is_outbound: bool,
1554 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1555 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1556 /// required confirmation count has been reached (and we were connected to the peer at some
1557 /// point after the funding transaction received enough confirmations). The required
1558 /// confirmation count is provided in [`confirmations_required`].
1560 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1561 pub is_channel_ready: bool,
1562 /// The stage of the channel's shutdown.
1563 /// `None` for `ChannelDetails` serialized on LDK versions prior to 0.0.116.
1564 pub channel_shutdown_state: Option<ChannelShutdownState>,
1565 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1566 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1568 /// This is a strict superset of `is_channel_ready`.
1569 pub is_usable: bool,
1570 /// True if this channel is (or will be) publicly-announced.
1571 pub is_public: bool,
1572 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1573 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1574 pub inbound_htlc_minimum_msat: Option<u64>,
1575 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1576 pub inbound_htlc_maximum_msat: Option<u64>,
1577 /// Set of configurable parameters that affect channel operation.
1579 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1580 pub config: Option<ChannelConfig>,
1583 impl ChannelDetails {
1584 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1585 /// This should be used for providing invoice hints or in any other context where our
1586 /// counterparty will forward a payment to us.
1588 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1589 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1590 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1591 self.inbound_scid_alias.or(self.short_channel_id)
1594 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1595 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1596 /// we're sending or forwarding a payment outbound over this channel.
1598 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1599 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1600 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1601 self.short_channel_id.or(self.outbound_scid_alias)
1604 fn from_channel_context<SP: Deref, F: Deref>(
1605 context: &ChannelContext<SP>, best_block_height: u32, latest_features: InitFeatures,
1606 fee_estimator: &LowerBoundedFeeEstimator<F>
1609 SP::Target: SignerProvider,
1610 F::Target: FeeEstimator
1612 let balance = context.get_available_balances(fee_estimator);
1613 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1614 context.get_holder_counterparty_selected_channel_reserve_satoshis();
1616 channel_id: context.channel_id(),
1617 counterparty: ChannelCounterparty {
1618 node_id: context.get_counterparty_node_id(),
1619 features: latest_features,
1620 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1621 forwarding_info: context.counterparty_forwarding_info(),
1622 // Ensures that we have actually received the `htlc_minimum_msat` value
1623 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1624 // message (as they are always the first message from the counterparty).
1625 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1626 // default `0` value set by `Channel::new_outbound`.
1627 outbound_htlc_minimum_msat: if context.have_received_message() {
1628 Some(context.get_counterparty_htlc_minimum_msat()) } else { None },
1629 outbound_htlc_maximum_msat: context.get_counterparty_htlc_maximum_msat(),
1631 funding_txo: context.get_funding_txo(),
1632 // Note that accept_channel (or open_channel) is always the first message, so
1633 // `have_received_message` indicates that type negotiation has completed.
1634 channel_type: if context.have_received_message() { Some(context.get_channel_type().clone()) } else { None },
1635 short_channel_id: context.get_short_channel_id(),
1636 outbound_scid_alias: if context.is_usable() { Some(context.outbound_scid_alias()) } else { None },
1637 inbound_scid_alias: context.latest_inbound_scid_alias(),
1638 channel_value_satoshis: context.get_value_satoshis(),
1639 feerate_sat_per_1000_weight: Some(context.get_feerate_sat_per_1000_weight()),
1640 unspendable_punishment_reserve: to_self_reserve_satoshis,
1641 inbound_capacity_msat: balance.inbound_capacity_msat,
1642 outbound_capacity_msat: balance.outbound_capacity_msat,
1643 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1644 next_outbound_htlc_minimum_msat: balance.next_outbound_htlc_minimum_msat,
1645 user_channel_id: context.get_user_id(),
1646 confirmations_required: context.minimum_depth(),
1647 confirmations: Some(context.get_funding_tx_confirmations(best_block_height)),
1648 force_close_spend_delay: context.get_counterparty_selected_contest_delay(),
1649 is_outbound: context.is_outbound(),
1650 is_channel_ready: context.is_usable(),
1651 is_usable: context.is_live(),
1652 is_public: context.should_announce(),
1653 inbound_htlc_minimum_msat: Some(context.get_holder_htlc_minimum_msat()),
1654 inbound_htlc_maximum_msat: context.get_holder_htlc_maximum_msat(),
1655 config: Some(context.config()),
1656 channel_shutdown_state: Some(context.shutdown_state()),
1661 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
1662 /// Further information on the details of the channel shutdown.
1663 /// Upon channels being forced closed (i.e. commitment transaction confirmation detected
1664 /// by `ChainMonitor`), ChannelShutdownState will be set to `ShutdownComplete` or
1665 /// the channel will be removed shortly.
1666 /// Also note, that in normal operation, peers could disconnect at any of these states
1667 /// and require peer re-connection before making progress onto other states
1668 pub enum ChannelShutdownState {
1669 /// Channel has not sent or received a shutdown message.
1671 /// Local node has sent a shutdown message for this channel.
1673 /// Shutdown message exchanges have concluded and the channels are in the midst of
1674 /// resolving all existing open HTLCs before closing can continue.
1676 /// All HTLCs have been resolved, nodes are currently negotiating channel close onchain fee rates.
1677 NegotiatingClosingFee,
1678 /// We've successfully negotiated a closing_signed dance. At this point `ChannelManager` is about
1679 /// to drop the channel.
1683 /// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
1684 /// These include payments that have yet to find a successful path, or have unresolved HTLCs.
1685 #[derive(Debug, PartialEq)]
1686 pub enum RecentPaymentDetails {
1687 /// When an invoice was requested and thus a payment has not yet been sent.
1689 /// Identifier for the payment to ensure idempotency.
1690 payment_id: PaymentId,
1692 /// When a payment is still being sent and awaiting successful delivery.
1694 /// Hash of the payment that is currently being sent but has yet to be fulfilled or
1696 payment_hash: PaymentHash,
1697 /// Total amount (in msat, excluding fees) across all paths for this payment,
1698 /// not just the amount currently inflight.
1701 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
1702 /// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
1703 /// payment is removed from tracking.
1705 /// Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
1706 /// made before LDK version 0.0.104.
1707 payment_hash: Option<PaymentHash>,
1709 /// After a payment's retries are exhausted per the provided [`Retry`], or it is explicitly
1710 /// abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
1711 /// pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
1713 /// Hash of the payment that we have given up trying to send.
1714 payment_hash: PaymentHash,
1718 /// Route hints used in constructing invoices for [phantom node payents].
1720 /// [phantom node payments]: crate::sign::PhantomKeysManager
1722 pub struct PhantomRouteHints {
1723 /// The list of channels to be included in the invoice route hints.
1724 pub channels: Vec<ChannelDetails>,
1725 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1727 pub phantom_scid: u64,
1728 /// The pubkey of the real backing node that would ultimately receive the payment.
1729 pub real_node_pubkey: PublicKey,
1732 macro_rules! handle_error {
1733 ($self: ident, $internal: expr, $counterparty_node_id: expr) => { {
1734 // In testing, ensure there are no deadlocks where the lock is already held upon
1735 // entering the macro.
1736 debug_assert_ne!($self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
1737 debug_assert_ne!($self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
1741 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish, channel_capacity }) => {
1742 let mut msg_events = Vec::with_capacity(2);
1744 if let Some((shutdown_res, update_option)) = shutdown_finish {
1745 $self.finish_force_close_channel(shutdown_res);
1746 if let Some(update) = update_option {
1747 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1751 if let Some((channel_id, user_channel_id)) = chan_id {
1752 $self.pending_events.lock().unwrap().push_back((events::Event::ChannelClosed {
1753 channel_id, user_channel_id,
1754 reason: ClosureReason::ProcessingError { err: err.err.clone() },
1755 counterparty_node_id: Some($counterparty_node_id),
1756 channel_capacity_sats: channel_capacity,
1761 log_error!($self.logger, "{}", err.err);
1762 if let msgs::ErrorAction::IgnoreError = err.action {
1764 msg_events.push(events::MessageSendEvent::HandleError {
1765 node_id: $counterparty_node_id,
1766 action: err.action.clone()
1770 if !msg_events.is_empty() {
1771 let per_peer_state = $self.per_peer_state.read().unwrap();
1772 if let Some(peer_state_mutex) = per_peer_state.get(&$counterparty_node_id) {
1773 let mut peer_state = peer_state_mutex.lock().unwrap();
1774 peer_state.pending_msg_events.append(&mut msg_events);
1778 // Return error in case higher-API need one
1783 ($self: ident, $internal: expr) => {
1786 Err((chan, msg_handle_err)) => {
1787 let counterparty_node_id = chan.get_counterparty_node_id();
1788 handle_error!($self, Err(msg_handle_err), counterparty_node_id).map_err(|err| (chan, err))
1794 macro_rules! update_maps_on_chan_removal {
1795 ($self: expr, $channel_context: expr) => {{
1796 $self.id_to_peer.lock().unwrap().remove(&$channel_context.channel_id());
1797 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1798 if let Some(short_id) = $channel_context.get_short_channel_id() {
1799 short_to_chan_info.remove(&short_id);
1801 // If the channel was never confirmed on-chain prior to its closure, remove the
1802 // outbound SCID alias we used for it from the collision-prevention set. While we
1803 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1804 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1805 // opening a million channels with us which are closed before we ever reach the funding
1807 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel_context.outbound_scid_alias());
1808 debug_assert!(alias_removed);
1810 short_to_chan_info.remove(&$channel_context.outbound_scid_alias());
1814 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1815 macro_rules! convert_chan_phase_err {
1816 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, MANUAL_CHANNEL_UPDATE, $channel_update: expr) => {
1818 ChannelError::Warn(msg) => {
1819 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), *$channel_id))
1821 ChannelError::Ignore(msg) => {
1822 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), *$channel_id))
1824 ChannelError::Close(msg) => {
1825 log_error!($self.logger, "Closing channel {} due to close-required error: {}", $channel_id, msg);
1826 update_maps_on_chan_removal!($self, $channel.context);
1827 let shutdown_res = $channel.context.force_shutdown(true);
1828 let user_id = $channel.context.get_user_id();
1829 let channel_capacity_satoshis = $channel.context.get_value_satoshis();
1831 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, user_id,
1832 shutdown_res, $channel_update, channel_capacity_satoshis))
1836 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, FUNDED_CHANNEL) => {
1837 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, { $self.get_channel_update_for_broadcast($channel).ok() })
1839 ($self: ident, $err: expr, $channel: expr, $channel_id: expr, UNFUNDED_CHANNEL) => {
1840 convert_chan_phase_err!($self, $err, $channel, $channel_id, MANUAL_CHANNEL_UPDATE, None)
1842 ($self: ident, $err: expr, $channel_phase: expr, $channel_id: expr) => {
1843 match $channel_phase {
1844 ChannelPhase::Funded(channel) => {
1845 convert_chan_phase_err!($self, $err, channel, $channel_id, FUNDED_CHANNEL)
1847 ChannelPhase::UnfundedOutboundV1(channel) => {
1848 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
1850 ChannelPhase::UnfundedInboundV1(channel) => {
1851 convert_chan_phase_err!($self, $err, channel, $channel_id, UNFUNDED_CHANNEL)
1857 macro_rules! break_chan_phase_entry {
1858 ($self: ident, $res: expr, $entry: expr) => {
1862 let key = *$entry.key();
1863 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
1865 $entry.remove_entry();
1873 macro_rules! try_chan_phase_entry {
1874 ($self: ident, $res: expr, $entry: expr) => {
1878 let key = *$entry.key();
1879 let (drop, res) = convert_chan_phase_err!($self, e, $entry.get_mut(), &key);
1881 $entry.remove_entry();
1889 macro_rules! remove_channel_phase {
1890 ($self: expr, $entry: expr) => {
1892 let channel = $entry.remove_entry().1;
1893 update_maps_on_chan_removal!($self, &channel.context());
1899 macro_rules! send_channel_ready {
1900 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
1901 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1902 node_id: $channel.context.get_counterparty_node_id(),
1903 msg: $channel_ready_msg,
1905 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1906 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1907 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1908 let outbound_alias_insert = short_to_chan_info.insert($channel.context.outbound_scid_alias(), ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
1909 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
1910 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1911 if let Some(real_scid) = $channel.context.get_short_channel_id() {
1912 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
1913 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
1914 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1919 macro_rules! emit_channel_pending_event {
1920 ($locked_events: expr, $channel: expr) => {
1921 if $channel.context.should_emit_channel_pending_event() {
1922 $locked_events.push_back((events::Event::ChannelPending {
1923 channel_id: $channel.context.channel_id(),
1924 former_temporary_channel_id: $channel.context.temporary_channel_id(),
1925 counterparty_node_id: $channel.context.get_counterparty_node_id(),
1926 user_channel_id: $channel.context.get_user_id(),
1927 funding_txo: $channel.context.get_funding_txo().unwrap().into_bitcoin_outpoint(),
1929 $channel.context.set_channel_pending_event_emitted();
1934 macro_rules! emit_channel_ready_event {
1935 ($locked_events: expr, $channel: expr) => {
1936 if $channel.context.should_emit_channel_ready_event() {
1937 debug_assert!($channel.context.channel_pending_event_emitted());
1938 $locked_events.push_back((events::Event::ChannelReady {
1939 channel_id: $channel.context.channel_id(),
1940 user_channel_id: $channel.context.get_user_id(),
1941 counterparty_node_id: $channel.context.get_counterparty_node_id(),
1942 channel_type: $channel.context.get_channel_type().clone(),
1944 $channel.context.set_channel_ready_event_emitted();
1949 macro_rules! handle_monitor_update_completion {
1950 ($self: ident, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
1951 let mut updates = $chan.monitor_updating_restored(&$self.logger,
1952 &$self.node_signer, $self.genesis_hash, &$self.default_configuration,
1953 $self.best_block.read().unwrap().height());
1954 let counterparty_node_id = $chan.context.get_counterparty_node_id();
1955 let channel_update = if updates.channel_ready.is_some() && $chan.context.is_usable() {
1956 // We only send a channel_update in the case where we are just now sending a
1957 // channel_ready and the channel is in a usable state. We may re-send a
1958 // channel_update later through the announcement_signatures process for public
1959 // channels, but there's no reason not to just inform our counterparty of our fees
1961 if let Ok(msg) = $self.get_channel_update_for_unicast($chan) {
1962 Some(events::MessageSendEvent::SendChannelUpdate {
1963 node_id: counterparty_node_id,
1969 let update_actions = $peer_state.monitor_update_blocked_actions
1970 .remove(&$chan.context.channel_id()).unwrap_or(Vec::new());
1972 let htlc_forwards = $self.handle_channel_resumption(
1973 &mut $peer_state.pending_msg_events, $chan, updates.raa,
1974 updates.commitment_update, updates.order, updates.accepted_htlcs,
1975 updates.funding_broadcastable, updates.channel_ready,
1976 updates.announcement_sigs);
1977 if let Some(upd) = channel_update {
1978 $peer_state.pending_msg_events.push(upd);
1981 let channel_id = $chan.context.channel_id();
1982 core::mem::drop($peer_state_lock);
1983 core::mem::drop($per_peer_state_lock);
1985 $self.handle_monitor_update_completion_actions(update_actions);
1987 if let Some(forwards) = htlc_forwards {
1988 $self.forward_htlcs(&mut [forwards][..]);
1990 $self.finalize_claims(updates.finalized_claimed_htlcs);
1991 for failure in updates.failed_htlcs.drain(..) {
1992 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
1993 $self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
1998 macro_rules! handle_new_monitor_update {
1999 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr, _internal, $remove: expr, $completed: expr) => { {
2000 // update_maps_on_chan_removal needs to be able to take id_to_peer, so make sure we can in
2001 // any case so that it won't deadlock.
2002 debug_assert_ne!($self.id_to_peer.held_by_thread(), LockHeldState::HeldByThread);
2003 debug_assert!($self.background_events_processed_since_startup.load(Ordering::Acquire));
2005 ChannelMonitorUpdateStatus::InProgress => {
2006 log_debug!($self.logger, "ChannelMonitor update for {} in flight, holding messages until the update completes.",
2007 &$chan.context.channel_id());
2010 ChannelMonitorUpdateStatus::PermanentFailure => {
2011 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateStatus::PermanentFailure",
2012 &$chan.context.channel_id());
2013 update_maps_on_chan_removal!($self, &$chan.context);
2014 let res = Err(MsgHandleErrInternal::from_finish_shutdown(
2015 "ChannelMonitor storage failure".to_owned(), $chan.context.channel_id(),
2016 $chan.context.get_user_id(), $chan.context.force_shutdown(false),
2017 $self.get_channel_update_for_broadcast(&$chan).ok(), $chan.context.get_value_satoshis()));
2021 ChannelMonitorUpdateStatus::Completed => {
2027 ($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) => {
2028 handle_new_monitor_update!($self, $update_res, $peer_state_lock, $peer_state,
2029 $per_peer_state_lock, $chan, _internal, $remove,
2030 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan))
2032 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan_entry: expr, INITIAL_MONITOR) => {
2033 if let ChannelPhase::Funded(chan) = $chan_entry.get_mut() {
2034 handle_new_monitor_update!($self, $update_res, $peer_state_lock, $peer_state,
2035 $per_peer_state_lock, chan, MANUALLY_REMOVING_INITIAL_MONITOR, { $chan_entry.remove() })
2037 // We're not supposed to handle monitor updates for unfunded channels (they have no monitors to
2039 debug_assert!(false);
2040 let channel_id = *$chan_entry.key();
2041 let (_, err) = convert_chan_phase_err!($self, ChannelError::Close(
2042 "Cannot update monitor for unfunded channels as they don't have monitors yet".into()),
2043 $chan_entry.get_mut(), &channel_id);
2044 $chan_entry.remove();
2048 ($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) => { {
2049 let in_flight_updates = $peer_state.in_flight_monitor_updates.entry($funding_txo)
2050 .or_insert_with(Vec::new);
2051 // During startup, we push monitor updates as background events through to here in
2052 // order to replay updates that were in-flight when we shut down. Thus, we have to
2053 // filter for uniqueness here.
2054 let idx = in_flight_updates.iter().position(|upd| upd == &$update)
2055 .unwrap_or_else(|| {
2056 in_flight_updates.push($update);
2057 in_flight_updates.len() - 1
2059 let update_res = $self.chain_monitor.update_channel($funding_txo, &in_flight_updates[idx]);
2060 handle_new_monitor_update!($self, update_res, $peer_state_lock, $peer_state,
2061 $per_peer_state_lock, $chan, _internal, $remove,
2063 let _ = in_flight_updates.remove(idx);
2064 if in_flight_updates.is_empty() && $chan.blocked_monitor_updates_pending() == 0 {
2065 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan);
2069 ($self: ident, $funding_txo: expr, $update: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan_entry: expr) => {
2070 if let ChannelPhase::Funded(chan) = $chan_entry.get_mut() {
2071 handle_new_monitor_update!($self, $funding_txo, $update, $peer_state_lock, $peer_state,
2072 $per_peer_state_lock, chan, MANUALLY_REMOVING, { $chan_entry.remove() })
2074 // We're not supposed to handle monitor updates for unfunded channels (they have no monitors to
2076 debug_assert!(false);
2077 let channel_id = *$chan_entry.key();
2078 let (_, err) = convert_chan_phase_err!($self, ChannelError::Close(
2079 "Cannot update monitor for unfunded channels as they don't have monitors yet".into()),
2080 $chan_entry.get_mut(), &channel_id);
2081 $chan_entry.remove();
2087 macro_rules! process_events_body {
2088 ($self: expr, $event_to_handle: expr, $handle_event: expr) => {
2089 let mut processed_all_events = false;
2090 while !processed_all_events {
2091 if $self.pending_events_processor.compare_exchange(false, true, Ordering::Acquire, Ordering::Relaxed).is_err() {
2095 let mut result = NotifyOption::SkipPersist;
2098 // We'll acquire our total consistency lock so that we can be sure no other
2099 // persists happen while processing monitor events.
2100 let _read_guard = $self.total_consistency_lock.read().unwrap();
2102 // Because `handle_post_event_actions` may send `ChannelMonitorUpdate`s to the user we must
2103 // ensure any startup-generated background events are handled first.
2104 if $self.process_background_events() == NotifyOption::DoPersist { result = NotifyOption::DoPersist; }
2106 // TODO: This behavior should be documented. It's unintuitive that we query
2107 // ChannelMonitors when clearing other events.
2108 if $self.process_pending_monitor_events() {
2109 result = NotifyOption::DoPersist;
2113 let pending_events = $self.pending_events.lock().unwrap().clone();
2114 let num_events = pending_events.len();
2115 if !pending_events.is_empty() {
2116 result = NotifyOption::DoPersist;
2119 let mut post_event_actions = Vec::new();
2121 for (event, action_opt) in pending_events {
2122 $event_to_handle = event;
2124 if let Some(action) = action_opt {
2125 post_event_actions.push(action);
2130 let mut pending_events = $self.pending_events.lock().unwrap();
2131 pending_events.drain(..num_events);
2132 processed_all_events = pending_events.is_empty();
2133 // Note that `push_pending_forwards_ev` relies on `pending_events_processor` being
2134 // updated here with the `pending_events` lock acquired.
2135 $self.pending_events_processor.store(false, Ordering::Release);
2138 if !post_event_actions.is_empty() {
2139 $self.handle_post_event_actions(post_event_actions);
2140 // If we had some actions, go around again as we may have more events now
2141 processed_all_events = false;
2144 if result == NotifyOption::DoPersist {
2145 $self.needs_persist_flag.store(true, Ordering::Release);
2146 $self.event_persist_notifier.notify();
2152 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>
2154 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
2155 T::Target: BroadcasterInterface,
2156 ES::Target: EntropySource,
2157 NS::Target: NodeSigner,
2158 SP::Target: SignerProvider,
2159 F::Target: FeeEstimator,
2163 /// Constructs a new `ChannelManager` to hold several channels and route between them.
2165 /// The current time or latest block header time can be provided as the `current_timestamp`.
2167 /// This is the main "logic hub" for all channel-related actions, and implements
2168 /// [`ChannelMessageHandler`].
2170 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
2172 /// Users need to notify the new `ChannelManager` when a new block is connected or
2173 /// disconnected using its [`block_connected`] and [`block_disconnected`] methods, starting
2174 /// from after [`params.best_block.block_hash`]. See [`chain::Listen`] and [`chain::Confirm`] for
2177 /// [`block_connected`]: chain::Listen::block_connected
2178 /// [`block_disconnected`]: chain::Listen::block_disconnected
2179 /// [`params.best_block.block_hash`]: chain::BestBlock::block_hash
2181 fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, entropy_source: ES,
2182 node_signer: NS, signer_provider: SP, config: UserConfig, params: ChainParameters,
2183 current_timestamp: u32,
2185 let mut secp_ctx = Secp256k1::new();
2186 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
2187 let inbound_pmt_key_material = node_signer.get_inbound_payment_key_material();
2188 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
2190 default_configuration: config.clone(),
2191 genesis_hash: genesis_block(params.network).header.block_hash(),
2192 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
2197 best_block: RwLock::new(params.best_block),
2199 outbound_scid_aliases: Mutex::new(HashSet::new()),
2200 pending_inbound_payments: Mutex::new(HashMap::new()),
2201 pending_outbound_payments: OutboundPayments::new(),
2202 forward_htlcs: Mutex::new(HashMap::new()),
2203 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments: HashMap::new(), pending_claiming_payments: HashMap::new() }),
2204 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
2205 id_to_peer: Mutex::new(HashMap::new()),
2206 short_to_chan_info: FairRwLock::new(HashMap::new()),
2208 our_network_pubkey: node_signer.get_node_id(Recipient::Node).unwrap(),
2211 inbound_payment_key: expanded_inbound_key,
2212 fake_scid_rand_bytes: entropy_source.get_secure_random_bytes(),
2214 probing_cookie_secret: entropy_source.get_secure_random_bytes(),
2216 highest_seen_timestamp: AtomicUsize::new(current_timestamp as usize),
2218 per_peer_state: FairRwLock::new(HashMap::new()),
2220 pending_events: Mutex::new(VecDeque::new()),
2221 pending_events_processor: AtomicBool::new(false),
2222 pending_background_events: Mutex::new(Vec::new()),
2223 total_consistency_lock: RwLock::new(()),
2224 background_events_processed_since_startup: AtomicBool::new(false),
2226 event_persist_notifier: Notifier::new(),
2227 needs_persist_flag: AtomicBool::new(false),
2237 /// Gets the current configuration applied to all new channels.
2238 pub fn get_current_default_configuration(&self) -> &UserConfig {
2239 &self.default_configuration
2242 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
2243 let height = self.best_block.read().unwrap().height();
2244 let mut outbound_scid_alias = 0;
2247 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
2248 outbound_scid_alias += 1;
2250 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
2252 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
2256 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"); }
2261 /// Creates a new outbound channel to the given remote node and with the given value.
2263 /// `user_channel_id` will be provided back as in
2264 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
2265 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
2266 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
2267 /// is simply copied to events and otherwise ignored.
2269 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
2270 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
2272 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be opened due to failing to
2273 /// generate a shutdown scriptpubkey or destination script set by
2274 /// [`SignerProvider::get_shutdown_scriptpubkey`] or [`SignerProvider::get_destination_script`].
2276 /// Note that we do not check if you are currently connected to the given peer. If no
2277 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
2278 /// the channel eventually being silently forgotten (dropped on reload).
2280 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
2281 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
2282 /// [`ChannelDetails::channel_id`] until after
2283 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
2284 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
2285 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
2287 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
2288 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
2289 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
2290 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_channel_id: u128, override_config: Option<UserConfig>) -> Result<ChannelId, APIError> {
2291 if channel_value_satoshis < 1000 {
2292 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
2295 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2296 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
2297 debug_assert!(&self.total_consistency_lock.try_write().is_err());
2299 let per_peer_state = self.per_peer_state.read().unwrap();
2301 let peer_state_mutex = per_peer_state.get(&their_network_key)
2302 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Not connected to node: {}", their_network_key) })?;
2304 let mut peer_state = peer_state_mutex.lock().unwrap();
2306 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
2307 let their_features = &peer_state.latest_features;
2308 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
2309 match OutboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider, their_network_key,
2310 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
2311 self.best_block.read().unwrap().height(), outbound_scid_alias)
2315 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
2320 let res = channel.get_open_channel(self.genesis_hash.clone());
2322 let temporary_channel_id = channel.context.channel_id();
2323 match peer_state.channel_by_id.entry(temporary_channel_id) {
2324 hash_map::Entry::Occupied(_) => {
2326 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
2328 panic!("RNG is bad???");
2331 hash_map::Entry::Vacant(entry) => { entry.insert(ChannelPhase::UnfundedOutboundV1(channel)); }
2334 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
2335 node_id: their_network_key,
2338 Ok(temporary_channel_id)
2341 fn list_funded_channels_with_filter<Fn: FnMut(&(&ChannelId, &Channel<SP>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
2342 // Allocate our best estimate of the number of channels we have in the `res`
2343 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2344 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2345 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2346 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2347 // the same channel.
2348 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2350 let best_block_height = self.best_block.read().unwrap().height();
2351 let per_peer_state = self.per_peer_state.read().unwrap();
2352 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2353 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2354 let peer_state = &mut *peer_state_lock;
2355 res.extend(peer_state.channel_by_id.iter()
2356 .filter_map(|(chan_id, phase)| match phase {
2357 // Only `Channels` in the `ChannelPhase::Funded` phase can be considered funded.
2358 ChannelPhase::Funded(chan) => Some((chan_id, chan)),
2362 .map(|(_channel_id, channel)| {
2363 ChannelDetails::from_channel_context(&channel.context, best_block_height,
2364 peer_state.latest_features.clone(), &self.fee_estimator)
2372 /// Gets the list of open channels, in random order. See [`ChannelDetails`] field documentation for
2373 /// more information.
2374 pub fn list_channels(&self) -> Vec<ChannelDetails> {
2375 // Allocate our best estimate of the number of channels we have in the `res`
2376 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2377 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2378 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2379 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2380 // the same channel.
2381 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2383 let best_block_height = self.best_block.read().unwrap().height();
2384 let per_peer_state = self.per_peer_state.read().unwrap();
2385 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2386 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2387 let peer_state = &mut *peer_state_lock;
2388 for context in peer_state.channel_by_id.iter().map(|(_, phase)| phase.context()) {
2389 let details = ChannelDetails::from_channel_context(context, best_block_height,
2390 peer_state.latest_features.clone(), &self.fee_estimator);
2398 /// Gets the list of usable channels, in random order. Useful as an argument to
2399 /// [`Router::find_route`] to ensure non-announced channels are used.
2401 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
2402 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
2404 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
2405 // Note we use is_live here instead of usable which leads to somewhat confused
2406 // internal/external nomenclature, but that's ok cause that's probably what the user
2407 // really wanted anyway.
2408 self.list_funded_channels_with_filter(|&(_, ref channel)| channel.context.is_live())
2411 /// Gets the list of channels we have with a given counterparty, in random order.
2412 pub fn list_channels_with_counterparty(&self, counterparty_node_id: &PublicKey) -> Vec<ChannelDetails> {
2413 let best_block_height = self.best_block.read().unwrap().height();
2414 let per_peer_state = self.per_peer_state.read().unwrap();
2416 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
2417 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2418 let peer_state = &mut *peer_state_lock;
2419 let features = &peer_state.latest_features;
2420 let context_to_details = |context| {
2421 ChannelDetails::from_channel_context(context, best_block_height, features.clone(), &self.fee_estimator)
2423 return peer_state.channel_by_id
2425 .map(|(_, phase)| phase.context())
2426 .map(context_to_details)
2432 /// Returns in an undefined order recent payments that -- if not fulfilled -- have yet to find a
2433 /// successful path, or have unresolved HTLCs.
2435 /// This can be useful for payments that may have been prepared, but ultimately not sent, as a
2436 /// result of a crash. If such a payment exists, is not listed here, and an
2437 /// [`Event::PaymentSent`] has not been received, you may consider resending the payment.
2439 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2440 pub fn list_recent_payments(&self) -> Vec<RecentPaymentDetails> {
2441 self.pending_outbound_payments.pending_outbound_payments.lock().unwrap().iter()
2442 .filter_map(|(payment_id, pending_outbound_payment)| match pending_outbound_payment {
2443 PendingOutboundPayment::AwaitingInvoice { .. } => {
2444 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2446 // InvoiceReceived is an intermediate state and doesn't need to be exposed
2447 PendingOutboundPayment::InvoiceReceived { .. } => {
2448 Some(RecentPaymentDetails::AwaitingInvoice { payment_id: *payment_id })
2450 PendingOutboundPayment::Retryable { payment_hash, total_msat, .. } => {
2451 Some(RecentPaymentDetails::Pending {
2452 payment_hash: *payment_hash,
2453 total_msat: *total_msat,
2456 PendingOutboundPayment::Abandoned { payment_hash, .. } => {
2457 Some(RecentPaymentDetails::Abandoned { payment_hash: *payment_hash })
2459 PendingOutboundPayment::Fulfilled { payment_hash, .. } => {
2460 Some(RecentPaymentDetails::Fulfilled { payment_hash: *payment_hash })
2462 PendingOutboundPayment::Legacy { .. } => None
2467 /// Helper function that issues the channel close events
2468 fn issue_channel_close_events(&self, context: &ChannelContext<SP>, closure_reason: ClosureReason) {
2469 let mut pending_events_lock = self.pending_events.lock().unwrap();
2470 match context.unbroadcasted_funding() {
2471 Some(transaction) => {
2472 pending_events_lock.push_back((events::Event::DiscardFunding {
2473 channel_id: context.channel_id(), transaction
2478 pending_events_lock.push_back((events::Event::ChannelClosed {
2479 channel_id: context.channel_id(),
2480 user_channel_id: context.get_user_id(),
2481 reason: closure_reason,
2482 counterparty_node_id: Some(context.get_counterparty_node_id()),
2483 channel_capacity_sats: Some(context.get_value_satoshis()),
2487 fn close_channel_internal(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>, override_shutdown_script: Option<ShutdownScript>) -> Result<(), APIError> {
2488 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2490 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
2491 let result: Result<(), _> = loop {
2493 let per_peer_state = self.per_peer_state.read().unwrap();
2495 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2496 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2498 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2499 let peer_state = &mut *peer_state_lock;
2501 match peer_state.channel_by_id.entry(channel_id.clone()) {
2502 hash_map::Entry::Occupied(mut chan_phase_entry) => {
2503 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
2504 let funding_txo_opt = chan.context.get_funding_txo();
2505 let their_features = &peer_state.latest_features;
2506 let (shutdown_msg, mut monitor_update_opt, htlcs) =
2507 chan.get_shutdown(&self.signer_provider, their_features, target_feerate_sats_per_1000_weight, override_shutdown_script)?;
2508 failed_htlcs = htlcs;
2510 // We can send the `shutdown` message before updating the `ChannelMonitor`
2511 // here as we don't need the monitor update to complete until we send a
2512 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
2513 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2514 node_id: *counterparty_node_id,
2518 // Update the monitor with the shutdown script if necessary.
2519 if let Some(monitor_update) = monitor_update_opt.take() {
2520 break handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
2521 peer_state_lock, peer_state, per_peer_state, chan_phase_entry).map(|_| ());
2524 if chan.is_shutdown() {
2525 if let ChannelPhase::Funded(chan) = remove_channel_phase!(self, chan_phase_entry) {
2526 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&chan) {
2527 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2531 self.issue_channel_close_events(&chan.context, ClosureReason::HolderForceClosed);
2537 hash_map::Entry::Vacant(_) => (),
2540 // If we reach this point, it means that the channel_id either refers to an unfunded channel or
2541 // it does not exist for this peer. Either way, we can attempt to force-close it.
2543 // An appropriate error will be returned for non-existence of the channel if that's the case.
2544 return self.force_close_channel_with_peer(&channel_id, counterparty_node_id, None, false).map(|_| ())
2547 for htlc_source in failed_htlcs.drain(..) {
2548 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2549 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
2550 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
2553 let _ = handle_error!(self, result, *counterparty_node_id);
2557 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2558 /// will be accepted on the given channel, and after additional timeout/the closing of all
2559 /// pending HTLCs, the channel will be closed on chain.
2561 /// * If we are the channel initiator, we will pay between our [`Background`] and
2562 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
2564 /// * If our counterparty is the channel initiator, we will require a channel closing
2565 /// transaction feerate of at least our [`Background`] feerate or the feerate which
2566 /// would appear on a force-closure transaction, whichever is lower. We will allow our
2567 /// counterparty to pay as much fee as they'd like, however.
2569 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2571 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2572 /// generate a shutdown scriptpubkey or destination script set by
2573 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2576 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2577 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
2578 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
2579 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2580 pub fn close_channel(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey) -> Result<(), APIError> {
2581 self.close_channel_internal(channel_id, counterparty_node_id, None, None)
2584 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2585 /// will be accepted on the given channel, and after additional timeout/the closing of all
2586 /// pending HTLCs, the channel will be closed on chain.
2588 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
2589 /// the channel being closed or not:
2590 /// * If we are the channel initiator, we will pay at least this feerate on the closing
2591 /// transaction. The upper-bound is set by
2592 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
2593 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
2594 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
2595 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
2596 /// will appear on a force-closure transaction, whichever is lower).
2598 /// The `shutdown_script` provided will be used as the `scriptPubKey` for the closing transaction.
2599 /// Will fail if a shutdown script has already been set for this channel by
2600 /// ['ChannelHandshakeConfig::commit_upfront_shutdown_pubkey`]. The given shutdown script must
2601 /// also be compatible with our and the counterparty's features.
2603 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2605 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2606 /// generate a shutdown scriptpubkey or destination script set by
2607 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2610 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2611 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
2612 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
2613 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2614 pub fn close_channel_with_feerate_and_script(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>, shutdown_script: Option<ShutdownScript>) -> Result<(), APIError> {
2615 self.close_channel_internal(channel_id, counterparty_node_id, target_feerate_sats_per_1000_weight, shutdown_script)
2619 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
2620 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
2621 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
2622 for htlc_source in failed_htlcs.drain(..) {
2623 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
2624 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2625 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2626 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
2628 if let Some((_, funding_txo, monitor_update)) = monitor_update_option {
2629 // There isn't anything we can do if we get an update failure - we're already
2630 // force-closing. The monitor update on the required in-memory copy should broadcast
2631 // the latest local state, which is the best we can do anyway. Thus, it is safe to
2632 // ignore the result here.
2633 let _ = self.chain_monitor.update_channel(funding_txo, &monitor_update);
2637 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
2638 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
2639 fn force_close_channel_with_peer(&self, channel_id: &ChannelId, peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
2640 -> Result<PublicKey, APIError> {
2641 let per_peer_state = self.per_peer_state.read().unwrap();
2642 let peer_state_mutex = per_peer_state.get(peer_node_id)
2643 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", peer_node_id) })?;
2644 let (update_opt, counterparty_node_id) = {
2645 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2646 let peer_state = &mut *peer_state_lock;
2647 let closure_reason = if let Some(peer_msg) = peer_msg {
2648 ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(peer_msg.to_string()) }
2650 ClosureReason::HolderForceClosed
2652 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(channel_id.clone()) {
2653 log_error!(self.logger, "Force-closing channel {}", channel_id);
2654 self.issue_channel_close_events(&chan_phase_entry.get().context(), closure_reason);
2655 let mut chan_phase = remove_channel_phase!(self, chan_phase_entry);
2657 ChannelPhase::Funded(mut chan) => {
2658 self.finish_force_close_channel(chan.context.force_shutdown(broadcast));
2659 (self.get_channel_update_for_broadcast(&chan).ok(), chan.context.get_counterparty_node_id())
2661 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => {
2662 self.finish_force_close_channel(chan_phase.context_mut().force_shutdown(false));
2663 // Unfunded channel has no update
2664 (None, chan_phase.context().get_counterparty_node_id())
2667 } else if peer_state.inbound_channel_request_by_id.remove(channel_id).is_some() {
2668 log_error!(self.logger, "Force-closing channel {}", &channel_id);
2669 // N.B. that we don't send any channel close event here: we
2670 // don't have a user_channel_id, and we never sent any opening
2672 (None, *peer_node_id)
2674 return Err(APIError::ChannelUnavailable{ err: format!("Channel with id {} not found for the passed counterparty node_id {}", channel_id, peer_node_id) });
2677 if let Some(update) = update_opt {
2678 let mut peer_state = peer_state_mutex.lock().unwrap();
2679 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2684 Ok(counterparty_node_id)
2687 fn force_close_sending_error(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
2688 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2689 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
2690 Ok(counterparty_node_id) => {
2691 let per_peer_state = self.per_peer_state.read().unwrap();
2692 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2693 let mut peer_state = peer_state_mutex.lock().unwrap();
2694 peer_state.pending_msg_events.push(
2695 events::MessageSendEvent::HandleError {
2696 node_id: counterparty_node_id,
2697 action: msgs::ErrorAction::SendErrorMessage {
2698 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
2709 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
2710 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
2711 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
2713 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
2714 -> Result<(), APIError> {
2715 self.force_close_sending_error(channel_id, counterparty_node_id, true)
2718 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
2719 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
2720 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
2722 /// You can always get the latest local transaction(s) to broadcast from
2723 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
2724 pub fn force_close_without_broadcasting_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
2725 -> Result<(), APIError> {
2726 self.force_close_sending_error(channel_id, counterparty_node_id, false)
2729 /// Force close all channels, immediately broadcasting the latest local commitment transaction
2730 /// for each to the chain and rejecting new HTLCs on each.
2731 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
2732 for chan in self.list_channels() {
2733 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
2737 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
2738 /// local transaction(s).
2739 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
2740 for chan in self.list_channels() {
2741 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
2745 fn construct_fwd_pending_htlc_info(
2746 &self, msg: &msgs::UpdateAddHTLC, hop_data: msgs::InboundOnionPayload, hop_hmac: [u8; 32],
2747 new_packet_bytes: [u8; onion_utils::ONION_DATA_LEN], shared_secret: [u8; 32],
2748 next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
2749 ) -> Result<PendingHTLCInfo, InboundOnionErr> {
2750 debug_assert!(next_packet_pubkey_opt.is_some());
2751 let outgoing_packet = msgs::OnionPacket {
2753 public_key: next_packet_pubkey_opt.unwrap_or(Err(secp256k1::Error::InvalidPublicKey)),
2754 hop_data: new_packet_bytes,
2758 let (short_channel_id, amt_to_forward, outgoing_cltv_value) = match hop_data {
2759 msgs::InboundOnionPayload::Forward { short_channel_id, amt_to_forward, outgoing_cltv_value } =>
2760 (short_channel_id, amt_to_forward, outgoing_cltv_value),
2761 msgs::InboundOnionPayload::Receive { .. } =>
2762 return Err(InboundOnionErr {
2763 msg: "Final Node OnionHopData provided for us as an intermediary node",
2764 err_code: 0x4000 | 22,
2765 err_data: Vec::new(),
2769 Ok(PendingHTLCInfo {
2770 routing: PendingHTLCRouting::Forward {
2771 onion_packet: outgoing_packet,
2774 payment_hash: msg.payment_hash,
2775 incoming_shared_secret: shared_secret,
2776 incoming_amt_msat: Some(msg.amount_msat),
2777 outgoing_amt_msat: amt_to_forward,
2778 outgoing_cltv_value,
2779 skimmed_fee_msat: None,
2783 fn construct_recv_pending_htlc_info(
2784 &self, hop_data: msgs::InboundOnionPayload, shared_secret: [u8; 32], payment_hash: PaymentHash,
2785 amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>, allow_underpay: bool,
2786 counterparty_skimmed_fee_msat: Option<u64>,
2787 ) -> Result<PendingHTLCInfo, InboundOnionErr> {
2788 let (payment_data, keysend_preimage, custom_tlvs, onion_amt_msat, outgoing_cltv_value, payment_metadata) = match hop_data {
2789 msgs::InboundOnionPayload::Receive {
2790 payment_data, keysend_preimage, custom_tlvs, amt_msat, outgoing_cltv_value, payment_metadata, ..
2792 (payment_data, keysend_preimage, custom_tlvs, amt_msat, outgoing_cltv_value, payment_metadata),
2794 return Err(InboundOnionErr {
2795 err_code: 0x4000|22,
2796 err_data: Vec::new(),
2797 msg: "Got non final data with an HMAC of 0",
2800 // final_incorrect_cltv_expiry
2801 if outgoing_cltv_value > cltv_expiry {
2802 return Err(InboundOnionErr {
2803 msg: "Upstream node set CLTV to less than the CLTV set by the sender",
2805 err_data: cltv_expiry.to_be_bytes().to_vec()
2808 // final_expiry_too_soon
2809 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
2810 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
2812 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
2813 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
2814 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
2815 let current_height: u32 = self.best_block.read().unwrap().height();
2816 if (outgoing_cltv_value as u64) <= current_height as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
2817 let mut err_data = Vec::with_capacity(12);
2818 err_data.extend_from_slice(&amt_msat.to_be_bytes());
2819 err_data.extend_from_slice(¤t_height.to_be_bytes());
2820 return Err(InboundOnionErr {
2821 err_code: 0x4000 | 15, err_data,
2822 msg: "The final CLTV expiry is too soon to handle",
2825 if (!allow_underpay && onion_amt_msat > amt_msat) ||
2826 (allow_underpay && onion_amt_msat >
2827 amt_msat.saturating_add(counterparty_skimmed_fee_msat.unwrap_or(0)))
2829 return Err(InboundOnionErr {
2831 err_data: amt_msat.to_be_bytes().to_vec(),
2832 msg: "Upstream node sent less than we were supposed to receive in payment",
2836 let routing = if let Some(payment_preimage) = keysend_preimage {
2837 // We need to check that the sender knows the keysend preimage before processing this
2838 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
2839 // could discover the final destination of X, by probing the adjacent nodes on the route
2840 // with a keysend payment of identical payment hash to X and observing the processing
2841 // time discrepancies due to a hash collision with X.
2842 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2843 if hashed_preimage != payment_hash {
2844 return Err(InboundOnionErr {
2845 err_code: 0x4000|22,
2846 err_data: Vec::new(),
2847 msg: "Payment preimage didn't match payment hash",
2850 if !self.default_configuration.accept_mpp_keysend && payment_data.is_some() {
2851 return Err(InboundOnionErr {
2852 err_code: 0x4000|22,
2853 err_data: Vec::new(),
2854 msg: "We don't support MPP keysend payments",
2857 PendingHTLCRouting::ReceiveKeysend {
2861 incoming_cltv_expiry: outgoing_cltv_value,
2864 } else if let Some(data) = payment_data {
2865 PendingHTLCRouting::Receive {
2868 incoming_cltv_expiry: outgoing_cltv_value,
2869 phantom_shared_secret,
2873 return Err(InboundOnionErr {
2874 err_code: 0x4000|0x2000|3,
2875 err_data: Vec::new(),
2876 msg: "We require payment_secrets",
2879 Ok(PendingHTLCInfo {
2882 incoming_shared_secret: shared_secret,
2883 incoming_amt_msat: Some(amt_msat),
2884 outgoing_amt_msat: onion_amt_msat,
2885 outgoing_cltv_value,
2886 skimmed_fee_msat: counterparty_skimmed_fee_msat,
2890 fn decode_update_add_htlc_onion(
2891 &self, msg: &msgs::UpdateAddHTLC
2892 ) -> Result<(onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg> {
2893 macro_rules! return_malformed_err {
2894 ($msg: expr, $err_code: expr) => {
2896 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2897 return Err(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
2898 channel_id: msg.channel_id,
2899 htlc_id: msg.htlc_id,
2900 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
2901 failure_code: $err_code,
2907 if let Err(_) = msg.onion_routing_packet.public_key {
2908 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2911 let shared_secret = self.node_signer.ecdh(
2912 Recipient::Node, &msg.onion_routing_packet.public_key.unwrap(), None
2913 ).unwrap().secret_bytes();
2915 if msg.onion_routing_packet.version != 0 {
2916 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2917 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2918 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2919 //receiving node would have to brute force to figure out which version was put in the
2920 //packet by the node that send us the message, in the case of hashing the hop_data, the
2921 //node knows the HMAC matched, so they already know what is there...
2922 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2924 macro_rules! return_err {
2925 ($msg: expr, $err_code: expr, $data: expr) => {
2927 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2928 return Err(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2929 channel_id: msg.channel_id,
2930 htlc_id: msg.htlc_id,
2931 reason: HTLCFailReason::reason($err_code, $data.to_vec())
2932 .get_encrypted_failure_packet(&shared_secret, &None),
2938 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) {
2940 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2941 return_malformed_err!(err_msg, err_code);
2943 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2944 return_err!(err_msg, err_code, &[0; 0]);
2947 let (outgoing_scid, outgoing_amt_msat, outgoing_cltv_value, next_packet_pk_opt) = match next_hop {
2948 onion_utils::Hop::Forward {
2949 next_hop_data: msgs::InboundOnionPayload::Forward {
2950 short_channel_id, amt_to_forward, outgoing_cltv_value
2953 let next_packet_pk = onion_utils::next_hop_pubkey(&self.secp_ctx,
2954 msg.onion_routing_packet.public_key.unwrap(), &shared_secret);
2955 (short_channel_id, amt_to_forward, outgoing_cltv_value, Some(next_packet_pk))
2957 // We'll do receive checks in [`Self::construct_pending_htlc_info`] so we have access to the
2958 // inbound channel's state.
2959 onion_utils::Hop::Receive { .. } => return Ok((next_hop, shared_secret, None)),
2960 onion_utils::Hop::Forward { next_hop_data: msgs::InboundOnionPayload::Receive { .. }, .. } => {
2961 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0; 0]);
2965 // Perform outbound checks here instead of in [`Self::construct_pending_htlc_info`] because we
2966 // can't hold the outbound peer state lock at the same time as the inbound peer state lock.
2967 if let Some((err, mut code, chan_update)) = loop {
2968 let id_option = self.short_to_chan_info.read().unwrap().get(&outgoing_scid).cloned();
2969 let forwarding_chan_info_opt = match id_option {
2970 None => { // unknown_next_peer
2971 // Note that this is likely a timing oracle for detecting whether an scid is a
2972 // phantom or an intercept.
2973 if (self.default_configuration.accept_intercept_htlcs &&
2974 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, outgoing_scid, &self.genesis_hash)) ||
2975 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, outgoing_scid, &self.genesis_hash)
2979 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2982 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
2984 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
2985 let per_peer_state = self.per_peer_state.read().unwrap();
2986 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
2987 if peer_state_mutex_opt.is_none() {
2988 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2990 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
2991 let peer_state = &mut *peer_state_lock;
2992 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id).map(
2993 |chan_phase| if let ChannelPhase::Funded(chan) = chan_phase { Some(chan) } else { None }
2996 // Channel was removed. The short_to_chan_info and channel_by_id maps
2997 // have no consistency guarantees.
2998 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
3002 if !chan.context.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
3003 // Note that the behavior here should be identical to the above block - we
3004 // should NOT reveal the existence or non-existence of a private channel if
3005 // we don't allow forwards outbound over them.
3006 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
3008 if chan.context.get_channel_type().supports_scid_privacy() && outgoing_scid != chan.context.outbound_scid_alias() {
3009 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
3010 // "refuse to forward unless the SCID alias was used", so we pretend
3011 // we don't have the channel here.
3012 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
3014 let chan_update_opt = self.get_channel_update_for_onion(outgoing_scid, chan).ok();
3016 // Note that we could technically not return an error yet here and just hope
3017 // that the connection is reestablished or monitor updated by the time we get
3018 // around to doing the actual forward, but better to fail early if we can and
3019 // hopefully an attacker trying to path-trace payments cannot make this occur
3020 // on a small/per-node/per-channel scale.
3021 if !chan.context.is_live() { // channel_disabled
3022 // If the channel_update we're going to return is disabled (i.e. the
3023 // peer has been disabled for some time), return `channel_disabled`,
3024 // otherwise return `temporary_channel_failure`.
3025 if chan_update_opt.as_ref().map(|u| u.contents.flags & 2 == 2).unwrap_or(false) {
3026 break Some(("Forwarding channel has been disconnected for some time.", 0x1000 | 20, chan_update_opt));
3028 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 7, chan_update_opt));
3031 if outgoing_amt_msat < chan.context.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
3032 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
3034 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, outgoing_amt_msat, outgoing_cltv_value) {
3035 break Some((err, code, chan_update_opt));
3039 if (msg.cltv_expiry as u64) < (outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 {
3040 // We really should set `incorrect_cltv_expiry` here but as we're not
3041 // forwarding over a real channel we can't generate a channel_update
3042 // for it. Instead we just return a generic temporary_node_failure.
3044 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
3051 let cur_height = self.best_block.read().unwrap().height() + 1;
3052 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
3053 // but we want to be robust wrt to counterparty packet sanitization (see
3054 // HTLC_FAIL_BACK_BUFFER rationale).
3055 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
3056 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
3058 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
3059 break Some(("CLTV expiry is too far in the future", 21, None));
3061 // If the HTLC expires ~now, don't bother trying to forward it to our
3062 // counterparty. They should fail it anyway, but we don't want to bother with
3063 // the round-trips or risk them deciding they definitely want the HTLC and
3064 // force-closing to ensure they get it if we're offline.
3065 // We previously had a much more aggressive check here which tried to ensure
3066 // our counterparty receives an HTLC which has *our* risk threshold met on it,
3067 // but there is no need to do that, and since we're a bit conservative with our
3068 // risk threshold it just results in failing to forward payments.
3069 if (outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
3070 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
3076 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
3077 if let Some(chan_update) = chan_update {
3078 if code == 0x1000 | 11 || code == 0x1000 | 12 {
3079 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
3081 else if code == 0x1000 | 13 {
3082 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
3084 else if code == 0x1000 | 20 {
3085 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
3086 0u16.write(&mut res).expect("Writes cannot fail");
3088 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
3089 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
3090 chan_update.write(&mut res).expect("Writes cannot fail");
3091 } else if code & 0x1000 == 0x1000 {
3092 // If we're trying to return an error that requires a `channel_update` but
3093 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
3094 // generate an update), just use the generic "temporary_node_failure"
3098 return_err!(err, code, &res.0[..]);
3100 Ok((next_hop, shared_secret, next_packet_pk_opt))
3103 fn construct_pending_htlc_status<'a>(
3104 &self, msg: &msgs::UpdateAddHTLC, shared_secret: [u8; 32], decoded_hop: onion_utils::Hop,
3105 allow_underpay: bool, next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
3106 ) -> PendingHTLCStatus {
3107 macro_rules! return_err {
3108 ($msg: expr, $err_code: expr, $data: expr) => {
3110 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3111 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3112 channel_id: msg.channel_id,
3113 htlc_id: msg.htlc_id,
3114 reason: HTLCFailReason::reason($err_code, $data.to_vec())
3115 .get_encrypted_failure_packet(&shared_secret, &None),
3121 onion_utils::Hop::Receive(next_hop_data) => {
3123 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash,
3124 msg.amount_msat, msg.cltv_expiry, None, allow_underpay, msg.skimmed_fee_msat)
3127 // Note that we could obviously respond immediately with an update_fulfill_htlc
3128 // message, however that would leak that we are the recipient of this payment, so
3129 // instead we stay symmetric with the forwarding case, only responding (after a
3130 // delay) once they've send us a commitment_signed!
3131 PendingHTLCStatus::Forward(info)
3133 Err(InboundOnionErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3136 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
3137 match self.construct_fwd_pending_htlc_info(msg, next_hop_data, next_hop_hmac,
3138 new_packet_bytes, shared_secret, next_packet_pubkey_opt) {
3139 Ok(info) => PendingHTLCStatus::Forward(info),
3140 Err(InboundOnionErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3146 /// Gets the current [`channel_update`] for the given channel. This first checks if the channel is
3147 /// public, and thus should be called whenever the result is going to be passed out in a
3148 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
3150 /// Note that in [`internal_closing_signed`], this function is called without the `peer_state`
3151 /// corresponding to the channel's counterparty locked, as the channel been removed from the
3152 /// storage and the `peer_state` lock has been dropped.
3154 /// [`channel_update`]: msgs::ChannelUpdate
3155 /// [`internal_closing_signed`]: Self::internal_closing_signed
3156 fn get_channel_update_for_broadcast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3157 if !chan.context.should_announce() {
3158 return Err(LightningError {
3159 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
3160 action: msgs::ErrorAction::IgnoreError
3163 if chan.context.get_short_channel_id().is_none() {
3164 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
3166 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", &chan.context.channel_id());
3167 self.get_channel_update_for_unicast(chan)
3170 /// Gets the current [`channel_update`] for the given channel. This does not check if the channel
3171 /// is public (only returning an `Err` if the channel does not yet have an assigned SCID),
3172 /// and thus MUST NOT be called unless the recipient of the resulting message has already
3173 /// provided evidence that they know about the existence of the channel.
3175 /// Note that through [`internal_closing_signed`], this function is called without the
3176 /// `peer_state` corresponding to the channel's counterparty locked, as the channel been
3177 /// removed from the storage and the `peer_state` lock has been dropped.
3179 /// [`channel_update`]: msgs::ChannelUpdate
3180 /// [`internal_closing_signed`]: Self::internal_closing_signed
3181 fn get_channel_update_for_unicast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3182 log_trace!(self.logger, "Attempting to generate channel update for channel {}", &chan.context.channel_id());
3183 let short_channel_id = match chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias()) {
3184 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
3188 self.get_channel_update_for_onion(short_channel_id, chan)
3191 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3192 log_trace!(self.logger, "Generating channel update for channel {}", &chan.context.channel_id());
3193 let were_node_one = self.our_network_pubkey.serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
3195 let enabled = chan.context.is_usable() && match chan.channel_update_status() {
3196 ChannelUpdateStatus::Enabled => true,
3197 ChannelUpdateStatus::DisabledStaged(_) => true,
3198 ChannelUpdateStatus::Disabled => false,
3199 ChannelUpdateStatus::EnabledStaged(_) => false,
3202 let unsigned = msgs::UnsignedChannelUpdate {
3203 chain_hash: self.genesis_hash,
3205 timestamp: chan.context.get_update_time_counter(),
3206 flags: (!were_node_one) as u8 | ((!enabled as u8) << 1),
3207 cltv_expiry_delta: chan.context.get_cltv_expiry_delta(),
3208 htlc_minimum_msat: chan.context.get_counterparty_htlc_minimum_msat(),
3209 htlc_maximum_msat: chan.context.get_announced_htlc_max_msat(),
3210 fee_base_msat: chan.context.get_outbound_forwarding_fee_base_msat(),
3211 fee_proportional_millionths: chan.context.get_fee_proportional_millionths(),
3212 excess_data: Vec::new(),
3214 // Panic on failure to signal LDK should be restarted to retry signing the `ChannelUpdate`.
3215 // If we returned an error and the `node_signer` cannot provide a signature for whatever
3216 // reason`, we wouldn't be able to receive inbound payments through the corresponding
3218 let sig = self.node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelUpdate(&unsigned)).unwrap();
3220 Ok(msgs::ChannelUpdate {
3227 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> {
3228 let _lck = self.total_consistency_lock.read().unwrap();
3229 self.send_payment_along_path(SendAlongPathArgs {
3230 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3235 fn send_payment_along_path(&self, args: SendAlongPathArgs) -> Result<(), APIError> {
3236 let SendAlongPathArgs {
3237 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3240 // The top-level caller should hold the total_consistency_lock read lock.
3241 debug_assert!(self.total_consistency_lock.try_write().is_err());
3243 log_trace!(self.logger,
3244 "Attempting to send payment with payment hash {} along path with next hop {}",
3245 payment_hash, path.hops.first().unwrap().short_channel_id);
3246 let prng_seed = self.entropy_source.get_secure_random_bytes();
3247 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
3249 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
3250 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected".to_owned()})?;
3251 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, recipient_onion, cur_height, keysend_preimage)?;
3253 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash)
3254 .map_err(|_| APIError::InvalidRoute { err: "Route size too large considering onion data".to_owned()})?;
3256 let err: Result<(), _> = loop {
3257 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
3258 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
3259 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3262 let per_peer_state = self.per_peer_state.read().unwrap();
3263 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
3264 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
3265 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3266 let peer_state = &mut *peer_state_lock;
3267 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(id) {
3268 match chan_phase_entry.get_mut() {
3269 ChannelPhase::Funded(chan) => {
3270 if !chan.context.is_live() {
3271 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected".to_owned()});
3273 let funding_txo = chan.context.get_funding_txo().unwrap();
3274 let send_res = chan.send_htlc_and_commit(htlc_msat, payment_hash.clone(),
3275 htlc_cltv, HTLCSource::OutboundRoute {
3277 session_priv: session_priv.clone(),
3278 first_hop_htlc_msat: htlc_msat,
3280 }, onion_packet, None, &self.fee_estimator, &self.logger);
3281 match break_chan_phase_entry!(self, send_res, chan_phase_entry) {
3282 Some(monitor_update) => {
3283 match handle_new_monitor_update!(self, funding_txo, monitor_update, peer_state_lock, peer_state, per_peer_state, chan_phase_entry) {
3284 Err(e) => break Err(e),
3286 // Note that MonitorUpdateInProgress here indicates (per function
3287 // docs) that we will resend the commitment update once monitor
3288 // updating completes. Therefore, we must return an error
3289 // indicating that it is unsafe to retry the payment wholesale,
3290 // which we do in the send_payment check for
3291 // MonitorUpdateInProgress, below.
3292 return Err(APIError::MonitorUpdateInProgress);
3300 _ => return Err(APIError::ChannelUnavailable{err: "Channel to first hop is unfunded".to_owned()}),
3303 // The channel was likely removed after we fetched the id from the
3304 // `short_to_chan_info` map, but before we successfully locked the
3305 // `channel_by_id` map.
3306 // This can occur as no consistency guarantees exists between the two maps.
3307 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
3312 match handle_error!(self, err, path.hops.first().unwrap().pubkey) {
3313 Ok(_) => unreachable!(),
3315 Err(APIError::ChannelUnavailable { err: e.err })
3320 /// Sends a payment along a given route.
3322 /// Value parameters are provided via the last hop in route, see documentation for [`RouteHop`]
3323 /// fields for more info.
3325 /// May generate [`UpdateHTLCs`] message(s) event on success, which should be relayed (e.g. via
3326 /// [`PeerManager::process_events`]).
3328 /// # Avoiding Duplicate Payments
3330 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
3331 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
3332 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
3333 /// [`Event::PaymentSent`] or [`Event::PaymentFailed`]) LDK will not stop you from sending a
3334 /// second payment with the same [`PaymentId`].
3336 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
3337 /// tracking of payments, including state to indicate once a payment has completed. Because you
3338 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
3339 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
3340 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
3342 /// Additionally, in the scenario where we begin the process of sending a payment, but crash
3343 /// before `send_payment` returns (or prior to [`ChannelMonitorUpdate`] persistence if you're
3344 /// using [`ChannelMonitorUpdateStatus::InProgress`]), the payment may be lost on restart. See
3345 /// [`ChannelManager::list_recent_payments`] for more information.
3347 /// # Possible Error States on [`PaymentSendFailure`]
3349 /// Each path may have a different return value, and [`PaymentSendFailure`] may return a `Vec` with
3350 /// each entry matching the corresponding-index entry in the route paths, see
3351 /// [`PaymentSendFailure`] for more info.
3353 /// In general, a path may raise:
3354 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
3355 /// node public key) is specified.
3356 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
3357 /// (including due to previous monitor update failure or new permanent monitor update
3359 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
3360 /// relevant updates.
3362 /// Note that depending on the type of the [`PaymentSendFailure`] the HTLC may have been
3363 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
3364 /// different route unless you intend to pay twice!
3366 /// [`RouteHop`]: crate::routing::router::RouteHop
3367 /// [`Event::PaymentSent`]: events::Event::PaymentSent
3368 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
3369 /// [`UpdateHTLCs`]: events::MessageSendEvent::UpdateHTLCs
3370 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
3371 /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
3372 pub fn send_payment_with_route(&self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
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
3376 .send_payment_with_route(route, payment_hash, recipient_onion, payment_id,
3377 &self.entropy_source, &self.node_signer, best_block_height,
3378 |args| self.send_payment_along_path(args))
3381 /// Similar to [`ChannelManager::send_payment_with_route`], but will automatically find a route based on
3382 /// `route_params` and retry failed payment paths based on `retry_strategy`.
3383 pub fn send_payment(&self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<(), RetryableSendFailure> {
3384 let best_block_height = self.best_block.read().unwrap().height();
3385 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3386 self.pending_outbound_payments
3387 .send_payment(payment_hash, recipient_onion, payment_id, retry_strategy, route_params,
3388 &self.router, self.list_usable_channels(), || self.compute_inflight_htlcs(),
3389 &self.entropy_source, &self.node_signer, best_block_height, &self.logger,
3390 &self.pending_events, |args| self.send_payment_along_path(args))
3394 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> {
3395 let best_block_height = self.best_block.read().unwrap().height();
3396 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3397 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, recipient_onion,
3398 keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.node_signer,
3399 best_block_height, |args| self.send_payment_along_path(args))
3403 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> {
3404 let best_block_height = self.best_block.read().unwrap().height();
3405 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, recipient_onion, payment_id, route, None, &self.entropy_source, best_block_height)
3409 pub(crate) fn test_set_payment_metadata(&self, payment_id: PaymentId, new_payment_metadata: Option<Vec<u8>>) {
3410 self.pending_outbound_payments.test_set_payment_metadata(payment_id, new_payment_metadata);
3414 /// Signals that no further attempts for the given payment should occur. Useful if you have a
3415 /// pending outbound payment with retries remaining, but wish to stop retrying the payment before
3416 /// retries are exhausted.
3418 /// # Event Generation
3420 /// If no [`Event::PaymentFailed`] event had been generated before, one will be generated as soon
3421 /// as there are no remaining pending HTLCs for this payment.
3423 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
3424 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
3425 /// determine the ultimate status of a payment.
3427 /// # Requested Invoices
3429 /// In the case of paying a [`Bolt12Invoice`], abandoning the payment prior to receiving the
3430 /// invoice will result in an [`Event::InvoiceRequestFailed`] and prevent any attempts at paying
3431 /// it once received. The other events may only be generated once the invoice has been received.
3433 /// # Restart Behavior
3435 /// If an [`Event::PaymentFailed`] is generated and we restart without first persisting the
3436 /// [`ChannelManager`], another [`Event::PaymentFailed`] may be generated; likewise for
3437 /// [`Event::InvoiceRequestFailed`].
3439 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
3440 pub fn abandon_payment(&self, payment_id: PaymentId) {
3441 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3442 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
3445 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
3446 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
3447 /// the preimage, it must be a cryptographically secure random value that no intermediate node
3448 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
3449 /// never reach the recipient.
3451 /// See [`send_payment`] documentation for more details on the return value of this function
3452 /// and idempotency guarantees provided by the [`PaymentId`] key.
3454 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
3455 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
3457 /// [`send_payment`]: Self::send_payment
3458 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
3459 let best_block_height = self.best_block.read().unwrap().height();
3460 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3461 self.pending_outbound_payments.send_spontaneous_payment_with_route(
3462 route, payment_preimage, recipient_onion, payment_id, &self.entropy_source,
3463 &self.node_signer, best_block_height, |args| self.send_payment_along_path(args))
3466 /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
3467 /// based on `route_params` and retry failed payment paths based on `retry_strategy`.
3469 /// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous
3472 /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
3473 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> {
3474 let best_block_height = self.best_block.read().unwrap().height();
3475 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3476 self.pending_outbound_payments.send_spontaneous_payment(payment_preimage, recipient_onion,
3477 payment_id, retry_strategy, route_params, &self.router, self.list_usable_channels(),
3478 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
3479 &self.logger, &self.pending_events, |args| self.send_payment_along_path(args))
3482 /// Send a payment that is probing the given route for liquidity. We calculate the
3483 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
3484 /// us to easily discern them from real payments.
3485 pub fn send_probe(&self, path: Path) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
3486 let best_block_height = self.best_block.read().unwrap().height();
3487 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3488 self.pending_outbound_payments.send_probe(path, self.probing_cookie_secret,
3489 &self.entropy_source, &self.node_signer, best_block_height,
3490 |args| self.send_payment_along_path(args))
3493 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
3496 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
3497 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
3500 /// Handles the generation of a funding transaction, optionally (for tests) with a function
3501 /// which checks the correctness of the funding transaction given the associated channel.
3502 fn funding_transaction_generated_intern<FundingOutput: Fn(&OutboundV1Channel<SP>, &Transaction) -> Result<OutPoint, APIError>>(
3503 &self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
3504 ) -> Result<(), APIError> {
3505 let per_peer_state = self.per_peer_state.read().unwrap();
3506 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3507 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3509 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3510 let peer_state = &mut *peer_state_lock;
3511 let (chan, msg) = match peer_state.channel_by_id.remove(temporary_channel_id) {
3512 Some(ChannelPhase::UnfundedOutboundV1(chan)) => {
3513 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
3515 let funding_res = chan.get_funding_created(funding_transaction, funding_txo, &self.logger)
3516 .map_err(|(mut chan, e)| if let ChannelError::Close(msg) = e {
3517 let channel_id = chan.context.channel_id();
3518 let user_id = chan.context.get_user_id();
3519 let shutdown_res = chan.context.force_shutdown(false);
3520 let channel_capacity = chan.context.get_value_satoshis();
3521 (chan, MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, user_id, shutdown_res, None, channel_capacity))
3522 } else { unreachable!(); });
3524 Ok((chan, funding_msg)) => (chan, funding_msg),
3525 Err((chan, err)) => {
3526 mem::drop(peer_state_lock);
3527 mem::drop(per_peer_state);
3529 let _: Result<(), _> = handle_error!(self, Err(err), chan.context.get_counterparty_node_id());
3530 return Err(APIError::ChannelUnavailable {
3531 err: "Signer refused to sign the initial commitment transaction".to_owned()
3537 peer_state.channel_by_id.insert(*temporary_channel_id, phase);
3538 return Err(APIError::APIMisuseError {
3540 "Channel with id {} for the passed counterparty node_id {} is not an unfunded, outbound V1 channel",
3541 temporary_channel_id, counterparty_node_id),
3544 None => return Err(APIError::ChannelUnavailable {err: format!(
3545 "Channel with id {} not found for the passed counterparty node_id {}",
3546 temporary_channel_id, counterparty_node_id),
3550 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
3551 node_id: chan.context.get_counterparty_node_id(),
3554 match peer_state.channel_by_id.entry(chan.context.channel_id()) {
3555 hash_map::Entry::Occupied(_) => {
3556 panic!("Generated duplicate funding txid?");
3558 hash_map::Entry::Vacant(e) => {
3559 let mut id_to_peer = self.id_to_peer.lock().unwrap();
3560 if id_to_peer.insert(chan.context.channel_id(), chan.context.get_counterparty_node_id()).is_some() {
3561 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
3563 e.insert(ChannelPhase::Funded(chan));
3570 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
3571 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
3572 Ok(OutPoint { txid: tx.txid(), index: output_index })
3576 /// Call this upon creation of a funding transaction for the given channel.
3578 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
3579 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
3581 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
3582 /// across the p2p network.
3584 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
3585 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
3587 /// May panic if the output found in the funding transaction is duplicative with some other
3588 /// channel (note that this should be trivially prevented by using unique funding transaction
3589 /// keys per-channel).
3591 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
3592 /// counterparty's signature the funding transaction will automatically be broadcast via the
3593 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
3595 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
3596 /// not currently support replacing a funding transaction on an existing channel. Instead,
3597 /// create a new channel with a conflicting funding transaction.
3599 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
3600 /// the wallet software generating the funding transaction to apply anti-fee sniping as
3601 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
3602 /// for more details.
3604 /// [`Event::FundingGenerationReady`]: crate::events::Event::FundingGenerationReady
3605 /// [`Event::ChannelClosed`]: crate::events::Event::ChannelClosed
3606 pub fn funding_transaction_generated(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
3607 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3609 if !funding_transaction.is_coin_base() {
3610 for inp in funding_transaction.input.iter() {
3611 if inp.witness.is_empty() {
3612 return Err(APIError::APIMisuseError {
3613 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
3619 let height = self.best_block.read().unwrap().height();
3620 // Transactions are evaluated as final by network mempools if their locktime is strictly
3621 // lower than the next block height. However, the modules constituting our Lightning
3622 // node might not have perfect sync about their blockchain views. Thus, if the wallet
3623 // module is ahead of LDK, only allow one more block of headroom.
3624 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 {
3625 return Err(APIError::APIMisuseError {
3626 err: "Funding transaction absolute timelock is non-final".to_owned()
3630 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
3631 if tx.output.len() > u16::max_value() as usize {
3632 return Err(APIError::APIMisuseError {
3633 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
3637 let mut output_index = None;
3638 let expected_spk = chan.context.get_funding_redeemscript().to_v0_p2wsh();
3639 for (idx, outp) in tx.output.iter().enumerate() {
3640 if outp.script_pubkey == expected_spk && outp.value == chan.context.get_value_satoshis() {
3641 if output_index.is_some() {
3642 return Err(APIError::APIMisuseError {
3643 err: "Multiple outputs matched the expected script and value".to_owned()
3646 output_index = Some(idx as u16);
3649 if output_index.is_none() {
3650 return Err(APIError::APIMisuseError {
3651 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
3654 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
3658 /// Atomically applies partial updates to the [`ChannelConfig`] of the given channels.
3660 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3661 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3662 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3663 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3665 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3666 /// `counterparty_node_id` is provided.
3668 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3669 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3671 /// If an error is returned, none of the updates should be considered applied.
3673 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3674 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3675 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3676 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3677 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3678 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3679 /// [`APIMisuseError`]: APIError::APIMisuseError
3680 pub fn update_partial_channel_config(
3681 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config_update: &ChannelConfigUpdate,
3682 ) -> Result<(), APIError> {
3683 if config_update.cltv_expiry_delta.map(|delta| delta < MIN_CLTV_EXPIRY_DELTA).unwrap_or(false) {
3684 return Err(APIError::APIMisuseError {
3685 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
3689 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3690 let per_peer_state = self.per_peer_state.read().unwrap();
3691 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3692 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3693 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3694 let peer_state = &mut *peer_state_lock;
3695 for channel_id in channel_ids {
3696 if !peer_state.has_channel(channel_id) {
3697 return Err(APIError::ChannelUnavailable {
3698 err: format!("Channel with ID {} was not found for the passed counterparty_node_id {}", channel_id, counterparty_node_id),
3702 for channel_id in channel_ids {
3703 if let Some(channel_phase) = peer_state.channel_by_id.get_mut(channel_id) {
3704 let mut config = channel_phase.context().config();
3705 config.apply(config_update);
3706 if !channel_phase.context_mut().update_config(&config) {
3709 if let ChannelPhase::Funded(channel) = channel_phase {
3710 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
3711 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
3712 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
3713 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
3714 node_id: channel.context.get_counterparty_node_id(),
3721 // This should not be reachable as we've already checked for non-existence in the previous channel_id loop.
3722 debug_assert!(false);
3723 return Err(APIError::ChannelUnavailable {
3725 "Channel with ID {} for passed counterparty_node_id {} disappeared after we confirmed its existence - this should not be reachable!",
3726 channel_id, counterparty_node_id),
3733 /// Atomically updates the [`ChannelConfig`] for the given channels.
3735 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3736 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3737 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3738 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3740 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3741 /// `counterparty_node_id` is provided.
3743 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3744 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3746 /// If an error is returned, none of the updates should be considered applied.
3748 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3749 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3750 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3751 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3752 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3753 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3754 /// [`APIMisuseError`]: APIError::APIMisuseError
3755 pub fn update_channel_config(
3756 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config: &ChannelConfig,
3757 ) -> Result<(), APIError> {
3758 return self.update_partial_channel_config(counterparty_node_id, channel_ids, &(*config).into());
3761 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
3762 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
3764 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
3765 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
3767 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
3768 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
3769 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
3770 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
3771 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
3773 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
3774 /// you from forwarding more than you received. See
3775 /// [`HTLCIntercepted::expected_outbound_amount_msat`] for more on forwarding a different amount
3778 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
3781 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
3782 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
3783 /// [`HTLCIntercepted::expected_outbound_amount_msat`]: events::Event::HTLCIntercepted::expected_outbound_amount_msat
3784 // TODO: when we move to deciding the best outbound channel at forward time, only take
3785 // `next_node_id` and not `next_hop_channel_id`
3786 pub fn forward_intercepted_htlc(&self, intercept_id: InterceptId, next_hop_channel_id: &ChannelId, next_node_id: PublicKey, amt_to_forward_msat: u64) -> Result<(), APIError> {
3787 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3789 let next_hop_scid = {
3790 let peer_state_lock = self.per_peer_state.read().unwrap();
3791 let peer_state_mutex = peer_state_lock.get(&next_node_id)
3792 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) })?;
3793 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3794 let peer_state = &mut *peer_state_lock;
3795 match peer_state.channel_by_id.get(next_hop_channel_id) {
3796 Some(ChannelPhase::Funded(chan)) => {
3797 if !chan.context.is_usable() {
3798 return Err(APIError::ChannelUnavailable {
3799 err: format!("Channel with id {} not fully established", next_hop_channel_id)
3802 chan.context.get_short_channel_id().unwrap_or(chan.context.outbound_scid_alias())
3804 Some(_) => return Err(APIError::ChannelUnavailable {
3805 err: format!("Channel with id {} for the passed counterparty node_id {} is still opening.",
3806 next_hop_channel_id, next_node_id)
3808 None => return Err(APIError::ChannelUnavailable {
3809 err: format!("Channel with id {} not found for the passed counterparty node_id {}.",
3810 next_hop_channel_id, next_node_id)
3815 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
3816 .ok_or_else(|| APIError::APIMisuseError {
3817 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
3820 let routing = match payment.forward_info.routing {
3821 PendingHTLCRouting::Forward { onion_packet, .. } => {
3822 PendingHTLCRouting::Forward { onion_packet, short_channel_id: next_hop_scid }
3824 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
3826 let skimmed_fee_msat =
3827 payment.forward_info.outgoing_amt_msat.saturating_sub(amt_to_forward_msat);
3828 let pending_htlc_info = PendingHTLCInfo {
3829 skimmed_fee_msat: if skimmed_fee_msat == 0 { None } else { Some(skimmed_fee_msat) },
3830 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
3833 let mut per_source_pending_forward = [(
3834 payment.prev_short_channel_id,
3835 payment.prev_funding_outpoint,
3836 payment.prev_user_channel_id,
3837 vec![(pending_htlc_info, payment.prev_htlc_id)]
3839 self.forward_htlcs(&mut per_source_pending_forward);
3843 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
3844 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
3846 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
3849 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
3850 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
3851 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3853 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
3854 .ok_or_else(|| APIError::APIMisuseError {
3855 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
3858 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
3859 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3860 short_channel_id: payment.prev_short_channel_id,
3861 user_channel_id: Some(payment.prev_user_channel_id),
3862 outpoint: payment.prev_funding_outpoint,
3863 htlc_id: payment.prev_htlc_id,
3864 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
3865 phantom_shared_secret: None,
3868 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
3869 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
3870 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
3871 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
3876 /// Processes HTLCs which are pending waiting on random forward delay.
3878 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
3879 /// Will likely generate further events.
3880 pub fn process_pending_htlc_forwards(&self) {
3881 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3883 let mut new_events = VecDeque::new();
3884 let mut failed_forwards = Vec::new();
3885 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
3887 let mut forward_htlcs = HashMap::new();
3888 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
3890 for (short_chan_id, mut pending_forwards) in forward_htlcs {
3891 if short_chan_id != 0 {
3892 macro_rules! forwarding_channel_not_found {
3894 for forward_info in pending_forwards.drain(..) {
3895 match forward_info {
3896 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3897 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3898 forward_info: PendingHTLCInfo {
3899 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
3900 outgoing_cltv_value, ..
3903 macro_rules! failure_handler {
3904 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
3905 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3907 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3908 short_channel_id: prev_short_channel_id,
3909 user_channel_id: Some(prev_user_channel_id),
3910 outpoint: prev_funding_outpoint,
3911 htlc_id: prev_htlc_id,
3912 incoming_packet_shared_secret: incoming_shared_secret,
3913 phantom_shared_secret: $phantom_ss,
3916 let reason = if $next_hop_unknown {
3917 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
3919 HTLCDestination::FailedPayment{ payment_hash }
3922 failed_forwards.push((htlc_source, payment_hash,
3923 HTLCFailReason::reason($err_code, $err_data),
3929 macro_rules! fail_forward {
3930 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3932 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
3936 macro_rules! failed_payment {
3937 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3939 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
3943 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
3944 let phantom_pubkey_res = self.node_signer.get_node_id(Recipient::PhantomNode);
3945 if phantom_pubkey_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.genesis_hash) {
3946 let phantom_shared_secret = self.node_signer.ecdh(Recipient::PhantomNode, &onion_packet.public_key.unwrap(), None).unwrap().secret_bytes();
3947 let next_hop = match onion_utils::decode_next_payment_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
3949 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
3950 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
3951 // In this scenario, the phantom would have sent us an
3952 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
3953 // if it came from us (the second-to-last hop) but contains the sha256
3955 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
3957 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3958 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
3962 onion_utils::Hop::Receive(hop_data) => {
3963 match self.construct_recv_pending_htlc_info(hop_data,
3964 incoming_shared_secret, payment_hash, outgoing_amt_msat,
3965 outgoing_cltv_value, Some(phantom_shared_secret), false, None)
3967 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
3968 Err(InboundOnionErr { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
3974 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3977 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3980 HTLCForwardInfo::FailHTLC { .. } => {
3981 // Channel went away before we could fail it. This implies
3982 // the channel is now on chain and our counterparty is
3983 // trying to broadcast the HTLC-Timeout, but that's their
3984 // problem, not ours.
3990 let (counterparty_node_id, forward_chan_id) = match self.short_to_chan_info.read().unwrap().get(&short_chan_id) {
3991 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3993 forwarding_channel_not_found!();
3997 let per_peer_state = self.per_peer_state.read().unwrap();
3998 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3999 if peer_state_mutex_opt.is_none() {
4000 forwarding_channel_not_found!();
4003 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4004 let peer_state = &mut *peer_state_lock;
4005 if let Some(ChannelPhase::Funded(ref mut chan)) = peer_state.channel_by_id.get_mut(&forward_chan_id) {
4006 for forward_info in pending_forwards.drain(..) {
4007 match forward_info {
4008 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4009 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4010 forward_info: PendingHTLCInfo {
4011 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
4012 routing: PendingHTLCRouting::Forward { onion_packet, .. }, skimmed_fee_msat, ..
4015 log_trace!(self.logger, "Adding HTLC from short id {} with payment_hash {} to channel with short id {} after delay", prev_short_channel_id, &payment_hash, short_chan_id);
4016 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4017 short_channel_id: prev_short_channel_id,
4018 user_channel_id: Some(prev_user_channel_id),
4019 outpoint: prev_funding_outpoint,
4020 htlc_id: prev_htlc_id,
4021 incoming_packet_shared_secret: incoming_shared_secret,
4022 // Phantom payments are only PendingHTLCRouting::Receive.
4023 phantom_shared_secret: None,
4025 if let Err(e) = chan.queue_add_htlc(outgoing_amt_msat,
4026 payment_hash, outgoing_cltv_value, htlc_source.clone(),
4027 onion_packet, skimmed_fee_msat, &self.fee_estimator,
4030 if let ChannelError::Ignore(msg) = e {
4031 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", &payment_hash, msg);
4033 panic!("Stated return value requirements in send_htlc() were not met");
4035 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan);
4036 failed_forwards.push((htlc_source, payment_hash,
4037 HTLCFailReason::reason(failure_code, data),
4038 HTLCDestination::NextHopChannel { node_id: Some(chan.context.get_counterparty_node_id()), channel_id: forward_chan_id }
4043 HTLCForwardInfo::AddHTLC { .. } => {
4044 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
4046 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
4047 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
4048 if let Err(e) = chan.queue_fail_htlc(
4049 htlc_id, err_packet, &self.logger
4051 if let ChannelError::Ignore(msg) = e {
4052 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
4054 panic!("Stated return value requirements in queue_fail_htlc() were not met");
4056 // fail-backs are best-effort, we probably already have one
4057 // pending, and if not that's OK, if not, the channel is on
4058 // the chain and sending the HTLC-Timeout is their problem.
4065 forwarding_channel_not_found!();
4069 'next_forwardable_htlc: for forward_info in pending_forwards.drain(..) {
4070 match forward_info {
4071 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4072 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4073 forward_info: PendingHTLCInfo {
4074 routing, incoming_shared_secret, payment_hash, incoming_amt_msat, outgoing_amt_msat,
4075 skimmed_fee_msat, ..
4078 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret, mut onion_fields) = match routing {
4079 PendingHTLCRouting::Receive { payment_data, payment_metadata, incoming_cltv_expiry, phantom_shared_secret, custom_tlvs } => {
4080 let _legacy_hop_data = Some(payment_data.clone());
4081 let onion_fields = RecipientOnionFields { payment_secret: Some(payment_data.payment_secret),
4082 payment_metadata, custom_tlvs };
4083 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data },
4084 Some(payment_data), phantom_shared_secret, onion_fields)
4086 PendingHTLCRouting::ReceiveKeysend { payment_data, payment_preimage, payment_metadata, incoming_cltv_expiry, custom_tlvs } => {
4087 let onion_fields = RecipientOnionFields {
4088 payment_secret: payment_data.as_ref().map(|data| data.payment_secret),
4092 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage),
4093 payment_data, None, onion_fields)
4096 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
4099 let claimable_htlc = ClaimableHTLC {
4100 prev_hop: HTLCPreviousHopData {
4101 short_channel_id: prev_short_channel_id,
4102 user_channel_id: Some(prev_user_channel_id),
4103 outpoint: prev_funding_outpoint,
4104 htlc_id: prev_htlc_id,
4105 incoming_packet_shared_secret: incoming_shared_secret,
4106 phantom_shared_secret,
4108 // We differentiate the received value from the sender intended value
4109 // if possible so that we don't prematurely mark MPP payments complete
4110 // if routing nodes overpay
4111 value: incoming_amt_msat.unwrap_or(outgoing_amt_msat),
4112 sender_intended_value: outgoing_amt_msat,
4114 total_value_received: None,
4115 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
4118 counterparty_skimmed_fee_msat: skimmed_fee_msat,
4121 let mut committed_to_claimable = false;
4123 macro_rules! fail_htlc {
4124 ($htlc: expr, $payment_hash: expr) => {
4125 debug_assert!(!committed_to_claimable);
4126 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
4127 htlc_msat_height_data.extend_from_slice(
4128 &self.best_block.read().unwrap().height().to_be_bytes(),
4130 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
4131 short_channel_id: $htlc.prev_hop.short_channel_id,
4132 user_channel_id: $htlc.prev_hop.user_channel_id,
4133 outpoint: prev_funding_outpoint,
4134 htlc_id: $htlc.prev_hop.htlc_id,
4135 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
4136 phantom_shared_secret,
4138 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
4139 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
4141 continue 'next_forwardable_htlc;
4144 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
4145 let mut receiver_node_id = self.our_network_pubkey;
4146 if phantom_shared_secret.is_some() {
4147 receiver_node_id = self.node_signer.get_node_id(Recipient::PhantomNode)
4148 .expect("Failed to get node_id for phantom node recipient");
4151 macro_rules! check_total_value {
4152 ($purpose: expr) => {{
4153 let mut payment_claimable_generated = false;
4154 let is_keysend = match $purpose {
4155 events::PaymentPurpose::SpontaneousPayment(_) => true,
4156 events::PaymentPurpose::InvoicePayment { .. } => false,
4158 let mut claimable_payments = self.claimable_payments.lock().unwrap();
4159 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
4160 fail_htlc!(claimable_htlc, payment_hash);
4162 let ref mut claimable_payment = claimable_payments.claimable_payments
4163 .entry(payment_hash)
4164 // Note that if we insert here we MUST NOT fail_htlc!()
4165 .or_insert_with(|| {
4166 committed_to_claimable = true;
4168 purpose: $purpose.clone(), htlcs: Vec::new(), onion_fields: None,
4171 if $purpose != claimable_payment.purpose {
4172 let log_keysend = |keysend| if keysend { "keysend" } else { "non-keysend" };
4173 log_trace!(self.logger, "Failing new {} HTLC with payment_hash {} as we already had an existing {} HTLC with the same payment hash", log_keysend(is_keysend), &payment_hash, log_keysend(!is_keysend));
4174 fail_htlc!(claimable_htlc, payment_hash);
4176 if !self.default_configuration.accept_mpp_keysend && is_keysend && !claimable_payment.htlcs.is_empty() {
4177 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} as we already had an existing keysend HTLC with the same payment hash and our config states we don't accept MPP keysend", &payment_hash);
4178 fail_htlc!(claimable_htlc, payment_hash);
4180 if let Some(earlier_fields) = &mut claimable_payment.onion_fields {
4181 if earlier_fields.check_merge(&mut onion_fields).is_err() {
4182 fail_htlc!(claimable_htlc, payment_hash);
4185 claimable_payment.onion_fields = Some(onion_fields);
4187 let ref mut htlcs = &mut claimable_payment.htlcs;
4188 let mut total_value = claimable_htlc.sender_intended_value;
4189 let mut earliest_expiry = claimable_htlc.cltv_expiry;
4190 for htlc in htlcs.iter() {
4191 total_value += htlc.sender_intended_value;
4192 earliest_expiry = cmp::min(earliest_expiry, htlc.cltv_expiry);
4193 if htlc.total_msat != claimable_htlc.total_msat {
4194 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
4195 &payment_hash, claimable_htlc.total_msat, htlc.total_msat);
4196 total_value = msgs::MAX_VALUE_MSAT;
4198 if total_value >= msgs::MAX_VALUE_MSAT { break; }
4200 // The condition determining whether an MPP is complete must
4201 // match exactly the condition used in `timer_tick_occurred`
4202 if total_value >= msgs::MAX_VALUE_MSAT {
4203 fail_htlc!(claimable_htlc, payment_hash);
4204 } else if total_value - claimable_htlc.sender_intended_value >= claimable_htlc.total_msat {
4205 log_trace!(self.logger, "Failing HTLC with payment_hash {} as payment is already claimable",
4207 fail_htlc!(claimable_htlc, payment_hash);
4208 } else if total_value >= claimable_htlc.total_msat {
4209 #[allow(unused_assignments)] {
4210 committed_to_claimable = true;
4212 let prev_channel_id = prev_funding_outpoint.to_channel_id();
4213 htlcs.push(claimable_htlc);
4214 let amount_msat = htlcs.iter().map(|htlc| htlc.value).sum();
4215 htlcs.iter_mut().for_each(|htlc| htlc.total_value_received = Some(amount_msat));
4216 let counterparty_skimmed_fee_msat = htlcs.iter()
4217 .map(|htlc| htlc.counterparty_skimmed_fee_msat.unwrap_or(0)).sum();
4218 debug_assert!(total_value.saturating_sub(amount_msat) <=
4219 counterparty_skimmed_fee_msat);
4220 new_events.push_back((events::Event::PaymentClaimable {
4221 receiver_node_id: Some(receiver_node_id),
4225 counterparty_skimmed_fee_msat,
4226 via_channel_id: Some(prev_channel_id),
4227 via_user_channel_id: Some(prev_user_channel_id),
4228 claim_deadline: Some(earliest_expiry - HTLC_FAIL_BACK_BUFFER),
4229 onion_fields: claimable_payment.onion_fields.clone(),
4231 payment_claimable_generated = true;
4233 // Nothing to do - we haven't reached the total
4234 // payment value yet, wait until we receive more
4236 htlcs.push(claimable_htlc);
4237 #[allow(unused_assignments)] {
4238 committed_to_claimable = true;
4241 payment_claimable_generated
4245 // Check that the payment hash and secret are known. Note that we
4246 // MUST take care to handle the "unknown payment hash" and
4247 // "incorrect payment secret" cases here identically or we'd expose
4248 // that we are the ultimate recipient of the given payment hash.
4249 // Further, we must not expose whether we have any other HTLCs
4250 // associated with the same payment_hash pending or not.
4251 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4252 match payment_secrets.entry(payment_hash) {
4253 hash_map::Entry::Vacant(_) => {
4254 match claimable_htlc.onion_payload {
4255 OnionPayload::Invoice { .. } => {
4256 let payment_data = payment_data.unwrap();
4257 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) {
4258 Ok(result) => result,
4260 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as payment verification failed", &payment_hash);
4261 fail_htlc!(claimable_htlc, payment_hash);
4264 if let Some(min_final_cltv_expiry_delta) = min_final_cltv_expiry_delta {
4265 let expected_min_expiry_height = (self.current_best_block().height() + min_final_cltv_expiry_delta as u32) as u64;
4266 if (cltv_expiry as u64) < expected_min_expiry_height {
4267 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as its CLTV expiry was too soon (had {}, earliest expected {})",
4268 &payment_hash, cltv_expiry, expected_min_expiry_height);
4269 fail_htlc!(claimable_htlc, payment_hash);
4272 let purpose = events::PaymentPurpose::InvoicePayment {
4273 payment_preimage: payment_preimage.clone(),
4274 payment_secret: payment_data.payment_secret,
4276 check_total_value!(purpose);
4278 OnionPayload::Spontaneous(preimage) => {
4279 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
4280 check_total_value!(purpose);
4284 hash_map::Entry::Occupied(inbound_payment) => {
4285 if let OnionPayload::Spontaneous(_) = claimable_htlc.onion_payload {
4286 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} because we already have an inbound payment with the same payment hash", &payment_hash);
4287 fail_htlc!(claimable_htlc, payment_hash);
4289 let payment_data = payment_data.unwrap();
4290 if inbound_payment.get().payment_secret != payment_data.payment_secret {
4291 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", &payment_hash);
4292 fail_htlc!(claimable_htlc, payment_hash);
4293 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
4294 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
4295 &payment_hash, payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
4296 fail_htlc!(claimable_htlc, payment_hash);
4298 let purpose = events::PaymentPurpose::InvoicePayment {
4299 payment_preimage: inbound_payment.get().payment_preimage,
4300 payment_secret: payment_data.payment_secret,
4302 let payment_claimable_generated = check_total_value!(purpose);
4303 if payment_claimable_generated {
4304 inbound_payment.remove_entry();
4310 HTLCForwardInfo::FailHTLC { .. } => {
4311 panic!("Got pending fail of our own HTLC");
4319 let best_block_height = self.best_block.read().unwrap().height();
4320 self.pending_outbound_payments.check_retry_payments(&self.router, || self.list_usable_channels(),
4321 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
4322 &self.pending_events, &self.logger, |args| self.send_payment_along_path(args));
4324 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
4325 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4327 self.forward_htlcs(&mut phantom_receives);
4329 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
4330 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
4331 // nice to do the work now if we can rather than while we're trying to get messages in the
4333 self.check_free_holding_cells();
4335 if new_events.is_empty() { return }
4336 let mut events = self.pending_events.lock().unwrap();
4337 events.append(&mut new_events);
4340 /// Free the background events, generally called from [`PersistenceNotifierGuard`] constructors.
4342 /// Expects the caller to have a total_consistency_lock read lock.
4343 fn process_background_events(&self) -> NotifyOption {
4344 debug_assert_ne!(self.total_consistency_lock.held_by_thread(), LockHeldState::NotHeldByThread);
4346 self.background_events_processed_since_startup.store(true, Ordering::Release);
4348 let mut background_events = Vec::new();
4349 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
4350 if background_events.is_empty() {
4351 return NotifyOption::SkipPersist;
4354 for event in background_events.drain(..) {
4356 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((funding_txo, update)) => {
4357 // The channel has already been closed, so no use bothering to care about the
4358 // monitor updating completing.
4359 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4361 BackgroundEvent::MonitorUpdateRegeneratedOnStartup { counterparty_node_id, funding_txo, update } => {
4362 let mut updated_chan = false;
4364 let per_peer_state = self.per_peer_state.read().unwrap();
4365 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4366 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4367 let peer_state = &mut *peer_state_lock;
4368 match peer_state.channel_by_id.entry(funding_txo.to_channel_id()) {
4369 hash_map::Entry::Occupied(mut chan_phase) => {
4370 updated_chan = true;
4371 handle_new_monitor_update!(self, funding_txo, update.clone(),
4372 peer_state_lock, peer_state, per_peer_state, chan_phase).map(|_| ())
4374 hash_map::Entry::Vacant(_) => Ok(()),
4379 // TODO: Track this as in-flight even though the channel is closed.
4380 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4382 // TODO: If this channel has since closed, we're likely providing a payment
4383 // preimage update, which we must ensure is durable! We currently don't,
4384 // however, ensure that.
4386 log_error!(self.logger,
4387 "Failed to provide ChannelMonitorUpdate to closed channel! This likely lost us a payment preimage!");
4389 let _ = handle_error!(self, res, counterparty_node_id);
4391 BackgroundEvent::MonitorUpdatesComplete { counterparty_node_id, channel_id } => {
4392 let per_peer_state = self.per_peer_state.read().unwrap();
4393 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4394 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4395 let peer_state = &mut *peer_state_lock;
4396 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&channel_id) {
4397 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, chan);
4399 let update_actions = peer_state.monitor_update_blocked_actions
4400 .remove(&channel_id).unwrap_or(Vec::new());
4401 mem::drop(peer_state_lock);
4402 mem::drop(per_peer_state);
4403 self.handle_monitor_update_completion_actions(update_actions);
4409 NotifyOption::DoPersist
4412 #[cfg(any(test, feature = "_test_utils"))]
4413 /// Process background events, for functional testing
4414 pub fn test_process_background_events(&self) {
4415 let _lck = self.total_consistency_lock.read().unwrap();
4416 let _ = self.process_background_events();
4419 fn update_channel_fee(&self, chan_id: &ChannelId, chan: &mut Channel<SP>, new_feerate: u32) -> NotifyOption {
4420 if !chan.context.is_outbound() { return NotifyOption::SkipPersist; }
4421 // If the feerate has decreased by less than half, don't bother
4422 if new_feerate <= chan.context.get_feerate_sat_per_1000_weight() && new_feerate * 2 > chan.context.get_feerate_sat_per_1000_weight() {
4423 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
4424 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4425 return NotifyOption::SkipPersist;
4427 if !chan.context.is_live() {
4428 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).",
4429 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4430 return NotifyOption::SkipPersist;
4432 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
4433 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4435 chan.queue_update_fee(new_feerate, &self.fee_estimator, &self.logger);
4436 NotifyOption::DoPersist
4440 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
4441 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
4442 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
4443 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
4444 pub fn maybe_update_chan_fees(&self) {
4445 PersistenceNotifierGuard::optionally_notify(self, || {
4446 let mut should_persist = NotifyOption::SkipPersist;
4448 let normal_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4449 let min_mempool_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::MempoolMinimum);
4451 let per_peer_state = self.per_peer_state.read().unwrap();
4452 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
4453 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4454 let peer_state = &mut *peer_state_lock;
4455 for (chan_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
4456 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
4458 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4463 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4464 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4472 /// Performs actions which should happen on startup and roughly once per minute thereafter.
4474 /// This currently includes:
4475 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
4476 /// * Broadcasting [`ChannelUpdate`] messages if we've been disconnected from our peer for more
4477 /// than a minute, informing the network that they should no longer attempt to route over
4479 /// * Expiring a channel's previous [`ChannelConfig`] if necessary to only allow forwarding HTLCs
4480 /// with the current [`ChannelConfig`].
4481 /// * Removing peers which have disconnected but and no longer have any channels.
4482 /// * Force-closing and removing channels which have not completed establishment in a timely manner.
4484 /// Note that this may cause reentrancy through [`chain::Watch::update_channel`] calls or feerate
4485 /// estimate fetches.
4487 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4488 /// [`ChannelConfig`]: crate::util::config::ChannelConfig
4489 pub fn timer_tick_occurred(&self) {
4490 PersistenceNotifierGuard::optionally_notify(self, || {
4491 let mut should_persist = NotifyOption::SkipPersist;
4493 let normal_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4494 let min_mempool_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::MempoolMinimum);
4496 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
4497 let mut timed_out_mpp_htlcs = Vec::new();
4498 let mut pending_peers_awaiting_removal = Vec::new();
4500 let process_unfunded_channel_tick = |
4501 chan_id: &ChannelId,
4502 context: &mut ChannelContext<SP>,
4503 unfunded_context: &mut UnfundedChannelContext,
4504 pending_msg_events: &mut Vec<MessageSendEvent>,
4505 counterparty_node_id: PublicKey,
4507 context.maybe_expire_prev_config();
4508 if unfunded_context.should_expire_unfunded_channel() {
4509 log_error!(self.logger,
4510 "Force-closing pending channel with ID {} for not establishing in a timely manner", chan_id);
4511 update_maps_on_chan_removal!(self, &context);
4512 self.issue_channel_close_events(&context, ClosureReason::HolderForceClosed);
4513 self.finish_force_close_channel(context.force_shutdown(false));
4514 pending_msg_events.push(MessageSendEvent::HandleError {
4515 node_id: counterparty_node_id,
4516 action: msgs::ErrorAction::SendErrorMessage {
4517 msg: msgs::ErrorMessage {
4518 channel_id: *chan_id,
4519 data: "Force-closing pending channel due to timeout awaiting establishment handshake".to_owned(),
4530 let per_peer_state = self.per_peer_state.read().unwrap();
4531 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
4532 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4533 let peer_state = &mut *peer_state_lock;
4534 let pending_msg_events = &mut peer_state.pending_msg_events;
4535 let counterparty_node_id = *counterparty_node_id;
4536 peer_state.channel_by_id.retain(|chan_id, phase| {
4538 ChannelPhase::Funded(chan) => {
4539 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4544 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4545 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4547 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
4548 let (needs_close, err) = convert_chan_phase_err!(self, e, chan, chan_id, FUNDED_CHANNEL);
4549 handle_errors.push((Err(err), counterparty_node_id));
4550 if needs_close { return false; }
4553 match chan.channel_update_status() {
4554 ChannelUpdateStatus::Enabled if !chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(0)),
4555 ChannelUpdateStatus::Disabled if chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(0)),
4556 ChannelUpdateStatus::DisabledStaged(_) if chan.context.is_live()
4557 => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
4558 ChannelUpdateStatus::EnabledStaged(_) if !chan.context.is_live()
4559 => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
4560 ChannelUpdateStatus::DisabledStaged(mut n) if !chan.context.is_live() => {
4562 if n >= DISABLE_GOSSIP_TICKS {
4563 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
4564 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4565 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4569 should_persist = NotifyOption::DoPersist;
4571 chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(n));
4574 ChannelUpdateStatus::EnabledStaged(mut n) if chan.context.is_live() => {
4576 if n >= ENABLE_GOSSIP_TICKS {
4577 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
4578 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4579 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4583 should_persist = NotifyOption::DoPersist;
4585 chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(n));
4591 chan.context.maybe_expire_prev_config();
4593 if chan.should_disconnect_peer_awaiting_response() {
4594 log_debug!(self.logger, "Disconnecting peer {} due to not making any progress on channel {}",
4595 counterparty_node_id, chan_id);
4596 pending_msg_events.push(MessageSendEvent::HandleError {
4597 node_id: counterparty_node_id,
4598 action: msgs::ErrorAction::DisconnectPeerWithWarning {
4599 msg: msgs::WarningMessage {
4600 channel_id: *chan_id,
4601 data: "Disconnecting due to timeout awaiting response".to_owned(),
4609 ChannelPhase::UnfundedInboundV1(chan) => {
4610 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
4611 pending_msg_events, counterparty_node_id)
4613 ChannelPhase::UnfundedOutboundV1(chan) => {
4614 process_unfunded_channel_tick(chan_id, &mut chan.context, &mut chan.unfunded_context,
4615 pending_msg_events, counterparty_node_id)
4620 for (chan_id, req) in peer_state.inbound_channel_request_by_id.iter_mut() {
4621 if { req.ticks_remaining -= 1 ; req.ticks_remaining } <= 0 {
4622 log_error!(self.logger, "Force-closing unaccepted inbound channel {} for not accepting in a timely manner", &chan_id);
4623 peer_state.pending_msg_events.push(
4624 events::MessageSendEvent::HandleError {
4625 node_id: counterparty_node_id,
4626 action: msgs::ErrorAction::SendErrorMessage {
4627 msg: msgs::ErrorMessage { channel_id: chan_id.clone(), data: "Channel force-closed".to_owned() }
4633 peer_state.inbound_channel_request_by_id.retain(|_, req| req.ticks_remaining > 0);
4635 if peer_state.ok_to_remove(true) {
4636 pending_peers_awaiting_removal.push(counterparty_node_id);
4641 // When a peer disconnects but still has channels, the peer's `peer_state` entry in the
4642 // `per_peer_state` is not removed by the `peer_disconnected` function. If the channels
4643 // of to that peer is later closed while still being disconnected (i.e. force closed),
4644 // we therefore need to remove the peer from `peer_state` separately.
4645 // To avoid having to take the `per_peer_state` `write` lock once the channels are
4646 // closed, we instead remove such peers awaiting removal here on a timer, to limit the
4647 // negative effects on parallelism as much as possible.
4648 if pending_peers_awaiting_removal.len() > 0 {
4649 let mut per_peer_state = self.per_peer_state.write().unwrap();
4650 for counterparty_node_id in pending_peers_awaiting_removal {
4651 match per_peer_state.entry(counterparty_node_id) {
4652 hash_map::Entry::Occupied(entry) => {
4653 // Remove the entry if the peer is still disconnected and we still
4654 // have no channels to the peer.
4655 let remove_entry = {
4656 let peer_state = entry.get().lock().unwrap();
4657 peer_state.ok_to_remove(true)
4660 entry.remove_entry();
4663 hash_map::Entry::Vacant(_) => { /* The PeerState has already been removed */ }
4668 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
4669 if payment.htlcs.is_empty() {
4670 // This should be unreachable
4671 debug_assert!(false);
4674 if let OnionPayload::Invoice { .. } = payment.htlcs[0].onion_payload {
4675 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
4676 // In this case we're not going to handle any timeouts of the parts here.
4677 // This condition determining whether the MPP is complete here must match
4678 // exactly the condition used in `process_pending_htlc_forwards`.
4679 if payment.htlcs[0].total_msat <= payment.htlcs.iter()
4680 .fold(0, |total, htlc| total + htlc.sender_intended_value)
4683 } else if payment.htlcs.iter_mut().any(|htlc| {
4684 htlc.timer_ticks += 1;
4685 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
4687 timed_out_mpp_htlcs.extend(payment.htlcs.drain(..)
4688 .map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
4695 for htlc_source in timed_out_mpp_htlcs.drain(..) {
4696 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
4697 let reason = HTLCFailReason::from_failure_code(23);
4698 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
4699 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
4702 for (err, counterparty_node_id) in handle_errors.drain(..) {
4703 let _ = handle_error!(self, err, counterparty_node_id);
4706 self.pending_outbound_payments.remove_stale_payments(&self.pending_events);
4708 // Technically we don't need to do this here, but if we have holding cell entries in a
4709 // channel that need freeing, it's better to do that here and block a background task
4710 // than block the message queueing pipeline.
4711 if self.check_free_holding_cells() {
4712 should_persist = NotifyOption::DoPersist;
4719 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
4720 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
4721 /// along the path (including in our own channel on which we received it).
4723 /// Note that in some cases around unclean shutdown, it is possible the payment may have
4724 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
4725 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
4726 /// may have already been failed automatically by LDK if it was nearing its expiration time.
4728 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
4729 /// [`ChannelManager::claim_funds`]), you should still monitor for
4730 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
4731 /// startup during which time claims that were in-progress at shutdown may be replayed.
4732 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
4733 self.fail_htlc_backwards_with_reason(payment_hash, FailureCode::IncorrectOrUnknownPaymentDetails);
4736 /// This is a variant of [`ChannelManager::fail_htlc_backwards`] that allows you to specify the
4737 /// reason for the failure.
4739 /// See [`FailureCode`] for valid failure codes.
4740 pub fn fail_htlc_backwards_with_reason(&self, payment_hash: &PaymentHash, failure_code: FailureCode) {
4741 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4743 let removed_source = self.claimable_payments.lock().unwrap().claimable_payments.remove(payment_hash);
4744 if let Some(payment) = removed_source {
4745 for htlc in payment.htlcs {
4746 let reason = self.get_htlc_fail_reason_from_failure_code(failure_code, &htlc);
4747 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
4748 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
4749 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
4754 /// Gets error data to form an [`HTLCFailReason`] given a [`FailureCode`] and [`ClaimableHTLC`].
4755 fn get_htlc_fail_reason_from_failure_code(&self, failure_code: FailureCode, htlc: &ClaimableHTLC) -> HTLCFailReason {
4756 match failure_code {
4757 FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(failure_code.into()),
4758 FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(failure_code.into()),
4759 FailureCode::IncorrectOrUnknownPaymentDetails => {
4760 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
4761 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
4762 HTLCFailReason::reason(failure_code.into(), htlc_msat_height_data)
4764 FailureCode::InvalidOnionPayload(data) => {
4765 let fail_data = match data {
4766 Some((typ, offset)) => [BigSize(typ).encode(), offset.encode()].concat(),
4769 HTLCFailReason::reason(failure_code.into(), fail_data)
4774 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
4775 /// that we want to return and a channel.
4777 /// This is for failures on the channel on which the HTLC was *received*, not failures
4779 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<SP>) -> (u16, Vec<u8>) {
4780 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
4781 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
4782 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
4783 // an inbound SCID alias before the real SCID.
4784 let scid_pref = if chan.context.should_announce() {
4785 chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias())
4787 chan.context.latest_inbound_scid_alias().or(chan.context.get_short_channel_id())
4789 if let Some(scid) = scid_pref {
4790 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
4792 (0x4000|10, Vec::new())
4797 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
4798 /// that we want to return and a channel.
4799 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<SP>) -> (u16, Vec<u8>) {
4800 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
4801 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
4802 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
4803 if desired_err_code == 0x1000 | 20 {
4804 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
4805 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
4806 0u16.write(&mut enc).expect("Writes cannot fail");
4808 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
4809 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
4810 upd.write(&mut enc).expect("Writes cannot fail");
4811 (desired_err_code, enc.0)
4813 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
4814 // which means we really shouldn't have gotten a payment to be forwarded over this
4815 // channel yet, or if we did it's from a route hint. Either way, returning an error of
4816 // PERM|no_such_channel should be fine.
4817 (0x4000|10, Vec::new())
4821 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
4822 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
4823 // be surfaced to the user.
4824 fn fail_holding_cell_htlcs(
4825 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: ChannelId,
4826 counterparty_node_id: &PublicKey
4828 let (failure_code, onion_failure_data) = {
4829 let per_peer_state = self.per_peer_state.read().unwrap();
4830 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4831 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4832 let peer_state = &mut *peer_state_lock;
4833 match peer_state.channel_by_id.entry(channel_id) {
4834 hash_map::Entry::Occupied(chan_phase_entry) => {
4835 if let ChannelPhase::Funded(chan) = chan_phase_entry.get() {
4836 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan)
4838 // We shouldn't be trying to fail holding cell HTLCs on an unfunded channel.
4839 debug_assert!(false);
4840 (0x4000|10, Vec::new())
4843 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
4845 } else { (0x4000|10, Vec::new()) }
4848 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
4849 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
4850 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
4851 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
4855 /// Fails an HTLC backwards to the sender of it to us.
4856 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
4857 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
4858 // Ensure that no peer state channel storage lock is held when calling this function.
4859 // This ensures that future code doesn't introduce a lock-order requirement for
4860 // `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
4861 // this function with any `per_peer_state` peer lock acquired would.
4862 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
4863 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
4866 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
4867 //identify whether we sent it or not based on the (I presume) very different runtime
4868 //between the branches here. We should make this async and move it into the forward HTLCs
4871 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4872 // from block_connected which may run during initialization prior to the chain_monitor
4873 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
4875 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, .. } => {
4876 if self.pending_outbound_payments.fail_htlc(source, payment_hash, onion_error, path,
4877 session_priv, payment_id, self.probing_cookie_secret, &self.secp_ctx,
4878 &self.pending_events, &self.logger)
4879 { self.push_pending_forwards_ev(); }
4881 HTLCSource::PreviousHopData(HTLCPreviousHopData { ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret, ref phantom_shared_secret, ref outpoint, .. }) => {
4882 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with {:?}", &payment_hash, onion_error);
4883 let err_packet = onion_error.get_encrypted_failure_packet(incoming_packet_shared_secret, phantom_shared_secret);
4885 let mut push_forward_ev = false;
4886 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
4887 if forward_htlcs.is_empty() {
4888 push_forward_ev = true;
4890 match forward_htlcs.entry(*short_channel_id) {
4891 hash_map::Entry::Occupied(mut entry) => {
4892 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet });
4894 hash_map::Entry::Vacant(entry) => {
4895 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }));
4898 mem::drop(forward_htlcs);
4899 if push_forward_ev { self.push_pending_forwards_ev(); }
4900 let mut pending_events = self.pending_events.lock().unwrap();
4901 pending_events.push_back((events::Event::HTLCHandlingFailed {
4902 prev_channel_id: outpoint.to_channel_id(),
4903 failed_next_destination: destination,
4909 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
4910 /// [`MessageSendEvent`]s needed to claim the payment.
4912 /// This method is guaranteed to ensure the payment has been claimed but only if the current
4913 /// height is strictly below [`Event::PaymentClaimable::claim_deadline`]. To avoid race
4914 /// conditions, you should wait for an [`Event::PaymentClaimed`] before considering the payment
4915 /// successful. It will generally be available in the next [`process_pending_events`] call.
4917 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
4918 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
4919 /// event matches your expectation. If you fail to do so and call this method, you may provide
4920 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
4922 /// This function will fail the payment if it has custom TLVs with even type numbers, as we
4923 /// will assume they are unknown. If you intend to accept even custom TLVs, you should use
4924 /// [`claim_funds_with_known_custom_tlvs`].
4926 /// [`Event::PaymentClaimable`]: crate::events::Event::PaymentClaimable
4927 /// [`Event::PaymentClaimable::claim_deadline`]: crate::events::Event::PaymentClaimable::claim_deadline
4928 /// [`Event::PaymentClaimed`]: crate::events::Event::PaymentClaimed
4929 /// [`process_pending_events`]: EventsProvider::process_pending_events
4930 /// [`create_inbound_payment`]: Self::create_inbound_payment
4931 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
4932 /// [`claim_funds_with_known_custom_tlvs`]: Self::claim_funds_with_known_custom_tlvs
4933 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
4934 self.claim_payment_internal(payment_preimage, false);
4937 /// This is a variant of [`claim_funds`] that allows accepting a payment with custom TLVs with
4938 /// even type numbers.
4942 /// You MUST check you've understood all even TLVs before using this to
4943 /// claim, otherwise you may unintentionally agree to some protocol you do not understand.
4945 /// [`claim_funds`]: Self::claim_funds
4946 pub fn claim_funds_with_known_custom_tlvs(&self, payment_preimage: PaymentPreimage) {
4947 self.claim_payment_internal(payment_preimage, true);
4950 fn claim_payment_internal(&self, payment_preimage: PaymentPreimage, custom_tlvs_known: bool) {
4951 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4953 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4956 let mut claimable_payments = self.claimable_payments.lock().unwrap();
4957 if let Some(payment) = claimable_payments.claimable_payments.remove(&payment_hash) {
4958 let mut receiver_node_id = self.our_network_pubkey;
4959 for htlc in payment.htlcs.iter() {
4960 if htlc.prev_hop.phantom_shared_secret.is_some() {
4961 let phantom_pubkey = self.node_signer.get_node_id(Recipient::PhantomNode)
4962 .expect("Failed to get node_id for phantom node recipient");
4963 receiver_node_id = phantom_pubkey;
4968 let htlcs = payment.htlcs.iter().map(events::ClaimedHTLC::from).collect();
4969 let sender_intended_value = payment.htlcs.first().map(|htlc| htlc.total_msat);
4970 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
4971 ClaimingPayment { amount_msat: payment.htlcs.iter().map(|source| source.value).sum(),
4972 payment_purpose: payment.purpose, receiver_node_id, htlcs, sender_intended_value
4974 if dup_purpose.is_some() {
4975 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
4976 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
4980 if let Some(RecipientOnionFields { ref custom_tlvs, .. }) = payment.onion_fields {
4981 if !custom_tlvs_known && custom_tlvs.iter().any(|(typ, _)| typ % 2 == 0) {
4982 log_info!(self.logger, "Rejecting payment with payment hash {} as we cannot accept payment with unknown even TLVs: {}",
4983 &payment_hash, log_iter!(custom_tlvs.iter().map(|(typ, _)| typ).filter(|typ| *typ % 2 == 0)));
4984 claimable_payments.pending_claiming_payments.remove(&payment_hash);
4985 mem::drop(claimable_payments);
4986 for htlc in payment.htlcs {
4987 let reason = self.get_htlc_fail_reason_from_failure_code(FailureCode::InvalidOnionPayload(None), &htlc);
4988 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
4989 let receiver = HTLCDestination::FailedPayment { payment_hash };
4990 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
4999 debug_assert!(!sources.is_empty());
5001 // Just in case one HTLC has been failed between when we generated the `PaymentClaimable`
5002 // and when we got here we need to check that the amount we're about to claim matches the
5003 // amount we told the user in the last `PaymentClaimable`. We also do a sanity-check that
5004 // the MPP parts all have the same `total_msat`.
5005 let mut claimable_amt_msat = 0;
5006 let mut prev_total_msat = None;
5007 let mut expected_amt_msat = None;
5008 let mut valid_mpp = true;
5009 let mut errs = Vec::new();
5010 let per_peer_state = self.per_peer_state.read().unwrap();
5011 for htlc in sources.iter() {
5012 if prev_total_msat.is_some() && prev_total_msat != Some(htlc.total_msat) {
5013 log_error!(self.logger, "Somehow ended up with an MPP payment with different expected total amounts - this should not be reachable!");
5014 debug_assert!(false);
5018 prev_total_msat = Some(htlc.total_msat);
5020 if expected_amt_msat.is_some() && expected_amt_msat != htlc.total_value_received {
5021 log_error!(self.logger, "Somehow ended up with an MPP payment with different received total amounts - this should not be reachable!");
5022 debug_assert!(false);
5026 expected_amt_msat = htlc.total_value_received;
5027 claimable_amt_msat += htlc.value;
5029 mem::drop(per_peer_state);
5030 if sources.is_empty() || expected_amt_msat.is_none() {
5031 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5032 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
5035 if claimable_amt_msat != expected_amt_msat.unwrap() {
5036 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5037 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
5038 expected_amt_msat.unwrap(), claimable_amt_msat);
5042 for htlc in sources.drain(..) {
5043 if let Err((pk, err)) = self.claim_funds_from_hop(
5044 htlc.prev_hop, payment_preimage,
5045 |_| Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash }))
5047 if let msgs::ErrorAction::IgnoreError = err.err.action {
5048 // We got a temporary failure updating monitor, but will claim the
5049 // HTLC when the monitor updating is restored (or on chain).
5050 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
5051 } else { errs.push((pk, err)); }
5056 for htlc in sources.drain(..) {
5057 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5058 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5059 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5060 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
5061 let receiver = HTLCDestination::FailedPayment { payment_hash };
5062 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5064 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5067 // Now we can handle any errors which were generated.
5068 for (counterparty_node_id, err) in errs.drain(..) {
5069 let res: Result<(), _> = Err(err);
5070 let _ = handle_error!(self, res, counterparty_node_id);
5074 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>) -> Option<MonitorUpdateCompletionAction>>(&self,
5075 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
5076 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
5077 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
5079 // If we haven't yet run background events assume we're still deserializing and shouldn't
5080 // actually pass `ChannelMonitorUpdate`s to users yet. Instead, queue them up as
5081 // `BackgroundEvent`s.
5082 let during_init = !self.background_events_processed_since_startup.load(Ordering::Acquire);
5085 let per_peer_state = self.per_peer_state.read().unwrap();
5086 let chan_id = prev_hop.outpoint.to_channel_id();
5087 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
5088 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
5092 let peer_state_opt = counterparty_node_id_opt.as_ref().map(
5093 |counterparty_node_id| per_peer_state.get(counterparty_node_id)
5094 .map(|peer_mutex| peer_mutex.lock().unwrap())
5097 if peer_state_opt.is_some() {
5098 let mut peer_state_lock = peer_state_opt.unwrap();
5099 let peer_state = &mut *peer_state_lock;
5100 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(chan_id) {
5101 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
5102 let counterparty_node_id = chan.context.get_counterparty_node_id();
5103 let fulfill_res = chan.get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger);
5105 if let UpdateFulfillCommitFetch::NewClaim { htlc_value_msat, monitor_update } = fulfill_res {
5106 if let Some(action) = completion_action(Some(htlc_value_msat)) {
5107 log_trace!(self.logger, "Tracking monitor update completion action for channel {}: {:?}",
5109 peer_state.monitor_update_blocked_actions.entry(chan_id).or_insert(Vec::new()).push(action);
5112 let res = handle_new_monitor_update!(self, prev_hop.outpoint, monitor_update, peer_state_lock,
5113 peer_state, per_peer_state, chan_phase_entry);
5114 if let Err(e) = res {
5115 // TODO: This is a *critical* error - we probably updated the outbound edge
5116 // of the HTLC's monitor with a preimage. We should retry this monitor
5117 // update over and over again until morale improves.
5118 log_error!(self.logger, "Failed to update channel monitor with preimage {:?}", payment_preimage);
5119 return Err((counterparty_node_id, e));
5122 // If we're running during init we cannot update a monitor directly -
5123 // they probably haven't actually been loaded yet. Instead, push the
5124 // monitor update as a background event.
5125 self.pending_background_events.lock().unwrap().push(
5126 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
5127 counterparty_node_id,
5128 funding_txo: prev_hop.outpoint,
5129 update: monitor_update.clone(),
5138 let preimage_update = ChannelMonitorUpdate {
5139 update_id: CLOSED_CHANNEL_UPDATE_ID,
5140 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
5146 // We update the ChannelMonitor on the backward link, after
5147 // receiving an `update_fulfill_htlc` from the forward link.
5148 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, &preimage_update);
5149 if update_res != ChannelMonitorUpdateStatus::Completed {
5150 // TODO: This needs to be handled somehow - if we receive a monitor update
5151 // with a preimage we *must* somehow manage to propagate it to the upstream
5152 // channel, or we must have an ability to receive the same event and try
5153 // again on restart.
5154 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
5155 payment_preimage, update_res);
5158 // If we're running during init we cannot update a monitor directly - they probably
5159 // haven't actually been loaded yet. Instead, push the monitor update as a background
5161 // Note that while it's safe to use `ClosedMonitorUpdateRegeneratedOnStartup` here (the
5162 // channel is already closed) we need to ultimately handle the monitor update
5163 // completion action only after we've completed the monitor update. This is the only
5164 // way to guarantee this update *will* be regenerated on startup (otherwise if this was
5165 // from a forwarded HTLC the downstream preimage may be deleted before we claim
5166 // upstream). Thus, we need to transition to some new `BackgroundEvent` type which will
5167 // complete the monitor update completion action from `completion_action`.
5168 self.pending_background_events.lock().unwrap().push(
5169 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((
5170 prev_hop.outpoint, preimage_update,
5173 // Note that we do process the completion action here. This totally could be a
5174 // duplicate claim, but we have no way of knowing without interrogating the
5175 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
5176 // generally always allowed to be duplicative (and it's specifically noted in
5177 // `PaymentForwarded`).
5178 self.handle_monitor_update_completion_actions(completion_action(None));
5182 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
5183 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
5186 fn claim_funds_internal(&self, source: HTLCSource, payment_preimage: PaymentPreimage, forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, next_channel_outpoint: OutPoint) {
5188 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
5189 debug_assert!(self.background_events_processed_since_startup.load(Ordering::Acquire),
5190 "We don't support claim_htlc claims during startup - monitors may not be available yet");
5191 let ev_completion_action = EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
5192 channel_funding_outpoint: next_channel_outpoint,
5193 counterparty_node_id: path.hops[0].pubkey,
5195 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage,
5196 session_priv, path, from_onchain, ev_completion_action, &self.pending_events,
5199 HTLCSource::PreviousHopData(hop_data) => {
5200 let prev_outpoint = hop_data.outpoint;
5201 let res = self.claim_funds_from_hop(hop_data, payment_preimage,
5202 |htlc_claim_value_msat| {
5203 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
5204 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
5205 Some(claimed_htlc_value - forwarded_htlc_value)
5208 Some(MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5209 event: events::Event::PaymentForwarded {
5211 claim_from_onchain_tx: from_onchain,
5212 prev_channel_id: Some(prev_outpoint.to_channel_id()),
5213 next_channel_id: Some(next_channel_outpoint.to_channel_id()),
5214 outbound_amount_forwarded_msat: forwarded_htlc_value_msat,
5216 downstream_counterparty_and_funding_outpoint: None,
5220 if let Err((pk, err)) = res {
5221 let result: Result<(), _> = Err(err);
5222 let _ = handle_error!(self, result, pk);
5228 /// Gets the node_id held by this ChannelManager
5229 pub fn get_our_node_id(&self) -> PublicKey {
5230 self.our_network_pubkey.clone()
5233 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
5234 for action in actions.into_iter() {
5236 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
5237 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5238 if let Some(ClaimingPayment {
5240 payment_purpose: purpose,
5243 sender_intended_value: sender_intended_total_msat,
5245 self.pending_events.lock().unwrap().push_back((events::Event::PaymentClaimed {
5249 receiver_node_id: Some(receiver_node_id),
5251 sender_intended_total_msat,
5255 MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5256 event, downstream_counterparty_and_funding_outpoint
5258 self.pending_events.lock().unwrap().push_back((event, None));
5259 if let Some((node_id, funding_outpoint, blocker)) = downstream_counterparty_and_funding_outpoint {
5260 self.handle_monitor_update_release(node_id, funding_outpoint, Some(blocker));
5267 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
5268 /// update completion.
5269 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
5270 channel: &mut Channel<SP>, raa: Option<msgs::RevokeAndACK>,
5271 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
5272 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
5273 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
5274 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
5275 log_trace!(self.logger, "Handling channel resumption for channel {} with {} RAA, {} commitment update, {} pending forwards, {}broadcasting funding, {} channel ready, {} announcement",
5276 &channel.context.channel_id(),
5277 if raa.is_some() { "an" } else { "no" },
5278 if commitment_update.is_some() { "a" } else { "no" }, pending_forwards.len(),
5279 if funding_broadcastable.is_some() { "" } else { "not " },
5280 if channel_ready.is_some() { "sending" } else { "without" },
5281 if announcement_sigs.is_some() { "sending" } else { "without" });
5283 let mut htlc_forwards = None;
5285 let counterparty_node_id = channel.context.get_counterparty_node_id();
5286 if !pending_forwards.is_empty() {
5287 htlc_forwards = Some((channel.context.get_short_channel_id().unwrap_or(channel.context.outbound_scid_alias()),
5288 channel.context.get_funding_txo().unwrap(), channel.context.get_user_id(), pending_forwards));
5291 if let Some(msg) = channel_ready {
5292 send_channel_ready!(self, pending_msg_events, channel, msg);
5294 if let Some(msg) = announcement_sigs {
5295 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5296 node_id: counterparty_node_id,
5301 macro_rules! handle_cs { () => {
5302 if let Some(update) = commitment_update {
5303 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5304 node_id: counterparty_node_id,
5309 macro_rules! handle_raa { () => {
5310 if let Some(revoke_and_ack) = raa {
5311 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
5312 node_id: counterparty_node_id,
5313 msg: revoke_and_ack,
5318 RAACommitmentOrder::CommitmentFirst => {
5322 RAACommitmentOrder::RevokeAndACKFirst => {
5328 if let Some(tx) = funding_broadcastable {
5329 log_info!(self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
5330 self.tx_broadcaster.broadcast_transactions(&[&tx]);
5334 let mut pending_events = self.pending_events.lock().unwrap();
5335 emit_channel_pending_event!(pending_events, channel);
5336 emit_channel_ready_event!(pending_events, channel);
5342 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
5343 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
5345 let counterparty_node_id = match counterparty_node_id {
5346 Some(cp_id) => cp_id.clone(),
5348 // TODO: Once we can rely on the counterparty_node_id from the
5349 // monitor event, this and the id_to_peer map should be removed.
5350 let id_to_peer = self.id_to_peer.lock().unwrap();
5351 match id_to_peer.get(&funding_txo.to_channel_id()) {
5352 Some(cp_id) => cp_id.clone(),
5357 let per_peer_state = self.per_peer_state.read().unwrap();
5358 let mut peer_state_lock;
5359 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
5360 if peer_state_mutex_opt.is_none() { return }
5361 peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5362 let peer_state = &mut *peer_state_lock;
5364 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get_mut(&funding_txo.to_channel_id()) {
5367 let update_actions = peer_state.monitor_update_blocked_actions
5368 .remove(&funding_txo.to_channel_id()).unwrap_or(Vec::new());
5369 mem::drop(peer_state_lock);
5370 mem::drop(per_peer_state);
5371 self.handle_monitor_update_completion_actions(update_actions);
5374 let remaining_in_flight =
5375 if let Some(pending) = peer_state.in_flight_monitor_updates.get_mut(funding_txo) {
5376 pending.retain(|upd| upd.update_id > highest_applied_update_id);
5379 log_trace!(self.logger, "ChannelMonitor updated to {}. Current highest is {}. {} pending in-flight updates.",
5380 highest_applied_update_id, channel.context.get_latest_monitor_update_id(),
5381 remaining_in_flight);
5382 if !channel.is_awaiting_monitor_update() || channel.context.get_latest_monitor_update_id() != highest_applied_update_id {
5385 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, channel);
5388 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
5390 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
5391 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
5394 /// The `user_channel_id` parameter will be provided back in
5395 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5396 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5398 /// Note that this method will return an error and reject the channel, if it requires support
5399 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
5400 /// used to accept such channels.
5402 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5403 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5404 pub fn accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5405 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
5408 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
5409 /// it as confirmed immediately.
5411 /// The `user_channel_id` parameter will be provided back in
5412 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5413 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5415 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
5416 /// and (if the counterparty agrees), enables forwarding of payments immediately.
5418 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
5419 /// transaction and blindly assumes that it will eventually confirm.
5421 /// If it does not confirm before we decide to close the channel, or if the funding transaction
5422 /// does not pay to the correct script the correct amount, *you will lose funds*.
5424 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5425 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5426 pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5427 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
5430 fn do_accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
5431 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5433 let peers_without_funded_channels =
5434 self.peers_without_funded_channels(|peer| { peer.total_channel_count() > 0 });
5435 let per_peer_state = self.per_peer_state.read().unwrap();
5436 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5437 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
5438 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5439 let peer_state = &mut *peer_state_lock;
5440 let is_only_peer_channel = peer_state.total_channel_count() == 1;
5442 // Find (and remove) the channel in the unaccepted table. If it's not there, something weird is
5443 // happening and return an error. N.B. that we create channel with an outbound SCID of zero so
5444 // that we can delay allocating the SCID until after we're sure that the checks below will
5446 let mut channel = match peer_state.inbound_channel_request_by_id.remove(temporary_channel_id) {
5447 Some(unaccepted_channel) => {
5448 let best_block_height = self.best_block.read().unwrap().height();
5449 InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
5450 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features,
5451 &unaccepted_channel.open_channel_msg, user_channel_id, &self.default_configuration, best_block_height,
5452 &self.logger, accept_0conf).map_err(|e| APIError::ChannelUnavailable { err: e.to_string() })
5454 _ => Err(APIError::APIMisuseError { err: "No such channel awaiting to be accepted.".to_owned() })
5458 // This should have been correctly configured by the call to InboundV1Channel::new.
5459 debug_assert!(channel.context.minimum_depth().unwrap() == 0);
5460 } else if channel.context.get_channel_type().requires_zero_conf() {
5461 let send_msg_err_event = events::MessageSendEvent::HandleError {
5462 node_id: channel.context.get_counterparty_node_id(),
5463 action: msgs::ErrorAction::SendErrorMessage{
5464 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
5467 peer_state.pending_msg_events.push(send_msg_err_event);
5468 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
5470 // If this peer already has some channels, a new channel won't increase our number of peers
5471 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
5472 // channels per-peer we can accept channels from a peer with existing ones.
5473 if is_only_peer_channel && peers_without_funded_channels >= MAX_UNFUNDED_CHANNEL_PEERS {
5474 let send_msg_err_event = events::MessageSendEvent::HandleError {
5475 node_id: channel.context.get_counterparty_node_id(),
5476 action: msgs::ErrorAction::SendErrorMessage{
5477 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "Have too many peers with unfunded channels, not accepting new ones".to_owned(), }
5480 peer_state.pending_msg_events.push(send_msg_err_event);
5481 return Err(APIError::APIMisuseError { err: "Too many peers with unfunded channels, refusing to accept new ones".to_owned() });
5485 // Now that we know we have a channel, assign an outbound SCID alias.
5486 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
5487 channel.context.set_outbound_scid_alias(outbound_scid_alias);
5489 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
5490 node_id: channel.context.get_counterparty_node_id(),
5491 msg: channel.accept_inbound_channel(),
5494 peer_state.channel_by_id.insert(temporary_channel_id.clone(), ChannelPhase::UnfundedInboundV1(channel));
5499 /// Gets the number of peers which match the given filter and do not have any funded, outbound,
5500 /// or 0-conf channels.
5502 /// The filter is called for each peer and provided with the number of unfunded, inbound, and
5503 /// non-0-conf channels we have with the peer.
5504 fn peers_without_funded_channels<Filter>(&self, maybe_count_peer: Filter) -> usize
5505 where Filter: Fn(&PeerState<SP>) -> bool {
5506 let mut peers_without_funded_channels = 0;
5507 let best_block_height = self.best_block.read().unwrap().height();
5509 let peer_state_lock = self.per_peer_state.read().unwrap();
5510 for (_, peer_mtx) in peer_state_lock.iter() {
5511 let peer = peer_mtx.lock().unwrap();
5512 if !maybe_count_peer(&*peer) { continue; }
5513 let num_unfunded_channels = Self::unfunded_channel_count(&peer, best_block_height);
5514 if num_unfunded_channels == peer.total_channel_count() {
5515 peers_without_funded_channels += 1;
5519 return peers_without_funded_channels;
5522 fn unfunded_channel_count(
5523 peer: &PeerState<SP>, best_block_height: u32
5525 let mut num_unfunded_channels = 0;
5526 for (_, phase) in peer.channel_by_id.iter() {
5528 ChannelPhase::Funded(chan) => {
5529 // This covers non-zero-conf inbound `Channel`s that we are currently monitoring, but those
5530 // which have not yet had any confirmations on-chain.
5531 if !chan.context.is_outbound() && chan.context.minimum_depth().unwrap_or(1) != 0 &&
5532 chan.context.get_funding_tx_confirmations(best_block_height) == 0
5534 num_unfunded_channels += 1;
5537 ChannelPhase::UnfundedInboundV1(chan) => {
5538 if chan.context.minimum_depth().unwrap_or(1) != 0 {
5539 num_unfunded_channels += 1;
5542 ChannelPhase::UnfundedOutboundV1(_) => {
5543 // Outbound channels don't contribute to the unfunded count in the DoS context.
5548 num_unfunded_channels + peer.inbound_channel_request_by_id.len()
5551 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
5552 if msg.chain_hash != self.genesis_hash {
5553 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
5556 if !self.default_configuration.accept_inbound_channels {
5557 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
5560 // Get the number of peers with channels, but without funded ones. We don't care too much
5561 // about peers that never open a channel, so we filter by peers that have at least one
5562 // channel, and then limit the number of those with unfunded channels.
5563 let channeled_peers_without_funding =
5564 self.peers_without_funded_channels(|node| node.total_channel_count() > 0);
5566 let per_peer_state = self.per_peer_state.read().unwrap();
5567 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5569 debug_assert!(false);
5570 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())
5572 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5573 let peer_state = &mut *peer_state_lock;
5575 // If this peer already has some channels, a new channel won't increase our number of peers
5576 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
5577 // channels per-peer we can accept channels from a peer with existing ones.
5578 if peer_state.total_channel_count() == 0 &&
5579 channeled_peers_without_funding >= MAX_UNFUNDED_CHANNEL_PEERS &&
5580 !self.default_configuration.manually_accept_inbound_channels
5582 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5583 "Have too many peers with unfunded channels, not accepting new ones".to_owned(),
5584 msg.temporary_channel_id.clone()));
5587 let best_block_height = self.best_block.read().unwrap().height();
5588 if Self::unfunded_channel_count(peer_state, best_block_height) >= MAX_UNFUNDED_CHANS_PER_PEER {
5589 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5590 format!("Refusing more than {} unfunded channels.", MAX_UNFUNDED_CHANS_PER_PEER),
5591 msg.temporary_channel_id.clone()));
5594 let channel_id = msg.temporary_channel_id;
5595 let channel_exists = peer_state.has_channel(&channel_id);
5597 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision for the same peer!".to_owned(), msg.temporary_channel_id.clone()));
5600 // If we're doing manual acceptance checks on the channel, then defer creation until we're sure we want to accept.
5601 if self.default_configuration.manually_accept_inbound_channels {
5602 let mut pending_events = self.pending_events.lock().unwrap();
5603 pending_events.push_back((events::Event::OpenChannelRequest {
5604 temporary_channel_id: msg.temporary_channel_id.clone(),
5605 counterparty_node_id: counterparty_node_id.clone(),
5606 funding_satoshis: msg.funding_satoshis,
5607 push_msat: msg.push_msat,
5608 channel_type: msg.channel_type.clone().unwrap(),
5610 peer_state.inbound_channel_request_by_id.insert(channel_id, InboundChannelRequest {
5611 open_channel_msg: msg.clone(),
5612 ticks_remaining: UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS,
5617 // Otherwise create the channel right now.
5618 let mut random_bytes = [0u8; 16];
5619 random_bytes.copy_from_slice(&self.entropy_source.get_secure_random_bytes()[..16]);
5620 let user_channel_id = u128::from_be_bytes(random_bytes);
5621 let mut channel = match InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
5622 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id,
5623 &self.default_configuration, best_block_height, &self.logger, /*is_0conf=*/false)
5626 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
5631 let channel_type = channel.context.get_channel_type();
5632 if channel_type.requires_zero_conf() {
5633 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
5635 if channel_type.requires_anchors_zero_fee_htlc_tx() {
5636 return Err(MsgHandleErrInternal::send_err_msg_no_close("No channels with anchor outputs accepted".to_owned(), msg.temporary_channel_id.clone()));
5639 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
5640 channel.context.set_outbound_scid_alias(outbound_scid_alias);
5642 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
5643 node_id: counterparty_node_id.clone(),
5644 msg: channel.accept_inbound_channel(),
5646 peer_state.channel_by_id.insert(channel_id, ChannelPhase::UnfundedInboundV1(channel));
5650 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
5651 let (value, output_script, user_id) = {
5652 let per_peer_state = self.per_peer_state.read().unwrap();
5653 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5655 debug_assert!(false);
5656 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.temporary_channel_id)
5658 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5659 let peer_state = &mut *peer_state_lock;
5660 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
5661 hash_map::Entry::Occupied(mut phase) => {
5662 match phase.get_mut() {
5663 ChannelPhase::UnfundedOutboundV1(chan) => {
5664 try_chan_phase_entry!(self, chan.accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &peer_state.latest_features), phase);
5665 (chan.context.get_value_satoshis(), chan.context.get_funding_redeemscript().to_v0_p2wsh(), chan.context.get_user_id())
5668 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got an unexpected accept_channel message from peer with counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id));
5672 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))
5675 let mut pending_events = self.pending_events.lock().unwrap();
5676 pending_events.push_back((events::Event::FundingGenerationReady {
5677 temporary_channel_id: msg.temporary_channel_id,
5678 counterparty_node_id: *counterparty_node_id,
5679 channel_value_satoshis: value,
5681 user_channel_id: user_id,
5686 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
5687 let best_block = *self.best_block.read().unwrap();
5689 let per_peer_state = self.per_peer_state.read().unwrap();
5690 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5692 debug_assert!(false);
5693 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)
5696 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5697 let peer_state = &mut *peer_state_lock;
5698 let (chan, funding_msg, monitor) =
5699 match peer_state.channel_by_id.remove(&msg.temporary_channel_id) {
5700 Some(ChannelPhase::UnfundedInboundV1(inbound_chan)) => {
5701 match inbound_chan.funding_created(msg, best_block, &self.signer_provider, &self.logger) {
5703 Err((mut inbound_chan, err)) => {
5704 // We've already removed this inbound channel from the map in `PeerState`
5705 // above so at this point we just need to clean up any lingering entries
5706 // concerning this channel as it is safe to do so.
5707 update_maps_on_chan_removal!(self, &inbound_chan.context);
5708 let user_id = inbound_chan.context.get_user_id();
5709 let shutdown_res = inbound_chan.context.force_shutdown(false);
5710 return Err(MsgHandleErrInternal::from_finish_shutdown(format!("{}", err),
5711 msg.temporary_channel_id, user_id, shutdown_res, None, inbound_chan.context.get_value_satoshis()));
5715 Some(ChannelPhase::Funded(_)) | Some(ChannelPhase::UnfundedOutboundV1(_)) => {
5716 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got an unexpected funding_created message from peer with counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id));
5718 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))
5721 match peer_state.channel_by_id.entry(funding_msg.channel_id) {
5722 hash_map::Entry::Occupied(_) => {
5723 Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
5725 hash_map::Entry::Vacant(e) => {
5726 match self.id_to_peer.lock().unwrap().entry(chan.context.channel_id()) {
5727 hash_map::Entry::Occupied(_) => {
5728 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5729 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
5730 funding_msg.channel_id))
5732 hash_map::Entry::Vacant(i_e) => {
5733 i_e.insert(chan.context.get_counterparty_node_id());
5737 // There's no problem signing a counterparty's funding transaction if our monitor
5738 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
5739 // accepted payment from yet. We do, however, need to wait to send our channel_ready
5740 // until we have persisted our monitor.
5741 let new_channel_id = funding_msg.channel_id;
5742 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
5743 node_id: counterparty_node_id.clone(),
5747 let monitor_res = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
5749 if let ChannelPhase::Funded(chan) = e.insert(ChannelPhase::Funded(chan)) {
5750 let mut res = handle_new_monitor_update!(self, monitor_res, peer_state_lock, peer_state,
5751 per_peer_state, chan, MANUALLY_REMOVING_INITIAL_MONITOR,
5752 { peer_state.channel_by_id.remove(&new_channel_id) });
5754 // Note that we reply with the new channel_id in error messages if we gave up on the
5755 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
5756 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
5757 // any messages referencing a previously-closed channel anyway.
5758 // We do not propagate the monitor update to the user as it would be for a monitor
5759 // that we didn't manage to store (and that we don't care about - we don't respond
5760 // with the funding_signed so the channel can never go on chain).
5761 if let Err(MsgHandleErrInternal { shutdown_finish: Some((res, _)), .. }) = &mut res {
5766 unreachable!("This must be a funded channel as we just inserted it.");
5772 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
5773 let best_block = *self.best_block.read().unwrap();
5774 let per_peer_state = self.per_peer_state.read().unwrap();
5775 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5777 debug_assert!(false);
5778 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5781 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5782 let peer_state = &mut *peer_state_lock;
5783 match peer_state.channel_by_id.entry(msg.channel_id) {
5784 hash_map::Entry::Occupied(mut chan_phase_entry) => {
5785 match chan_phase_entry.get_mut() {
5786 ChannelPhase::Funded(ref mut chan) => {
5787 let monitor = try_chan_phase_entry!(self,
5788 chan.funding_signed(&msg, best_block, &self.signer_provider, &self.logger), chan_phase_entry);
5789 let update_res = self.chain_monitor.watch_channel(chan.context.get_funding_txo().unwrap(), monitor);
5790 let mut res = handle_new_monitor_update!(self, update_res, peer_state_lock, peer_state, per_peer_state, chan_phase_entry, INITIAL_MONITOR);
5791 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
5792 // We weren't able to watch the channel to begin with, so no updates should be made on
5793 // it. Previously, full_stack_target found an (unreachable) panic when the
5794 // monitor update contained within `shutdown_finish` was applied.
5795 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
5796 shutdown_finish.0.take();
5802 return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id));
5806 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5810 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
5811 let per_peer_state = self.per_peer_state.read().unwrap();
5812 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5814 debug_assert!(false);
5815 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5817 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5818 let peer_state = &mut *peer_state_lock;
5819 match peer_state.channel_by_id.entry(msg.channel_id) {
5820 hash_map::Entry::Occupied(mut chan_phase_entry) => {
5821 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
5822 let announcement_sigs_opt = try_chan_phase_entry!(self, chan.channel_ready(&msg, &self.node_signer,
5823 self.genesis_hash.clone(), &self.default_configuration, &self.best_block.read().unwrap(), &self.logger), chan_phase_entry);
5824 if let Some(announcement_sigs) = announcement_sigs_opt {
5825 log_trace!(self.logger, "Sending announcement_signatures for channel {}", chan.context.channel_id());
5826 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5827 node_id: counterparty_node_id.clone(),
5828 msg: announcement_sigs,
5830 } else if chan.context.is_usable() {
5831 // If we're sending an announcement_signatures, we'll send the (public)
5832 // channel_update after sending a channel_announcement when we receive our
5833 // counterparty's announcement_signatures. Thus, we only bother to send a
5834 // channel_update here if the channel is not public, i.e. we're not sending an
5835 // announcement_signatures.
5836 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", chan.context.channel_id());
5837 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
5838 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
5839 node_id: counterparty_node_id.clone(),
5846 let mut pending_events = self.pending_events.lock().unwrap();
5847 emit_channel_ready_event!(pending_events, chan);
5852 try_chan_phase_entry!(self, Err(ChannelError::Close(
5853 "Got a channel_ready message for an unfunded channel!".into())), chan_phase_entry)
5856 hash_map::Entry::Vacant(_) => {
5857 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))
5862 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
5863 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
5864 let result: Result<(), _> = loop {
5865 let per_peer_state = self.per_peer_state.read().unwrap();
5866 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5868 debug_assert!(false);
5869 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5871 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5872 let peer_state = &mut *peer_state_lock;
5873 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(msg.channel_id.clone()) {
5874 let phase = chan_phase_entry.get_mut();
5876 ChannelPhase::Funded(chan) => {
5877 if !chan.received_shutdown() {
5878 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
5880 if chan.sent_shutdown() { " after we initiated shutdown" } else { "" });
5883 let funding_txo_opt = chan.context.get_funding_txo();
5884 let (shutdown, monitor_update_opt, htlcs) = try_chan_phase_entry!(self,
5885 chan.shutdown(&self.signer_provider, &peer_state.latest_features, &msg), chan_phase_entry);
5886 dropped_htlcs = htlcs;
5888 if let Some(msg) = shutdown {
5889 // We can send the `shutdown` message before updating the `ChannelMonitor`
5890 // here as we don't need the monitor update to complete until we send a
5891 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
5892 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5893 node_id: *counterparty_node_id,
5897 // Update the monitor with the shutdown script if necessary.
5898 if let Some(monitor_update) = monitor_update_opt {
5899 break handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
5900 peer_state_lock, peer_state, per_peer_state, chan_phase_entry).map(|_| ());
5904 ChannelPhase::UnfundedInboundV1(_) | ChannelPhase::UnfundedOutboundV1(_) => {
5905 let context = phase.context_mut();
5906 log_error!(self.logger, "Immediately closing unfunded channel {} as peer asked to cooperatively shut it down (which is unnecessary)", &msg.channel_id);
5907 self.issue_channel_close_events(&context, ClosureReason::CounterpartyCoopClosedUnfundedChannel);
5908 let mut chan = remove_channel_phase!(self, chan_phase_entry);
5909 self.finish_force_close_channel(chan.context_mut().force_shutdown(false));
5914 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))
5917 for htlc_source in dropped_htlcs.drain(..) {
5918 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
5919 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
5920 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
5926 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
5927 let per_peer_state = self.per_peer_state.read().unwrap();
5928 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5930 debug_assert!(false);
5931 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5933 let (tx, chan_option) = {
5934 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5935 let peer_state = &mut *peer_state_lock;
5936 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
5937 hash_map::Entry::Occupied(mut chan_phase_entry) => {
5938 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
5939 let (closing_signed, tx) = try_chan_phase_entry!(self, chan.closing_signed(&self.fee_estimator, &msg), chan_phase_entry);
5940 if let Some(msg) = closing_signed {
5941 peer_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5942 node_id: counterparty_node_id.clone(),
5947 // We're done with this channel, we've got a signed closing transaction and
5948 // will send the closing_signed back to the remote peer upon return. This
5949 // also implies there are no pending HTLCs left on the channel, so we can
5950 // fully delete it from tracking (the channel monitor is still around to
5951 // watch for old state broadcasts)!
5952 (tx, Some(remove_channel_phase!(self, chan_phase_entry)))
5953 } else { (tx, None) }
5955 return try_chan_phase_entry!(self, Err(ChannelError::Close(
5956 "Got a closing_signed message for an unfunded channel!".into())), chan_phase_entry);
5959 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))
5962 if let Some(broadcast_tx) = tx {
5963 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
5964 self.tx_broadcaster.broadcast_transactions(&[&broadcast_tx]);
5966 if let Some(ChannelPhase::Funded(chan)) = chan_option {
5967 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5968 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5969 let peer_state = &mut *peer_state_lock;
5970 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5974 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
5979 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
5980 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
5981 //determine the state of the payment based on our response/if we forward anything/the time
5982 //we take to respond. We should take care to avoid allowing such an attack.
5984 //TODO: There exists a further attack where a node may garble the onion data, forward it to
5985 //us repeatedly garbled in different ways, and compare our error messages, which are
5986 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
5987 //but we should prevent it anyway.
5989 let decoded_hop_res = self.decode_update_add_htlc_onion(msg);
5990 let per_peer_state = self.per_peer_state.read().unwrap();
5991 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5993 debug_assert!(false);
5994 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5996 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5997 let peer_state = &mut *peer_state_lock;
5998 match peer_state.channel_by_id.entry(msg.channel_id) {
5999 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6000 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6001 let pending_forward_info = match decoded_hop_res {
6002 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
6003 self.construct_pending_htlc_status(msg, shared_secret, next_hop,
6004 chan.context.config().accept_underpaying_htlcs, next_packet_pk_opt),
6005 Err(e) => PendingHTLCStatus::Fail(e)
6007 let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
6008 // If the update_add is completely bogus, the call will Err and we will close,
6009 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
6010 // want to reject the new HTLC and fail it backwards instead of forwarding.
6011 match pending_forward_info {
6012 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
6013 let reason = if (error_code & 0x1000) != 0 {
6014 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
6015 HTLCFailReason::reason(real_code, error_data)
6017 HTLCFailReason::from_failure_code(error_code)
6018 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
6019 let msg = msgs::UpdateFailHTLC {
6020 channel_id: msg.channel_id,
6021 htlc_id: msg.htlc_id,
6024 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
6026 _ => pending_forward_info
6029 try_chan_phase_entry!(self, chan.update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.fee_estimator, &self.logger), chan_phase_entry);
6031 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6032 "Got an update_add_htlc message for an unfunded channel!".into())), chan_phase_entry);
6035 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))
6040 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
6042 let (htlc_source, forwarded_htlc_value) = {
6043 let per_peer_state = self.per_peer_state.read().unwrap();
6044 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6046 debug_assert!(false);
6047 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6049 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6050 let peer_state = &mut *peer_state_lock;
6051 match peer_state.channel_by_id.entry(msg.channel_id) {
6052 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6053 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6054 let res = try_chan_phase_entry!(self, chan.update_fulfill_htlc(&msg), chan_phase_entry);
6055 funding_txo = chan.context.get_funding_txo().expect("We won't accept a fulfill until funded");
6058 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6059 "Got an update_fulfill_htlc message for an unfunded channel!".into())), chan_phase_entry);
6062 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))
6065 self.claim_funds_internal(htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, funding_txo);
6069 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
6070 let per_peer_state = self.per_peer_state.read().unwrap();
6071 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6073 debug_assert!(false);
6074 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6076 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6077 let peer_state = &mut *peer_state_lock;
6078 match peer_state.channel_by_id.entry(msg.channel_id) {
6079 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6080 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6081 try_chan_phase_entry!(self, chan.update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan_phase_entry);
6083 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6084 "Got an update_fail_htlc message for an unfunded channel!".into())), chan_phase_entry);
6087 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))
6092 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
6093 let per_peer_state = self.per_peer_state.read().unwrap();
6094 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6096 debug_assert!(false);
6097 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6099 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6100 let peer_state = &mut *peer_state_lock;
6101 match peer_state.channel_by_id.entry(msg.channel_id) {
6102 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6103 if (msg.failure_code & 0x8000) == 0 {
6104 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
6105 try_chan_phase_entry!(self, Err(chan_err), chan_phase_entry);
6107 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6108 try_chan_phase_entry!(self, chan.update_fail_malformed_htlc(&msg, HTLCFailReason::reason(msg.failure_code, msg.sha256_of_onion.to_vec())), chan_phase_entry);
6110 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6111 "Got an update_fail_malformed_htlc message for an unfunded channel!".into())), chan_phase_entry);
6115 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))
6119 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
6120 let per_peer_state = self.per_peer_state.read().unwrap();
6121 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6123 debug_assert!(false);
6124 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6126 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6127 let peer_state = &mut *peer_state_lock;
6128 match peer_state.channel_by_id.entry(msg.channel_id) {
6129 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6130 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6131 let funding_txo = chan.context.get_funding_txo();
6132 let monitor_update_opt = try_chan_phase_entry!(self, chan.commitment_signed(&msg, &self.logger), chan_phase_entry);
6133 if let Some(monitor_update) = monitor_update_opt {
6134 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update, peer_state_lock,
6135 peer_state, per_peer_state, chan_phase_entry).map(|_| ())
6138 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6139 "Got a commitment_signed message for an unfunded channel!".into())), chan_phase_entry);
6142 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))
6147 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
6148 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
6149 let mut push_forward_event = false;
6150 let mut new_intercept_events = VecDeque::new();
6151 let mut failed_intercept_forwards = Vec::new();
6152 if !pending_forwards.is_empty() {
6153 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
6154 let scid = match forward_info.routing {
6155 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
6156 PendingHTLCRouting::Receive { .. } => 0,
6157 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
6159 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
6160 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
6162 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
6163 let forward_htlcs_empty = forward_htlcs.is_empty();
6164 match forward_htlcs.entry(scid) {
6165 hash_map::Entry::Occupied(mut entry) => {
6166 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6167 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
6169 hash_map::Entry::Vacant(entry) => {
6170 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
6171 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.genesis_hash)
6173 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).into_inner());
6174 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
6175 match pending_intercepts.entry(intercept_id) {
6176 hash_map::Entry::Vacant(entry) => {
6177 new_intercept_events.push_back((events::Event::HTLCIntercepted {
6178 requested_next_hop_scid: scid,
6179 payment_hash: forward_info.payment_hash,
6180 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
6181 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
6184 entry.insert(PendingAddHTLCInfo {
6185 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
6187 hash_map::Entry::Occupied(_) => {
6188 log_info!(self.logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
6189 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
6190 short_channel_id: prev_short_channel_id,
6191 user_channel_id: Some(prev_user_channel_id),
6192 outpoint: prev_funding_outpoint,
6193 htlc_id: prev_htlc_id,
6194 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
6195 phantom_shared_secret: None,
6198 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
6199 HTLCFailReason::from_failure_code(0x4000 | 10),
6200 HTLCDestination::InvalidForward { requested_forward_scid: scid },
6205 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
6206 // payments are being processed.
6207 if forward_htlcs_empty {
6208 push_forward_event = true;
6210 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6211 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
6218 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
6219 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
6222 if !new_intercept_events.is_empty() {
6223 let mut events = self.pending_events.lock().unwrap();
6224 events.append(&mut new_intercept_events);
6226 if push_forward_event { self.push_pending_forwards_ev() }
6230 fn push_pending_forwards_ev(&self) {
6231 let mut pending_events = self.pending_events.lock().unwrap();
6232 let is_processing_events = self.pending_events_processor.load(Ordering::Acquire);
6233 let num_forward_events = pending_events.iter().filter(|(ev, _)|
6234 if let events::Event::PendingHTLCsForwardable { .. } = ev { true } else { false }
6236 // We only want to push a PendingHTLCsForwardable event if no others are queued. Processing
6237 // events is done in batches and they are not removed until we're done processing each
6238 // batch. Since handling a `PendingHTLCsForwardable` event will call back into the
6239 // `ChannelManager`, we'll still see the original forwarding event not removed. Phantom
6240 // payments will need an additional forwarding event before being claimed to make them look
6241 // real by taking more time.
6242 if (is_processing_events && num_forward_events <= 1) || num_forward_events < 1 {
6243 pending_events.push_back((Event::PendingHTLCsForwardable {
6244 time_forwardable: Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
6249 /// Checks whether [`ChannelMonitorUpdate`]s generated by the receipt of a remote
6250 /// [`msgs::RevokeAndACK`] should be held for the given channel until some other action
6251 /// completes. Note that this needs to happen in the same [`PeerState`] mutex as any release of
6252 /// the [`ChannelMonitorUpdate`] in question.
6253 fn raa_monitor_updates_held(&self,
6254 actions_blocking_raa_monitor_updates: &BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
6255 channel_funding_outpoint: OutPoint, counterparty_node_id: PublicKey
6257 actions_blocking_raa_monitor_updates
6258 .get(&channel_funding_outpoint.to_channel_id()).map(|v| !v.is_empty()).unwrap_or(false)
6259 || self.pending_events.lock().unwrap().iter().any(|(_, action)| {
6260 action == &Some(EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
6261 channel_funding_outpoint,
6262 counterparty_node_id,
6267 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
6268 let (htlcs_to_fail, res) = {
6269 let per_peer_state = self.per_peer_state.read().unwrap();
6270 let mut peer_state_lock = per_peer_state.get(counterparty_node_id)
6272 debug_assert!(false);
6273 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6274 }).map(|mtx| mtx.lock().unwrap())?;
6275 let peer_state = &mut *peer_state_lock;
6276 match peer_state.channel_by_id.entry(msg.channel_id) {
6277 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6278 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6279 let funding_txo_opt = chan.context.get_funding_txo();
6280 let mon_update_blocked = if let Some(funding_txo) = funding_txo_opt {
6281 self.raa_monitor_updates_held(
6282 &peer_state.actions_blocking_raa_monitor_updates, funding_txo,
6283 *counterparty_node_id)
6285 let (htlcs_to_fail, monitor_update_opt) = try_chan_phase_entry!(self,
6286 chan.revoke_and_ack(&msg, &self.fee_estimator, &self.logger, mon_update_blocked), chan_phase_entry);
6287 let res = if let Some(monitor_update) = monitor_update_opt {
6288 let funding_txo = funding_txo_opt
6289 .expect("Funding outpoint must have been set for RAA handling to succeed");
6290 handle_new_monitor_update!(self, funding_txo, monitor_update,
6291 peer_state_lock, peer_state, per_peer_state, chan_phase_entry).map(|_| ())
6293 (htlcs_to_fail, res)
6295 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6296 "Got a revoke_and_ack message for an unfunded channel!".into())), chan_phase_entry);
6299 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))
6302 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
6306 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
6307 let per_peer_state = self.per_peer_state.read().unwrap();
6308 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6310 debug_assert!(false);
6311 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6313 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6314 let peer_state = &mut *peer_state_lock;
6315 match peer_state.channel_by_id.entry(msg.channel_id) {
6316 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6317 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6318 try_chan_phase_entry!(self, chan.update_fee(&self.fee_estimator, &msg, &self.logger), chan_phase_entry);
6320 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6321 "Got an update_fee message for an unfunded channel!".into())), chan_phase_entry);
6324 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))
6329 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
6330 let per_peer_state = self.per_peer_state.read().unwrap();
6331 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6333 debug_assert!(false);
6334 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6336 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6337 let peer_state = &mut *peer_state_lock;
6338 match peer_state.channel_by_id.entry(msg.channel_id) {
6339 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6340 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6341 if !chan.context.is_usable() {
6342 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
6345 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
6346 msg: try_chan_phase_entry!(self, chan.announcement_signatures(
6347 &self.node_signer, self.genesis_hash.clone(), self.best_block.read().unwrap().height(),
6348 msg, &self.default_configuration
6349 ), chan_phase_entry),
6350 // Note that announcement_signatures fails if the channel cannot be announced,
6351 // so get_channel_update_for_broadcast will never fail by the time we get here.
6352 update_msg: Some(self.get_channel_update_for_broadcast(chan).unwrap()),
6355 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6356 "Got an announcement_signatures message for an unfunded channel!".into())), chan_phase_entry);
6359 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))
6364 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
6365 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
6366 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
6367 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
6369 // It's not a local channel
6370 return Ok(NotifyOption::SkipPersist)
6373 let per_peer_state = self.per_peer_state.read().unwrap();
6374 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
6375 if peer_state_mutex_opt.is_none() {
6376 return Ok(NotifyOption::SkipPersist)
6378 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
6379 let peer_state = &mut *peer_state_lock;
6380 match peer_state.channel_by_id.entry(chan_id) {
6381 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6382 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6383 if chan.context.get_counterparty_node_id() != *counterparty_node_id {
6384 if chan.context.should_announce() {
6385 // If the announcement is about a channel of ours which is public, some
6386 // other peer may simply be forwarding all its gossip to us. Don't provide
6387 // a scary-looking error message and return Ok instead.
6388 return Ok(NotifyOption::SkipPersist);
6390 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));
6392 let were_node_one = self.get_our_node_id().serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
6393 let msg_from_node_one = msg.contents.flags & 1 == 0;
6394 if were_node_one == msg_from_node_one {
6395 return Ok(NotifyOption::SkipPersist);
6397 log_debug!(self.logger, "Received channel_update for channel {}.", chan_id);
6398 try_chan_phase_entry!(self, chan.channel_update(&msg), chan_phase_entry);
6401 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6402 "Got a channel_update for an unfunded channel!".into())), chan_phase_entry);
6405 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersist)
6407 Ok(NotifyOption::DoPersist)
6410 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
6412 let need_lnd_workaround = {
6413 let per_peer_state = self.per_peer_state.read().unwrap();
6415 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6417 debug_assert!(false);
6418 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6420 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6421 let peer_state = &mut *peer_state_lock;
6422 match peer_state.channel_by_id.entry(msg.channel_id) {
6423 hash_map::Entry::Occupied(mut chan_phase_entry) => {
6424 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6425 // Currently, we expect all holding cell update_adds to be dropped on peer
6426 // disconnect, so Channel's reestablish will never hand us any holding cell
6427 // freed HTLCs to fail backwards. If in the future we no longer drop pending
6428 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
6429 let responses = try_chan_phase_entry!(self, chan.channel_reestablish(
6430 msg, &self.logger, &self.node_signer, self.genesis_hash,
6431 &self.default_configuration, &*self.best_block.read().unwrap()), chan_phase_entry);
6432 let mut channel_update = None;
6433 if let Some(msg) = responses.shutdown_msg {
6434 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
6435 node_id: counterparty_node_id.clone(),
6438 } else if chan.context.is_usable() {
6439 // If the channel is in a usable state (ie the channel is not being shut
6440 // down), send a unicast channel_update to our counterparty to make sure
6441 // they have the latest channel parameters.
6442 if let Ok(msg) = self.get_channel_update_for_unicast(chan) {
6443 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
6444 node_id: chan.context.get_counterparty_node_id(),
6449 let need_lnd_workaround = chan.context.workaround_lnd_bug_4006.take();
6450 htlc_forwards = self.handle_channel_resumption(
6451 &mut peer_state.pending_msg_events, chan, responses.raa, responses.commitment_update, responses.order,
6452 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
6453 if let Some(upd) = channel_update {
6454 peer_state.pending_msg_events.push(upd);
6458 return try_chan_phase_entry!(self, Err(ChannelError::Close(
6459 "Got a channel_reestablish message for an unfunded channel!".into())), chan_phase_entry);
6462 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))
6466 if let Some(forwards) = htlc_forwards {
6467 self.forward_htlcs(&mut [forwards][..]);
6470 if let Some(channel_ready_msg) = need_lnd_workaround {
6471 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
6476 /// Process pending events from the [`chain::Watch`], returning whether any events were processed.
6477 fn process_pending_monitor_events(&self) -> bool {
6478 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
6480 let mut failed_channels = Vec::new();
6481 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
6482 let has_pending_monitor_events = !pending_monitor_events.is_empty();
6483 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
6484 for monitor_event in monitor_events.drain(..) {
6485 match monitor_event {
6486 MonitorEvent::HTLCEvent(htlc_update) => {
6487 if let Some(preimage) = htlc_update.payment_preimage {
6488 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", &preimage);
6489 self.claim_funds_internal(htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, funding_outpoint);
6491 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", &htlc_update.payment_hash);
6492 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
6493 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
6494 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
6497 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
6498 MonitorEvent::UpdateFailed(funding_outpoint) => {
6499 let counterparty_node_id_opt = match counterparty_node_id {
6500 Some(cp_id) => Some(cp_id),
6502 // TODO: Once we can rely on the counterparty_node_id from the
6503 // monitor event, this and the id_to_peer map should be removed.
6504 let id_to_peer = self.id_to_peer.lock().unwrap();
6505 id_to_peer.get(&funding_outpoint.to_channel_id()).cloned()
6508 if let Some(counterparty_node_id) = counterparty_node_id_opt {
6509 let per_peer_state = self.per_peer_state.read().unwrap();
6510 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
6511 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6512 let peer_state = &mut *peer_state_lock;
6513 let pending_msg_events = &mut peer_state.pending_msg_events;
6514 if let hash_map::Entry::Occupied(chan_phase_entry) = peer_state.channel_by_id.entry(funding_outpoint.to_channel_id()) {
6515 if let ChannelPhase::Funded(mut chan) = remove_channel_phase!(self, chan_phase_entry) {
6516 failed_channels.push(chan.context.force_shutdown(false));
6517 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6518 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6522 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
6523 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
6525 ClosureReason::CommitmentTxConfirmed
6527 self.issue_channel_close_events(&chan.context, reason);
6528 pending_msg_events.push(events::MessageSendEvent::HandleError {
6529 node_id: chan.context.get_counterparty_node_id(),
6530 action: msgs::ErrorAction::SendErrorMessage {
6531 msg: msgs::ErrorMessage { channel_id: chan.context.channel_id(), data: "Channel force-closed".to_owned() }
6539 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
6540 self.channel_monitor_updated(&funding_txo, monitor_update_id, counterparty_node_id.as_ref());
6546 for failure in failed_channels.drain(..) {
6547 self.finish_force_close_channel(failure);
6550 has_pending_monitor_events
6553 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
6554 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
6555 /// update events as a separate process method here.
6557 pub fn process_monitor_events(&self) {
6558 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6559 self.process_pending_monitor_events();
6562 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
6563 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
6564 /// update was applied.
6565 fn check_free_holding_cells(&self) -> bool {
6566 let mut has_monitor_update = false;
6567 let mut failed_htlcs = Vec::new();
6568 let mut handle_errors = Vec::new();
6570 // Walk our list of channels and find any that need to update. Note that when we do find an
6571 // update, if it includes actions that must be taken afterwards, we have to drop the
6572 // per-peer state lock as well as the top level per_peer_state lock. Thus, we loop until we
6573 // manage to go through all our peers without finding a single channel to update.
6575 let per_peer_state = self.per_peer_state.read().unwrap();
6576 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6578 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6579 let peer_state: &mut PeerState<_> = &mut *peer_state_lock;
6580 for (channel_id, chan) in peer_state.channel_by_id.iter_mut().filter_map(
6581 |(chan_id, phase)| if let ChannelPhase::Funded(chan) = phase { Some((chan_id, chan)) } else { None }
6583 let counterparty_node_id = chan.context.get_counterparty_node_id();
6584 let funding_txo = chan.context.get_funding_txo();
6585 let (monitor_opt, holding_cell_failed_htlcs) =
6586 chan.maybe_free_holding_cell_htlcs(&self.fee_estimator, &self.logger);
6587 if !holding_cell_failed_htlcs.is_empty() {
6588 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id, counterparty_node_id));
6590 if let Some(monitor_update) = monitor_opt {
6591 has_monitor_update = true;
6593 let channel_id: ChannelId = *channel_id;
6594 let res = handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update,
6595 peer_state_lock, peer_state, per_peer_state, chan, MANUALLY_REMOVING,
6596 peer_state.channel_by_id.remove(&channel_id));
6598 handle_errors.push((counterparty_node_id, res));
6600 continue 'peer_loop;
6609 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
6610 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
6611 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
6614 for (counterparty_node_id, err) in handle_errors.drain(..) {
6615 let _ = handle_error!(self, err, counterparty_node_id);
6621 /// Check whether any channels have finished removing all pending updates after a shutdown
6622 /// exchange and can now send a closing_signed.
6623 /// Returns whether any closing_signed messages were generated.
6624 fn maybe_generate_initial_closing_signed(&self) -> bool {
6625 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
6626 let mut has_update = false;
6628 let per_peer_state = self.per_peer_state.read().unwrap();
6630 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6631 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6632 let peer_state = &mut *peer_state_lock;
6633 let pending_msg_events = &mut peer_state.pending_msg_events;
6634 peer_state.channel_by_id.retain(|channel_id, phase| {
6636 ChannelPhase::Funded(chan) => {
6637 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
6638 Ok((msg_opt, tx_opt)) => {
6639 if let Some(msg) = msg_opt {
6641 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
6642 node_id: chan.context.get_counterparty_node_id(), msg,
6645 if let Some(tx) = tx_opt {
6646 // We're done with this channel. We got a closing_signed and sent back
6647 // a closing_signed with a closing transaction to broadcast.
6648 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6649 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6654 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
6656 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
6657 self.tx_broadcaster.broadcast_transactions(&[&tx]);
6658 update_maps_on_chan_removal!(self, &chan.context);
6664 let (close_channel, res) = convert_chan_phase_err!(self, e, chan, channel_id, FUNDED_CHANNEL);
6665 handle_errors.push((chan.context.get_counterparty_node_id(), Err(res)));
6670 _ => true, // Retain unfunded channels if present.
6676 for (counterparty_node_id, err) in handle_errors.drain(..) {
6677 let _ = handle_error!(self, err, counterparty_node_id);
6683 /// Handle a list of channel failures during a block_connected or block_disconnected call,
6684 /// pushing the channel monitor update (if any) to the background events queue and removing the
6686 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
6687 for mut failure in failed_channels.drain(..) {
6688 // Either a commitment transactions has been confirmed on-chain or
6689 // Channel::block_disconnected detected that the funding transaction has been
6690 // reorganized out of the main chain.
6691 // We cannot broadcast our latest local state via monitor update (as
6692 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
6693 // so we track the update internally and handle it when the user next calls
6694 // timer_tick_occurred, guaranteeing we're running normally.
6695 if let Some((counterparty_node_id, funding_txo, update)) = failure.0.take() {
6696 assert_eq!(update.updates.len(), 1);
6697 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
6698 assert!(should_broadcast);
6699 } else { unreachable!(); }
6700 self.pending_background_events.lock().unwrap().push(
6701 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
6702 counterparty_node_id, funding_txo, update
6705 self.finish_force_close_channel(failure);
6709 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
6712 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
6713 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
6715 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
6716 /// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
6717 /// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
6718 /// passed directly to [`claim_funds`].
6720 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
6722 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
6723 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
6727 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
6728 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
6730 /// Errors if `min_value_msat` is greater than total bitcoin supply.
6732 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
6733 /// on versions of LDK prior to 0.0.114.
6735 /// [`claim_funds`]: Self::claim_funds
6736 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
6737 /// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
6738 /// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
6739 /// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
6740 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
6741 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
6742 min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
6743 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs,
6744 &self.entropy_source, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
6745 min_final_cltv_expiry_delta)
6748 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
6749 /// stored external to LDK.
6751 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
6752 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
6753 /// the `min_value_msat` provided here, if one is provided.
6755 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
6756 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
6759 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
6760 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
6761 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
6762 /// sender "proof-of-payment" unless they have paid the required amount.
6764 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
6765 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
6766 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
6767 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
6768 /// invoices when no timeout is set.
6770 /// Note that we use block header time to time-out pending inbound payments (with some margin
6771 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
6772 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
6773 /// If you need exact expiry semantics, you should enforce them upon receipt of
6774 /// [`PaymentClaimable`].
6776 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
6777 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
6779 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
6780 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
6784 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
6785 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
6787 /// Errors if `min_value_msat` is greater than total bitcoin supply.
6789 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
6790 /// on versions of LDK prior to 0.0.114.
6792 /// [`create_inbound_payment`]: Self::create_inbound_payment
6793 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
6794 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>,
6795 invoice_expiry_delta_secs: u32, min_final_cltv_expiry: Option<u16>) -> Result<PaymentSecret, ()> {
6796 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash,
6797 invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
6798 min_final_cltv_expiry)
6801 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
6802 /// previously returned from [`create_inbound_payment`].
6804 /// [`create_inbound_payment`]: Self::create_inbound_payment
6805 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
6806 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
6809 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
6810 /// are used when constructing the phantom invoice's route hints.
6812 /// [phantom node payments]: crate::sign::PhantomKeysManager
6813 pub fn get_phantom_scid(&self) -> u64 {
6814 let best_block_height = self.best_block.read().unwrap().height();
6815 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
6817 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
6818 // Ensure the generated scid doesn't conflict with a real channel.
6819 match short_to_chan_info.get(&scid_candidate) {
6820 Some(_) => continue,
6821 None => return scid_candidate
6826 /// Gets route hints for use in receiving [phantom node payments].
6828 /// [phantom node payments]: crate::sign::PhantomKeysManager
6829 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
6831 channels: self.list_usable_channels(),
6832 phantom_scid: self.get_phantom_scid(),
6833 real_node_pubkey: self.get_our_node_id(),
6837 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
6838 /// used when constructing the route hints for HTLCs intended to be intercepted. See
6839 /// [`ChannelManager::forward_intercepted_htlc`].
6841 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
6842 /// times to get a unique scid.
6843 pub fn get_intercept_scid(&self) -> u64 {
6844 let best_block_height = self.best_block.read().unwrap().height();
6845 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
6847 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
6848 // Ensure the generated scid doesn't conflict with a real channel.
6849 if short_to_chan_info.contains_key(&scid_candidate) { continue }
6850 return scid_candidate
6854 /// Gets inflight HTLC information by processing pending outbound payments that are in
6855 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
6856 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
6857 let mut inflight_htlcs = InFlightHtlcs::new();
6859 let per_peer_state = self.per_peer_state.read().unwrap();
6860 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6861 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6862 let peer_state = &mut *peer_state_lock;
6863 for chan in peer_state.channel_by_id.values().filter_map(
6864 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
6866 for (htlc_source, _) in chan.inflight_htlc_sources() {
6867 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
6868 inflight_htlcs.process_path(path, self.get_our_node_id());
6877 #[cfg(any(test, feature = "_test_utils"))]
6878 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
6879 let events = core::cell::RefCell::new(Vec::new());
6880 let event_handler = |event: events::Event| events.borrow_mut().push(event);
6881 self.process_pending_events(&event_handler);
6885 #[cfg(feature = "_test_utils")]
6886 pub fn push_pending_event(&self, event: events::Event) {
6887 let mut events = self.pending_events.lock().unwrap();
6888 events.push_back((event, None));
6892 pub fn pop_pending_event(&self) -> Option<events::Event> {
6893 let mut events = self.pending_events.lock().unwrap();
6894 events.pop_front().map(|(e, _)| e)
6898 pub fn has_pending_payments(&self) -> bool {
6899 self.pending_outbound_payments.has_pending_payments()
6903 pub fn clear_pending_payments(&self) {
6904 self.pending_outbound_payments.clear_pending_payments()
6907 /// When something which was blocking a channel from updating its [`ChannelMonitor`] (e.g. an
6908 /// [`Event`] being handled) completes, this should be called to restore the channel to normal
6909 /// operation. It will double-check that nothing *else* is also blocking the same channel from
6910 /// making progress and then let any blocked [`ChannelMonitorUpdate`]s fly.
6911 fn handle_monitor_update_release(&self, counterparty_node_id: PublicKey, channel_funding_outpoint: OutPoint, mut completed_blocker: Option<RAAMonitorUpdateBlockingAction>) {
6912 let mut errors = Vec::new();
6914 let per_peer_state = self.per_peer_state.read().unwrap();
6915 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
6916 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
6917 let peer_state = &mut *peer_state_lck;
6919 if let Some(blocker) = completed_blocker.take() {
6920 // Only do this on the first iteration of the loop.
6921 if let Some(blockers) = peer_state.actions_blocking_raa_monitor_updates
6922 .get_mut(&channel_funding_outpoint.to_channel_id())
6924 blockers.retain(|iter| iter != &blocker);
6928 if self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
6929 channel_funding_outpoint, counterparty_node_id) {
6930 // Check that, while holding the peer lock, we don't have anything else
6931 // blocking monitor updates for this channel. If we do, release the monitor
6932 // update(s) when those blockers complete.
6933 log_trace!(self.logger, "Delaying monitor unlock for channel {} as another channel's mon update needs to complete first",
6934 &channel_funding_outpoint.to_channel_id());
6938 if let hash_map::Entry::Occupied(mut chan_phase_entry) = peer_state.channel_by_id.entry(channel_funding_outpoint.to_channel_id()) {
6939 if let ChannelPhase::Funded(chan) = chan_phase_entry.get_mut() {
6940 debug_assert_eq!(chan.context.get_funding_txo().unwrap(), channel_funding_outpoint);
6941 if let Some((monitor_update, further_update_exists)) = chan.unblock_next_blocked_monitor_update() {
6942 log_debug!(self.logger, "Unlocking monitor updating for channel {} and updating monitor",
6943 channel_funding_outpoint.to_channel_id());
6944 if let Err(e) = handle_new_monitor_update!(self, channel_funding_outpoint, monitor_update,
6945 peer_state_lck, peer_state, per_peer_state, chan_phase_entry)
6947 errors.push((e, counterparty_node_id));
6949 if further_update_exists {
6950 // If there are more `ChannelMonitorUpdate`s to process, restart at the
6955 log_trace!(self.logger, "Unlocked monitor updating for channel {} without monitors to update",
6956 channel_funding_outpoint.to_channel_id());
6961 log_debug!(self.logger,
6962 "Got a release post-RAA monitor update for peer {} but the channel is gone",
6963 log_pubkey!(counterparty_node_id));
6967 for (err, counterparty_node_id) in errors {
6968 let res = Err::<(), _>(err);
6969 let _ = handle_error!(self, res, counterparty_node_id);
6973 fn handle_post_event_actions(&self, actions: Vec<EventCompletionAction>) {
6974 for action in actions {
6976 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
6977 channel_funding_outpoint, counterparty_node_id
6979 self.handle_monitor_update_release(counterparty_node_id, channel_funding_outpoint, None);
6985 /// Processes any events asynchronously in the order they were generated since the last call
6986 /// using the given event handler.
6988 /// See the trait-level documentation of [`EventsProvider`] for requirements.
6989 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
6993 process_events_body!(self, ev, { handler(ev).await });
6997 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>
6999 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7000 T::Target: BroadcasterInterface,
7001 ES::Target: EntropySource,
7002 NS::Target: NodeSigner,
7003 SP::Target: SignerProvider,
7004 F::Target: FeeEstimator,
7008 /// Returns `MessageSendEvent`s strictly ordered per-peer, in the order they were generated.
7009 /// The returned array will contain `MessageSendEvent`s for different peers if
7010 /// `MessageSendEvent`s to more than one peer exists, but `MessageSendEvent`s to the same peer
7011 /// is always placed next to each other.
7013 /// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
7014 /// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
7015 /// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
7016 /// will randomly be placed first or last in the returned array.
7018 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
7019 /// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
7020 /// the `MessageSendEvent`s to the specific peer they were generated under.
7021 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
7022 let events = RefCell::new(Vec::new());
7023 PersistenceNotifierGuard::optionally_notify(self, || {
7024 let mut result = NotifyOption::SkipPersist;
7026 // TODO: This behavior should be documented. It's unintuitive that we query
7027 // ChannelMonitors when clearing other events.
7028 if self.process_pending_monitor_events() {
7029 result = NotifyOption::DoPersist;
7032 if self.check_free_holding_cells() {
7033 result = NotifyOption::DoPersist;
7035 if self.maybe_generate_initial_closing_signed() {
7036 result = NotifyOption::DoPersist;
7039 let mut pending_events = Vec::new();
7040 let per_peer_state = self.per_peer_state.read().unwrap();
7041 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7042 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7043 let peer_state = &mut *peer_state_lock;
7044 if peer_state.pending_msg_events.len() > 0 {
7045 pending_events.append(&mut peer_state.pending_msg_events);
7049 if !pending_events.is_empty() {
7050 events.replace(pending_events);
7059 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>
7061 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7062 T::Target: BroadcasterInterface,
7063 ES::Target: EntropySource,
7064 NS::Target: NodeSigner,
7065 SP::Target: SignerProvider,
7066 F::Target: FeeEstimator,
7070 /// Processes events that must be periodically handled.
7072 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
7073 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
7074 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
7076 process_events_body!(self, ev, handler.handle_event(ev));
7080 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>
7082 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7083 T::Target: BroadcasterInterface,
7084 ES::Target: EntropySource,
7085 NS::Target: NodeSigner,
7086 SP::Target: SignerProvider,
7087 F::Target: FeeEstimator,
7091 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
7093 let best_block = self.best_block.read().unwrap();
7094 assert_eq!(best_block.block_hash(), header.prev_blockhash,
7095 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
7096 assert_eq!(best_block.height(), height - 1,
7097 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
7100 self.transactions_confirmed(header, txdata, height);
7101 self.best_block_updated(header, height);
7104 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
7105 let _persistence_guard =
7106 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
7107 self, || -> NotifyOption { NotifyOption::DoPersist });
7108 let new_height = height - 1;
7110 let mut best_block = self.best_block.write().unwrap();
7111 assert_eq!(best_block.block_hash(), header.block_hash(),
7112 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
7113 assert_eq!(best_block.height(), height,
7114 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
7115 *best_block = BestBlock::new(header.prev_blockhash, new_height)
7118 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));
7122 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>
7124 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7125 T::Target: BroadcasterInterface,
7126 ES::Target: EntropySource,
7127 NS::Target: NodeSigner,
7128 SP::Target: SignerProvider,
7129 F::Target: FeeEstimator,
7133 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
7134 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
7135 // during initialization prior to the chain_monitor being fully configured in some cases.
7136 // See the docs for `ChannelManagerReadArgs` for more.
7138 let block_hash = header.block_hash();
7139 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
7141 let _persistence_guard =
7142 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
7143 self, || -> NotifyOption { NotifyOption::DoPersist });
7144 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)
7145 .map(|(a, b)| (a, Vec::new(), b)));
7147 let last_best_block_height = self.best_block.read().unwrap().height();
7148 if height < last_best_block_height {
7149 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
7150 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));
7154 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
7155 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
7156 // during initialization prior to the chain_monitor being fully configured in some cases.
7157 // See the docs for `ChannelManagerReadArgs` for more.
7159 let block_hash = header.block_hash();
7160 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
7162 let _persistence_guard =
7163 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
7164 self, || -> NotifyOption { NotifyOption::DoPersist });
7165 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
7167 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));
7169 macro_rules! max_time {
7170 ($timestamp: expr) => {
7172 // Update $timestamp to be the max of its current value and the block
7173 // timestamp. This should keep us close to the current time without relying on
7174 // having an explicit local time source.
7175 // Just in case we end up in a race, we loop until we either successfully
7176 // update $timestamp or decide we don't need to.
7177 let old_serial = $timestamp.load(Ordering::Acquire);
7178 if old_serial >= header.time as usize { break; }
7179 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
7185 max_time!(self.highest_seen_timestamp);
7186 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
7187 payment_secrets.retain(|_, inbound_payment| {
7188 inbound_payment.expiry_time > header.time as u64
7192 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
7193 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
7194 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
7195 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7196 let peer_state = &mut *peer_state_lock;
7197 for chan in peer_state.channel_by_id.values().filter_map(|phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }) {
7198 if let (Some(funding_txo), Some(block_hash)) = (chan.context.get_funding_txo(), chan.context.get_funding_tx_confirmed_in()) {
7199 res.push((funding_txo.txid, Some(block_hash)));
7206 fn transaction_unconfirmed(&self, txid: &Txid) {
7207 let _persistence_guard =
7208 PersistenceNotifierGuard::optionally_notify_skipping_background_events(
7209 self, || -> NotifyOption { NotifyOption::DoPersist });
7210 self.do_chain_event(None, |channel| {
7211 if let Some(funding_txo) = channel.context.get_funding_txo() {
7212 if funding_txo.txid == *txid {
7213 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
7214 } else { Ok((None, Vec::new(), None)) }
7215 } else { Ok((None, Vec::new(), None)) }
7220 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>
7222 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7223 T::Target: BroadcasterInterface,
7224 ES::Target: EntropySource,
7225 NS::Target: NodeSigner,
7226 SP::Target: SignerProvider,
7227 F::Target: FeeEstimator,
7231 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
7232 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
7234 fn do_chain_event<FN: Fn(&mut Channel<SP>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
7235 (&self, height_opt: Option<u32>, f: FN) {
7236 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
7237 // during initialization prior to the chain_monitor being fully configured in some cases.
7238 // See the docs for `ChannelManagerReadArgs` for more.
7240 let mut failed_channels = Vec::new();
7241 let mut timed_out_htlcs = Vec::new();
7243 let per_peer_state = self.per_peer_state.read().unwrap();
7244 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7245 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7246 let peer_state = &mut *peer_state_lock;
7247 let pending_msg_events = &mut peer_state.pending_msg_events;
7248 peer_state.channel_by_id.retain(|_, phase| {
7250 // Retain unfunded channels.
7251 ChannelPhase::UnfundedOutboundV1(_) | ChannelPhase::UnfundedInboundV1(_) => true,
7252 ChannelPhase::Funded(channel) => {
7253 let res = f(channel);
7254 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
7255 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
7256 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
7257 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
7258 HTLCDestination::NextHopChannel { node_id: Some(channel.context.get_counterparty_node_id()), channel_id: channel.context.channel_id() }));
7260 if let Some(channel_ready) = channel_ready_opt {
7261 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
7262 if channel.context.is_usable() {
7263 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", channel.context.channel_id());
7264 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
7265 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
7266 node_id: channel.context.get_counterparty_node_id(),
7271 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", channel.context.channel_id());
7276 let mut pending_events = self.pending_events.lock().unwrap();
7277 emit_channel_ready_event!(pending_events, channel);
7280 if let Some(announcement_sigs) = announcement_sigs {
7281 log_trace!(self.logger, "Sending announcement_signatures for channel {}", channel.context.channel_id());
7282 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
7283 node_id: channel.context.get_counterparty_node_id(),
7284 msg: announcement_sigs,
7286 if let Some(height) = height_opt {
7287 if let Some(announcement) = channel.get_signed_channel_announcement(&self.node_signer, self.genesis_hash, height, &self.default_configuration) {
7288 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
7290 // Note that announcement_signatures fails if the channel cannot be announced,
7291 // so get_channel_update_for_broadcast will never fail by the time we get here.
7292 update_msg: Some(self.get_channel_update_for_broadcast(channel).unwrap()),
7297 if channel.is_our_channel_ready() {
7298 if let Some(real_scid) = channel.context.get_short_channel_id() {
7299 // If we sent a 0conf channel_ready, and now have an SCID, we add it
7300 // to the short_to_chan_info map here. Note that we check whether we
7301 // can relay using the real SCID at relay-time (i.e.
7302 // enforce option_scid_alias then), and if the funding tx is ever
7303 // un-confirmed we force-close the channel, ensuring short_to_chan_info
7304 // is always consistent.
7305 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
7306 let scid_insert = short_to_chan_info.insert(real_scid, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
7307 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.context.get_counterparty_node_id(), channel.context.channel_id()),
7308 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
7309 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
7312 } else if let Err(reason) = res {
7313 update_maps_on_chan_removal!(self, &channel.context);
7314 // It looks like our counterparty went on-chain or funding transaction was
7315 // reorged out of the main chain. Close the channel.
7316 failed_channels.push(channel.context.force_shutdown(true));
7317 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
7318 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7322 let reason_message = format!("{}", reason);
7323 self.issue_channel_close_events(&channel.context, reason);
7324 pending_msg_events.push(events::MessageSendEvent::HandleError {
7325 node_id: channel.context.get_counterparty_node_id(),
7326 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
7327 channel_id: channel.context.channel_id(),
7328 data: reason_message,
7340 if let Some(height) = height_opt {
7341 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
7342 payment.htlcs.retain(|htlc| {
7343 // If height is approaching the number of blocks we think it takes us to get
7344 // our commitment transaction confirmed before the HTLC expires, plus the
7345 // number of blocks we generally consider it to take to do a commitment update,
7346 // just give up on it and fail the HTLC.
7347 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
7348 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
7349 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
7351 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
7352 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
7353 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
7357 !payment.htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
7360 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
7361 intercepted_htlcs.retain(|_, htlc| {
7362 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
7363 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
7364 short_channel_id: htlc.prev_short_channel_id,
7365 user_channel_id: Some(htlc.prev_user_channel_id),
7366 htlc_id: htlc.prev_htlc_id,
7367 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
7368 phantom_shared_secret: None,
7369 outpoint: htlc.prev_funding_outpoint,
7372 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
7373 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
7374 _ => unreachable!(),
7376 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
7377 HTLCFailReason::from_failure_code(0x2000 | 2),
7378 HTLCDestination::InvalidForward { requested_forward_scid }));
7379 log_trace!(self.logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
7385 self.handle_init_event_channel_failures(failed_channels);
7387 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
7388 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
7392 /// Gets a [`Future`] that completes when this [`ChannelManager`] may need to be persisted or
7393 /// may have events that need processing.
7395 /// In order to check if this [`ChannelManager`] needs persisting, call
7396 /// [`Self::get_and_clear_needs_persistence`].
7398 /// Note that callbacks registered on the [`Future`] MUST NOT call back into this
7399 /// [`ChannelManager`] and should instead register actions to be taken later.
7400 pub fn get_event_or_persistence_needed_future(&self) -> Future {
7401 self.event_persist_notifier.get_future()
7404 /// Returns true if this [`ChannelManager`] needs to be persisted.
7405 pub fn get_and_clear_needs_persistence(&self) -> bool {
7406 self.needs_persist_flag.swap(false, Ordering::AcqRel)
7409 #[cfg(any(test, feature = "_test_utils"))]
7410 pub fn get_event_or_persist_condvar_value(&self) -> bool {
7411 self.event_persist_notifier.notify_pending()
7414 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
7415 /// [`chain::Confirm`] interfaces.
7416 pub fn current_best_block(&self) -> BestBlock {
7417 self.best_block.read().unwrap().clone()
7420 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
7421 /// [`ChannelManager`].
7422 pub fn node_features(&self) -> NodeFeatures {
7423 provided_node_features(&self.default_configuration)
7426 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags which are provided by or required by
7427 /// [`ChannelManager`].
7429 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
7430 /// or not. Thus, this method is not public.
7431 #[cfg(any(feature = "_test_utils", test))]
7432 pub fn invoice_features(&self) -> Bolt11InvoiceFeatures {
7433 provided_invoice_features(&self.default_configuration)
7436 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
7437 /// [`ChannelManager`].
7438 pub fn channel_features(&self) -> ChannelFeatures {
7439 provided_channel_features(&self.default_configuration)
7442 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
7443 /// [`ChannelManager`].
7444 pub fn channel_type_features(&self) -> ChannelTypeFeatures {
7445 provided_channel_type_features(&self.default_configuration)
7448 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
7449 /// [`ChannelManager`].
7450 pub fn init_features(&self) -> InitFeatures {
7451 provided_init_features(&self.default_configuration)
7455 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7456 ChannelMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
7458 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7459 T::Target: BroadcasterInterface,
7460 ES::Target: EntropySource,
7461 NS::Target: NodeSigner,
7462 SP::Target: SignerProvider,
7463 F::Target: FeeEstimator,
7467 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) {
7468 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7469 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, msg), *counterparty_node_id);
7472 fn handle_open_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
7473 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7474 "Dual-funded channels not supported".to_owned(),
7475 msg.temporary_channel_id.clone())), *counterparty_node_id);
7478 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
7479 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7480 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, msg), *counterparty_node_id);
7483 fn handle_accept_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
7484 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7485 "Dual-funded channels not supported".to_owned(),
7486 msg.temporary_channel_id.clone())), *counterparty_node_id);
7489 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
7490 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7491 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
7494 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
7495 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7496 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
7499 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
7500 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7501 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
7504 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
7505 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7506 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
7509 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
7510 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7511 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
7514 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
7515 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7516 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
7519 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
7520 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7521 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
7524 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
7525 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7526 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
7529 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
7530 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7531 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
7534 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
7535 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7536 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
7539 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
7540 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7541 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
7544 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
7545 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7546 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
7549 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
7550 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7551 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
7554 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
7555 PersistenceNotifierGuard::optionally_notify(self, || {
7556 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
7559 NotifyOption::SkipPersist
7564 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
7565 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7566 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
7569 fn peer_disconnected(&self, counterparty_node_id: &PublicKey) {
7570 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7571 let mut failed_channels = Vec::new();
7572 let mut per_peer_state = self.per_peer_state.write().unwrap();
7574 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates.",
7575 log_pubkey!(counterparty_node_id));
7576 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
7577 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7578 let peer_state = &mut *peer_state_lock;
7579 let pending_msg_events = &mut peer_state.pending_msg_events;
7580 peer_state.channel_by_id.retain(|_, phase| {
7581 let context = match phase {
7582 ChannelPhase::Funded(chan) => {
7583 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
7584 // We only retain funded channels that are not shutdown.
7585 if !chan.is_shutdown() {
7590 // Unfunded channels will always be removed.
7591 ChannelPhase::UnfundedOutboundV1(chan) => {
7594 ChannelPhase::UnfundedInboundV1(chan) => {
7598 // Clean up for removal.
7599 update_maps_on_chan_removal!(self, &context);
7600 self.issue_channel_close_events(&context, ClosureReason::DisconnectedPeer);
7603 // Note that we don't bother generating any events for pre-accept channels -
7604 // they're not considered "channels" yet from the PoV of our events interface.
7605 peer_state.inbound_channel_request_by_id.clear();
7606 pending_msg_events.retain(|msg| {
7608 // V1 Channel Establishment
7609 &events::MessageSendEvent::SendAcceptChannel { .. } => false,
7610 &events::MessageSendEvent::SendOpenChannel { .. } => false,
7611 &events::MessageSendEvent::SendFundingCreated { .. } => false,
7612 &events::MessageSendEvent::SendFundingSigned { .. } => false,
7613 // V2 Channel Establishment
7614 &events::MessageSendEvent::SendAcceptChannelV2 { .. } => false,
7615 &events::MessageSendEvent::SendOpenChannelV2 { .. } => false,
7616 // Common Channel Establishment
7617 &events::MessageSendEvent::SendChannelReady { .. } => false,
7618 &events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
7619 // Interactive Transaction Construction
7620 &events::MessageSendEvent::SendTxAddInput { .. } => false,
7621 &events::MessageSendEvent::SendTxAddOutput { .. } => false,
7622 &events::MessageSendEvent::SendTxRemoveInput { .. } => false,
7623 &events::MessageSendEvent::SendTxRemoveOutput { .. } => false,
7624 &events::MessageSendEvent::SendTxComplete { .. } => false,
7625 &events::MessageSendEvent::SendTxSignatures { .. } => false,
7626 &events::MessageSendEvent::SendTxInitRbf { .. } => false,
7627 &events::MessageSendEvent::SendTxAckRbf { .. } => false,
7628 &events::MessageSendEvent::SendTxAbort { .. } => false,
7629 // Channel Operations
7630 &events::MessageSendEvent::UpdateHTLCs { .. } => false,
7631 &events::MessageSendEvent::SendRevokeAndACK { .. } => false,
7632 &events::MessageSendEvent::SendClosingSigned { .. } => false,
7633 &events::MessageSendEvent::SendShutdown { .. } => false,
7634 &events::MessageSendEvent::SendChannelReestablish { .. } => false,
7635 &events::MessageSendEvent::HandleError { .. } => false,
7637 &events::MessageSendEvent::SendChannelAnnouncement { .. } => false,
7638 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
7639 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
7640 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
7641 &events::MessageSendEvent::SendChannelUpdate { .. } => false,
7642 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
7643 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
7644 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
7645 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
7648 debug_assert!(peer_state.is_connected, "A disconnected peer cannot disconnect");
7649 peer_state.is_connected = false;
7650 peer_state.ok_to_remove(true)
7651 } else { debug_assert!(false, "Unconnected peer disconnected"); true }
7654 per_peer_state.remove(counterparty_node_id);
7656 mem::drop(per_peer_state);
7658 for failure in failed_channels.drain(..) {
7659 self.finish_force_close_channel(failure);
7663 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init, inbound: bool) -> Result<(), ()> {
7664 if !init_msg.features.supports_static_remote_key() {
7665 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting", log_pubkey!(counterparty_node_id));
7669 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7671 // If we have too many peers connected which don't have funded channels, disconnect the
7672 // peer immediately (as long as it doesn't have funded channels). If we have a bunch of
7673 // unfunded channels taking up space in memory for disconnected peers, we still let new
7674 // peers connect, but we'll reject new channels from them.
7675 let connected_peers_without_funded_channels = self.peers_without_funded_channels(|node| node.is_connected);
7676 let inbound_peer_limited = inbound && connected_peers_without_funded_channels >= MAX_NO_CHANNEL_PEERS;
7679 let mut peer_state_lock = self.per_peer_state.write().unwrap();
7680 match peer_state_lock.entry(counterparty_node_id.clone()) {
7681 hash_map::Entry::Vacant(e) => {
7682 if inbound_peer_limited {
7685 e.insert(Mutex::new(PeerState {
7686 channel_by_id: HashMap::new(),
7687 inbound_channel_request_by_id: HashMap::new(),
7688 latest_features: init_msg.features.clone(),
7689 pending_msg_events: Vec::new(),
7690 in_flight_monitor_updates: BTreeMap::new(),
7691 monitor_update_blocked_actions: BTreeMap::new(),
7692 actions_blocking_raa_monitor_updates: BTreeMap::new(),
7696 hash_map::Entry::Occupied(e) => {
7697 let mut peer_state = e.get().lock().unwrap();
7698 peer_state.latest_features = init_msg.features.clone();
7700 let best_block_height = self.best_block.read().unwrap().height();
7701 if inbound_peer_limited &&
7702 Self::unfunded_channel_count(&*peer_state, best_block_height) ==
7703 peer_state.channel_by_id.len()
7708 debug_assert!(!peer_state.is_connected, "A peer shouldn't be connected twice");
7709 peer_state.is_connected = true;
7714 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
7716 let per_peer_state = self.per_peer_state.read().unwrap();
7717 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
7718 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7719 let peer_state = &mut *peer_state_lock;
7720 let pending_msg_events = &mut peer_state.pending_msg_events;
7722 peer_state.channel_by_id.iter_mut().filter_map(|(_, phase)|
7723 if let ChannelPhase::Funded(chan) = phase { Some(chan) } else {
7724 // Since unfunded channel maps are cleared upon disconnecting a peer, and they're not persisted
7725 // (so won't be recovered after a crash), they shouldn't exist here and we would never need to
7726 // worry about closing and removing them.
7727 debug_assert!(false);
7731 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
7732 node_id: chan.context.get_counterparty_node_id(),
7733 msg: chan.get_channel_reestablish(&self.logger),
7737 //TODO: Also re-broadcast announcement_signatures
7741 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
7742 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7744 match &msg.data as &str {
7745 "cannot co-op close channel w/ active htlcs"|
7746 "link failed to shutdown" =>
7748 // LND hasn't properly handled shutdown messages ever, and force-closes any time we
7749 // send one while HTLCs are still present. The issue is tracked at
7750 // https://github.com/lightningnetwork/lnd/issues/6039 and has had multiple patches
7751 // to fix it but none so far have managed to land upstream. The issue appears to be
7752 // very low priority for the LND team despite being marked "P1".
7753 // We're not going to bother handling this in a sensible way, instead simply
7754 // repeating the Shutdown message on repeat until morale improves.
7755 if !msg.channel_id.is_zero() {
7756 let per_peer_state = self.per_peer_state.read().unwrap();
7757 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
7758 if peer_state_mutex_opt.is_none() { return; }
7759 let mut peer_state = peer_state_mutex_opt.unwrap().lock().unwrap();
7760 if let Some(ChannelPhase::Funded(chan)) = peer_state.channel_by_id.get(&msg.channel_id) {
7761 if let Some(msg) = chan.get_outbound_shutdown() {
7762 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
7763 node_id: *counterparty_node_id,
7767 peer_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
7768 node_id: *counterparty_node_id,
7769 action: msgs::ErrorAction::SendWarningMessage {
7770 msg: msgs::WarningMessage {
7771 channel_id: msg.channel_id,
7772 data: "You appear to be exhibiting LND bug 6039, we'll keep sending you shutdown messages until you handle them correctly".to_owned()
7774 log_level: Level::Trace,
7784 if msg.channel_id.is_zero() {
7785 let channel_ids: Vec<ChannelId> = {
7786 let per_peer_state = self.per_peer_state.read().unwrap();
7787 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
7788 if peer_state_mutex_opt.is_none() { return; }
7789 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
7790 let peer_state = &mut *peer_state_lock;
7791 // Note that we don't bother generating any events for pre-accept channels -
7792 // they're not considered "channels" yet from the PoV of our events interface.
7793 peer_state.inbound_channel_request_by_id.clear();
7794 peer_state.channel_by_id.keys().cloned().collect()
7796 for channel_id in channel_ids {
7797 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
7798 let _ = self.force_close_channel_with_peer(&channel_id, counterparty_node_id, Some(&msg.data), true);
7802 // First check if we can advance the channel type and try again.
7803 let per_peer_state = self.per_peer_state.read().unwrap();
7804 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
7805 if peer_state_mutex_opt.is_none() { return; }
7806 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
7807 let peer_state = &mut *peer_state_lock;
7808 if let Some(ChannelPhase::UnfundedOutboundV1(chan)) = peer_state.channel_by_id.get_mut(&msg.channel_id) {
7809 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash, &self.fee_estimator) {
7810 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
7811 node_id: *counterparty_node_id,
7819 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
7820 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
7824 fn provided_node_features(&self) -> NodeFeatures {
7825 provided_node_features(&self.default_configuration)
7828 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
7829 provided_init_features(&self.default_configuration)
7832 fn get_genesis_hashes(&self) -> Option<Vec<ChainHash>> {
7833 Some(vec![ChainHash::from(&self.genesis_hash[..])])
7836 fn handle_tx_add_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddInput) {
7837 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7838 "Dual-funded channels not supported".to_owned(),
7839 msg.channel_id.clone())), *counterparty_node_id);
7842 fn handle_tx_add_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
7843 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7844 "Dual-funded channels not supported".to_owned(),
7845 msg.channel_id.clone())), *counterparty_node_id);
7848 fn handle_tx_remove_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
7849 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7850 "Dual-funded channels not supported".to_owned(),
7851 msg.channel_id.clone())), *counterparty_node_id);
7854 fn handle_tx_remove_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
7855 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7856 "Dual-funded channels not supported".to_owned(),
7857 msg.channel_id.clone())), *counterparty_node_id);
7860 fn handle_tx_complete(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxComplete) {
7861 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7862 "Dual-funded channels not supported".to_owned(),
7863 msg.channel_id.clone())), *counterparty_node_id);
7866 fn handle_tx_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxSignatures) {
7867 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7868 "Dual-funded channels not supported".to_owned(),
7869 msg.channel_id.clone())), *counterparty_node_id);
7872 fn handle_tx_init_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
7873 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7874 "Dual-funded channels not supported".to_owned(),
7875 msg.channel_id.clone())), *counterparty_node_id);
7878 fn handle_tx_ack_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
7879 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7880 "Dual-funded channels not supported".to_owned(),
7881 msg.channel_id.clone())), *counterparty_node_id);
7884 fn handle_tx_abort(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAbort) {
7885 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7886 "Dual-funded channels not supported".to_owned(),
7887 msg.channel_id.clone())), *counterparty_node_id);
7891 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
7892 /// [`ChannelManager`].
7893 pub(crate) fn provided_node_features(config: &UserConfig) -> NodeFeatures {
7894 let mut node_features = provided_init_features(config).to_context();
7895 node_features.set_keysend_optional();
7899 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags which are provided by or required by
7900 /// [`ChannelManager`].
7902 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
7903 /// or not. Thus, this method is not public.
7904 #[cfg(any(feature = "_test_utils", test))]
7905 pub(crate) fn provided_invoice_features(config: &UserConfig) -> Bolt11InvoiceFeatures {
7906 provided_init_features(config).to_context()
7909 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
7910 /// [`ChannelManager`].
7911 pub(crate) fn provided_channel_features(config: &UserConfig) -> ChannelFeatures {
7912 provided_init_features(config).to_context()
7915 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
7916 /// [`ChannelManager`].
7917 pub(crate) fn provided_channel_type_features(config: &UserConfig) -> ChannelTypeFeatures {
7918 ChannelTypeFeatures::from_init(&provided_init_features(config))
7921 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
7922 /// [`ChannelManager`].
7923 pub fn provided_init_features(config: &UserConfig) -> InitFeatures {
7924 // Note that if new features are added here which other peers may (eventually) require, we
7925 // should also add the corresponding (optional) bit to the [`ChannelMessageHandler`] impl for
7926 // [`ErroringMessageHandler`].
7927 let mut features = InitFeatures::empty();
7928 features.set_data_loss_protect_required();
7929 features.set_upfront_shutdown_script_optional();
7930 features.set_variable_length_onion_required();
7931 features.set_static_remote_key_required();
7932 features.set_payment_secret_required();
7933 features.set_basic_mpp_optional();
7934 features.set_wumbo_optional();
7935 features.set_shutdown_any_segwit_optional();
7936 features.set_channel_type_optional();
7937 features.set_scid_privacy_optional();
7938 features.set_zero_conf_optional();
7939 if config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx {
7940 features.set_anchors_zero_fee_htlc_tx_optional();
7945 const SERIALIZATION_VERSION: u8 = 1;
7946 const MIN_SERIALIZATION_VERSION: u8 = 1;
7948 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
7949 (2, fee_base_msat, required),
7950 (4, fee_proportional_millionths, required),
7951 (6, cltv_expiry_delta, required),
7954 impl_writeable_tlv_based!(ChannelCounterparty, {
7955 (2, node_id, required),
7956 (4, features, required),
7957 (6, unspendable_punishment_reserve, required),
7958 (8, forwarding_info, option),
7959 (9, outbound_htlc_minimum_msat, option),
7960 (11, outbound_htlc_maximum_msat, option),
7963 impl Writeable for ChannelDetails {
7964 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
7965 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
7966 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
7967 let user_channel_id_low = self.user_channel_id as u64;
7968 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
7969 write_tlv_fields!(writer, {
7970 (1, self.inbound_scid_alias, option),
7971 (2, self.channel_id, required),
7972 (3, self.channel_type, option),
7973 (4, self.counterparty, required),
7974 (5, self.outbound_scid_alias, option),
7975 (6, self.funding_txo, option),
7976 (7, self.config, option),
7977 (8, self.short_channel_id, option),
7978 (9, self.confirmations, option),
7979 (10, self.channel_value_satoshis, required),
7980 (12, self.unspendable_punishment_reserve, option),
7981 (14, user_channel_id_low, required),
7982 (16, self.next_outbound_htlc_limit_msat, required), // Forwards compatibility for removed balance_msat field.
7983 (18, self.outbound_capacity_msat, required),
7984 (19, self.next_outbound_htlc_limit_msat, required),
7985 (20, self.inbound_capacity_msat, required),
7986 (21, self.next_outbound_htlc_minimum_msat, required),
7987 (22, self.confirmations_required, option),
7988 (24, self.force_close_spend_delay, option),
7989 (26, self.is_outbound, required),
7990 (28, self.is_channel_ready, required),
7991 (30, self.is_usable, required),
7992 (32, self.is_public, required),
7993 (33, self.inbound_htlc_minimum_msat, option),
7994 (35, self.inbound_htlc_maximum_msat, option),
7995 (37, user_channel_id_high_opt, option),
7996 (39, self.feerate_sat_per_1000_weight, option),
7997 (41, self.channel_shutdown_state, option),
8003 impl Readable for ChannelDetails {
8004 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8005 _init_and_read_len_prefixed_tlv_fields!(reader, {
8006 (1, inbound_scid_alias, option),
8007 (2, channel_id, required),
8008 (3, channel_type, option),
8009 (4, counterparty, required),
8010 (5, outbound_scid_alias, option),
8011 (6, funding_txo, option),
8012 (7, config, option),
8013 (8, short_channel_id, option),
8014 (9, confirmations, option),
8015 (10, channel_value_satoshis, required),
8016 (12, unspendable_punishment_reserve, option),
8017 (14, user_channel_id_low, required),
8018 (16, _balance_msat, option), // Backwards compatibility for removed balance_msat field.
8019 (18, outbound_capacity_msat, required),
8020 // Note that by the time we get past the required read above, outbound_capacity_msat will be
8021 // filled in, so we can safely unwrap it here.
8022 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
8023 (20, inbound_capacity_msat, required),
8024 (21, next_outbound_htlc_minimum_msat, (default_value, 0)),
8025 (22, confirmations_required, option),
8026 (24, force_close_spend_delay, option),
8027 (26, is_outbound, required),
8028 (28, is_channel_ready, required),
8029 (30, is_usable, required),
8030 (32, is_public, required),
8031 (33, inbound_htlc_minimum_msat, option),
8032 (35, inbound_htlc_maximum_msat, option),
8033 (37, user_channel_id_high_opt, option),
8034 (39, feerate_sat_per_1000_weight, option),
8035 (41, channel_shutdown_state, option),
8038 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
8039 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
8040 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
8041 let user_channel_id = user_channel_id_low as u128 +
8042 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
8044 let _balance_msat: Option<u64> = _balance_msat;
8048 channel_id: channel_id.0.unwrap(),
8050 counterparty: counterparty.0.unwrap(),
8051 outbound_scid_alias,
8055 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
8056 unspendable_punishment_reserve,
8058 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
8059 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
8060 next_outbound_htlc_minimum_msat: next_outbound_htlc_minimum_msat.0.unwrap(),
8061 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
8062 confirmations_required,
8064 force_close_spend_delay,
8065 is_outbound: is_outbound.0.unwrap(),
8066 is_channel_ready: is_channel_ready.0.unwrap(),
8067 is_usable: is_usable.0.unwrap(),
8068 is_public: is_public.0.unwrap(),
8069 inbound_htlc_minimum_msat,
8070 inbound_htlc_maximum_msat,
8071 feerate_sat_per_1000_weight,
8072 channel_shutdown_state,
8077 impl_writeable_tlv_based!(PhantomRouteHints, {
8078 (2, channels, required_vec),
8079 (4, phantom_scid, required),
8080 (6, real_node_pubkey, required),
8083 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
8085 (0, onion_packet, required),
8086 (2, short_channel_id, required),
8089 (0, payment_data, required),
8090 (1, phantom_shared_secret, option),
8091 (2, incoming_cltv_expiry, required),
8092 (3, payment_metadata, option),
8093 (5, custom_tlvs, optional_vec),
8095 (2, ReceiveKeysend) => {
8096 (0, payment_preimage, required),
8097 (2, incoming_cltv_expiry, required),
8098 (3, payment_metadata, option),
8099 (4, payment_data, option), // Added in 0.0.116
8100 (5, custom_tlvs, optional_vec),
8104 impl_writeable_tlv_based!(PendingHTLCInfo, {
8105 (0, routing, required),
8106 (2, incoming_shared_secret, required),
8107 (4, payment_hash, required),
8108 (6, outgoing_amt_msat, required),
8109 (8, outgoing_cltv_value, required),
8110 (9, incoming_amt_msat, option),
8111 (10, skimmed_fee_msat, option),
8115 impl Writeable for HTLCFailureMsg {
8116 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8118 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
8120 channel_id.write(writer)?;
8121 htlc_id.write(writer)?;
8122 reason.write(writer)?;
8124 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
8125 channel_id, htlc_id, sha256_of_onion, failure_code
8128 channel_id.write(writer)?;
8129 htlc_id.write(writer)?;
8130 sha256_of_onion.write(writer)?;
8131 failure_code.write(writer)?;
8138 impl Readable for HTLCFailureMsg {
8139 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8140 let id: u8 = Readable::read(reader)?;
8143 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
8144 channel_id: Readable::read(reader)?,
8145 htlc_id: Readable::read(reader)?,
8146 reason: Readable::read(reader)?,
8150 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
8151 channel_id: Readable::read(reader)?,
8152 htlc_id: Readable::read(reader)?,
8153 sha256_of_onion: Readable::read(reader)?,
8154 failure_code: Readable::read(reader)?,
8157 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
8158 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
8159 // messages contained in the variants.
8160 // In version 0.0.101, support for reading the variants with these types was added, and
8161 // we should migrate to writing these variants when UpdateFailHTLC or
8162 // UpdateFailMalformedHTLC get TLV fields.
8164 let length: BigSize = Readable::read(reader)?;
8165 let mut s = FixedLengthReader::new(reader, length.0);
8166 let res = Readable::read(&mut s)?;
8167 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
8168 Ok(HTLCFailureMsg::Relay(res))
8171 let length: BigSize = Readable::read(reader)?;
8172 let mut s = FixedLengthReader::new(reader, length.0);
8173 let res = Readable::read(&mut s)?;
8174 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
8175 Ok(HTLCFailureMsg::Malformed(res))
8177 _ => Err(DecodeError::UnknownRequiredFeature),
8182 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
8187 impl_writeable_tlv_based!(HTLCPreviousHopData, {
8188 (0, short_channel_id, required),
8189 (1, phantom_shared_secret, option),
8190 (2, outpoint, required),
8191 (4, htlc_id, required),
8192 (6, incoming_packet_shared_secret, required),
8193 (7, user_channel_id, option),
8196 impl Writeable for ClaimableHTLC {
8197 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8198 let (payment_data, keysend_preimage) = match &self.onion_payload {
8199 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
8200 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
8202 write_tlv_fields!(writer, {
8203 (0, self.prev_hop, required),
8204 (1, self.total_msat, required),
8205 (2, self.value, required),
8206 (3, self.sender_intended_value, required),
8207 (4, payment_data, option),
8208 (5, self.total_value_received, option),
8209 (6, self.cltv_expiry, required),
8210 (8, keysend_preimage, option),
8211 (10, self.counterparty_skimmed_fee_msat, option),
8217 impl Readable for ClaimableHTLC {
8218 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8219 _init_and_read_len_prefixed_tlv_fields!(reader, {
8220 (0, prev_hop, required),
8221 (1, total_msat, option),
8222 (2, value_ser, required),
8223 (3, sender_intended_value, option),
8224 (4, payment_data_opt, option),
8225 (5, total_value_received, option),
8226 (6, cltv_expiry, required),
8227 (8, keysend_preimage, option),
8228 (10, counterparty_skimmed_fee_msat, option),
8230 let payment_data: Option<msgs::FinalOnionHopData> = payment_data_opt;
8231 let value = value_ser.0.unwrap();
8232 let onion_payload = match keysend_preimage {
8234 if payment_data.is_some() {
8235 return Err(DecodeError::InvalidValue)
8237 if total_msat.is_none() {
8238 total_msat = Some(value);
8240 OnionPayload::Spontaneous(p)
8243 if total_msat.is_none() {
8244 if payment_data.is_none() {
8245 return Err(DecodeError::InvalidValue)
8247 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
8249 OnionPayload::Invoice { _legacy_hop_data: payment_data }
8253 prev_hop: prev_hop.0.unwrap(),
8256 sender_intended_value: sender_intended_value.unwrap_or(value),
8257 total_value_received,
8258 total_msat: total_msat.unwrap(),
8260 cltv_expiry: cltv_expiry.0.unwrap(),
8261 counterparty_skimmed_fee_msat,
8266 impl Readable for HTLCSource {
8267 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8268 let id: u8 = Readable::read(reader)?;
8271 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
8272 let mut first_hop_htlc_msat: u64 = 0;
8273 let mut path_hops = Vec::new();
8274 let mut payment_id = None;
8275 let mut payment_params: Option<PaymentParameters> = None;
8276 let mut blinded_tail: Option<BlindedTail> = None;
8277 read_tlv_fields!(reader, {
8278 (0, session_priv, required),
8279 (1, payment_id, option),
8280 (2, first_hop_htlc_msat, required),
8281 (4, path_hops, required_vec),
8282 (5, payment_params, (option: ReadableArgs, 0)),
8283 (6, blinded_tail, option),
8285 if payment_id.is_none() {
8286 // For backwards compat, if there was no payment_id written, use the session_priv bytes
8288 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
8290 let path = Path { hops: path_hops, blinded_tail };
8291 if path.hops.len() == 0 {
8292 return Err(DecodeError::InvalidValue);
8294 if let Some(params) = payment_params.as_mut() {
8295 if let Payee::Clear { ref mut final_cltv_expiry_delta, .. } = params.payee {
8296 if final_cltv_expiry_delta == &0 {
8297 *final_cltv_expiry_delta = path.final_cltv_expiry_delta().ok_or(DecodeError::InvalidValue)?;
8301 Ok(HTLCSource::OutboundRoute {
8302 session_priv: session_priv.0.unwrap(),
8303 first_hop_htlc_msat,
8305 payment_id: payment_id.unwrap(),
8308 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
8309 _ => Err(DecodeError::UnknownRequiredFeature),
8314 impl Writeable for HTLCSource {
8315 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
8317 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id } => {
8319 let payment_id_opt = Some(payment_id);
8320 write_tlv_fields!(writer, {
8321 (0, session_priv, required),
8322 (1, payment_id_opt, option),
8323 (2, first_hop_htlc_msat, required),
8324 // 3 was previously used to write a PaymentSecret for the payment.
8325 (4, path.hops, required_vec),
8326 (5, None::<PaymentParameters>, option), // payment_params in LDK versions prior to 0.0.115
8327 (6, path.blinded_tail, option),
8330 HTLCSource::PreviousHopData(ref field) => {
8332 field.write(writer)?;
8339 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
8340 (0, forward_info, required),
8341 (1, prev_user_channel_id, (default_value, 0)),
8342 (2, prev_short_channel_id, required),
8343 (4, prev_htlc_id, required),
8344 (6, prev_funding_outpoint, required),
8347 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
8349 (0, htlc_id, required),
8350 (2, err_packet, required),
8355 impl_writeable_tlv_based!(PendingInboundPayment, {
8356 (0, payment_secret, required),
8357 (2, expiry_time, required),
8358 (4, user_payment_id, required),
8359 (6, payment_preimage, required),
8360 (8, min_value_msat, required),
8363 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>
8365 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8366 T::Target: BroadcasterInterface,
8367 ES::Target: EntropySource,
8368 NS::Target: NodeSigner,
8369 SP::Target: SignerProvider,
8370 F::Target: FeeEstimator,
8374 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8375 let _consistency_lock = self.total_consistency_lock.write().unwrap();
8377 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
8379 self.genesis_hash.write(writer)?;
8381 let best_block = self.best_block.read().unwrap();
8382 best_block.height().write(writer)?;
8383 best_block.block_hash().write(writer)?;
8386 let mut serializable_peer_count: u64 = 0;
8388 let per_peer_state = self.per_peer_state.read().unwrap();
8389 let mut number_of_funded_channels = 0;
8390 for (_, peer_state_mutex) in per_peer_state.iter() {
8391 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8392 let peer_state = &mut *peer_state_lock;
8393 if !peer_state.ok_to_remove(false) {
8394 serializable_peer_count += 1;
8397 number_of_funded_channels += peer_state.channel_by_id.iter().filter(
8398 |(_, phase)| if let ChannelPhase::Funded(chan) = phase { chan.context.is_funding_initiated() } else { false }
8402 (number_of_funded_channels as u64).write(writer)?;
8404 for (_, peer_state_mutex) in per_peer_state.iter() {
8405 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8406 let peer_state = &mut *peer_state_lock;
8407 for channel in peer_state.channel_by_id.iter().filter_map(
8408 |(_, phase)| if let ChannelPhase::Funded(channel) = phase {
8409 if channel.context.is_funding_initiated() { Some(channel) } else { None }
8412 channel.write(writer)?;
8418 let forward_htlcs = self.forward_htlcs.lock().unwrap();
8419 (forward_htlcs.len() as u64).write(writer)?;
8420 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
8421 short_channel_id.write(writer)?;
8422 (pending_forwards.len() as u64).write(writer)?;
8423 for forward in pending_forwards {
8424 forward.write(writer)?;
8429 let per_peer_state = self.per_peer_state.write().unwrap();
8431 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
8432 let claimable_payments = self.claimable_payments.lock().unwrap();
8433 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
8435 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
8436 let mut htlc_onion_fields: Vec<&_> = Vec::new();
8437 (claimable_payments.claimable_payments.len() as u64).write(writer)?;
8438 for (payment_hash, payment) in claimable_payments.claimable_payments.iter() {
8439 payment_hash.write(writer)?;
8440 (payment.htlcs.len() as u64).write(writer)?;
8441 for htlc in payment.htlcs.iter() {
8442 htlc.write(writer)?;
8444 htlc_purposes.push(&payment.purpose);
8445 htlc_onion_fields.push(&payment.onion_fields);
8448 let mut monitor_update_blocked_actions_per_peer = None;
8449 let mut peer_states = Vec::new();
8450 for (_, peer_state_mutex) in per_peer_state.iter() {
8451 // Because we're holding the owning `per_peer_state` write lock here there's no chance
8452 // of a lockorder violation deadlock - no other thread can be holding any
8453 // per_peer_state lock at all.
8454 peer_states.push(peer_state_mutex.unsafe_well_ordered_double_lock_self());
8457 (serializable_peer_count).write(writer)?;
8458 for ((peer_pubkey, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
8459 // Peers which we have no channels to should be dropped once disconnected. As we
8460 // disconnect all peers when shutting down and serializing the ChannelManager, we
8461 // consider all peers as disconnected here. There's therefore no need write peers with
8463 if !peer_state.ok_to_remove(false) {
8464 peer_pubkey.write(writer)?;
8465 peer_state.latest_features.write(writer)?;
8466 if !peer_state.monitor_update_blocked_actions.is_empty() {
8467 monitor_update_blocked_actions_per_peer
8468 .get_or_insert_with(Vec::new)
8469 .push((*peer_pubkey, &peer_state.monitor_update_blocked_actions));
8474 let events = self.pending_events.lock().unwrap();
8475 // LDK versions prior to 0.0.115 don't support post-event actions, thus if there's no
8476 // actions at all, skip writing the required TLV. Otherwise, pre-0.0.115 versions will
8477 // refuse to read the new ChannelManager.
8478 let events_not_backwards_compatible = events.iter().any(|(_, action)| action.is_some());
8479 if events_not_backwards_compatible {
8480 // If we're gonna write a even TLV that will overwrite our events anyway we might as
8481 // well save the space and not write any events here.
8482 0u64.write(writer)?;
8484 (events.len() as u64).write(writer)?;
8485 for (event, _) in events.iter() {
8486 event.write(writer)?;
8490 // LDK versions prior to 0.0.116 wrote the `pending_background_events`
8491 // `MonitorUpdateRegeneratedOnStartup`s here, however there was never a reason to do so -
8492 // the closing monitor updates were always effectively replayed on startup (either directly
8493 // by calling `broadcast_latest_holder_commitment_txn` on a `ChannelMonitor` during
8494 // deserialization or, in 0.0.115, by regenerating the monitor update itself).
8495 0u64.write(writer)?;
8497 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
8498 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
8499 // likely to be identical.
8500 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
8501 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
8503 (pending_inbound_payments.len() as u64).write(writer)?;
8504 for (hash, pending_payment) in pending_inbound_payments.iter() {
8505 hash.write(writer)?;
8506 pending_payment.write(writer)?;
8509 // For backwards compat, write the session privs and their total length.
8510 let mut num_pending_outbounds_compat: u64 = 0;
8511 for (_, outbound) in pending_outbound_payments.iter() {
8512 if !outbound.is_fulfilled() && !outbound.abandoned() {
8513 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
8516 num_pending_outbounds_compat.write(writer)?;
8517 for (_, outbound) in pending_outbound_payments.iter() {
8519 PendingOutboundPayment::Legacy { session_privs } |
8520 PendingOutboundPayment::Retryable { session_privs, .. } => {
8521 for session_priv in session_privs.iter() {
8522 session_priv.write(writer)?;
8525 PendingOutboundPayment::AwaitingInvoice { .. } => {},
8526 PendingOutboundPayment::InvoiceReceived { .. } => {},
8527 PendingOutboundPayment::Fulfilled { .. } => {},
8528 PendingOutboundPayment::Abandoned { .. } => {},
8532 // Encode without retry info for 0.0.101 compatibility.
8533 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
8534 for (id, outbound) in pending_outbound_payments.iter() {
8536 PendingOutboundPayment::Legacy { session_privs } |
8537 PendingOutboundPayment::Retryable { session_privs, .. } => {
8538 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
8544 let mut pending_intercepted_htlcs = None;
8545 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
8546 if our_pending_intercepts.len() != 0 {
8547 pending_intercepted_htlcs = Some(our_pending_intercepts);
8550 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
8551 if pending_claiming_payments.as_ref().unwrap().is_empty() {
8552 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
8553 // map. Thus, if there are no entries we skip writing a TLV for it.
8554 pending_claiming_payments = None;
8557 let mut in_flight_monitor_updates: Option<HashMap<(&PublicKey, &OutPoint), &Vec<ChannelMonitorUpdate>>> = None;
8558 for ((counterparty_id, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
8559 for (funding_outpoint, updates) in peer_state.in_flight_monitor_updates.iter() {
8560 if !updates.is_empty() {
8561 if in_flight_monitor_updates.is_none() { in_flight_monitor_updates = Some(HashMap::new()); }
8562 in_flight_monitor_updates.as_mut().unwrap().insert((counterparty_id, funding_outpoint), updates);
8567 write_tlv_fields!(writer, {
8568 (1, pending_outbound_payments_no_retry, required),
8569 (2, pending_intercepted_htlcs, option),
8570 (3, pending_outbound_payments, required),
8571 (4, pending_claiming_payments, option),
8572 (5, self.our_network_pubkey, required),
8573 (6, monitor_update_blocked_actions_per_peer, option),
8574 (7, self.fake_scid_rand_bytes, required),
8575 (8, if events_not_backwards_compatible { Some(&*events) } else { None }, option),
8576 (9, htlc_purposes, required_vec),
8577 (10, in_flight_monitor_updates, option),
8578 (11, self.probing_cookie_secret, required),
8579 (13, htlc_onion_fields, optional_vec),
8586 impl Writeable for VecDeque<(Event, Option<EventCompletionAction>)> {
8587 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
8588 (self.len() as u64).write(w)?;
8589 for (event, action) in self.iter() {
8592 #[cfg(debug_assertions)] {
8593 // Events are MaybeReadable, in some cases indicating that they shouldn't actually
8594 // be persisted and are regenerated on restart. However, if such an event has a
8595 // post-event-handling action we'll write nothing for the event and would have to
8596 // either forget the action or fail on deserialization (which we do below). Thus,
8597 // check that the event is sane here.
8598 let event_encoded = event.encode();
8599 let event_read: Option<Event> =
8600 MaybeReadable::read(&mut &event_encoded[..]).unwrap();
8601 if action.is_some() { assert!(event_read.is_some()); }
8607 impl Readable for VecDeque<(Event, Option<EventCompletionAction>)> {
8608 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8609 let len: u64 = Readable::read(reader)?;
8610 const MAX_ALLOC_SIZE: u64 = 1024 * 16;
8611 let mut events: Self = VecDeque::with_capacity(cmp::min(
8612 MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>() as u64,
8615 let ev_opt = MaybeReadable::read(reader)?;
8616 let action = Readable::read(reader)?;
8617 if let Some(ev) = ev_opt {
8618 events.push_back((ev, action));
8619 } else if action.is_some() {
8620 return Err(DecodeError::InvalidValue);
8627 impl_writeable_tlv_based_enum!(ChannelShutdownState,
8628 (0, NotShuttingDown) => {},
8629 (2, ShutdownInitiated) => {},
8630 (4, ResolvingHTLCs) => {},
8631 (6, NegotiatingClosingFee) => {},
8632 (8, ShutdownComplete) => {}, ;
8635 /// Arguments for the creation of a ChannelManager that are not deserialized.
8637 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
8639 /// 1) Deserialize all stored [`ChannelMonitor`]s.
8640 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
8641 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
8642 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
8643 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
8644 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
8645 /// same way you would handle a [`chain::Filter`] call using
8646 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
8647 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
8648 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
8649 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
8650 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
8651 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
8653 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
8654 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
8656 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
8657 /// call any other methods on the newly-deserialized [`ChannelManager`].
8659 /// Note that because some channels may be closed during deserialization, it is critical that you
8660 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
8661 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
8662 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
8663 /// not force-close the same channels but consider them live), you may end up revoking a state for
8664 /// which you've already broadcasted the transaction.
8666 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
8667 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8669 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8670 T::Target: BroadcasterInterface,
8671 ES::Target: EntropySource,
8672 NS::Target: NodeSigner,
8673 SP::Target: SignerProvider,
8674 F::Target: FeeEstimator,
8678 /// A cryptographically secure source of entropy.
8679 pub entropy_source: ES,
8681 /// A signer that is able to perform node-scoped cryptographic operations.
8682 pub node_signer: NS,
8684 /// The keys provider which will give us relevant keys. Some keys will be loaded during
8685 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
8687 pub signer_provider: SP,
8689 /// The fee_estimator for use in the ChannelManager in the future.
8691 /// No calls to the FeeEstimator will be made during deserialization.
8692 pub fee_estimator: F,
8693 /// The chain::Watch for use in the ChannelManager in the future.
8695 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
8696 /// you have deserialized ChannelMonitors separately and will add them to your
8697 /// chain::Watch after deserializing this ChannelManager.
8698 pub chain_monitor: M,
8700 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
8701 /// used to broadcast the latest local commitment transactions of channels which must be
8702 /// force-closed during deserialization.
8703 pub tx_broadcaster: T,
8704 /// The router which will be used in the ChannelManager in the future for finding routes
8705 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
8707 /// No calls to the router will be made during deserialization.
8709 /// The Logger for use in the ChannelManager and which may be used to log information during
8710 /// deserialization.
8712 /// Default settings used for new channels. Any existing channels will continue to use the
8713 /// runtime settings which were stored when the ChannelManager was serialized.
8714 pub default_config: UserConfig,
8716 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
8717 /// value.context.get_funding_txo() should be the key).
8719 /// If a monitor is inconsistent with the channel state during deserialization the channel will
8720 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
8721 /// is true for missing channels as well. If there is a monitor missing for which we find
8722 /// channel data Err(DecodeError::InvalidValue) will be returned.
8724 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
8727 /// This is not exported to bindings users because we have no HashMap bindings
8728 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>,
8731 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8732 ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>
8734 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8735 T::Target: BroadcasterInterface,
8736 ES::Target: EntropySource,
8737 NS::Target: NodeSigner,
8738 SP::Target: SignerProvider,
8739 F::Target: FeeEstimator,
8743 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
8744 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
8745 /// populate a HashMap directly from C.
8746 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,
8747 mut channel_monitors: Vec<&'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>) -> Self {
8749 entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
8750 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
8755 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
8756 // SipmleArcChannelManager type:
8757 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8758 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, ES, NS, SP, F, R, L>>)
8760 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8761 T::Target: BroadcasterInterface,
8762 ES::Target: EntropySource,
8763 NS::Target: NodeSigner,
8764 SP::Target: SignerProvider,
8765 F::Target: FeeEstimator,
8769 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
8770 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)>::read(reader, args)?;
8771 Ok((blockhash, Arc::new(chan_manager)))
8775 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8776 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)
8778 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8779 T::Target: BroadcasterInterface,
8780 ES::Target: EntropySource,
8781 NS::Target: NodeSigner,
8782 SP::Target: SignerProvider,
8783 F::Target: FeeEstimator,
8787 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
8788 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
8790 let genesis_hash: BlockHash = Readable::read(reader)?;
8791 let best_block_height: u32 = Readable::read(reader)?;
8792 let best_block_hash: BlockHash = Readable::read(reader)?;
8794 let mut failed_htlcs = Vec::new();
8796 let channel_count: u64 = Readable::read(reader)?;
8797 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
8798 let mut funded_peer_channels: HashMap<PublicKey, HashMap<ChannelId, ChannelPhase<SP>>> = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8799 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8800 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8801 let mut channel_closures = VecDeque::new();
8802 let mut close_background_events = Vec::new();
8803 for _ in 0..channel_count {
8804 let mut channel: Channel<SP> = Channel::read(reader, (
8805 &args.entropy_source, &args.signer_provider, best_block_height, &provided_channel_type_features(&args.default_config)
8807 let funding_txo = channel.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
8808 funding_txo_set.insert(funding_txo.clone());
8809 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
8810 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
8811 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
8812 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
8813 channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
8814 // But if the channel is behind of the monitor, close the channel:
8815 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
8816 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
8817 if channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
8818 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
8819 &channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
8821 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() {
8822 log_error!(args.logger, " The ChannelMonitor for channel {} is at holder commitment number {} but the ChannelManager is at holder commitment number {}.",
8823 &channel.context.channel_id(), monitor.get_cur_holder_commitment_number(), channel.get_cur_holder_commitment_transaction_number());
8825 if channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() {
8826 log_error!(args.logger, " The ChannelMonitor for channel {} is at revoked counterparty transaction number {} but the ChannelManager is at revoked counterparty transaction number {}.",
8827 &channel.context.channel_id(), monitor.get_min_seen_secret(), channel.get_revoked_counterparty_commitment_transaction_number());
8829 if channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() {
8830 log_error!(args.logger, " The ChannelMonitor for channel {} is at counterparty commitment transaction number {} but the ChannelManager is at counterparty commitment transaction number {}.",
8831 &channel.context.channel_id(), monitor.get_cur_counterparty_commitment_number(), channel.get_cur_counterparty_commitment_transaction_number());
8833 let (monitor_update, mut new_failed_htlcs) = channel.context.force_shutdown(true);
8834 if let Some((counterparty_node_id, funding_txo, update)) = monitor_update {
8835 close_background_events.push(BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
8836 counterparty_node_id, funding_txo, update
8839 failed_htlcs.append(&mut new_failed_htlcs);
8840 channel_closures.push_back((events::Event::ChannelClosed {
8841 channel_id: channel.context.channel_id(),
8842 user_channel_id: channel.context.get_user_id(),
8843 reason: ClosureReason::OutdatedChannelManager,
8844 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
8845 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
8847 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
8848 let mut found_htlc = false;
8849 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
8850 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
8853 // If we have some HTLCs in the channel which are not present in the newer
8854 // ChannelMonitor, they have been removed and should be failed back to
8855 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
8856 // were actually claimed we'd have generated and ensured the previous-hop
8857 // claim update ChannelMonitor updates were persisted prior to persising
8858 // the ChannelMonitor update for the forward leg, so attempting to fail the
8859 // backwards leg of the HTLC will simply be rejected.
8860 log_info!(args.logger,
8861 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
8862 &channel.context.channel_id(), &payment_hash);
8863 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8867 log_info!(args.logger, "Successfully loaded channel {} at update_id {} against monitor at update id {}",
8868 &channel.context.channel_id(), channel.context.get_latest_monitor_update_id(),
8869 monitor.get_latest_update_id());
8870 if let Some(short_channel_id) = channel.context.get_short_channel_id() {
8871 short_to_chan_info.insert(short_channel_id, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8873 if channel.context.is_funding_initiated() {
8874 id_to_peer.insert(channel.context.channel_id(), channel.context.get_counterparty_node_id());
8876 match funded_peer_channels.entry(channel.context.get_counterparty_node_id()) {
8877 hash_map::Entry::Occupied(mut entry) => {
8878 let by_id_map = entry.get_mut();
8879 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
8881 hash_map::Entry::Vacant(entry) => {
8882 let mut by_id_map = HashMap::new();
8883 by_id_map.insert(channel.context.channel_id(), ChannelPhase::Funded(channel));
8884 entry.insert(by_id_map);
8888 } else if channel.is_awaiting_initial_mon_persist() {
8889 // If we were persisted and shut down while the initial ChannelMonitor persistence
8890 // was in-progress, we never broadcasted the funding transaction and can still
8891 // safely discard the channel.
8892 let _ = channel.context.force_shutdown(false);
8893 channel_closures.push_back((events::Event::ChannelClosed {
8894 channel_id: channel.context.channel_id(),
8895 user_channel_id: channel.context.get_user_id(),
8896 reason: ClosureReason::DisconnectedPeer,
8897 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
8898 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
8901 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
8902 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
8903 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
8904 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
8905 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");
8906 return Err(DecodeError::InvalidValue);
8910 for (funding_txo, _) in args.channel_monitors.iter() {
8911 if !funding_txo_set.contains(funding_txo) {
8912 log_info!(args.logger, "Queueing monitor update to ensure missing channel {} is force closed",
8913 &funding_txo.to_channel_id());
8914 let monitor_update = ChannelMonitorUpdate {
8915 update_id: CLOSED_CHANNEL_UPDATE_ID,
8916 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast: true }],
8918 close_background_events.push(BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((*funding_txo, monitor_update)));
8922 const MAX_ALLOC_SIZE: usize = 1024 * 64;
8923 let forward_htlcs_count: u64 = Readable::read(reader)?;
8924 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
8925 for _ in 0..forward_htlcs_count {
8926 let short_channel_id = Readable::read(reader)?;
8927 let pending_forwards_count: u64 = Readable::read(reader)?;
8928 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
8929 for _ in 0..pending_forwards_count {
8930 pending_forwards.push(Readable::read(reader)?);
8932 forward_htlcs.insert(short_channel_id, pending_forwards);
8935 let claimable_htlcs_count: u64 = Readable::read(reader)?;
8936 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
8937 for _ in 0..claimable_htlcs_count {
8938 let payment_hash = Readable::read(reader)?;
8939 let previous_hops_len: u64 = Readable::read(reader)?;
8940 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
8941 for _ in 0..previous_hops_len {
8942 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
8944 claimable_htlcs_list.push((payment_hash, previous_hops));
8947 let peer_state_from_chans = |channel_by_id| {
8950 inbound_channel_request_by_id: HashMap::new(),
8951 latest_features: InitFeatures::empty(),
8952 pending_msg_events: Vec::new(),
8953 in_flight_monitor_updates: BTreeMap::new(),
8954 monitor_update_blocked_actions: BTreeMap::new(),
8955 actions_blocking_raa_monitor_updates: BTreeMap::new(),
8956 is_connected: false,
8960 let peer_count: u64 = Readable::read(reader)?;
8961 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<SP>>)>()));
8962 for _ in 0..peer_count {
8963 let peer_pubkey = Readable::read(reader)?;
8964 let peer_chans = funded_peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new());
8965 let mut peer_state = peer_state_from_chans(peer_chans);
8966 peer_state.latest_features = Readable::read(reader)?;
8967 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
8970 let event_count: u64 = Readable::read(reader)?;
8971 let mut pending_events_read: VecDeque<(events::Event, Option<EventCompletionAction>)> =
8972 VecDeque::with_capacity(cmp::min(event_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>()));
8973 for _ in 0..event_count {
8974 match MaybeReadable::read(reader)? {
8975 Some(event) => pending_events_read.push_back((event, None)),
8980 let background_event_count: u64 = Readable::read(reader)?;
8981 for _ in 0..background_event_count {
8982 match <u8 as Readable>::read(reader)? {
8984 // LDK versions prior to 0.0.116 wrote pending `MonitorUpdateRegeneratedOnStartup`s here,
8985 // however we really don't (and never did) need them - we regenerate all
8986 // on-startup monitor updates.
8987 let _: OutPoint = Readable::read(reader)?;
8988 let _: ChannelMonitorUpdate = Readable::read(reader)?;
8990 _ => return Err(DecodeError::InvalidValue),
8994 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
8995 let highest_seen_timestamp: u32 = Readable::read(reader)?;
8997 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
8998 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
8999 for _ in 0..pending_inbound_payment_count {
9000 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
9001 return Err(DecodeError::InvalidValue);
9005 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
9006 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
9007 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
9008 for _ in 0..pending_outbound_payments_count_compat {
9009 let session_priv = Readable::read(reader)?;
9010 let payment = PendingOutboundPayment::Legacy {
9011 session_privs: [session_priv].iter().cloned().collect()
9013 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
9014 return Err(DecodeError::InvalidValue)
9018 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
9019 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
9020 let mut pending_outbound_payments = None;
9021 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
9022 let mut received_network_pubkey: Option<PublicKey> = None;
9023 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
9024 let mut probing_cookie_secret: Option<[u8; 32]> = None;
9025 let mut claimable_htlc_purposes = None;
9026 let mut claimable_htlc_onion_fields = None;
9027 let mut pending_claiming_payments = Some(HashMap::new());
9028 let mut monitor_update_blocked_actions_per_peer: Option<Vec<(_, BTreeMap<_, Vec<_>>)>> = Some(Vec::new());
9029 let mut events_override = None;
9030 let mut in_flight_monitor_updates: Option<HashMap<(PublicKey, OutPoint), Vec<ChannelMonitorUpdate>>> = None;
9031 read_tlv_fields!(reader, {
9032 (1, pending_outbound_payments_no_retry, option),
9033 (2, pending_intercepted_htlcs, option),
9034 (3, pending_outbound_payments, option),
9035 (4, pending_claiming_payments, option),
9036 (5, received_network_pubkey, option),
9037 (6, monitor_update_blocked_actions_per_peer, option),
9038 (7, fake_scid_rand_bytes, option),
9039 (8, events_override, option),
9040 (9, claimable_htlc_purposes, optional_vec),
9041 (10, in_flight_monitor_updates, option),
9042 (11, probing_cookie_secret, option),
9043 (13, claimable_htlc_onion_fields, optional_vec),
9045 if fake_scid_rand_bytes.is_none() {
9046 fake_scid_rand_bytes = Some(args.entropy_source.get_secure_random_bytes());
9049 if probing_cookie_secret.is_none() {
9050 probing_cookie_secret = Some(args.entropy_source.get_secure_random_bytes());
9053 if let Some(events) = events_override {
9054 pending_events_read = events;
9057 if !channel_closures.is_empty() {
9058 pending_events_read.append(&mut channel_closures);
9061 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
9062 pending_outbound_payments = Some(pending_outbound_payments_compat);
9063 } else if pending_outbound_payments.is_none() {
9064 let mut outbounds = HashMap::new();
9065 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
9066 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
9068 pending_outbound_payments = Some(outbounds);
9070 let pending_outbounds = OutboundPayments {
9071 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
9072 retry_lock: Mutex::new(())
9075 // We have to replay (or skip, if they were completed after we wrote the `ChannelManager`)
9076 // each `ChannelMonitorUpdate` in `in_flight_monitor_updates`. After doing so, we have to
9077 // check that each channel we have isn't newer than the latest `ChannelMonitorUpdate`(s) we
9078 // replayed, and for each monitor update we have to replay we have to ensure there's a
9079 // `ChannelMonitor` for it.
9081 // In order to do so we first walk all of our live channels (so that we can check their
9082 // state immediately after doing the update replays, when we have the `update_id`s
9083 // available) and then walk any remaining in-flight updates.
9085 // Because the actual handling of the in-flight updates is the same, it's macro'ized here:
9086 let mut pending_background_events = Vec::new();
9087 macro_rules! handle_in_flight_updates {
9088 ($counterparty_node_id: expr, $chan_in_flight_upds: expr, $funding_txo: expr,
9089 $monitor: expr, $peer_state: expr, $channel_info_log: expr
9091 let mut max_in_flight_update_id = 0;
9092 $chan_in_flight_upds.retain(|upd| upd.update_id > $monitor.get_latest_update_id());
9093 for update in $chan_in_flight_upds.iter() {
9094 log_trace!(args.logger, "Replaying ChannelMonitorUpdate {} for {}channel {}",
9095 update.update_id, $channel_info_log, &$funding_txo.to_channel_id());
9096 max_in_flight_update_id = cmp::max(max_in_flight_update_id, update.update_id);
9097 pending_background_events.push(
9098 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
9099 counterparty_node_id: $counterparty_node_id,
9100 funding_txo: $funding_txo,
9101 update: update.clone(),
9104 if $chan_in_flight_upds.is_empty() {
9105 // We had some updates to apply, but it turns out they had completed before we
9106 // were serialized, we just weren't notified of that. Thus, we may have to run
9107 // the completion actions for any monitor updates, but otherwise are done.
9108 pending_background_events.push(
9109 BackgroundEvent::MonitorUpdatesComplete {
9110 counterparty_node_id: $counterparty_node_id,
9111 channel_id: $funding_txo.to_channel_id(),
9114 if $peer_state.in_flight_monitor_updates.insert($funding_txo, $chan_in_flight_upds).is_some() {
9115 log_error!(args.logger, "Duplicate in-flight monitor update set for the same channel!");
9116 return Err(DecodeError::InvalidValue);
9118 max_in_flight_update_id
9122 for (counterparty_id, peer_state_mtx) in per_peer_state.iter_mut() {
9123 let mut peer_state_lock = peer_state_mtx.lock().unwrap();
9124 let peer_state = &mut *peer_state_lock;
9125 for phase in peer_state.channel_by_id.values() {
9126 if let ChannelPhase::Funded(chan) = phase {
9127 // Channels that were persisted have to be funded, otherwise they should have been
9129 let funding_txo = chan.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
9130 let monitor = args.channel_monitors.get(&funding_txo)
9131 .expect("We already checked for monitor presence when loading channels");
9132 let mut max_in_flight_update_id = monitor.get_latest_update_id();
9133 if let Some(in_flight_upds) = &mut in_flight_monitor_updates {
9134 if let Some(mut chan_in_flight_upds) = in_flight_upds.remove(&(*counterparty_id, funding_txo)) {
9135 max_in_flight_update_id = cmp::max(max_in_flight_update_id,
9136 handle_in_flight_updates!(*counterparty_id, chan_in_flight_upds,
9137 funding_txo, monitor, peer_state, ""));
9140 if chan.get_latest_unblocked_monitor_update_id() > max_in_flight_update_id {
9141 // If the channel is ahead of the monitor, return InvalidValue:
9142 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
9143 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} with update_id through {} in-flight",
9144 chan.context.channel_id(), monitor.get_latest_update_id(), max_in_flight_update_id);
9145 log_error!(args.logger, " but the ChannelManager is at update_id {}.", chan.get_latest_unblocked_monitor_update_id());
9146 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
9147 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
9148 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
9149 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");
9150 return Err(DecodeError::InvalidValue);
9153 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
9154 // created in this `channel_by_id` map.
9155 debug_assert!(false);
9156 return Err(DecodeError::InvalidValue);
9161 if let Some(in_flight_upds) = in_flight_monitor_updates {
9162 for ((counterparty_id, funding_txo), mut chan_in_flight_updates) in in_flight_upds {
9163 if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
9164 // Now that we've removed all the in-flight monitor updates for channels that are
9165 // still open, we need to replay any monitor updates that are for closed channels,
9166 // creating the neccessary peer_state entries as we go.
9167 let peer_state_mutex = per_peer_state.entry(counterparty_id).or_insert_with(|| {
9168 Mutex::new(peer_state_from_chans(HashMap::new()))
9170 let mut peer_state = peer_state_mutex.lock().unwrap();
9171 handle_in_flight_updates!(counterparty_id, chan_in_flight_updates,
9172 funding_txo, monitor, peer_state, "closed ");
9174 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!");
9175 log_error!(args.logger, " The ChannelMonitor for channel {} is missing.",
9176 &funding_txo.to_channel_id());
9177 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
9178 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
9179 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
9180 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");
9181 return Err(DecodeError::InvalidValue);
9186 // Note that we have to do the above replays before we push new monitor updates.
9187 pending_background_events.append(&mut close_background_events);
9189 // If there's any preimages for forwarded HTLCs hanging around in ChannelMonitors we
9190 // should ensure we try them again on the inbound edge. We put them here and do so after we
9191 // have a fully-constructed `ChannelManager` at the end.
9192 let mut pending_claims_to_replay = Vec::new();
9195 // If we're tracking pending payments, ensure we haven't lost any by looking at the
9196 // ChannelMonitor data for any channels for which we do not have authorative state
9197 // (i.e. those for which we just force-closed above or we otherwise don't have a
9198 // corresponding `Channel` at all).
9199 // This avoids several edge-cases where we would otherwise "forget" about pending
9200 // payments which are still in-flight via their on-chain state.
9201 // We only rebuild the pending payments map if we were most recently serialized by
9203 for (_, monitor) in args.channel_monitors.iter() {
9204 let counterparty_opt = id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id());
9205 if counterparty_opt.is_none() {
9206 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
9207 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
9208 if path.hops.is_empty() {
9209 log_error!(args.logger, "Got an empty path for a pending payment");
9210 return Err(DecodeError::InvalidValue);
9213 let path_amt = path.final_value_msat();
9214 let mut session_priv_bytes = [0; 32];
9215 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
9216 match pending_outbounds.pending_outbound_payments.lock().unwrap().entry(payment_id) {
9217 hash_map::Entry::Occupied(mut entry) => {
9218 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
9219 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
9220 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), &htlc.payment_hash);
9222 hash_map::Entry::Vacant(entry) => {
9223 let path_fee = path.fee_msat();
9224 entry.insert(PendingOutboundPayment::Retryable {
9225 retry_strategy: None,
9226 attempts: PaymentAttempts::new(),
9227 payment_params: None,
9228 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
9229 payment_hash: htlc.payment_hash,
9230 payment_secret: None, // only used for retries, and we'll never retry on startup
9231 payment_metadata: None, // only used for retries, and we'll never retry on startup
9232 keysend_preimage: None, // only used for retries, and we'll never retry on startup
9233 custom_tlvs: Vec::new(), // only used for retries, and we'll never retry on startup
9234 pending_amt_msat: path_amt,
9235 pending_fee_msat: Some(path_fee),
9236 total_msat: path_amt,
9237 starting_block_height: best_block_height,
9239 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
9240 path_amt, &htlc.payment_hash, log_bytes!(session_priv_bytes));
9245 for (htlc_source, (htlc, preimage_opt)) in monitor.get_all_current_outbound_htlcs() {
9247 HTLCSource::PreviousHopData(prev_hop_data) => {
9248 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
9249 info.prev_funding_outpoint == prev_hop_data.outpoint &&
9250 info.prev_htlc_id == prev_hop_data.htlc_id
9252 // The ChannelMonitor is now responsible for this HTLC's
9253 // failure/success and will let us know what its outcome is. If we
9254 // still have an entry for this HTLC in `forward_htlcs` or
9255 // `pending_intercepted_htlcs`, we were apparently not persisted after
9256 // the monitor was when forwarding the payment.
9257 forward_htlcs.retain(|_, forwards| {
9258 forwards.retain(|forward| {
9259 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
9260 if pending_forward_matches_htlc(&htlc_info) {
9261 log_info!(args.logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
9262 &htlc.payment_hash, &monitor.get_funding_txo().0.to_channel_id());
9267 !forwards.is_empty()
9269 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
9270 if pending_forward_matches_htlc(&htlc_info) {
9271 log_info!(args.logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
9272 &htlc.payment_hash, &monitor.get_funding_txo().0.to_channel_id());
9273 pending_events_read.retain(|(event, _)| {
9274 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
9275 intercepted_id != ev_id
9282 HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } => {
9283 if let Some(preimage) = preimage_opt {
9284 let pending_events = Mutex::new(pending_events_read);
9285 // Note that we set `from_onchain` to "false" here,
9286 // deliberately keeping the pending payment around forever.
9287 // Given it should only occur when we have a channel we're
9288 // force-closing for being stale that's okay.
9289 // The alternative would be to wipe the state when claiming,
9290 // generating a `PaymentPathSuccessful` event but regenerating
9291 // it and the `PaymentSent` on every restart until the
9292 // `ChannelMonitor` is removed.
9294 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
9295 channel_funding_outpoint: monitor.get_funding_txo().0,
9296 counterparty_node_id: path.hops[0].pubkey,
9298 pending_outbounds.claim_htlc(payment_id, preimage, session_priv,
9299 path, false, compl_action, &pending_events, &args.logger);
9300 pending_events_read = pending_events.into_inner().unwrap();
9307 // Whether the downstream channel was closed or not, try to re-apply any payment
9308 // preimages from it which may be needed in upstream channels for forwarded
9310 let outbound_claimed_htlcs_iter = monitor.get_all_current_outbound_htlcs()
9312 .filter_map(|(htlc_source, (htlc, preimage_opt))| {
9313 if let HTLCSource::PreviousHopData(_) = htlc_source {
9314 if let Some(payment_preimage) = preimage_opt {
9315 Some((htlc_source, payment_preimage, htlc.amount_msat,
9316 // Check if `counterparty_opt.is_none()` to see if the
9317 // downstream chan is closed (because we don't have a
9318 // channel_id -> peer map entry).
9319 counterparty_opt.is_none(),
9320 monitor.get_funding_txo().0))
9323 // If it was an outbound payment, we've handled it above - if a preimage
9324 // came in and we persisted the `ChannelManager` we either handled it and
9325 // are good to go or the channel force-closed - we don't have to handle the
9326 // channel still live case here.
9330 for tuple in outbound_claimed_htlcs_iter {
9331 pending_claims_to_replay.push(tuple);
9336 if !forward_htlcs.is_empty() || pending_outbounds.needs_abandon() {
9337 // If we have pending HTLCs to forward, assume we either dropped a
9338 // `PendingHTLCsForwardable` or the user received it but never processed it as they
9339 // shut down before the timer hit. Either way, set the time_forwardable to a small
9340 // constant as enough time has likely passed that we should simply handle the forwards
9341 // now, or at least after the user gets a chance to reconnect to our peers.
9342 pending_events_read.push_back((events::Event::PendingHTLCsForwardable {
9343 time_forwardable: Duration::from_secs(2),
9347 let inbound_pmt_key_material = args.node_signer.get_inbound_payment_key_material();
9348 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
9350 let mut claimable_payments = HashMap::with_capacity(claimable_htlcs_list.len());
9351 if let Some(purposes) = claimable_htlc_purposes {
9352 if purposes.len() != claimable_htlcs_list.len() {
9353 return Err(DecodeError::InvalidValue);
9355 if let Some(onion_fields) = claimable_htlc_onion_fields {
9356 if onion_fields.len() != claimable_htlcs_list.len() {
9357 return Err(DecodeError::InvalidValue);
9359 for (purpose, (onion, (payment_hash, htlcs))) in
9360 purposes.into_iter().zip(onion_fields.into_iter().zip(claimable_htlcs_list.into_iter()))
9362 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
9363 purpose, htlcs, onion_fields: onion,
9365 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
9368 for (purpose, (payment_hash, htlcs)) in purposes.into_iter().zip(claimable_htlcs_list.into_iter()) {
9369 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
9370 purpose, htlcs, onion_fields: None,
9372 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
9376 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
9377 // include a `_legacy_hop_data` in the `OnionPayload`.
9378 for (payment_hash, htlcs) in claimable_htlcs_list.drain(..) {
9379 if htlcs.is_empty() {
9380 return Err(DecodeError::InvalidValue);
9382 let purpose = match &htlcs[0].onion_payload {
9383 OnionPayload::Invoice { _legacy_hop_data } => {
9384 if let Some(hop_data) = _legacy_hop_data {
9385 events::PaymentPurpose::InvoicePayment {
9386 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
9387 Some(inbound_payment) => inbound_payment.payment_preimage,
9388 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
9389 Ok((payment_preimage, _)) => payment_preimage,
9391 log_error!(args.logger, "Failed to read claimable payment data for HTLC with payment hash {} - was not a pending inbound payment and didn't match our payment key", &payment_hash);
9392 return Err(DecodeError::InvalidValue);
9396 payment_secret: hop_data.payment_secret,
9398 } else { return Err(DecodeError::InvalidValue); }
9400 OnionPayload::Spontaneous(payment_preimage) =>
9401 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
9403 claimable_payments.insert(payment_hash, ClaimablePayment {
9404 purpose, htlcs, onion_fields: None,
9409 let mut secp_ctx = Secp256k1::new();
9410 secp_ctx.seeded_randomize(&args.entropy_source.get_secure_random_bytes());
9412 let our_network_pubkey = match args.node_signer.get_node_id(Recipient::Node) {
9414 Err(()) => return Err(DecodeError::InvalidValue)
9416 if let Some(network_pubkey) = received_network_pubkey {
9417 if network_pubkey != our_network_pubkey {
9418 log_error!(args.logger, "Key that was generated does not match the existing key.");
9419 return Err(DecodeError::InvalidValue);
9423 let mut outbound_scid_aliases = HashSet::new();
9424 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
9425 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9426 let peer_state = &mut *peer_state_lock;
9427 for (chan_id, phase) in peer_state.channel_by_id.iter_mut() {
9428 if let ChannelPhase::Funded(chan) = phase {
9429 if chan.context.outbound_scid_alias() == 0 {
9430 let mut outbound_scid_alias;
9432 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
9433 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.entropy_source);
9434 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
9436 chan.context.set_outbound_scid_alias(outbound_scid_alias);
9437 } else if !outbound_scid_aliases.insert(chan.context.outbound_scid_alias()) {
9438 // Note that in rare cases its possible to hit this while reading an older
9439 // channel if we just happened to pick a colliding outbound alias above.
9440 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
9441 return Err(DecodeError::InvalidValue);
9443 if chan.context.is_usable() {
9444 if short_to_chan_info.insert(chan.context.outbound_scid_alias(), (chan.context.get_counterparty_node_id(), *chan_id)).is_some() {
9445 // Note that in rare cases its possible to hit this while reading an older
9446 // channel if we just happened to pick a colliding outbound alias above.
9447 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
9448 return Err(DecodeError::InvalidValue);
9452 // We shouldn't have persisted (or read) any unfunded channel types so none should have been
9453 // created in this `channel_by_id` map.
9454 debug_assert!(false);
9455 return Err(DecodeError::InvalidValue);
9460 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
9462 for (_, monitor) in args.channel_monitors.iter() {
9463 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
9464 if let Some(payment) = claimable_payments.remove(&payment_hash) {
9465 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", &payment_hash);
9466 let mut claimable_amt_msat = 0;
9467 let mut receiver_node_id = Some(our_network_pubkey);
9468 let phantom_shared_secret = payment.htlcs[0].prev_hop.phantom_shared_secret;
9469 if phantom_shared_secret.is_some() {
9470 let phantom_pubkey = args.node_signer.get_node_id(Recipient::PhantomNode)
9471 .expect("Failed to get node_id for phantom node recipient");
9472 receiver_node_id = Some(phantom_pubkey)
9474 for claimable_htlc in &payment.htlcs {
9475 claimable_amt_msat += claimable_htlc.value;
9477 // Add a holding-cell claim of the payment to the Channel, which should be
9478 // applied ~immediately on peer reconnection. Because it won't generate a
9479 // new commitment transaction we can just provide the payment preimage to
9480 // the corresponding ChannelMonitor and nothing else.
9482 // We do so directly instead of via the normal ChannelMonitor update
9483 // procedure as the ChainMonitor hasn't yet been initialized, implying
9484 // we're not allowed to call it directly yet. Further, we do the update
9485 // without incrementing the ChannelMonitor update ID as there isn't any
9487 // If we were to generate a new ChannelMonitor update ID here and then
9488 // crash before the user finishes block connect we'd end up force-closing
9489 // this channel as well. On the flip side, there's no harm in restarting
9490 // without the new monitor persisted - we'll end up right back here on
9492 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
9493 if let Some(peer_node_id) = id_to_peer.get(&previous_channel_id){
9494 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
9495 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9496 let peer_state = &mut *peer_state_lock;
9497 if let Some(ChannelPhase::Funded(channel)) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
9498 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
9501 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
9502 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
9505 pending_events_read.push_back((events::Event::PaymentClaimed {
9508 purpose: payment.purpose,
9509 amount_msat: claimable_amt_msat,
9510 htlcs: payment.htlcs.iter().map(events::ClaimedHTLC::from).collect(),
9511 sender_intended_total_msat: payment.htlcs.first().map(|htlc| htlc.total_msat),
9517 for (node_id, monitor_update_blocked_actions) in monitor_update_blocked_actions_per_peer.unwrap() {
9518 if let Some(peer_state) = per_peer_state.get(&node_id) {
9519 for (_, actions) in monitor_update_blocked_actions.iter() {
9520 for action in actions.iter() {
9521 if let MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
9522 downstream_counterparty_and_funding_outpoint:
9523 Some((blocked_node_id, blocked_channel_outpoint, blocking_action)), ..
9525 if let Some(blocked_peer_state) = per_peer_state.get(&blocked_node_id) {
9526 blocked_peer_state.lock().unwrap().actions_blocking_raa_monitor_updates
9527 .entry(blocked_channel_outpoint.to_channel_id())
9528 .or_insert_with(Vec::new).push(blocking_action.clone());
9530 // If the channel we were blocking has closed, we don't need to
9531 // worry about it - the blocked monitor update should never have
9532 // been released from the `Channel` object so it can't have
9533 // completed, and if the channel closed there's no reason to bother
9539 peer_state.lock().unwrap().monitor_update_blocked_actions = monitor_update_blocked_actions;
9541 log_error!(args.logger, "Got blocked actions without a per-peer-state for {}", node_id);
9542 return Err(DecodeError::InvalidValue);
9546 let channel_manager = ChannelManager {
9548 fee_estimator: bounded_fee_estimator,
9549 chain_monitor: args.chain_monitor,
9550 tx_broadcaster: args.tx_broadcaster,
9551 router: args.router,
9553 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
9555 inbound_payment_key: expanded_inbound_key,
9556 pending_inbound_payments: Mutex::new(pending_inbound_payments),
9557 pending_outbound_payments: pending_outbounds,
9558 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
9560 forward_htlcs: Mutex::new(forward_htlcs),
9561 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments, pending_claiming_payments: pending_claiming_payments.unwrap() }),
9562 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
9563 id_to_peer: Mutex::new(id_to_peer),
9564 short_to_chan_info: FairRwLock::new(short_to_chan_info),
9565 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
9567 probing_cookie_secret: probing_cookie_secret.unwrap(),
9572 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
9574 per_peer_state: FairRwLock::new(per_peer_state),
9576 pending_events: Mutex::new(pending_events_read),
9577 pending_events_processor: AtomicBool::new(false),
9578 pending_background_events: Mutex::new(pending_background_events),
9579 total_consistency_lock: RwLock::new(()),
9580 background_events_processed_since_startup: AtomicBool::new(false),
9582 event_persist_notifier: Notifier::new(),
9583 needs_persist_flag: AtomicBool::new(false),
9585 entropy_source: args.entropy_source,
9586 node_signer: args.node_signer,
9587 signer_provider: args.signer_provider,
9589 logger: args.logger,
9590 default_configuration: args.default_config,
9593 for htlc_source in failed_htlcs.drain(..) {
9594 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
9595 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
9596 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
9597 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
9600 for (source, preimage, downstream_value, downstream_closed, downstream_funding) in pending_claims_to_replay {
9601 // We use `downstream_closed` in place of `from_onchain` here just as a guess - we
9602 // don't remember in the `ChannelMonitor` where we got a preimage from, but if the
9603 // channel is closed we just assume that it probably came from an on-chain claim.
9604 channel_manager.claim_funds_internal(source, preimage, Some(downstream_value),
9605 downstream_closed, downstream_funding);
9608 //TODO: Broadcast channel update for closed channels, but only after we've made a
9609 //connection or two.
9611 Ok((best_block_hash.clone(), channel_manager))
9617 use bitcoin::hashes::Hash;
9618 use bitcoin::hashes::sha256::Hash as Sha256;
9619 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
9620 use core::sync::atomic::Ordering;
9621 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
9622 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
9623 use crate::ln::ChannelId;
9624 use crate::ln::channelmanager::{inbound_payment, PaymentId, PaymentSendFailure, RecipientOnionFields, InterceptId};
9625 use crate::ln::functional_test_utils::*;
9626 use crate::ln::msgs::{self, ErrorAction};
9627 use crate::ln::msgs::ChannelMessageHandler;
9628 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
9629 use crate::util::errors::APIError;
9630 use crate::util::test_utils;
9631 use crate::util::config::{ChannelConfig, ChannelConfigUpdate};
9632 use crate::sign::EntropySource;
9635 fn test_notify_limits() {
9636 // Check that a few cases which don't require the persistence of a new ChannelManager,
9637 // indeed, do not cause the persistence of a new ChannelManager.
9638 let chanmon_cfgs = create_chanmon_cfgs(3);
9639 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9640 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9641 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9643 // All nodes start with a persistable update pending as `create_network` connects each node
9644 // with all other nodes to make most tests simpler.
9645 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
9646 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
9647 assert!(nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
9649 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1);
9651 // We check that the channel info nodes have doesn't change too early, even though we try
9652 // to connect messages with new values
9653 chan.0.contents.fee_base_msat *= 2;
9654 chan.1.contents.fee_base_msat *= 2;
9655 let node_a_chan_info = nodes[0].node.list_channels_with_counterparty(
9656 &nodes[1].node.get_our_node_id()).pop().unwrap();
9657 let node_b_chan_info = nodes[1].node.list_channels_with_counterparty(
9658 &nodes[0].node.get_our_node_id()).pop().unwrap();
9660 // The first two nodes (which opened a channel) should now require fresh persistence
9661 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
9662 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
9663 // ... but the last node should not.
9664 assert!(!nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
9665 // After persisting the first two nodes they should no longer need fresh persistence.
9666 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
9667 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
9669 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
9670 // about the channel.
9671 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
9672 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
9673 assert!(!nodes[2].node.get_event_or_persistence_needed_future().poll_is_complete());
9675 // The nodes which are a party to the channel should also ignore messages from unrelated
9677 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
9678 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
9679 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
9680 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
9681 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
9682 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
9684 // At this point the channel info given by peers should still be the same.
9685 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
9686 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
9688 // An earlier version of handle_channel_update didn't check the directionality of the
9689 // update message and would always update the local fee info, even if our peer was
9690 // (spuriously) forwarding us our own channel_update.
9691 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
9692 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
9693 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
9695 // First deliver each peers' own message, checking that the node doesn't need to be
9696 // persisted and that its channel info remains the same.
9697 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
9698 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
9699 assert!(!nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
9700 assert!(!nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
9701 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
9702 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
9704 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
9705 // the channel info has updated.
9706 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
9707 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
9708 assert!(nodes[0].node.get_event_or_persistence_needed_future().poll_is_complete());
9709 assert!(nodes[1].node.get_event_or_persistence_needed_future().poll_is_complete());
9710 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
9711 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
9715 fn test_keysend_dup_hash_partial_mpp() {
9716 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
9718 let chanmon_cfgs = create_chanmon_cfgs(2);
9719 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9720 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9721 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9722 create_announced_chan_between_nodes(&nodes, 0, 1);
9724 // First, send a partial MPP payment.
9725 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
9726 let mut mpp_route = route.clone();
9727 mpp_route.paths.push(mpp_route.paths[0].clone());
9729 let payment_id = PaymentId([42; 32]);
9730 // Use the utility function send_payment_along_path to send the payment with MPP data which
9731 // indicates there are more HTLCs coming.
9732 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.
9733 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
9734 RecipientOnionFields::secret_only(payment_secret), payment_id, &mpp_route).unwrap();
9735 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[0], &our_payment_hash,
9736 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
9737 check_added_monitors!(nodes[0], 1);
9738 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9739 assert_eq!(events.len(), 1);
9740 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
9742 // Next, send a keysend payment with the same payment_hash and make sure it fails.
9743 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9744 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9745 check_added_monitors!(nodes[0], 1);
9746 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9747 assert_eq!(events.len(), 1);
9748 let ev = events.drain(..).next().unwrap();
9749 let payment_event = SendEvent::from_event(ev);
9750 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9751 check_added_monitors!(nodes[1], 0);
9752 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9753 expect_pending_htlcs_forwardable!(nodes[1]);
9754 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
9755 check_added_monitors!(nodes[1], 1);
9756 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9757 assert!(updates.update_add_htlcs.is_empty());
9758 assert!(updates.update_fulfill_htlcs.is_empty());
9759 assert_eq!(updates.update_fail_htlcs.len(), 1);
9760 assert!(updates.update_fail_malformed_htlcs.is_empty());
9761 assert!(updates.update_fee.is_none());
9762 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9763 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9764 expect_payment_failed!(nodes[0], our_payment_hash, true);
9766 // Send the second half of the original MPP payment.
9767 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[1], &our_payment_hash,
9768 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
9769 check_added_monitors!(nodes[0], 1);
9770 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9771 assert_eq!(events.len(), 1);
9772 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
9774 // Claim the full MPP payment. Note that we can't use a test utility like
9775 // claim_funds_along_route because the ordering of the messages causes the second half of the
9776 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
9777 // lightning messages manually.
9778 nodes[1].node.claim_funds(payment_preimage);
9779 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
9780 check_added_monitors!(nodes[1], 2);
9782 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9783 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
9784 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
9785 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
9786 check_added_monitors!(nodes[0], 1);
9787 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9788 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
9789 check_added_monitors!(nodes[1], 1);
9790 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9791 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
9792 check_added_monitors!(nodes[1], 1);
9793 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
9794 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
9795 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
9796 check_added_monitors!(nodes[0], 1);
9797 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
9798 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
9799 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9800 check_added_monitors!(nodes[0], 1);
9801 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
9802 check_added_monitors!(nodes[1], 1);
9803 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
9804 check_added_monitors!(nodes[1], 1);
9805 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
9806 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
9807 check_added_monitors!(nodes[0], 1);
9809 // Note that successful MPP payments will generate a single PaymentSent event upon the first
9810 // path's success and a PaymentPathSuccessful event for each path's success.
9811 let events = nodes[0].node.get_and_clear_pending_events();
9812 assert_eq!(events.len(), 2);
9814 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
9815 assert_eq!(payment_id, *actual_payment_id);
9816 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
9817 assert_eq!(route.paths[0], *path);
9819 _ => panic!("Unexpected event"),
9822 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
9823 assert_eq!(payment_id, *actual_payment_id);
9824 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
9825 assert_eq!(route.paths[0], *path);
9827 _ => panic!("Unexpected event"),
9832 fn test_keysend_dup_payment_hash() {
9833 do_test_keysend_dup_payment_hash(false);
9834 do_test_keysend_dup_payment_hash(true);
9837 fn do_test_keysend_dup_payment_hash(accept_mpp_keysend: bool) {
9838 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
9839 // outbound regular payment fails as expected.
9840 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
9841 // fails as expected.
9842 // (3): Test that a keysend payment with a duplicate payment hash to an existing keysend
9843 // payment fails as expected. When `accept_mpp_keysend` is false, this tests that we
9844 // reject MPP keysend payments, since in this case where the payment has no payment
9845 // secret, a keysend payment with a duplicate hash is basically an MPP keysend. If
9846 // `accept_mpp_keysend` is true, this tests that we only accept MPP keysends with
9847 // payment secrets and reject otherwise.
9848 let chanmon_cfgs = create_chanmon_cfgs(2);
9849 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9850 let mut mpp_keysend_cfg = test_default_channel_config();
9851 mpp_keysend_cfg.accept_mpp_keysend = accept_mpp_keysend;
9852 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(mpp_keysend_cfg)]);
9853 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9854 create_announced_chan_between_nodes(&nodes, 0, 1);
9855 let scorer = test_utils::TestScorer::new();
9856 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9858 // To start (1), send a regular payment but don't claim it.
9859 let expected_route = [&nodes[1]];
9860 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
9862 // Next, attempt a keysend payment and make sure it fails.
9863 let route_params = RouteParameters::from_payment_params_and_value(
9864 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(),
9865 TEST_FINAL_CLTV, false), 100_000);
9866 let route = find_route(
9867 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
9868 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
9870 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9871 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9872 check_added_monitors!(nodes[0], 1);
9873 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9874 assert_eq!(events.len(), 1);
9875 let ev = events.drain(..).next().unwrap();
9876 let payment_event = SendEvent::from_event(ev);
9877 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9878 check_added_monitors!(nodes[1], 0);
9879 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9880 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
9881 // fails), the second will process the resulting failure and fail the HTLC backward
9882 expect_pending_htlcs_forwardable!(nodes[1]);
9883 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9884 check_added_monitors!(nodes[1], 1);
9885 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9886 assert!(updates.update_add_htlcs.is_empty());
9887 assert!(updates.update_fulfill_htlcs.is_empty());
9888 assert_eq!(updates.update_fail_htlcs.len(), 1);
9889 assert!(updates.update_fail_malformed_htlcs.is_empty());
9890 assert!(updates.update_fee.is_none());
9891 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9892 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9893 expect_payment_failed!(nodes[0], payment_hash, true);
9895 // Finally, claim the original payment.
9896 claim_payment(&nodes[0], &expected_route, payment_preimage);
9898 // To start (2), send a keysend payment but don't claim it.
9899 let payment_preimage = PaymentPreimage([42; 32]);
9900 let route = find_route(
9901 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
9902 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
9904 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9905 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9906 check_added_monitors!(nodes[0], 1);
9907 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9908 assert_eq!(events.len(), 1);
9909 let event = events.pop().unwrap();
9910 let path = vec![&nodes[1]];
9911 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
9913 // Next, attempt a regular payment and make sure it fails.
9914 let payment_secret = PaymentSecret([43; 32]);
9915 nodes[0].node.send_payment_with_route(&route, payment_hash,
9916 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
9917 check_added_monitors!(nodes[0], 1);
9918 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9919 assert_eq!(events.len(), 1);
9920 let ev = events.drain(..).next().unwrap();
9921 let payment_event = SendEvent::from_event(ev);
9922 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9923 check_added_monitors!(nodes[1], 0);
9924 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9925 expect_pending_htlcs_forwardable!(nodes[1]);
9926 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9927 check_added_monitors!(nodes[1], 1);
9928 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9929 assert!(updates.update_add_htlcs.is_empty());
9930 assert!(updates.update_fulfill_htlcs.is_empty());
9931 assert_eq!(updates.update_fail_htlcs.len(), 1);
9932 assert!(updates.update_fail_malformed_htlcs.is_empty());
9933 assert!(updates.update_fee.is_none());
9934 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9935 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9936 expect_payment_failed!(nodes[0], payment_hash, true);
9938 // Finally, succeed the keysend payment.
9939 claim_payment(&nodes[0], &expected_route, payment_preimage);
9941 // To start (3), send a keysend payment but don't claim it.
9942 let payment_id_1 = PaymentId([44; 32]);
9943 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9944 RecipientOnionFields::spontaneous_empty(), payment_id_1).unwrap();
9945 check_added_monitors!(nodes[0], 1);
9946 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9947 assert_eq!(events.len(), 1);
9948 let event = events.pop().unwrap();
9949 let path = vec![&nodes[1]];
9950 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
9952 // Next, attempt a keysend payment and make sure it fails.
9953 let route_params = RouteParameters::from_payment_params_and_value(
9954 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
9957 let route = find_route(
9958 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
9959 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
9961 let payment_id_2 = PaymentId([45; 32]);
9962 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9963 RecipientOnionFields::spontaneous_empty(), payment_id_2).unwrap();
9964 check_added_monitors!(nodes[0], 1);
9965 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9966 assert_eq!(events.len(), 1);
9967 let ev = events.drain(..).next().unwrap();
9968 let payment_event = SendEvent::from_event(ev);
9969 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9970 check_added_monitors!(nodes[1], 0);
9971 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9972 expect_pending_htlcs_forwardable!(nodes[1]);
9973 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9974 check_added_monitors!(nodes[1], 1);
9975 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9976 assert!(updates.update_add_htlcs.is_empty());
9977 assert!(updates.update_fulfill_htlcs.is_empty());
9978 assert_eq!(updates.update_fail_htlcs.len(), 1);
9979 assert!(updates.update_fail_malformed_htlcs.is_empty());
9980 assert!(updates.update_fee.is_none());
9981 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9982 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9983 expect_payment_failed!(nodes[0], payment_hash, true);
9985 // Finally, claim the original payment.
9986 claim_payment(&nodes[0], &expected_route, payment_preimage);
9990 fn test_keysend_hash_mismatch() {
9991 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
9992 // preimage doesn't match the msg's payment hash.
9993 let chanmon_cfgs = create_chanmon_cfgs(2);
9994 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9995 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9996 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9998 let payer_pubkey = nodes[0].node.get_our_node_id();
9999 let payee_pubkey = nodes[1].node.get_our_node_id();
10001 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
10002 let route_params = RouteParameters::from_payment_params_and_value(
10003 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
10004 let network_graph = nodes[0].network_graph.clone();
10005 let first_hops = nodes[0].node.list_usable_channels();
10006 let scorer = test_utils::TestScorer::new();
10007 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
10008 let route = find_route(
10009 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
10010 nodes[0].logger, &scorer, &(), &random_seed_bytes
10013 let test_preimage = PaymentPreimage([42; 32]);
10014 let mismatch_payment_hash = PaymentHash([43; 32]);
10015 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash,
10016 RecipientOnionFields::spontaneous_empty(), PaymentId(mismatch_payment_hash.0), &route).unwrap();
10017 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash,
10018 RecipientOnionFields::spontaneous_empty(), Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
10019 check_added_monitors!(nodes[0], 1);
10021 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
10022 assert_eq!(updates.update_add_htlcs.len(), 1);
10023 assert!(updates.update_fulfill_htlcs.is_empty());
10024 assert!(updates.update_fail_htlcs.is_empty());
10025 assert!(updates.update_fail_malformed_htlcs.is_empty());
10026 assert!(updates.update_fee.is_none());
10027 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
10029 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "Payment preimage didn't match payment hash", 1);
10033 fn test_keysend_msg_with_secret_err() {
10034 // Test that we error as expected if we receive a keysend payment that includes a payment
10035 // secret when we don't support MPP keysend.
10036 let mut reject_mpp_keysend_cfg = test_default_channel_config();
10037 reject_mpp_keysend_cfg.accept_mpp_keysend = false;
10038 let chanmon_cfgs = create_chanmon_cfgs(2);
10039 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10040 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(reject_mpp_keysend_cfg)]);
10041 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10043 let payer_pubkey = nodes[0].node.get_our_node_id();
10044 let payee_pubkey = nodes[1].node.get_our_node_id();
10046 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
10047 let route_params = RouteParameters::from_payment_params_and_value(
10048 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
10049 let network_graph = nodes[0].network_graph.clone();
10050 let first_hops = nodes[0].node.list_usable_channels();
10051 let scorer = test_utils::TestScorer::new();
10052 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
10053 let route = find_route(
10054 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
10055 nodes[0].logger, &scorer, &(), &random_seed_bytes
10058 let test_preimage = PaymentPreimage([42; 32]);
10059 let test_secret = PaymentSecret([43; 32]);
10060 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
10061 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash,
10062 RecipientOnionFields::secret_only(test_secret), PaymentId(payment_hash.0), &route).unwrap();
10063 nodes[0].node.test_send_payment_internal(&route, payment_hash,
10064 RecipientOnionFields::secret_only(test_secret), Some(test_preimage),
10065 PaymentId(payment_hash.0), None, session_privs).unwrap();
10066 check_added_monitors!(nodes[0], 1);
10068 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
10069 assert_eq!(updates.update_add_htlcs.len(), 1);
10070 assert!(updates.update_fulfill_htlcs.is_empty());
10071 assert!(updates.update_fail_htlcs.is_empty());
10072 assert!(updates.update_fail_malformed_htlcs.is_empty());
10073 assert!(updates.update_fee.is_none());
10074 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
10076 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "We don't support MPP keysend payments", 1);
10080 fn test_multi_hop_missing_secret() {
10081 let chanmon_cfgs = create_chanmon_cfgs(4);
10082 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
10083 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
10084 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
10086 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
10087 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
10088 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
10089 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
10091 // Marshall an MPP route.
10092 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
10093 let path = route.paths[0].clone();
10094 route.paths.push(path);
10095 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
10096 route.paths[0].hops[0].short_channel_id = chan_1_id;
10097 route.paths[0].hops[1].short_channel_id = chan_3_id;
10098 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
10099 route.paths[1].hops[0].short_channel_id = chan_2_id;
10100 route.paths[1].hops[1].short_channel_id = chan_4_id;
10102 match nodes[0].node.send_payment_with_route(&route, payment_hash,
10103 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0))
10105 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
10106 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err))
10108 _ => panic!("unexpected error")
10113 fn test_drop_disconnected_peers_when_removing_channels() {
10114 let chanmon_cfgs = create_chanmon_cfgs(2);
10115 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10116 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10117 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10119 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
10121 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
10122 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10124 nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
10125 check_closed_broadcast!(nodes[0], true);
10126 check_added_monitors!(nodes[0], 1);
10127 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
10130 // Assert that nodes[1] is awaiting removal for nodes[0] once nodes[1] has been
10131 // disconnected and the channel between has been force closed.
10132 let nodes_0_per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
10133 // Assert that nodes[1] isn't removed before `timer_tick_occurred` has been executed.
10134 assert_eq!(nodes_0_per_peer_state.len(), 1);
10135 assert!(nodes_0_per_peer_state.get(&nodes[1].node.get_our_node_id()).is_some());
10138 nodes[0].node.timer_tick_occurred();
10141 // Assert that nodes[1] has now been removed.
10142 assert_eq!(nodes[0].node.per_peer_state.read().unwrap().len(), 0);
10147 fn bad_inbound_payment_hash() {
10148 // Add coverage for checking that a user-provided payment hash matches the payment secret.
10149 let chanmon_cfgs = create_chanmon_cfgs(2);
10150 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10151 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10152 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10154 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
10155 let payment_data = msgs::FinalOnionHopData {
10157 total_msat: 100_000,
10160 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
10161 // payment verification fails as expected.
10162 let mut bad_payment_hash = payment_hash.clone();
10163 bad_payment_hash.0[0] += 1;
10164 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) {
10165 Ok(_) => panic!("Unexpected ok"),
10167 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment", "Failing HTLC with user-generated payment_hash", 1);
10171 // Check that using the original payment hash succeeds.
10172 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());
10176 fn test_id_to_peer_coverage() {
10177 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
10178 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
10179 // the channel is successfully closed.
10180 let chanmon_cfgs = create_chanmon_cfgs(2);
10181 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10182 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10183 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10185 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
10186 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10187 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
10188 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10189 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
10191 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
10192 let channel_id = ChannelId::from_bytes(tx.txid().into_inner());
10194 // Ensure that the `id_to_peer` map is empty until either party has received the
10195 // funding transaction, and have the real `channel_id`.
10196 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
10197 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
10200 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
10202 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
10203 // as it has the funding transaction.
10204 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
10205 assert_eq!(nodes_0_lock.len(), 1);
10206 assert!(nodes_0_lock.contains_key(&channel_id));
10209 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
10211 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
10213 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
10215 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
10216 assert_eq!(nodes_0_lock.len(), 1);
10217 assert!(nodes_0_lock.contains_key(&channel_id));
10219 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
10222 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
10223 // as it has the funding transaction.
10224 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
10225 assert_eq!(nodes_1_lock.len(), 1);
10226 assert!(nodes_1_lock.contains_key(&channel_id));
10228 check_added_monitors!(nodes[1], 1);
10229 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
10230 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
10231 check_added_monitors!(nodes[0], 1);
10232 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
10233 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
10234 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
10235 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
10237 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
10238 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()));
10239 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
10240 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &nodes_1_shutdown);
10242 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
10243 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
10245 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
10246 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
10247 // fee for the closing transaction has been negotiated and the parties has the other
10248 // party's signature for the fee negotiated closing transaction.)
10249 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
10250 assert_eq!(nodes_0_lock.len(), 1);
10251 assert!(nodes_0_lock.contains_key(&channel_id));
10255 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
10256 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
10257 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
10258 // kept in the `nodes[1]`'s `id_to_peer` map.
10259 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
10260 assert_eq!(nodes_1_lock.len(), 1);
10261 assert!(nodes_1_lock.contains_key(&channel_id));
10264 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()));
10266 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
10267 // therefore has all it needs to fully close the channel (both signatures for the
10268 // closing transaction).
10269 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
10270 // fully closed by `nodes[0]`.
10271 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
10273 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
10274 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
10275 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
10276 assert_eq!(nodes_1_lock.len(), 1);
10277 assert!(nodes_1_lock.contains_key(&channel_id));
10280 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
10282 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
10284 // Assert that the channel has now been removed from both parties `id_to_peer` map once
10285 // they both have everything required to fully close the channel.
10286 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
10288 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
10290 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
10291 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
10294 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
10295 let expected_message = format!("Not connected to node: {}", expected_public_key);
10296 check_api_error_message(expected_message, res_err)
10299 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
10300 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
10301 check_api_error_message(expected_message, res_err)
10304 fn check_api_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
10306 Err(APIError::APIMisuseError { err }) => {
10307 assert_eq!(err, expected_err_message);
10309 Err(APIError::ChannelUnavailable { err }) => {
10310 assert_eq!(err, expected_err_message);
10312 Ok(_) => panic!("Unexpected Ok"),
10313 Err(_) => panic!("Unexpected Error"),
10318 fn test_api_calls_with_unkown_counterparty_node() {
10319 // Tests that our API functions that expects a `counterparty_node_id` as input, behaves as
10320 // expected if the `counterparty_node_id` is an unkown peer in the
10321 // `ChannelManager::per_peer_state` map.
10322 let chanmon_cfg = create_chanmon_cfgs(2);
10323 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
10324 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
10325 let nodes = create_network(2, &node_cfg, &node_chanmgr);
10328 let channel_id = ChannelId::from_bytes([4; 32]);
10329 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
10330 let intercept_id = InterceptId([0; 32]);
10332 // Test the API functions.
10333 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);
10335 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&channel_id, &unkown_public_key, 42), unkown_public_key);
10337 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
10339 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
10341 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
10343 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
10345 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
10349 fn test_connection_limiting() {
10350 // Test that we limit un-channel'd peers and un-funded channels properly.
10351 let chanmon_cfgs = create_chanmon_cfgs(2);
10352 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10353 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10354 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10356 // Note that create_network connects the nodes together for us
10358 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10359 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10361 let mut funding_tx = None;
10362 for idx in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
10363 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10364 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10367 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
10368 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
10369 funding_tx = Some(tx.clone());
10370 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx).unwrap();
10371 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
10373 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
10374 check_added_monitors!(nodes[1], 1);
10375 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
10377 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
10379 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
10380 check_added_monitors!(nodes[0], 1);
10381 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
10383 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10386 // A MAX_UNFUNDED_CHANS_PER_PEER + 1 channel will be summarily rejected
10387 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10388 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10389 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
10390 open_channel_msg.temporary_channel_id);
10392 // Further, because all of our channels with nodes[0] are inbound, and none of them funded,
10393 // it doesn't count as a "protected" peer, i.e. it counts towards the MAX_NO_CHANNEL_PEERS
10395 let mut peer_pks = Vec::with_capacity(super::MAX_NO_CHANNEL_PEERS);
10396 for _ in 1..super::MAX_NO_CHANNEL_PEERS {
10397 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10398 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10399 peer_pks.push(random_pk);
10400 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
10401 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10404 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10405 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10406 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10407 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10408 }, true).unwrap_err();
10410 // Also importantly, because nodes[0] isn't "protected", we will refuse a reconnection from
10411 // them if we have too many un-channel'd peers.
10412 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10413 let chan_closed_events = nodes[1].node.get_and_clear_pending_events();
10414 assert_eq!(chan_closed_events.len(), super::MAX_UNFUNDED_CHANS_PER_PEER - 1);
10415 for ev in chan_closed_events {
10416 if let Event::ChannelClosed { .. } = ev { } else { panic!(); }
10418 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10419 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10421 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10422 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10423 }, true).unwrap_err();
10425 // but of course if the connection is outbound its allowed...
10426 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10427 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10428 }, false).unwrap();
10429 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10431 // Now nodes[0] is disconnected but still has a pending, un-funded channel lying around.
10432 // Even though we accept one more connection from new peers, we won't actually let them
10434 assert!(peer_pks.len() > super::MAX_UNFUNDED_CHANNEL_PEERS - 1);
10435 for i in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
10436 nodes[1].node.handle_open_channel(&peer_pks[i], &open_channel_msg);
10437 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, peer_pks[i]);
10438 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10440 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10441 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
10442 open_channel_msg.temporary_channel_id);
10444 // Of course, however, outbound channels are always allowed
10445 nodes[1].node.create_channel(last_random_pk, 100_000, 0, 42, None).unwrap();
10446 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, last_random_pk);
10448 // If we fund the first channel, nodes[0] has a live on-chain channel with us, it is now
10449 // "protected" and can connect again.
10450 mine_transaction(&nodes[1], funding_tx.as_ref().unwrap());
10451 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10452 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10454 get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
10456 // Further, because the first channel was funded, we can open another channel with
10458 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10459 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
10463 fn test_outbound_chans_unlimited() {
10464 // Test that we never refuse an outbound channel even if a peer is unfuned-channel-limited
10465 let chanmon_cfgs = create_chanmon_cfgs(2);
10466 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10467 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10468 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10470 // Note that create_network connects the nodes together for us
10472 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10473 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10475 for _ in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
10476 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10477 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10478 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10481 // Once we have MAX_UNFUNDED_CHANS_PER_PEER unfunded channels, new inbound channels will be
10483 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10484 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
10485 open_channel_msg.temporary_channel_id);
10487 // but we can still open an outbound channel.
10488 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10489 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
10491 // but even with such an outbound channel, additional inbound channels will still fail.
10492 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10493 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
10494 open_channel_msg.temporary_channel_id);
10498 fn test_0conf_limiting() {
10499 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
10500 // flag set and (sometimes) accept channels as 0conf.
10501 let chanmon_cfgs = create_chanmon_cfgs(2);
10502 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10503 let mut settings = test_default_channel_config();
10504 settings.manually_accept_inbound_channels = true;
10505 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(settings)]);
10506 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10508 // Note that create_network connects the nodes together for us
10510 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10511 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10513 // First, get us up to MAX_UNFUNDED_CHANNEL_PEERS so we can test at the edge
10514 for _ in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
10515 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10516 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10517 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
10518 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10521 nodes[1].node.handle_open_channel(&random_pk, &open_channel_msg);
10522 let events = nodes[1].node.get_and_clear_pending_events();
10524 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10525 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23).unwrap();
10527 _ => panic!("Unexpected event"),
10529 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, random_pk);
10530 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10533 // If we try to accept a channel from another peer non-0conf it will fail.
10534 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10535 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10536 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10537 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10539 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10540 let events = nodes[1].node.get_and_clear_pending_events();
10542 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10543 match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23) {
10544 Err(APIError::APIMisuseError { err }) =>
10545 assert_eq!(err, "Too many peers with unfunded channels, refusing to accept new ones"),
10549 _ => panic!("Unexpected event"),
10551 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
10552 open_channel_msg.temporary_channel_id);
10554 // ...however if we accept the same channel 0conf it should work just fine.
10555 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10556 let events = nodes[1].node.get_and_clear_pending_events();
10558 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10559 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23).unwrap();
10561 _ => panic!("Unexpected event"),
10563 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
10567 fn reject_excessively_underpaying_htlcs() {
10568 let chanmon_cfg = create_chanmon_cfgs(1);
10569 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
10570 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
10571 let node = create_network(1, &node_cfg, &node_chanmgr);
10572 let sender_intended_amt_msat = 100;
10573 let extra_fee_msat = 10;
10574 let hop_data = msgs::InboundOnionPayload::Receive {
10576 outgoing_cltv_value: 42,
10577 payment_metadata: None,
10578 keysend_preimage: None,
10579 payment_data: Some(msgs::FinalOnionHopData {
10580 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
10582 custom_tlvs: Vec::new(),
10584 // Check that if the amount we received + the penultimate hop extra fee is less than the sender
10585 // intended amount, we fail the payment.
10586 if let Err(crate::ln::channelmanager::InboundOnionErr { err_code, .. }) =
10587 node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
10588 sender_intended_amt_msat - extra_fee_msat - 1, 42, None, true, Some(extra_fee_msat))
10590 assert_eq!(err_code, 19);
10591 } else { panic!(); }
10593 // If amt_received + extra_fee is equal to the sender intended amount, we're fine.
10594 let hop_data = msgs::InboundOnionPayload::Receive { // This is the same payload as above, InboundOnionPayload doesn't implement Clone
10596 outgoing_cltv_value: 42,
10597 payment_metadata: None,
10598 keysend_preimage: None,
10599 payment_data: Some(msgs::FinalOnionHopData {
10600 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
10602 custom_tlvs: Vec::new(),
10604 assert!(node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
10605 sender_intended_amt_msat - extra_fee_msat, 42, None, true, Some(extra_fee_msat)).is_ok());
10609 fn test_inbound_anchors_manual_acceptance() {
10610 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
10611 // flag set and (sometimes) accept channels as 0conf.
10612 let mut anchors_cfg = test_default_channel_config();
10613 anchors_cfg.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
10615 let mut anchors_manual_accept_cfg = anchors_cfg.clone();
10616 anchors_manual_accept_cfg.manually_accept_inbound_channels = true;
10618 let chanmon_cfgs = create_chanmon_cfgs(3);
10619 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
10620 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs,
10621 &[Some(anchors_cfg.clone()), Some(anchors_cfg.clone()), Some(anchors_manual_accept_cfg.clone())]);
10622 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
10624 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10625 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10627 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10628 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
10629 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
10630 match &msg_events[0] {
10631 MessageSendEvent::HandleError { node_id, action } => {
10632 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
10634 ErrorAction::SendErrorMessage { msg } =>
10635 assert_eq!(msg.data, "No channels with anchor outputs accepted".to_owned()),
10636 _ => panic!("Unexpected error action"),
10639 _ => panic!("Unexpected event"),
10642 nodes[2].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10643 let events = nodes[2].node.get_and_clear_pending_events();
10645 Event::OpenChannelRequest { temporary_channel_id, .. } =>
10646 nodes[2].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap(),
10647 _ => panic!("Unexpected event"),
10649 get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10653 fn test_anchors_zero_fee_htlc_tx_fallback() {
10654 // Tests that if both nodes support anchors, but the remote node does not want to accept
10655 // anchor channels at the moment, an error it sent to the local node such that it can retry
10656 // the channel without the anchors feature.
10657 let chanmon_cfgs = create_chanmon_cfgs(2);
10658 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10659 let mut anchors_config = test_default_channel_config();
10660 anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
10661 anchors_config.manually_accept_inbound_channels = true;
10662 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config.clone()), Some(anchors_config.clone())]);
10663 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10665 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 0, None).unwrap();
10666 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10667 assert!(open_channel_msg.channel_type.as_ref().unwrap().supports_anchors_zero_fee_htlc_tx());
10669 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10670 let events = nodes[1].node.get_and_clear_pending_events();
10672 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10673 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
10675 _ => panic!("Unexpected event"),
10678 let error_msg = get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id());
10679 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &error_msg);
10681 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10682 assert!(!open_channel_msg.channel_type.unwrap().supports_anchors_zero_fee_htlc_tx());
10684 // Since nodes[1] should not have accepted the channel, it should
10685 // not have generated any events.
10686 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
10690 fn test_update_channel_config() {
10691 let chanmon_cfg = create_chanmon_cfgs(2);
10692 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
10693 let mut user_config = test_default_channel_config();
10694 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
10695 let nodes = create_network(2, &node_cfg, &node_chanmgr);
10696 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
10697 let channel = &nodes[0].node.list_channels()[0];
10699 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
10700 let events = nodes[0].node.get_and_clear_pending_msg_events();
10701 assert_eq!(events.len(), 0);
10703 user_config.channel_config.forwarding_fee_base_msat += 10;
10704 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
10705 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_base_msat, user_config.channel_config.forwarding_fee_base_msat);
10706 let events = nodes[0].node.get_and_clear_pending_msg_events();
10707 assert_eq!(events.len(), 1);
10709 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10710 _ => panic!("expected BroadcastChannelUpdate event"),
10713 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate::default()).unwrap();
10714 let events = nodes[0].node.get_and_clear_pending_msg_events();
10715 assert_eq!(events.len(), 0);
10717 let new_cltv_expiry_delta = user_config.channel_config.cltv_expiry_delta + 6;
10718 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
10719 cltv_expiry_delta: Some(new_cltv_expiry_delta),
10720 ..Default::default()
10722 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
10723 let events = nodes[0].node.get_and_clear_pending_msg_events();
10724 assert_eq!(events.len(), 1);
10726 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10727 _ => panic!("expected BroadcastChannelUpdate event"),
10730 let new_fee = user_config.channel_config.forwarding_fee_proportional_millionths + 100;
10731 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
10732 forwarding_fee_proportional_millionths: Some(new_fee),
10733 ..Default::default()
10735 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
10736 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, new_fee);
10737 let events = nodes[0].node.get_and_clear_pending_msg_events();
10738 assert_eq!(events.len(), 1);
10740 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10741 _ => panic!("expected BroadcastChannelUpdate event"),
10744 // If we provide a channel_id not associated with the peer, we should get an error and no updates
10745 // should be applied to ensure update atomicity as specified in the API docs.
10746 let bad_channel_id = ChannelId::v1_from_funding_txid(&[10; 32], 10);
10747 let current_fee = nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths;
10748 let new_fee = current_fee + 100;
10751 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id, bad_channel_id], &ChannelConfigUpdate {
10752 forwarding_fee_proportional_millionths: Some(new_fee),
10753 ..Default::default()
10755 Err(APIError::ChannelUnavailable { err: _ }),
10758 // Check that the fee hasn't changed for the channel that exists.
10759 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, current_fee);
10760 let events = nodes[0].node.get_and_clear_pending_msg_events();
10761 assert_eq!(events.len(), 0);
10765 fn test_payment_display() {
10766 let payment_id = PaymentId([42; 32]);
10767 assert_eq!(format!("{}", &payment_id), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
10768 let payment_hash = PaymentHash([42; 32]);
10769 assert_eq!(format!("{}", &payment_hash), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
10770 let payment_preimage = PaymentPreimage([42; 32]);
10771 assert_eq!(format!("{}", &payment_preimage), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
10777 use crate::chain::Listen;
10778 use crate::chain::chainmonitor::{ChainMonitor, Persist};
10779 use crate::sign::{KeysManager, InMemorySigner};
10780 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider};
10781 use crate::ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId, RecipientOnionFields, Retry};
10782 use crate::ln::functional_test_utils::*;
10783 use crate::ln::msgs::{ChannelMessageHandler, Init};
10784 use crate::routing::gossip::NetworkGraph;
10785 use crate::routing::router::{PaymentParameters, RouteParameters};
10786 use crate::util::test_utils;
10787 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
10789 use bitcoin::hashes::Hash;
10790 use bitcoin::hashes::sha256::Hash as Sha256;
10791 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
10793 use crate::sync::{Arc, Mutex, RwLock};
10795 use criterion::Criterion;
10797 type Manager<'a, P> = ChannelManager<
10798 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
10799 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
10800 &'a test_utils::TestLogger, &'a P>,
10801 &'a test_utils::TestBroadcaster, &'a KeysManager, &'a KeysManager, &'a KeysManager,
10802 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
10803 &'a test_utils::TestLogger>;
10805 struct ANodeHolder<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> {
10806 node: &'node_cfg Manager<'chan_mon_cfg, P>,
10808 impl<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> NodeHolder for ANodeHolder<'node_cfg, 'chan_mon_cfg, P> {
10809 type CM = Manager<'chan_mon_cfg, P>;
10811 fn node(&self) -> &Manager<'chan_mon_cfg, P> { self.node }
10813 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { None }
10816 pub fn bench_sends(bench: &mut Criterion) {
10817 bench_two_sends(bench, "bench_sends", test_utils::TestPersister::new(), test_utils::TestPersister::new());
10820 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Criterion, bench_name: &str, persister_a: P, persister_b: P) {
10821 // Do a simple benchmark of sending a payment back and forth between two nodes.
10822 // Note that this is unrealistic as each payment send will require at least two fsync
10824 let network = bitcoin::Network::Testnet;
10825 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
10827 let tx_broadcaster = test_utils::TestBroadcaster::new(network);
10828 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
10829 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
10830 let scorer = RwLock::new(test_utils::TestScorer::new());
10831 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(network, &logger_a)), &scorer);
10833 let mut config: UserConfig = Default::default();
10834 config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
10835 config.channel_handshake_config.minimum_depth = 1;
10837 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
10838 let seed_a = [1u8; 32];
10839 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
10840 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 {
10842 best_block: BestBlock::from_network(network),
10843 }, genesis_block.header.time);
10844 let node_a_holder = ANodeHolder { node: &node_a };
10846 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
10847 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
10848 let seed_b = [2u8; 32];
10849 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
10850 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 {
10852 best_block: BestBlock::from_network(network),
10853 }, genesis_block.header.time);
10854 let node_b_holder = ANodeHolder { node: &node_b };
10856 node_a.peer_connected(&node_b.get_our_node_id(), &Init {
10857 features: node_b.init_features(), networks: None, remote_network_address: None
10859 node_b.peer_connected(&node_a.get_our_node_id(), &Init {
10860 features: node_a.init_features(), networks: None, remote_network_address: None
10861 }, false).unwrap();
10862 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
10863 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()));
10864 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()));
10867 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
10868 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
10869 value: 8_000_000, script_pubkey: output_script,
10871 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
10872 } else { panic!(); }
10874 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()));
10875 let events_b = node_b.get_and_clear_pending_events();
10876 assert_eq!(events_b.len(), 1);
10877 match events_b[0] {
10878 Event::ChannelPending{ ref counterparty_node_id, .. } => {
10879 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
10881 _ => panic!("Unexpected event"),
10884 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()));
10885 let events_a = node_a.get_and_clear_pending_events();
10886 assert_eq!(events_a.len(), 1);
10887 match events_a[0] {
10888 Event::ChannelPending{ ref counterparty_node_id, .. } => {
10889 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
10891 _ => panic!("Unexpected event"),
10894 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
10896 let block = create_dummy_block(BestBlock::from_network(network).block_hash(), 42, vec![tx]);
10897 Listen::block_connected(&node_a, &block, 1);
10898 Listen::block_connected(&node_b, &block, 1);
10900 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()));
10901 let msg_events = node_a.get_and_clear_pending_msg_events();
10902 assert_eq!(msg_events.len(), 2);
10903 match msg_events[0] {
10904 MessageSendEvent::SendChannelReady { ref msg, .. } => {
10905 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
10906 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
10910 match msg_events[1] {
10911 MessageSendEvent::SendChannelUpdate { .. } => {},
10915 let events_a = node_a.get_and_clear_pending_events();
10916 assert_eq!(events_a.len(), 1);
10917 match events_a[0] {
10918 Event::ChannelReady{ ref counterparty_node_id, .. } => {
10919 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
10921 _ => panic!("Unexpected event"),
10924 let events_b = node_b.get_and_clear_pending_events();
10925 assert_eq!(events_b.len(), 1);
10926 match events_b[0] {
10927 Event::ChannelReady{ ref counterparty_node_id, .. } => {
10928 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
10930 _ => panic!("Unexpected event"),
10933 let mut payment_count: u64 = 0;
10934 macro_rules! send_payment {
10935 ($node_a: expr, $node_b: expr) => {
10936 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id(), TEST_FINAL_CLTV)
10937 .with_bolt11_features($node_b.invoice_features()).unwrap();
10938 let mut payment_preimage = PaymentPreimage([0; 32]);
10939 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
10940 payment_count += 1;
10941 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
10942 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
10944 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
10945 PaymentId(payment_hash.0),
10946 RouteParameters::from_payment_params_and_value(payment_params, 10_000),
10947 Retry::Attempts(0)).unwrap();
10948 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
10949 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
10950 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
10951 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_b }, &$node_a.get_our_node_id());
10952 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
10953 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
10954 $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()));
10956 expect_pending_htlcs_forwardable!(ANodeHolder { node: &$node_b });
10957 expect_payment_claimable!(ANodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
10958 $node_b.claim_funds(payment_preimage);
10959 expect_payment_claimed!(ANodeHolder { node: &$node_b }, payment_hash, 10_000);
10961 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
10962 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
10963 assert_eq!(node_id, $node_a.get_our_node_id());
10964 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
10965 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
10967 _ => panic!("Failed to generate claim event"),
10970 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_a }, &$node_b.get_our_node_id());
10971 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
10972 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
10973 $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()));
10975 expect_payment_sent!(ANodeHolder { node: &$node_a }, payment_preimage);
10979 bench.bench_function(bench_name, |b| b.iter(|| {
10980 send_payment!(node_a, node_b);
10981 send_payment!(node_b, node_a);