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, 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` -> `Channel`.
676 /// Holds all funded channels where the peer is the counterparty.
677 pub(super) channel_by_id: HashMap<ChannelId, Channel<SP>>,
678 /// `temporary_channel_id` -> `OutboundV1Channel`.
680 /// Holds all outbound V1 channels where the peer is the counterparty. Once an outbound channel has
681 /// been assigned a `channel_id`, the entry in this map is removed and one is created in
683 pub(super) outbound_v1_channel_by_id: HashMap<ChannelId, OutboundV1Channel<SP>>,
684 /// `temporary_channel_id` -> `InboundV1Channel`.
686 /// Holds all inbound V1 channels where the peer is the counterparty. Once an inbound channel has
687 /// been assigned a `channel_id`, the entry in this map is removed and one is created in
689 pub(super) inbound_v1_channel_by_id: HashMap<ChannelId, InboundV1Channel<SP>>,
690 /// `temporary_channel_id` -> `InboundChannelRequest`.
692 /// When manual channel acceptance is enabled, this holds all unaccepted inbound channels where
693 /// the peer is the counterparty. If the channel is accepted, then the entry in this table is
694 /// removed, and an InboundV1Channel is created and placed in the `inbound_v1_channel_by_id` table. If
695 /// the channel is rejected, then the entry is simply removed.
696 pub(super) inbound_channel_request_by_id: HashMap<ChannelId, InboundChannelRequest>,
697 /// The latest `InitFeatures` we heard from the peer.
698 latest_features: InitFeatures,
699 /// Messages to send to the peer - pushed to in the same lock that they are generated in (except
700 /// for broadcast messages, where ordering isn't as strict).
701 pub(super) pending_msg_events: Vec<MessageSendEvent>,
702 /// Map from Channel IDs to pending [`ChannelMonitorUpdate`]s which have been passed to the
703 /// user but which have not yet completed.
705 /// Note that the channel may no longer exist. For example if the 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.
708 in_flight_monitor_updates: BTreeMap<OutPoint, Vec<ChannelMonitorUpdate>>,
709 /// Map from a specific channel to some action(s) that should be taken when all pending
710 /// [`ChannelMonitorUpdate`]s for the channel complete updating.
712 /// Note that because we generally only have one entry here a HashMap is pretty overkill. A
713 /// BTreeMap currently stores more than ten elements per leaf node, so even up to a few
714 /// channels with a peer this will just be one allocation and will amount to a linear list of
715 /// channels to walk, avoiding the whole hashing rigmarole.
717 /// Note that the channel may no longer exist. For example, if a channel was closed but we
718 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
719 /// for a missing channel. While a malicious peer could construct a second channel with the
720 /// same `temporary_channel_id` (or final `channel_id` in the case of 0conf channels or prior
721 /// to funding appearing on-chain), the downstream `ChannelMonitor` set is required to ensure
722 /// duplicates do not occur, so such channels should fail without a monitor update completing.
723 monitor_update_blocked_actions: BTreeMap<ChannelId, Vec<MonitorUpdateCompletionAction>>,
724 /// If another channel's [`ChannelMonitorUpdate`] needs to complete before a channel we have
725 /// with this peer can complete an RAA [`ChannelMonitorUpdate`] (e.g. because the RAA update
726 /// will remove a preimage that needs to be durably in an upstream channel first), we put an
727 /// entry here to note that the channel with the key's ID is blocked on a set of actions.
728 actions_blocking_raa_monitor_updates: BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
729 /// The peer is currently connected (i.e. we've seen a
730 /// [`ChannelMessageHandler::peer_connected`] and no corresponding
731 /// [`ChannelMessageHandler::peer_disconnected`].
735 impl <SP: Deref> PeerState<SP> where SP::Target: SignerProvider {
736 /// Indicates that a peer meets the criteria where we're ok to remove it from our storage.
737 /// If true is passed for `require_disconnected`, the function will return false if we haven't
738 /// disconnected from the node already, ie. `PeerState::is_connected` is set to `true`.
739 fn ok_to_remove(&self, require_disconnected: bool) -> bool {
740 if require_disconnected && self.is_connected {
743 self.channel_by_id.is_empty() && self.monitor_update_blocked_actions.is_empty()
744 && self.in_flight_monitor_updates.is_empty()
747 // Returns a count of all channels we have with this peer, including unfunded channels.
748 fn total_channel_count(&self) -> usize {
749 self.channel_by_id.len() +
750 self.outbound_v1_channel_by_id.len() +
751 self.inbound_v1_channel_by_id.len() +
752 self.inbound_channel_request_by_id.len()
755 // Returns a bool indicating if the given `channel_id` matches a channel we have with this peer.
756 fn has_channel(&self, channel_id: &ChannelId) -> bool {
757 self.channel_by_id.contains_key(&channel_id) ||
758 self.outbound_v1_channel_by_id.contains_key(&channel_id) ||
759 self.inbound_v1_channel_by_id.contains_key(&channel_id) ||
760 self.inbound_channel_request_by_id.contains_key(&channel_id)
764 /// A not-yet-accepted inbound (from counterparty) channel. Once
765 /// accepted, the parameters will be used to construct a channel.
766 pub(super) struct InboundChannelRequest {
767 /// The original OpenChannel message.
768 pub open_channel_msg: msgs::OpenChannel,
769 /// The number of ticks remaining before the request expires.
770 pub ticks_remaining: i32,
773 /// The number of ticks that may elapse while we're waiting for an unaccepted inbound channel to be
774 /// accepted. An unaccepted channel that exceeds this limit will be abandoned.
775 const UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS: i32 = 2;
777 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
778 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
780 /// For users who don't want to bother doing their own payment preimage storage, we also store that
783 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
784 /// and instead encoding it in the payment secret.
785 struct PendingInboundPayment {
786 /// The payment secret that the sender must use for us to accept this payment
787 payment_secret: PaymentSecret,
788 /// Time at which this HTLC expires - blocks with a header time above this value will result in
789 /// this payment being removed.
791 /// Arbitrary identifier the user specifies (or not)
792 user_payment_id: u64,
793 // Other required attributes of the payment, optionally enforced:
794 payment_preimage: Option<PaymentPreimage>,
795 min_value_msat: Option<u64>,
798 /// [`SimpleArcChannelManager`] is useful when you need a [`ChannelManager`] with a static lifetime, e.g.
799 /// when you're using `lightning-net-tokio` (since `tokio::spawn` requires parameters with static
800 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
801 /// [`SimpleRefChannelManager`] is the more appropriate type. Defining these type aliases prevents
802 /// issues such as overly long function definitions. Note that the `ChannelManager` can take any type
803 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
804 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
805 /// of [`KeysManager`] and [`DefaultRouter`].
807 /// This is not exported to bindings users as Arcs don't make sense in bindings
808 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
816 Arc<NetworkGraph<Arc<L>>>,
818 Arc<Mutex<ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>>,
819 ProbabilisticScoringFeeParameters,
820 ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>,
825 /// [`SimpleRefChannelManager`] is a type alias for a ChannelManager reference, and is the reference
826 /// counterpart to the [`SimpleArcChannelManager`] type alias. Use this type by default when you don't
827 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
828 /// usage of lightning-net-tokio (since `tokio::spawn` requires parameters with static lifetimes).
829 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
830 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
831 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
832 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
833 /// of [`KeysManager`] and [`DefaultRouter`].
835 /// This is not exported to bindings users as Arcs don't make sense in bindings
836 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> =
845 &'f NetworkGraph<&'g L>,
847 &'h Mutex<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>,
848 ProbabilisticScoringFeeParameters,
849 ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>
854 macro_rules! define_test_pub_trait { ($vis: vis) => {
855 /// A trivial trait which describes any [`ChannelManager`] used in testing.
856 $vis trait AChannelManager {
857 type Watch: chain::Watch<Self::Signer> + ?Sized;
858 type M: Deref<Target = Self::Watch>;
859 type Broadcaster: BroadcasterInterface + ?Sized;
860 type T: Deref<Target = Self::Broadcaster>;
861 type EntropySource: EntropySource + ?Sized;
862 type ES: Deref<Target = Self::EntropySource>;
863 type NodeSigner: NodeSigner + ?Sized;
864 type NS: Deref<Target = Self::NodeSigner>;
865 type Signer: WriteableEcdsaChannelSigner + Sized;
866 type SignerProvider: SignerProvider<Signer = Self::Signer> + ?Sized;
867 type SP: Deref<Target = Self::SignerProvider>;
868 type FeeEstimator: FeeEstimator + ?Sized;
869 type F: Deref<Target = Self::FeeEstimator>;
870 type Router: Router + ?Sized;
871 type R: Deref<Target = Self::Router>;
872 type Logger: Logger + ?Sized;
873 type L: Deref<Target = Self::Logger>;
874 fn get_cm(&self) -> &ChannelManager<Self::M, Self::T, Self::ES, Self::NS, Self::SP, Self::F, Self::R, Self::L>;
877 #[cfg(any(test, feature = "_test_utils"))]
878 define_test_pub_trait!(pub);
879 #[cfg(not(any(test, feature = "_test_utils")))]
880 define_test_pub_trait!(pub(crate));
881 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> AChannelManager
882 for ChannelManager<M, T, ES, NS, SP, F, R, L>
884 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
885 T::Target: BroadcasterInterface,
886 ES::Target: EntropySource,
887 NS::Target: NodeSigner,
888 SP::Target: SignerProvider,
889 F::Target: FeeEstimator,
893 type Watch = M::Target;
895 type Broadcaster = T::Target;
897 type EntropySource = ES::Target;
899 type NodeSigner = NS::Target;
901 type Signer = <SP::Target as SignerProvider>::Signer;
902 type SignerProvider = SP::Target;
904 type FeeEstimator = F::Target;
906 type Router = R::Target;
908 type Logger = L::Target;
910 fn get_cm(&self) -> &ChannelManager<M, T, ES, NS, SP, F, R, L> { self }
913 /// Manager which keeps track of a number of channels and sends messages to the appropriate
914 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
916 /// Implements [`ChannelMessageHandler`], handling the multi-channel parts and passing things through
917 /// to individual Channels.
919 /// Implements [`Writeable`] to write out all channel state to disk. Implies [`peer_disconnected`] for
920 /// all peers during write/read (though does not modify this instance, only the instance being
921 /// serialized). This will result in any channels which have not yet exchanged [`funding_created`] (i.e.,
922 /// called [`funding_transaction_generated`] for outbound channels) being closed.
924 /// Note that you can be a bit lazier about writing out `ChannelManager` than you can be with
925 /// [`ChannelMonitor`]. With [`ChannelMonitor`] you MUST write each monitor update out to disk before
926 /// returning from [`chain::Watch::watch_channel`]/[`update_channel`], with ChannelManagers, writing updates
927 /// happens out-of-band (and will prevent any other `ChannelManager` operations from occurring during
928 /// the serialization process). If the deserialized version is out-of-date compared to the
929 /// [`ChannelMonitor`] passed by reference to [`read`], those channels will be force-closed based on the
930 /// `ChannelMonitor` state and no funds will be lost (mod on-chain transaction fees).
932 /// Note that the deserializer is only implemented for `(`[`BlockHash`]`, `[`ChannelManager`]`)`, which
933 /// tells you the last block hash which was connected. You should get the best block tip before using the manager.
934 /// See [`chain::Listen`] and [`chain::Confirm`] for more details.
936 /// Note that `ChannelManager` is responsible for tracking liveness of its channels and generating
937 /// [`ChannelUpdate`] messages informing peers that the channel is temporarily disabled. To avoid
938 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
939 /// offline for a full minute. In order to track this, you must call
940 /// [`timer_tick_occurred`] roughly once per minute, though it doesn't have to be perfect.
942 /// To avoid trivial DoS issues, `ChannelManager` limits the number of inbound connections and
943 /// inbound channels without confirmed funding transactions. This may result in nodes which we do
944 /// not have a channel with being unable to connect to us or open new channels with us if we have
945 /// many peers with unfunded channels.
947 /// Because it is an indication of trust, inbound channels which we've accepted as 0conf are
948 /// exempted from the count of unfunded channels. Similarly, outbound channels and connections are
949 /// never limited. Please ensure you limit the count of such channels yourself.
951 /// Rather than using a plain `ChannelManager`, it is preferable to use either a [`SimpleArcChannelManager`]
952 /// a [`SimpleRefChannelManager`], for conciseness. See their documentation for more details, but
953 /// essentially you should default to using a [`SimpleRefChannelManager`], and use a
954 /// [`SimpleArcChannelManager`] when you require a `ChannelManager` with a static lifetime, such as when
955 /// you're using lightning-net-tokio.
957 /// [`peer_disconnected`]: msgs::ChannelMessageHandler::peer_disconnected
958 /// [`funding_created`]: msgs::FundingCreated
959 /// [`funding_transaction_generated`]: Self::funding_transaction_generated
960 /// [`BlockHash`]: bitcoin::hash_types::BlockHash
961 /// [`update_channel`]: chain::Watch::update_channel
962 /// [`ChannelUpdate`]: msgs::ChannelUpdate
963 /// [`timer_tick_occurred`]: Self::timer_tick_occurred
964 /// [`read`]: ReadableArgs::read
967 // The tree structure below illustrates the lock order requirements for the different locks of the
968 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
969 // and should then be taken in the order of the lowest to the highest level in the tree.
970 // Note that locks on different branches shall not be taken at the same time, as doing so will
971 // create a new lock order for those specific locks in the order they were taken.
975 // `total_consistency_lock`
977 // |__`forward_htlcs`
979 // | |__`pending_intercepted_htlcs`
981 // |__`per_peer_state`
983 // | |__`pending_inbound_payments`
985 // | |__`claimable_payments`
987 // | |__`pending_outbound_payments` // This field's struct contains a map of pending outbounds
993 // | |__`short_to_chan_info`
995 // | |__`outbound_scid_aliases`
999 // | |__`pending_events`
1001 // | |__`pending_background_events`
1003 pub struct ChannelManager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
1005 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
1006 T::Target: BroadcasterInterface,
1007 ES::Target: EntropySource,
1008 NS::Target: NodeSigner,
1009 SP::Target: SignerProvider,
1010 F::Target: FeeEstimator,
1014 default_configuration: UserConfig,
1015 genesis_hash: BlockHash,
1016 fee_estimator: LowerBoundedFeeEstimator<F>,
1022 /// See `ChannelManager` struct-level documentation for lock order requirements.
1024 pub(super) best_block: RwLock<BestBlock>,
1026 best_block: RwLock<BestBlock>,
1027 secp_ctx: Secp256k1<secp256k1::All>,
1029 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
1030 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
1031 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
1032 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
1034 /// See `ChannelManager` struct-level documentation for lock order requirements.
1035 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
1037 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
1038 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
1039 /// (if the channel has been force-closed), however we track them here to prevent duplicative
1040 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
1041 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
1042 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
1043 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
1044 /// after reloading from disk while replaying blocks against ChannelMonitors.
1046 /// See `PendingOutboundPayment` documentation for more info.
1048 /// See `ChannelManager` struct-level documentation for lock order requirements.
1049 pending_outbound_payments: OutboundPayments,
1051 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
1053 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
1054 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
1055 /// and via the classic SCID.
1057 /// Note that no consistency guarantees are made about the existence of a channel with the
1058 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
1060 /// See `ChannelManager` struct-level documentation for lock order requirements.
1062 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1064 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
1065 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
1066 /// until the user tells us what we should do with them.
1068 /// See `ChannelManager` struct-level documentation for lock order requirements.
1069 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
1071 /// The sets of payments which are claimable or currently being claimed. See
1072 /// [`ClaimablePayments`]' individual field docs for more info.
1074 /// See `ChannelManager` struct-level documentation for lock order requirements.
1075 claimable_payments: Mutex<ClaimablePayments>,
1077 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
1078 /// and some closed channels which reached a usable state prior to being closed. This is used
1079 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
1080 /// active channel list on load.
1082 /// See `ChannelManager` struct-level documentation for lock order requirements.
1083 outbound_scid_aliases: Mutex<HashSet<u64>>,
1085 /// `channel_id` -> `counterparty_node_id`.
1087 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
1088 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
1089 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
1091 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
1092 /// the corresponding channel for the event, as we only have access to the `channel_id` during
1093 /// the handling of the events.
1095 /// Note that no consistency guarantees are made about the existence of a peer with the
1096 /// `counterparty_node_id` in our other maps.
1099 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
1100 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
1101 /// would break backwards compatability.
1102 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
1103 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
1104 /// required to access the channel with the `counterparty_node_id`.
1106 /// See `ChannelManager` struct-level documentation for lock order requirements.
1107 id_to_peer: Mutex<HashMap<ChannelId, PublicKey>>,
1109 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
1111 /// Outbound SCID aliases are added here once the channel is available for normal use, with
1112 /// SCIDs being added once the funding transaction is confirmed at the channel's required
1113 /// confirmation depth.
1115 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
1116 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
1117 /// channel with the `channel_id` in our other maps.
1119 /// See `ChannelManager` struct-level documentation for lock order requirements.
1121 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1123 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, ChannelId)>>,
1125 our_network_pubkey: PublicKey,
1127 inbound_payment_key: inbound_payment::ExpandedKey,
1129 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
1130 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
1131 /// we encrypt the namespace identifier using these bytes.
1133 /// [fake scids]: crate::util::scid_utils::fake_scid
1134 fake_scid_rand_bytes: [u8; 32],
1136 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
1137 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
1138 /// keeping additional state.
1139 probing_cookie_secret: [u8; 32],
1141 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
1142 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
1143 /// very far in the past, and can only ever be up to two hours in the future.
1144 highest_seen_timestamp: AtomicUsize,
1146 /// The bulk of our storage. Currently the `per_peer_state` stores our channels on a per-peer
1147 /// basis, as well as the peer's latest features.
1149 /// If we are connected to a peer we always at least have an entry here, even if no channels
1150 /// are currently open with that peer.
1152 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
1153 /// operate on the inner value freely. This opens up for parallel per-peer operation for
1156 /// Note that the same thread must never acquire two inner `PeerState` locks at the same time.
1158 /// See `ChannelManager` struct-level documentation for lock order requirements.
1159 #[cfg(not(any(test, feature = "_test_utils")))]
1160 per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1161 #[cfg(any(test, feature = "_test_utils"))]
1162 pub(super) per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<SP>>>>,
1164 /// The set of events which we need to give to the user to handle. In some cases an event may
1165 /// require some further action after the user handles it (currently only blocking a monitor
1166 /// update from being handed to the user to ensure the included changes to the channel state
1167 /// are handled by the user before they're persisted durably to disk). In that case, the second
1168 /// element in the tuple is set to `Some` with further details of the action.
1170 /// Note that events MUST NOT be removed from pending_events after deserialization, as they
1171 /// could be in the middle of being processed without the direct mutex held.
1173 /// See `ChannelManager` struct-level documentation for lock order requirements.
1174 #[cfg(not(any(test, feature = "_test_utils")))]
1175 pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1176 #[cfg(any(test, feature = "_test_utils"))]
1177 pub(crate) pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1179 /// A simple atomic flag to ensure only one task at a time can be processing events asynchronously.
1180 pending_events_processor: AtomicBool,
1182 /// If we are running during init (either directly during the deserialization method or in
1183 /// block connection methods which run after deserialization but before normal operation) we
1184 /// cannot provide the user with [`ChannelMonitorUpdate`]s through the normal update flow -
1185 /// prior to normal operation the user may not have loaded the [`ChannelMonitor`]s into their
1186 /// [`ChainMonitor`] and thus attempting to update it will fail or panic.
1188 /// Thus, we place them here to be handled as soon as possible once we are running normally.
1190 /// See `ChannelManager` struct-level documentation for lock order requirements.
1192 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
1193 pending_background_events: Mutex<Vec<BackgroundEvent>>,
1194 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
1195 /// Essentially just when we're serializing ourselves out.
1196 /// Taken first everywhere where we are making changes before any other locks.
1197 /// When acquiring this lock in read mode, rather than acquiring it directly, call
1198 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
1199 /// Notifier the lock contains sends out a notification when the lock is released.
1200 total_consistency_lock: RwLock<()>,
1202 background_events_processed_since_startup: AtomicBool,
1204 persistence_notifier: Notifier,
1208 signer_provider: SP,
1213 /// Chain-related parameters used to construct a new `ChannelManager`.
1215 /// Typically, the block-specific parameters are derived from the best block hash for the network,
1216 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
1217 /// are not needed when deserializing a previously constructed `ChannelManager`.
1218 #[derive(Clone, Copy, PartialEq)]
1219 pub struct ChainParameters {
1220 /// The network for determining the `chain_hash` in Lightning messages.
1221 pub network: Network,
1223 /// The hash and height of the latest block successfully connected.
1225 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
1226 pub best_block: BestBlock,
1229 #[derive(Copy, Clone, PartialEq)]
1236 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
1237 /// desirable to notify any listeners on `await_persistable_update_timeout`/
1238 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
1239 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
1240 /// sending the aforementioned notification (since the lock being released indicates that the
1241 /// updates are ready for persistence).
1243 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
1244 /// notify or not based on whether relevant changes have been made, providing a closure to
1245 /// `optionally_notify` which returns a `NotifyOption`.
1246 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
1247 persistence_notifier: &'a Notifier,
1249 // We hold onto this result so the lock doesn't get released immediately.
1250 _read_guard: RwLockReadGuard<'a, ()>,
1253 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
1254 fn notify_on_drop<C: AChannelManager>(cm: &'a C) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
1255 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1256 let _ = cm.get_cm().process_background_events(); // We always persist
1258 PersistenceNotifierGuard {
1259 persistence_notifier: &cm.get_cm().persistence_notifier,
1260 should_persist: || -> NotifyOption { NotifyOption::DoPersist },
1261 _read_guard: read_guard,
1266 /// Note that if any [`ChannelMonitorUpdate`]s are possibly generated,
1267 /// [`ChannelManager::process_background_events`] MUST be called first.
1268 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a Notifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
1269 let read_guard = lock.read().unwrap();
1271 PersistenceNotifierGuard {
1272 persistence_notifier: notifier,
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.persistence_notifier.notify();
1287 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
1288 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
1290 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
1292 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
1293 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
1294 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
1295 /// the maximum required amount in lnd as of March 2021.
1296 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
1298 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
1299 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
1301 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
1303 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
1304 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
1305 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
1306 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
1307 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
1308 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
1309 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
1310 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
1311 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
1312 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
1313 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
1314 // routing failure for any HTLC sender picking up an LDK node among the first hops.
1315 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
1317 /// Minimum CLTV difference between the current block height and received inbound payments.
1318 /// Invoices generated for payment to us must set their `min_final_cltv_expiry_delta` field to at least
1320 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
1321 // any payments to succeed. Further, we don't want payments to fail if a block was found while
1322 // a payment was being routed, so we add an extra block to be safe.
1323 pub const MIN_FINAL_CLTV_EXPIRY_DELTA: u16 = HTLC_FAIL_BACK_BUFFER as u16 + 3;
1325 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
1326 // ie that if the next-hop peer fails the HTLC within
1327 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
1328 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
1329 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
1330 // LATENCY_GRACE_PERIOD_BLOCKS.
1333 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;
1335 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
1336 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
1339 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
1341 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
1342 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
1344 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until we time-out the
1345 /// idempotency of payments by [`PaymentId`]. See
1346 /// [`OutboundPayments::remove_stale_resolved_payments`].
1347 pub(crate) const IDEMPOTENCY_TIMEOUT_TICKS: u8 = 7;
1349 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is disconnected
1350 /// until we mark the channel disabled and gossip the update.
1351 pub(crate) const DISABLE_GOSSIP_TICKS: u8 = 10;
1353 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is connected until
1354 /// we mark the channel enabled and gossip the update.
1355 pub(crate) const ENABLE_GOSSIP_TICKS: u8 = 5;
1357 /// The maximum number of unfunded channels we can have per-peer before we start rejecting new
1358 /// (inbound) ones. The number of peers with unfunded channels is limited separately in
1359 /// [`MAX_UNFUNDED_CHANNEL_PEERS`].
1360 const MAX_UNFUNDED_CHANS_PER_PEER: usize = 4;
1362 /// The maximum number of peers from which we will allow pending unfunded channels. Once we reach
1363 /// this many peers we reject new (inbound) channels from peers with which we don't have a channel.
1364 const MAX_UNFUNDED_CHANNEL_PEERS: usize = 50;
1366 /// The maximum number of peers which we do not have a (funded) channel with. Once we reach this
1367 /// many peers we reject new (inbound) connections.
1368 const MAX_NO_CHANNEL_PEERS: usize = 250;
1370 /// Information needed for constructing an invoice route hint for this channel.
1371 #[derive(Clone, Debug, PartialEq)]
1372 pub struct CounterpartyForwardingInfo {
1373 /// Base routing fee in millisatoshis.
1374 pub fee_base_msat: u32,
1375 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
1376 pub fee_proportional_millionths: u32,
1377 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
1378 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
1379 /// `cltv_expiry_delta` for more details.
1380 pub cltv_expiry_delta: u16,
1383 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
1384 /// to better separate parameters.
1385 #[derive(Clone, Debug, PartialEq)]
1386 pub struct ChannelCounterparty {
1387 /// The node_id of our counterparty
1388 pub node_id: PublicKey,
1389 /// The Features the channel counterparty provided upon last connection.
1390 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
1391 /// many routing-relevant features are present in the init context.
1392 pub features: InitFeatures,
1393 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
1394 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
1395 /// claiming at least this value on chain.
1397 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
1399 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
1400 pub unspendable_punishment_reserve: u64,
1401 /// Information on the fees and requirements that the counterparty requires when forwarding
1402 /// payments to us through this channel.
1403 pub forwarding_info: Option<CounterpartyForwardingInfo>,
1404 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
1405 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
1406 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
1407 pub outbound_htlc_minimum_msat: Option<u64>,
1408 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
1409 pub outbound_htlc_maximum_msat: Option<u64>,
1412 /// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
1414 /// Balances of a channel are available through [`ChainMonitor::get_claimable_balances`] and
1415 /// [`ChannelMonitor::get_claimable_balances`], calculated with respect to the corresponding on-chain
1418 /// [`ChainMonitor::get_claimable_balances`]: crate::chain::chainmonitor::ChainMonitor::get_claimable_balances
1419 #[derive(Clone, Debug, PartialEq)]
1420 pub struct ChannelDetails {
1421 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
1422 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
1423 /// Note that this means this value is *not* persistent - it can change once during the
1424 /// lifetime of the channel.
1425 pub channel_id: ChannelId,
1426 /// Parameters which apply to our counterparty. See individual fields for more information.
1427 pub counterparty: ChannelCounterparty,
1428 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
1429 /// our counterparty already.
1431 /// Note that, if this has been set, `channel_id` will be equivalent to
1432 /// `funding_txo.unwrap().to_channel_id()`.
1433 pub funding_txo: Option<OutPoint>,
1434 /// The features which this channel operates with. See individual features for more info.
1436 /// `None` until negotiation completes and the channel type is finalized.
1437 pub channel_type: Option<ChannelTypeFeatures>,
1438 /// The position of the funding transaction in the chain. None if the funding transaction has
1439 /// not yet been confirmed and the channel fully opened.
1441 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1442 /// payments instead of this. See [`get_inbound_payment_scid`].
1444 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1445 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1447 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1448 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1449 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1450 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1451 /// [`confirmations_required`]: Self::confirmations_required
1452 pub short_channel_id: Option<u64>,
1453 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1454 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1455 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1458 /// This will be `None` as long as the channel is not available for routing outbound payments.
1460 /// [`short_channel_id`]: Self::short_channel_id
1461 /// [`confirmations_required`]: Self::confirmations_required
1462 pub outbound_scid_alias: Option<u64>,
1463 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1464 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1465 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1466 /// when they see a payment to be routed to us.
1468 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1469 /// previous values for inbound payment forwarding.
1471 /// [`short_channel_id`]: Self::short_channel_id
1472 pub inbound_scid_alias: Option<u64>,
1473 /// The value, in satoshis, of this channel as appears in the funding output
1474 pub channel_value_satoshis: u64,
1475 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1476 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1477 /// this value on chain.
1479 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1481 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1483 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1484 pub unspendable_punishment_reserve: Option<u64>,
1485 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
1486 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
1487 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
1488 /// `user_channel_id` will be randomized for an inbound channel. This may be zero for objects
1489 /// serialized with LDK versions prior to 0.0.113.
1491 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
1492 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
1493 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
1494 pub user_channel_id: u128,
1495 /// The currently negotiated fee rate denominated in satoshi per 1000 weight units,
1496 /// which is applied to commitment and HTLC transactions.
1498 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
1499 pub feerate_sat_per_1000_weight: Option<u32>,
1500 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1501 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1502 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1503 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1505 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1506 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1507 /// should be able to spend nearly this amount.
1508 pub outbound_capacity_msat: u64,
1509 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1510 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1511 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1512 /// to use a limit as close as possible to the HTLC limit we can currently send.
1514 /// See also [`ChannelDetails::next_outbound_htlc_minimum_msat`] and
1515 /// [`ChannelDetails::outbound_capacity_msat`].
1516 pub next_outbound_htlc_limit_msat: u64,
1517 /// The minimum value for sending a single HTLC to the remote peer. This is the equivalent of
1518 /// [`ChannelDetails::next_outbound_htlc_limit_msat`] but represents a lower-bound, rather than
1519 /// an upper-bound. This is intended for use when routing, allowing us to ensure we pick a
1520 /// route which is valid.
1521 pub next_outbound_htlc_minimum_msat: u64,
1522 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1523 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1524 /// available for inclusion in new inbound HTLCs).
1525 /// Note that there are some corner cases not fully handled here, so the actual available
1526 /// inbound capacity may be slightly higher than this.
1528 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1529 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1530 /// However, our counterparty should be able to spend nearly this amount.
1531 pub inbound_capacity_msat: u64,
1532 /// The number of required confirmations on the funding transaction before the funding will be
1533 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1534 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1535 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1536 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1538 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1540 /// [`is_outbound`]: ChannelDetails::is_outbound
1541 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1542 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1543 pub confirmations_required: Option<u32>,
1544 /// The current number of confirmations on the funding transaction.
1546 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1547 pub confirmations: Option<u32>,
1548 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1549 /// until we can claim our funds after we force-close the channel. During this time our
1550 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1551 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1552 /// time to claim our non-HTLC-encumbered funds.
1554 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1555 pub force_close_spend_delay: Option<u16>,
1556 /// True if the channel was initiated (and thus funded) by us.
1557 pub is_outbound: bool,
1558 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1559 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1560 /// required confirmation count has been reached (and we were connected to the peer at some
1561 /// point after the funding transaction received enough confirmations). The required
1562 /// confirmation count is provided in [`confirmations_required`].
1564 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1565 pub is_channel_ready: bool,
1566 /// The stage of the channel's shutdown.
1567 /// `None` for `ChannelDetails` serialized on LDK versions prior to 0.0.116.
1568 pub channel_shutdown_state: Option<ChannelShutdownState>,
1569 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1570 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1572 /// This is a strict superset of `is_channel_ready`.
1573 pub is_usable: bool,
1574 /// True if this channel is (or will be) publicly-announced.
1575 pub is_public: bool,
1576 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1577 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1578 pub inbound_htlc_minimum_msat: Option<u64>,
1579 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1580 pub inbound_htlc_maximum_msat: Option<u64>,
1581 /// Set of configurable parameters that affect channel operation.
1583 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1584 pub config: Option<ChannelConfig>,
1587 impl ChannelDetails {
1588 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1589 /// This should be used for providing invoice hints or in any other context where our
1590 /// counterparty will forward a payment to us.
1592 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1593 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1594 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1595 self.inbound_scid_alias.or(self.short_channel_id)
1598 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1599 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1600 /// we're sending or forwarding a payment outbound over this channel.
1602 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1603 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1604 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1605 self.short_channel_id.or(self.outbound_scid_alias)
1608 fn from_channel_context<SP: Deref, F: Deref>(
1609 context: &ChannelContext<SP>, best_block_height: u32, latest_features: InitFeatures,
1610 fee_estimator: &LowerBoundedFeeEstimator<F>
1613 SP::Target: SignerProvider,
1614 F::Target: FeeEstimator
1616 let balance = context.get_available_balances(fee_estimator);
1617 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1618 context.get_holder_counterparty_selected_channel_reserve_satoshis();
1620 channel_id: context.channel_id(),
1621 counterparty: ChannelCounterparty {
1622 node_id: context.get_counterparty_node_id(),
1623 features: latest_features,
1624 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1625 forwarding_info: context.counterparty_forwarding_info(),
1626 // Ensures that we have actually received the `htlc_minimum_msat` value
1627 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1628 // message (as they are always the first message from the counterparty).
1629 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1630 // default `0` value set by `Channel::new_outbound`.
1631 outbound_htlc_minimum_msat: if context.have_received_message() {
1632 Some(context.get_counterparty_htlc_minimum_msat()) } else { None },
1633 outbound_htlc_maximum_msat: context.get_counterparty_htlc_maximum_msat(),
1635 funding_txo: context.get_funding_txo(),
1636 // Note that accept_channel (or open_channel) is always the first message, so
1637 // `have_received_message` indicates that type negotiation has completed.
1638 channel_type: if context.have_received_message() { Some(context.get_channel_type().clone()) } else { None },
1639 short_channel_id: context.get_short_channel_id(),
1640 outbound_scid_alias: if context.is_usable() { Some(context.outbound_scid_alias()) } else { None },
1641 inbound_scid_alias: context.latest_inbound_scid_alias(),
1642 channel_value_satoshis: context.get_value_satoshis(),
1643 feerate_sat_per_1000_weight: Some(context.get_feerate_sat_per_1000_weight()),
1644 unspendable_punishment_reserve: to_self_reserve_satoshis,
1645 inbound_capacity_msat: balance.inbound_capacity_msat,
1646 outbound_capacity_msat: balance.outbound_capacity_msat,
1647 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1648 next_outbound_htlc_minimum_msat: balance.next_outbound_htlc_minimum_msat,
1649 user_channel_id: context.get_user_id(),
1650 confirmations_required: context.minimum_depth(),
1651 confirmations: Some(context.get_funding_tx_confirmations(best_block_height)),
1652 force_close_spend_delay: context.get_counterparty_selected_contest_delay(),
1653 is_outbound: context.is_outbound(),
1654 is_channel_ready: context.is_usable(),
1655 is_usable: context.is_live(),
1656 is_public: context.should_announce(),
1657 inbound_htlc_minimum_msat: Some(context.get_holder_htlc_minimum_msat()),
1658 inbound_htlc_maximum_msat: context.get_holder_htlc_maximum_msat(),
1659 config: Some(context.config()),
1660 channel_shutdown_state: Some(context.shutdown_state()),
1665 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
1666 /// Further information on the details of the channel shutdown.
1667 /// Upon channels being forced closed (i.e. commitment transaction confirmation detected
1668 /// by `ChainMonitor`), ChannelShutdownState will be set to `ShutdownComplete` or
1669 /// the channel will be removed shortly.
1670 /// Also note, that in normal operation, peers could disconnect at any of these states
1671 /// and require peer re-connection before making progress onto other states
1672 pub enum ChannelShutdownState {
1673 /// Channel has not sent or received a shutdown message.
1675 /// Local node has sent a shutdown message for this channel.
1677 /// Shutdown message exchanges have concluded and the channels are in the midst of
1678 /// resolving all existing open HTLCs before closing can continue.
1680 /// All HTLCs have been resolved, nodes are currently negotiating channel close onchain fee rates.
1681 NegotiatingClosingFee,
1682 /// We've successfully negotiated a closing_signed dance. At this point `ChannelManager` is about
1683 /// to drop the channel.
1687 /// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
1688 /// These include payments that have yet to find a successful path, or have unresolved HTLCs.
1689 #[derive(Debug, PartialEq)]
1690 pub enum RecentPaymentDetails {
1691 /// When a payment is still being sent and awaiting successful delivery.
1693 /// Hash of the payment that is currently being sent but has yet to be fulfilled or
1695 payment_hash: PaymentHash,
1696 /// Total amount (in msat, excluding fees) across all paths for this payment,
1697 /// not just the amount currently inflight.
1700 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
1701 /// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
1702 /// payment is removed from tracking.
1704 /// Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
1705 /// made before LDK version 0.0.104.
1706 payment_hash: Option<PaymentHash>,
1708 /// After a payment's retries are exhausted per the provided [`Retry`], or it is explicitly
1709 /// abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
1710 /// pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
1712 /// Hash of the payment that we have given up trying to send.
1713 payment_hash: PaymentHash,
1717 /// Route hints used in constructing invoices for [phantom node payents].
1719 /// [phantom node payments]: crate::sign::PhantomKeysManager
1721 pub struct PhantomRouteHints {
1722 /// The list of channels to be included in the invoice route hints.
1723 pub channels: Vec<ChannelDetails>,
1724 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1726 pub phantom_scid: u64,
1727 /// The pubkey of the real backing node that would ultimately receive the payment.
1728 pub real_node_pubkey: PublicKey,
1731 macro_rules! handle_error {
1732 ($self: ident, $internal: expr, $counterparty_node_id: expr) => { {
1733 // In testing, ensure there are no deadlocks where the lock is already held upon
1734 // entering the macro.
1735 debug_assert_ne!($self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
1736 debug_assert_ne!($self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
1740 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish, channel_capacity }) => {
1741 let mut msg_events = Vec::with_capacity(2);
1743 if let Some((shutdown_res, update_option)) = shutdown_finish {
1744 $self.finish_force_close_channel(shutdown_res);
1745 if let Some(update) = update_option {
1746 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1750 if let Some((channel_id, user_channel_id)) = chan_id {
1751 $self.pending_events.lock().unwrap().push_back((events::Event::ChannelClosed {
1752 channel_id, user_channel_id,
1753 reason: ClosureReason::ProcessingError { err: err.err.clone() },
1754 counterparty_node_id: Some($counterparty_node_id),
1755 channel_capacity_sats: channel_capacity,
1760 log_error!($self.logger, "{}", err.err);
1761 if let msgs::ErrorAction::IgnoreError = err.action {
1763 msg_events.push(events::MessageSendEvent::HandleError {
1764 node_id: $counterparty_node_id,
1765 action: err.action.clone()
1769 if !msg_events.is_empty() {
1770 let per_peer_state = $self.per_peer_state.read().unwrap();
1771 if let Some(peer_state_mutex) = per_peer_state.get(&$counterparty_node_id) {
1772 let mut peer_state = peer_state_mutex.lock().unwrap();
1773 peer_state.pending_msg_events.append(&mut msg_events);
1777 // Return error in case higher-API need one
1782 ($self: ident, $internal: expr) => {
1785 Err((chan, msg_handle_err)) => {
1786 let counterparty_node_id = chan.get_counterparty_node_id();
1787 handle_error!($self, Err(msg_handle_err), counterparty_node_id).map_err(|err| (chan, err))
1793 macro_rules! update_maps_on_chan_removal {
1794 ($self: expr, $channel_context: expr) => {{
1795 $self.id_to_peer.lock().unwrap().remove(&$channel_context.channel_id());
1796 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1797 if let Some(short_id) = $channel_context.get_short_channel_id() {
1798 short_to_chan_info.remove(&short_id);
1800 // If the channel was never confirmed on-chain prior to its closure, remove the
1801 // outbound SCID alias we used for it from the collision-prevention set. While we
1802 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1803 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1804 // opening a million channels with us which are closed before we ever reach the funding
1806 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel_context.outbound_scid_alias());
1807 debug_assert!(alias_removed);
1809 short_to_chan_info.remove(&$channel_context.outbound_scid_alias());
1813 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1814 macro_rules! convert_chan_err {
1815 ($self: ident, $err: expr, $channel: expr, $channel_id: expr) => {
1817 ChannelError::Warn(msg) => {
1818 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), $channel_id.clone()))
1820 ChannelError::Ignore(msg) => {
1821 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
1823 ChannelError::Close(msg) => {
1824 log_error!($self.logger, "Closing channel {} due to close-required error: {}", &$channel_id, msg);
1825 update_maps_on_chan_removal!($self, &$channel.context);
1826 let shutdown_res = $channel.context.force_shutdown(true);
1827 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.context.get_user_id(),
1828 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok(), $channel.context.get_value_satoshis()))
1832 ($self: ident, $err: expr, $channel_context: expr, $channel_id: expr, UNFUNDED) => {
1834 // We should only ever have `ChannelError::Close` when unfunded channels error.
1835 // In any case, just close the channel.
1836 ChannelError::Warn(msg) | ChannelError::Ignore(msg) | ChannelError::Close(msg) => {
1837 log_error!($self.logger, "Closing unfunded channel {} due to an error: {}", &$channel_id, msg);
1838 update_maps_on_chan_removal!($self, &$channel_context);
1839 let shutdown_res = $channel_context.force_shutdown(false);
1840 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel_context.get_user_id(),
1841 shutdown_res, None, $channel_context.get_value_satoshis()))
1847 macro_rules! break_chan_entry {
1848 ($self: ident, $res: expr, $entry: expr) => {
1852 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1854 $entry.remove_entry();
1862 macro_rules! try_v1_outbound_chan_entry {
1863 ($self: ident, $res: expr, $entry: expr) => {
1867 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut().context, $entry.key(), UNFUNDED);
1869 $entry.remove_entry();
1877 macro_rules! try_chan_entry {
1878 ($self: ident, $res: expr, $entry: expr) => {
1882 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1884 $entry.remove_entry();
1892 macro_rules! remove_channel {
1893 ($self: expr, $entry: expr) => {
1895 let channel = $entry.remove_entry().1;
1896 update_maps_on_chan_removal!($self, &channel.context);
1902 macro_rules! send_channel_ready {
1903 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
1904 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1905 node_id: $channel.context.get_counterparty_node_id(),
1906 msg: $channel_ready_msg,
1908 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1909 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1910 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1911 let outbound_alias_insert = short_to_chan_info.insert($channel.context.outbound_scid_alias(), ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
1912 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
1913 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1914 if let Some(real_scid) = $channel.context.get_short_channel_id() {
1915 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
1916 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
1917 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1922 macro_rules! emit_channel_pending_event {
1923 ($locked_events: expr, $channel: expr) => {
1924 if $channel.context.should_emit_channel_pending_event() {
1925 $locked_events.push_back((events::Event::ChannelPending {
1926 channel_id: $channel.context.channel_id(),
1927 former_temporary_channel_id: $channel.context.temporary_channel_id(),
1928 counterparty_node_id: $channel.context.get_counterparty_node_id(),
1929 user_channel_id: $channel.context.get_user_id(),
1930 funding_txo: $channel.context.get_funding_txo().unwrap().into_bitcoin_outpoint(),
1932 $channel.context.set_channel_pending_event_emitted();
1937 macro_rules! emit_channel_ready_event {
1938 ($locked_events: expr, $channel: expr) => {
1939 if $channel.context.should_emit_channel_ready_event() {
1940 debug_assert!($channel.context.channel_pending_event_emitted());
1941 $locked_events.push_back((events::Event::ChannelReady {
1942 channel_id: $channel.context.channel_id(),
1943 user_channel_id: $channel.context.get_user_id(),
1944 counterparty_node_id: $channel.context.get_counterparty_node_id(),
1945 channel_type: $channel.context.get_channel_type().clone(),
1947 $channel.context.set_channel_ready_event_emitted();
1952 macro_rules! handle_monitor_update_completion {
1953 ($self: ident, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
1954 let mut updates = $chan.monitor_updating_restored(&$self.logger,
1955 &$self.node_signer, $self.genesis_hash, &$self.default_configuration,
1956 $self.best_block.read().unwrap().height());
1957 let counterparty_node_id = $chan.context.get_counterparty_node_id();
1958 let channel_update = if updates.channel_ready.is_some() && $chan.context.is_usable() {
1959 // We only send a channel_update in the case where we are just now sending a
1960 // channel_ready and the channel is in a usable state. We may re-send a
1961 // channel_update later through the announcement_signatures process for public
1962 // channels, but there's no reason not to just inform our counterparty of our fees
1964 if let Ok(msg) = $self.get_channel_update_for_unicast($chan) {
1965 Some(events::MessageSendEvent::SendChannelUpdate {
1966 node_id: counterparty_node_id,
1972 let update_actions = $peer_state.monitor_update_blocked_actions
1973 .remove(&$chan.context.channel_id()).unwrap_or(Vec::new());
1975 let htlc_forwards = $self.handle_channel_resumption(
1976 &mut $peer_state.pending_msg_events, $chan, updates.raa,
1977 updates.commitment_update, updates.order, updates.accepted_htlcs,
1978 updates.funding_broadcastable, updates.channel_ready,
1979 updates.announcement_sigs);
1980 if let Some(upd) = channel_update {
1981 $peer_state.pending_msg_events.push(upd);
1984 let channel_id = $chan.context.channel_id();
1985 core::mem::drop($peer_state_lock);
1986 core::mem::drop($per_peer_state_lock);
1988 $self.handle_monitor_update_completion_actions(update_actions);
1990 if let Some(forwards) = htlc_forwards {
1991 $self.forward_htlcs(&mut [forwards][..]);
1993 $self.finalize_claims(updates.finalized_claimed_htlcs);
1994 for failure in updates.failed_htlcs.drain(..) {
1995 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
1996 $self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
2001 macro_rules! handle_new_monitor_update {
2002 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr, _internal, $remove: expr, $completed: expr) => { {
2003 // update_maps_on_chan_removal needs to be able to take id_to_peer, so make sure we can in
2004 // any case so that it won't deadlock.
2005 debug_assert_ne!($self.id_to_peer.held_by_thread(), LockHeldState::HeldByThread);
2006 debug_assert!($self.background_events_processed_since_startup.load(Ordering::Acquire));
2008 ChannelMonitorUpdateStatus::InProgress => {
2009 log_debug!($self.logger, "ChannelMonitor update for {} in flight, holding messages until the update completes.",
2010 &$chan.context.channel_id());
2013 ChannelMonitorUpdateStatus::PermanentFailure => {
2014 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateStatus::PermanentFailure",
2015 &$chan.context.channel_id());
2016 update_maps_on_chan_removal!($self, &$chan.context);
2017 let res = Err(MsgHandleErrInternal::from_finish_shutdown(
2018 "ChannelMonitor storage failure".to_owned(), $chan.context.channel_id(),
2019 $chan.context.get_user_id(), $chan.context.force_shutdown(false),
2020 $self.get_channel_update_for_broadcast(&$chan).ok(), $chan.context.get_value_satoshis()));
2024 ChannelMonitorUpdateStatus::Completed => {
2030 ($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) => {
2031 handle_new_monitor_update!($self, $update_res, $peer_state_lock, $peer_state,
2032 $per_peer_state_lock, $chan, _internal, $remove,
2033 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan))
2035 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan_entry: expr, INITIAL_MONITOR) => {
2036 handle_new_monitor_update!($self, $update_res, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan_entry.get_mut(), MANUALLY_REMOVING_INITIAL_MONITOR, $chan_entry.remove_entry())
2038 ($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) => { {
2039 let in_flight_updates = $peer_state.in_flight_monitor_updates.entry($funding_txo)
2040 .or_insert_with(Vec::new);
2041 // During startup, we push monitor updates as background events through to here in
2042 // order to replay updates that were in-flight when we shut down. Thus, we have to
2043 // filter for uniqueness here.
2044 let idx = in_flight_updates.iter().position(|upd| upd == &$update)
2045 .unwrap_or_else(|| {
2046 in_flight_updates.push($update);
2047 in_flight_updates.len() - 1
2049 let update_res = $self.chain_monitor.update_channel($funding_txo, &in_flight_updates[idx]);
2050 handle_new_monitor_update!($self, update_res, $peer_state_lock, $peer_state,
2051 $per_peer_state_lock, $chan, _internal, $remove,
2053 let _ = in_flight_updates.remove(idx);
2054 if in_flight_updates.is_empty() && $chan.blocked_monitor_updates_pending() == 0 {
2055 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan);
2059 ($self: ident, $funding_txo: expr, $update: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan_entry: expr) => {
2060 handle_new_monitor_update!($self, $funding_txo, $update, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan_entry.get_mut(), MANUALLY_REMOVING, $chan_entry.remove_entry())
2064 macro_rules! process_events_body {
2065 ($self: expr, $event_to_handle: expr, $handle_event: expr) => {
2066 let mut processed_all_events = false;
2067 while !processed_all_events {
2068 if $self.pending_events_processor.compare_exchange(false, true, Ordering::Acquire, Ordering::Relaxed).is_err() {
2072 let mut result = NotifyOption::SkipPersist;
2075 // We'll acquire our total consistency lock so that we can be sure no other
2076 // persists happen while processing monitor events.
2077 let _read_guard = $self.total_consistency_lock.read().unwrap();
2079 // Because `handle_post_event_actions` may send `ChannelMonitorUpdate`s to the user we must
2080 // ensure any startup-generated background events are handled first.
2081 if $self.process_background_events() == NotifyOption::DoPersist { result = NotifyOption::DoPersist; }
2083 // TODO: This behavior should be documented. It's unintuitive that we query
2084 // ChannelMonitors when clearing other events.
2085 if $self.process_pending_monitor_events() {
2086 result = NotifyOption::DoPersist;
2090 let pending_events = $self.pending_events.lock().unwrap().clone();
2091 let num_events = pending_events.len();
2092 if !pending_events.is_empty() {
2093 result = NotifyOption::DoPersist;
2096 let mut post_event_actions = Vec::new();
2098 for (event, action_opt) in pending_events {
2099 $event_to_handle = event;
2101 if let Some(action) = action_opt {
2102 post_event_actions.push(action);
2107 let mut pending_events = $self.pending_events.lock().unwrap();
2108 pending_events.drain(..num_events);
2109 processed_all_events = pending_events.is_empty();
2110 // Note that `push_pending_forwards_ev` relies on `pending_events_processor` being
2111 // updated here with the `pending_events` lock acquired.
2112 $self.pending_events_processor.store(false, Ordering::Release);
2115 if !post_event_actions.is_empty() {
2116 $self.handle_post_event_actions(post_event_actions);
2117 // If we had some actions, go around again as we may have more events now
2118 processed_all_events = false;
2121 if result == NotifyOption::DoPersist {
2122 $self.persistence_notifier.notify();
2128 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>
2130 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
2131 T::Target: BroadcasterInterface,
2132 ES::Target: EntropySource,
2133 NS::Target: NodeSigner,
2134 SP::Target: SignerProvider,
2135 F::Target: FeeEstimator,
2139 /// Constructs a new `ChannelManager` to hold several channels and route between them.
2141 /// The current time or latest block header time can be provided as the `current_timestamp`.
2143 /// This is the main "logic hub" for all channel-related actions, and implements
2144 /// [`ChannelMessageHandler`].
2146 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
2148 /// Users need to notify the new `ChannelManager` when a new block is connected or
2149 /// disconnected using its [`block_connected`] and [`block_disconnected`] methods, starting
2150 /// from after [`params.best_block.block_hash`]. See [`chain::Listen`] and [`chain::Confirm`] for
2153 /// [`block_connected`]: chain::Listen::block_connected
2154 /// [`block_disconnected`]: chain::Listen::block_disconnected
2155 /// [`params.best_block.block_hash`]: chain::BestBlock::block_hash
2157 fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, entropy_source: ES,
2158 node_signer: NS, signer_provider: SP, config: UserConfig, params: ChainParameters,
2159 current_timestamp: u32,
2161 let mut secp_ctx = Secp256k1::new();
2162 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
2163 let inbound_pmt_key_material = node_signer.get_inbound_payment_key_material();
2164 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
2166 default_configuration: config.clone(),
2167 genesis_hash: genesis_block(params.network).header.block_hash(),
2168 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
2173 best_block: RwLock::new(params.best_block),
2175 outbound_scid_aliases: Mutex::new(HashSet::new()),
2176 pending_inbound_payments: Mutex::new(HashMap::new()),
2177 pending_outbound_payments: OutboundPayments::new(),
2178 forward_htlcs: Mutex::new(HashMap::new()),
2179 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments: HashMap::new(), pending_claiming_payments: HashMap::new() }),
2180 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
2181 id_to_peer: Mutex::new(HashMap::new()),
2182 short_to_chan_info: FairRwLock::new(HashMap::new()),
2184 our_network_pubkey: node_signer.get_node_id(Recipient::Node).unwrap(),
2187 inbound_payment_key: expanded_inbound_key,
2188 fake_scid_rand_bytes: entropy_source.get_secure_random_bytes(),
2190 probing_cookie_secret: entropy_source.get_secure_random_bytes(),
2192 highest_seen_timestamp: AtomicUsize::new(current_timestamp as usize),
2194 per_peer_state: FairRwLock::new(HashMap::new()),
2196 pending_events: Mutex::new(VecDeque::new()),
2197 pending_events_processor: AtomicBool::new(false),
2198 pending_background_events: Mutex::new(Vec::new()),
2199 total_consistency_lock: RwLock::new(()),
2200 background_events_processed_since_startup: AtomicBool::new(false),
2201 persistence_notifier: Notifier::new(),
2211 /// Gets the current configuration applied to all new channels.
2212 pub fn get_current_default_configuration(&self) -> &UserConfig {
2213 &self.default_configuration
2216 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
2217 let height = self.best_block.read().unwrap().height();
2218 let mut outbound_scid_alias = 0;
2221 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
2222 outbound_scid_alias += 1;
2224 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
2226 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
2230 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"); }
2235 /// Creates a new outbound channel to the given remote node and with the given value.
2237 /// `user_channel_id` will be provided back as in
2238 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
2239 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
2240 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
2241 /// is simply copied to events and otherwise ignored.
2243 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
2244 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
2246 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be opened due to failing to
2247 /// generate a shutdown scriptpubkey or destination script set by
2248 /// [`SignerProvider::get_shutdown_scriptpubkey`] or [`SignerProvider::get_destination_script`].
2250 /// Note that we do not check if you are currently connected to the given peer. If no
2251 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
2252 /// the channel eventually being silently forgotten (dropped on reload).
2254 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
2255 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
2256 /// [`ChannelDetails::channel_id`] until after
2257 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
2258 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
2259 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
2261 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
2262 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
2263 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
2264 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> {
2265 if channel_value_satoshis < 1000 {
2266 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
2269 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2270 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
2271 debug_assert!(&self.total_consistency_lock.try_write().is_err());
2273 let per_peer_state = self.per_peer_state.read().unwrap();
2275 let peer_state_mutex = per_peer_state.get(&their_network_key)
2276 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Not connected to node: {}", their_network_key) })?;
2278 let mut peer_state = peer_state_mutex.lock().unwrap();
2280 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
2281 let their_features = &peer_state.latest_features;
2282 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
2283 match OutboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider, their_network_key,
2284 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
2285 self.best_block.read().unwrap().height(), outbound_scid_alias)
2289 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
2294 let res = channel.get_open_channel(self.genesis_hash.clone());
2296 let temporary_channel_id = channel.context.channel_id();
2297 match peer_state.outbound_v1_channel_by_id.entry(temporary_channel_id) {
2298 hash_map::Entry::Occupied(_) => {
2300 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
2302 panic!("RNG is bad???");
2305 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
2308 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
2309 node_id: their_network_key,
2312 Ok(temporary_channel_id)
2315 fn list_funded_channels_with_filter<Fn: FnMut(&(&ChannelId, &Channel<SP>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
2316 // Allocate our best estimate of the number of channels we have in the `res`
2317 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2318 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2319 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2320 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2321 // the same channel.
2322 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2324 let best_block_height = self.best_block.read().unwrap().height();
2325 let per_peer_state = self.per_peer_state.read().unwrap();
2326 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2327 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2328 let peer_state = &mut *peer_state_lock;
2329 // Only `Channels` in the channel_by_id map can be considered funded.
2330 for (_channel_id, channel) in peer_state.channel_by_id.iter().filter(f) {
2331 let details = ChannelDetails::from_channel_context(&channel.context, best_block_height,
2332 peer_state.latest_features.clone(), &self.fee_estimator);
2340 /// Gets the list of open channels, in random order. See [`ChannelDetails`] field documentation for
2341 /// more information.
2342 pub fn list_channels(&self) -> Vec<ChannelDetails> {
2343 // Allocate our best estimate of the number of channels we have in the `res`
2344 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2345 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2346 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2347 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2348 // the same channel.
2349 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2351 let best_block_height = self.best_block.read().unwrap().height();
2352 let per_peer_state = self.per_peer_state.read().unwrap();
2353 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2354 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2355 let peer_state = &mut *peer_state_lock;
2356 for (_channel_id, channel) in peer_state.channel_by_id.iter() {
2357 let details = ChannelDetails::from_channel_context(&channel.context, best_block_height,
2358 peer_state.latest_features.clone(), &self.fee_estimator);
2361 for (_channel_id, channel) in peer_state.inbound_v1_channel_by_id.iter() {
2362 let details = ChannelDetails::from_channel_context(&channel.context, best_block_height,
2363 peer_state.latest_features.clone(), &self.fee_estimator);
2366 for (_channel_id, channel) in peer_state.outbound_v1_channel_by_id.iter() {
2367 let details = ChannelDetails::from_channel_context(&channel.context, best_block_height,
2368 peer_state.latest_features.clone(), &self.fee_estimator);
2376 /// Gets the list of usable channels, in random order. Useful as an argument to
2377 /// [`Router::find_route`] to ensure non-announced channels are used.
2379 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
2380 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
2382 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
2383 // Note we use is_live here instead of usable which leads to somewhat confused
2384 // internal/external nomenclature, but that's ok cause that's probably what the user
2385 // really wanted anyway.
2386 self.list_funded_channels_with_filter(|&(_, ref channel)| channel.context.is_live())
2389 /// Gets the list of channels we have with a given counterparty, in random order.
2390 pub fn list_channels_with_counterparty(&self, counterparty_node_id: &PublicKey) -> Vec<ChannelDetails> {
2391 let best_block_height = self.best_block.read().unwrap().height();
2392 let per_peer_state = self.per_peer_state.read().unwrap();
2394 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
2395 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2396 let peer_state = &mut *peer_state_lock;
2397 let features = &peer_state.latest_features;
2398 let chan_context_to_details = |context| {
2399 ChannelDetails::from_channel_context(context, best_block_height, features.clone(), &self.fee_estimator)
2401 return peer_state.channel_by_id
2403 .map(|(_, channel)| &channel.context)
2404 .chain(peer_state.outbound_v1_channel_by_id.iter().map(|(_, channel)| &channel.context))
2405 .chain(peer_state.inbound_v1_channel_by_id.iter().map(|(_, channel)| &channel.context))
2406 .map(chan_context_to_details)
2412 /// Returns in an undefined order recent payments that -- if not fulfilled -- have yet to find a
2413 /// successful path, or have unresolved HTLCs.
2415 /// This can be useful for payments that may have been prepared, but ultimately not sent, as a
2416 /// result of a crash. If such a payment exists, is not listed here, and an
2417 /// [`Event::PaymentSent`] has not been received, you may consider resending the payment.
2419 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2420 pub fn list_recent_payments(&self) -> Vec<RecentPaymentDetails> {
2421 self.pending_outbound_payments.pending_outbound_payments.lock().unwrap().iter()
2422 .filter_map(|(_, pending_outbound_payment)| match pending_outbound_payment {
2423 PendingOutboundPayment::Retryable { payment_hash, total_msat, .. } => {
2424 Some(RecentPaymentDetails::Pending {
2425 payment_hash: *payment_hash,
2426 total_msat: *total_msat,
2429 PendingOutboundPayment::Abandoned { payment_hash, .. } => {
2430 Some(RecentPaymentDetails::Abandoned { payment_hash: *payment_hash })
2432 PendingOutboundPayment::Fulfilled { payment_hash, .. } => {
2433 Some(RecentPaymentDetails::Fulfilled { payment_hash: *payment_hash })
2435 PendingOutboundPayment::Legacy { .. } => None
2440 /// Helper function that issues the channel close events
2441 fn issue_channel_close_events(&self, context: &ChannelContext<SP>, closure_reason: ClosureReason) {
2442 let mut pending_events_lock = self.pending_events.lock().unwrap();
2443 match context.unbroadcasted_funding() {
2444 Some(transaction) => {
2445 pending_events_lock.push_back((events::Event::DiscardFunding {
2446 channel_id: context.channel_id(), transaction
2451 pending_events_lock.push_back((events::Event::ChannelClosed {
2452 channel_id: context.channel_id(),
2453 user_channel_id: context.get_user_id(),
2454 reason: closure_reason,
2455 counterparty_node_id: Some(context.get_counterparty_node_id()),
2456 channel_capacity_sats: Some(context.get_value_satoshis()),
2460 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> {
2461 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2463 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
2464 let result: Result<(), _> = loop {
2466 let per_peer_state = self.per_peer_state.read().unwrap();
2468 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2469 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2471 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2472 let peer_state = &mut *peer_state_lock;
2474 match peer_state.channel_by_id.entry(channel_id.clone()) {
2475 hash_map::Entry::Occupied(mut chan_entry) => {
2476 let funding_txo_opt = chan_entry.get().context.get_funding_txo();
2477 let their_features = &peer_state.latest_features;
2478 let (shutdown_msg, mut monitor_update_opt, htlcs) = chan_entry.get_mut()
2479 .get_shutdown(&self.signer_provider, their_features, target_feerate_sats_per_1000_weight, override_shutdown_script)?;
2480 failed_htlcs = htlcs;
2482 // We can send the `shutdown` message before updating the `ChannelMonitor`
2483 // here as we don't need the monitor update to complete until we send a
2484 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
2485 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2486 node_id: *counterparty_node_id,
2490 // Update the monitor with the shutdown script if necessary.
2491 if let Some(monitor_update) = monitor_update_opt.take() {
2492 break handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
2493 peer_state_lock, peer_state, per_peer_state, chan_entry).map(|_| ());
2496 if chan_entry.get().is_shutdown() {
2497 let channel = remove_channel!(self, chan_entry);
2498 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
2499 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2503 self.issue_channel_close_events(&channel.context, ClosureReason::HolderForceClosed);
2507 hash_map::Entry::Vacant(_) => (),
2510 // If we reach this point, it means that the channel_id either refers to an unfunded channel or
2511 // it does not exist for this peer. Either way, we can attempt to force-close it.
2513 // An appropriate error will be returned for non-existence of the channel if that's the case.
2514 return self.force_close_channel_with_peer(&channel_id, counterparty_node_id, None, false).map(|_| ())
2515 // TODO(dunxen): This is still not ideal as we're doing some extra lookups.
2516 // Fix this with https://github.com/lightningdevkit/rust-lightning/issues/2422
2519 for htlc_source in failed_htlcs.drain(..) {
2520 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2521 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
2522 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
2525 let _ = handle_error!(self, result, *counterparty_node_id);
2529 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2530 /// will be accepted on the given channel, and after additional timeout/the closing of all
2531 /// pending HTLCs, the channel will be closed on chain.
2533 /// * If we are the channel initiator, we will pay between our [`Background`] and
2534 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
2536 /// * If our counterparty is the channel initiator, we will require a channel closing
2537 /// transaction feerate of at least our [`Background`] feerate or the feerate which
2538 /// would appear on a force-closure transaction, whichever is lower. We will allow our
2539 /// counterparty to pay as much fee as they'd like, however.
2541 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2543 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2544 /// generate a shutdown scriptpubkey or destination script set by
2545 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2548 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2549 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
2550 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
2551 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2552 pub fn close_channel(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey) -> Result<(), APIError> {
2553 self.close_channel_internal(channel_id, counterparty_node_id, None, None)
2556 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2557 /// will be accepted on the given channel, and after additional timeout/the closing of all
2558 /// pending HTLCs, the channel will be closed on chain.
2560 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
2561 /// the channel being closed or not:
2562 /// * If we are the channel initiator, we will pay at least this feerate on the closing
2563 /// transaction. The upper-bound is set by
2564 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
2565 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
2566 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
2567 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
2568 /// will appear on a force-closure transaction, whichever is lower).
2570 /// The `shutdown_script` provided will be used as the `scriptPubKey` for the closing transaction.
2571 /// Will fail if a shutdown script has already been set for this channel by
2572 /// ['ChannelHandshakeConfig::commit_upfront_shutdown_pubkey`]. The given shutdown script must
2573 /// also be compatible with our and the counterparty's features.
2575 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2577 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2578 /// generate a shutdown scriptpubkey or destination script set by
2579 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2582 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2583 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
2584 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
2585 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2586 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> {
2587 self.close_channel_internal(channel_id, counterparty_node_id, target_feerate_sats_per_1000_weight, shutdown_script)
2591 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
2592 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
2593 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
2594 for htlc_source in failed_htlcs.drain(..) {
2595 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
2596 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2597 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2598 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
2600 if let Some((_, funding_txo, monitor_update)) = monitor_update_option {
2601 // There isn't anything we can do if we get an update failure - we're already
2602 // force-closing. The monitor update on the required in-memory copy should broadcast
2603 // the latest local state, which is the best we can do anyway. Thus, it is safe to
2604 // ignore the result here.
2605 let _ = self.chain_monitor.update_channel(funding_txo, &monitor_update);
2609 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
2610 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
2611 fn force_close_channel_with_peer(&self, channel_id: &ChannelId, peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
2612 -> Result<PublicKey, APIError> {
2613 let per_peer_state = self.per_peer_state.read().unwrap();
2614 let peer_state_mutex = per_peer_state.get(peer_node_id)
2615 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", peer_node_id) })?;
2616 let (update_opt, counterparty_node_id) = {
2617 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2618 let peer_state = &mut *peer_state_lock;
2619 let closure_reason = if let Some(peer_msg) = peer_msg {
2620 ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(peer_msg.to_string()) }
2622 ClosureReason::HolderForceClosed
2624 if let hash_map::Entry::Occupied(chan) = peer_state.channel_by_id.entry(channel_id.clone()) {
2625 log_error!(self.logger, "Force-closing channel {}", &channel_id);
2626 self.issue_channel_close_events(&chan.get().context, closure_reason);
2627 let mut chan = remove_channel!(self, chan);
2628 self.finish_force_close_channel(chan.context.force_shutdown(broadcast));
2629 (self.get_channel_update_for_broadcast(&chan).ok(), chan.context.get_counterparty_node_id())
2630 } else if let hash_map::Entry::Occupied(chan) = peer_state.outbound_v1_channel_by_id.entry(channel_id.clone()) {
2631 log_error!(self.logger, "Force-closing channel {}", &channel_id);
2632 self.issue_channel_close_events(&chan.get().context, closure_reason);
2633 let mut chan = remove_channel!(self, chan);
2634 self.finish_force_close_channel(chan.context.force_shutdown(false));
2635 // Unfunded channel has no update
2636 (None, chan.context.get_counterparty_node_id())
2637 } else if let hash_map::Entry::Occupied(chan) = peer_state.inbound_v1_channel_by_id.entry(channel_id.clone()) {
2638 log_error!(self.logger, "Force-closing channel {}", &channel_id);
2639 self.issue_channel_close_events(&chan.get().context, closure_reason);
2640 let mut chan = remove_channel!(self, chan);
2641 self.finish_force_close_channel(chan.context.force_shutdown(false));
2642 // Unfunded channel has no update
2643 (None, chan.context.get_counterparty_node_id())
2644 } else if peer_state.inbound_channel_request_by_id.remove(channel_id).is_some() {
2645 log_error!(self.logger, "Force-closing channel {}", &channel_id);
2646 // N.B. that we don't send any channel close event here: we
2647 // don't have a user_channel_id, and we never sent any opening
2649 (None, *peer_node_id)
2651 return Err(APIError::ChannelUnavailable{ err: format!("Channel with id {} not found for the passed counterparty node_id {}", channel_id, peer_node_id) });
2654 if let Some(update) = update_opt {
2655 let mut peer_state = peer_state_mutex.lock().unwrap();
2656 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2661 Ok(counterparty_node_id)
2664 fn force_close_sending_error(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
2665 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2666 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
2667 Ok(counterparty_node_id) => {
2668 let per_peer_state = self.per_peer_state.read().unwrap();
2669 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2670 let mut peer_state = peer_state_mutex.lock().unwrap();
2671 peer_state.pending_msg_events.push(
2672 events::MessageSendEvent::HandleError {
2673 node_id: counterparty_node_id,
2674 action: msgs::ErrorAction::SendErrorMessage {
2675 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
2686 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
2687 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
2688 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
2690 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
2691 -> Result<(), APIError> {
2692 self.force_close_sending_error(channel_id, counterparty_node_id, true)
2695 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
2696 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
2697 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
2699 /// You can always get the latest local transaction(s) to broadcast from
2700 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
2701 pub fn force_close_without_broadcasting_txn(&self, channel_id: &ChannelId, counterparty_node_id: &PublicKey)
2702 -> Result<(), APIError> {
2703 self.force_close_sending_error(channel_id, counterparty_node_id, false)
2706 /// Force close all channels, immediately broadcasting the latest local commitment transaction
2707 /// for each to the chain and rejecting new HTLCs on each.
2708 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
2709 for chan in self.list_channels() {
2710 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
2714 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
2715 /// local transaction(s).
2716 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
2717 for chan in self.list_channels() {
2718 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
2722 fn construct_fwd_pending_htlc_info(
2723 &self, msg: &msgs::UpdateAddHTLC, hop_data: msgs::InboundOnionPayload, hop_hmac: [u8; 32],
2724 new_packet_bytes: [u8; onion_utils::ONION_DATA_LEN], shared_secret: [u8; 32],
2725 next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
2726 ) -> Result<PendingHTLCInfo, InboundOnionErr> {
2727 debug_assert!(next_packet_pubkey_opt.is_some());
2728 let outgoing_packet = msgs::OnionPacket {
2730 public_key: next_packet_pubkey_opt.unwrap_or(Err(secp256k1::Error::InvalidPublicKey)),
2731 hop_data: new_packet_bytes,
2735 let (short_channel_id, amt_to_forward, outgoing_cltv_value) = match hop_data {
2736 msgs::InboundOnionPayload::Forward { short_channel_id, amt_to_forward, outgoing_cltv_value } =>
2737 (short_channel_id, amt_to_forward, outgoing_cltv_value),
2738 msgs::InboundOnionPayload::Receive { .. } =>
2739 return Err(InboundOnionErr {
2740 msg: "Final Node OnionHopData provided for us as an intermediary node",
2741 err_code: 0x4000 | 22,
2742 err_data: Vec::new(),
2746 Ok(PendingHTLCInfo {
2747 routing: PendingHTLCRouting::Forward {
2748 onion_packet: outgoing_packet,
2751 payment_hash: msg.payment_hash,
2752 incoming_shared_secret: shared_secret,
2753 incoming_amt_msat: Some(msg.amount_msat),
2754 outgoing_amt_msat: amt_to_forward,
2755 outgoing_cltv_value,
2756 skimmed_fee_msat: None,
2760 fn construct_recv_pending_htlc_info(
2761 &self, hop_data: msgs::InboundOnionPayload, shared_secret: [u8; 32], payment_hash: PaymentHash,
2762 amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>, allow_underpay: bool,
2763 counterparty_skimmed_fee_msat: Option<u64>,
2764 ) -> Result<PendingHTLCInfo, InboundOnionErr> {
2765 let (payment_data, keysend_preimage, custom_tlvs, onion_amt_msat, outgoing_cltv_value, payment_metadata) = match hop_data {
2766 msgs::InboundOnionPayload::Receive {
2767 payment_data, keysend_preimage, custom_tlvs, amt_msat, outgoing_cltv_value, payment_metadata, ..
2769 (payment_data, keysend_preimage, custom_tlvs, amt_msat, outgoing_cltv_value, payment_metadata),
2771 return Err(InboundOnionErr {
2772 err_code: 0x4000|22,
2773 err_data: Vec::new(),
2774 msg: "Got non final data with an HMAC of 0",
2777 // final_incorrect_cltv_expiry
2778 if outgoing_cltv_value > cltv_expiry {
2779 return Err(InboundOnionErr {
2780 msg: "Upstream node set CLTV to less than the CLTV set by the sender",
2782 err_data: cltv_expiry.to_be_bytes().to_vec()
2785 // final_expiry_too_soon
2786 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
2787 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
2789 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
2790 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
2791 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
2792 let current_height: u32 = self.best_block.read().unwrap().height();
2793 if (outgoing_cltv_value as u64) <= current_height as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
2794 let mut err_data = Vec::with_capacity(12);
2795 err_data.extend_from_slice(&amt_msat.to_be_bytes());
2796 err_data.extend_from_slice(¤t_height.to_be_bytes());
2797 return Err(InboundOnionErr {
2798 err_code: 0x4000 | 15, err_data,
2799 msg: "The final CLTV expiry is too soon to handle",
2802 if (!allow_underpay && onion_amt_msat > amt_msat) ||
2803 (allow_underpay && onion_amt_msat >
2804 amt_msat.saturating_add(counterparty_skimmed_fee_msat.unwrap_or(0)))
2806 return Err(InboundOnionErr {
2808 err_data: amt_msat.to_be_bytes().to_vec(),
2809 msg: "Upstream node sent less than we were supposed to receive in payment",
2813 let routing = if let Some(payment_preimage) = keysend_preimage {
2814 // We need to check that the sender knows the keysend preimage before processing this
2815 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
2816 // could discover the final destination of X, by probing the adjacent nodes on the route
2817 // with a keysend payment of identical payment hash to X and observing the processing
2818 // time discrepancies due to a hash collision with X.
2819 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2820 if hashed_preimage != payment_hash {
2821 return Err(InboundOnionErr {
2822 err_code: 0x4000|22,
2823 err_data: Vec::new(),
2824 msg: "Payment preimage didn't match payment hash",
2827 if !self.default_configuration.accept_mpp_keysend && payment_data.is_some() {
2828 return Err(InboundOnionErr {
2829 err_code: 0x4000|22,
2830 err_data: Vec::new(),
2831 msg: "We don't support MPP keysend payments",
2834 PendingHTLCRouting::ReceiveKeysend {
2838 incoming_cltv_expiry: outgoing_cltv_value,
2841 } else if let Some(data) = payment_data {
2842 PendingHTLCRouting::Receive {
2845 incoming_cltv_expiry: outgoing_cltv_value,
2846 phantom_shared_secret,
2850 return Err(InboundOnionErr {
2851 err_code: 0x4000|0x2000|3,
2852 err_data: Vec::new(),
2853 msg: "We require payment_secrets",
2856 Ok(PendingHTLCInfo {
2859 incoming_shared_secret: shared_secret,
2860 incoming_amt_msat: Some(amt_msat),
2861 outgoing_amt_msat: onion_amt_msat,
2862 outgoing_cltv_value,
2863 skimmed_fee_msat: counterparty_skimmed_fee_msat,
2867 fn decode_update_add_htlc_onion(
2868 &self, msg: &msgs::UpdateAddHTLC
2869 ) -> Result<(onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg> {
2870 macro_rules! return_malformed_err {
2871 ($msg: expr, $err_code: expr) => {
2873 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2874 return Err(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
2875 channel_id: msg.channel_id,
2876 htlc_id: msg.htlc_id,
2877 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
2878 failure_code: $err_code,
2884 if let Err(_) = msg.onion_routing_packet.public_key {
2885 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2888 let shared_secret = self.node_signer.ecdh(
2889 Recipient::Node, &msg.onion_routing_packet.public_key.unwrap(), None
2890 ).unwrap().secret_bytes();
2892 if msg.onion_routing_packet.version != 0 {
2893 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2894 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2895 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2896 //receiving node would have to brute force to figure out which version was put in the
2897 //packet by the node that send us the message, in the case of hashing the hop_data, the
2898 //node knows the HMAC matched, so they already know what is there...
2899 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2901 macro_rules! return_err {
2902 ($msg: expr, $err_code: expr, $data: expr) => {
2904 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2905 return Err(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2906 channel_id: msg.channel_id,
2907 htlc_id: msg.htlc_id,
2908 reason: HTLCFailReason::reason($err_code, $data.to_vec())
2909 .get_encrypted_failure_packet(&shared_secret, &None),
2915 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) {
2917 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2918 return_malformed_err!(err_msg, err_code);
2920 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2921 return_err!(err_msg, err_code, &[0; 0]);
2924 let (outgoing_scid, outgoing_amt_msat, outgoing_cltv_value, next_packet_pk_opt) = match next_hop {
2925 onion_utils::Hop::Forward {
2926 next_hop_data: msgs::InboundOnionPayload::Forward {
2927 short_channel_id, amt_to_forward, outgoing_cltv_value
2930 let next_packet_pk = onion_utils::next_hop_pubkey(&self.secp_ctx,
2931 msg.onion_routing_packet.public_key.unwrap(), &shared_secret);
2932 (short_channel_id, amt_to_forward, outgoing_cltv_value, Some(next_packet_pk))
2934 // We'll do receive checks in [`Self::construct_pending_htlc_info`] so we have access to the
2935 // inbound channel's state.
2936 onion_utils::Hop::Receive { .. } => return Ok((next_hop, shared_secret, None)),
2937 onion_utils::Hop::Forward { next_hop_data: msgs::InboundOnionPayload::Receive { .. }, .. } => {
2938 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0; 0]);
2942 // Perform outbound checks here instead of in [`Self::construct_pending_htlc_info`] because we
2943 // can't hold the outbound peer state lock at the same time as the inbound peer state lock.
2944 if let Some((err, mut code, chan_update)) = loop {
2945 let id_option = self.short_to_chan_info.read().unwrap().get(&outgoing_scid).cloned();
2946 let forwarding_chan_info_opt = match id_option {
2947 None => { // unknown_next_peer
2948 // Note that this is likely a timing oracle for detecting whether an scid is a
2949 // phantom or an intercept.
2950 if (self.default_configuration.accept_intercept_htlcs &&
2951 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, outgoing_scid, &self.genesis_hash)) ||
2952 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, outgoing_scid, &self.genesis_hash)
2956 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2959 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
2961 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
2962 let per_peer_state = self.per_peer_state.read().unwrap();
2963 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
2964 if peer_state_mutex_opt.is_none() {
2965 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2967 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
2968 let peer_state = &mut *peer_state_lock;
2969 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id) {
2971 // Channel was removed. The short_to_chan_info and channel_by_id maps
2972 // have no consistency guarantees.
2973 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2977 if !chan.context.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
2978 // Note that the behavior here should be identical to the above block - we
2979 // should NOT reveal the existence or non-existence of a private channel if
2980 // we don't allow forwards outbound over them.
2981 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
2983 if chan.context.get_channel_type().supports_scid_privacy() && outgoing_scid != chan.context.outbound_scid_alias() {
2984 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
2985 // "refuse to forward unless the SCID alias was used", so we pretend
2986 // we don't have the channel here.
2987 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
2989 let chan_update_opt = self.get_channel_update_for_onion(outgoing_scid, chan).ok();
2991 // Note that we could technically not return an error yet here and just hope
2992 // that the connection is reestablished or monitor updated by the time we get
2993 // around to doing the actual forward, but better to fail early if we can and
2994 // hopefully an attacker trying to path-trace payments cannot make this occur
2995 // on a small/per-node/per-channel scale.
2996 if !chan.context.is_live() { // channel_disabled
2997 // If the channel_update we're going to return is disabled (i.e. the
2998 // peer has been disabled for some time), return `channel_disabled`,
2999 // otherwise return `temporary_channel_failure`.
3000 if chan_update_opt.as_ref().map(|u| u.contents.flags & 2 == 2).unwrap_or(false) {
3001 break Some(("Forwarding channel has been disconnected for some time.", 0x1000 | 20, chan_update_opt));
3003 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 7, chan_update_opt));
3006 if outgoing_amt_msat < chan.context.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
3007 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
3009 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, outgoing_amt_msat, outgoing_cltv_value) {
3010 break Some((err, code, chan_update_opt));
3014 if (msg.cltv_expiry as u64) < (outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 {
3015 // We really should set `incorrect_cltv_expiry` here but as we're not
3016 // forwarding over a real channel we can't generate a channel_update
3017 // for it. Instead we just return a generic temporary_node_failure.
3019 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
3026 let cur_height = self.best_block.read().unwrap().height() + 1;
3027 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
3028 // but we want to be robust wrt to counterparty packet sanitization (see
3029 // HTLC_FAIL_BACK_BUFFER rationale).
3030 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
3031 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
3033 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
3034 break Some(("CLTV expiry is too far in the future", 21, None));
3036 // If the HTLC expires ~now, don't bother trying to forward it to our
3037 // counterparty. They should fail it anyway, but we don't want to bother with
3038 // the round-trips or risk them deciding they definitely want the HTLC and
3039 // force-closing to ensure they get it if we're offline.
3040 // We previously had a much more aggressive check here which tried to ensure
3041 // our counterparty receives an HTLC which has *our* risk threshold met on it,
3042 // but there is no need to do that, and since we're a bit conservative with our
3043 // risk threshold it just results in failing to forward payments.
3044 if (outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
3045 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
3051 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
3052 if let Some(chan_update) = chan_update {
3053 if code == 0x1000 | 11 || code == 0x1000 | 12 {
3054 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
3056 else if code == 0x1000 | 13 {
3057 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
3059 else if code == 0x1000 | 20 {
3060 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
3061 0u16.write(&mut res).expect("Writes cannot fail");
3063 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
3064 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
3065 chan_update.write(&mut res).expect("Writes cannot fail");
3066 } else if code & 0x1000 == 0x1000 {
3067 // If we're trying to return an error that requires a `channel_update` but
3068 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
3069 // generate an update), just use the generic "temporary_node_failure"
3073 return_err!(err, code, &res.0[..]);
3075 Ok((next_hop, shared_secret, next_packet_pk_opt))
3078 fn construct_pending_htlc_status<'a>(
3079 &self, msg: &msgs::UpdateAddHTLC, shared_secret: [u8; 32], decoded_hop: onion_utils::Hop,
3080 allow_underpay: bool, next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
3081 ) -> PendingHTLCStatus {
3082 macro_rules! return_err {
3083 ($msg: expr, $err_code: expr, $data: expr) => {
3085 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3086 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
3087 channel_id: msg.channel_id,
3088 htlc_id: msg.htlc_id,
3089 reason: HTLCFailReason::reason($err_code, $data.to_vec())
3090 .get_encrypted_failure_packet(&shared_secret, &None),
3096 onion_utils::Hop::Receive(next_hop_data) => {
3098 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash,
3099 msg.amount_msat, msg.cltv_expiry, None, allow_underpay, msg.skimmed_fee_msat)
3102 // Note that we could obviously respond immediately with an update_fulfill_htlc
3103 // message, however that would leak that we are the recipient of this payment, so
3104 // instead we stay symmetric with the forwarding case, only responding (after a
3105 // delay) once they've send us a commitment_signed!
3106 PendingHTLCStatus::Forward(info)
3108 Err(InboundOnionErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3111 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
3112 match self.construct_fwd_pending_htlc_info(msg, next_hop_data, next_hop_hmac,
3113 new_packet_bytes, shared_secret, next_packet_pubkey_opt) {
3114 Ok(info) => PendingHTLCStatus::Forward(info),
3115 Err(InboundOnionErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
3121 /// Gets the current [`channel_update`] for the given channel. This first checks if the channel is
3122 /// public, and thus should be called whenever the result is going to be passed out in a
3123 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
3125 /// Note that in [`internal_closing_signed`], this function is called without the `peer_state`
3126 /// corresponding to the channel's counterparty locked, as the channel been removed from the
3127 /// storage and the `peer_state` lock has been dropped.
3129 /// [`channel_update`]: msgs::ChannelUpdate
3130 /// [`internal_closing_signed`]: Self::internal_closing_signed
3131 fn get_channel_update_for_broadcast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3132 if !chan.context.should_announce() {
3133 return Err(LightningError {
3134 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
3135 action: msgs::ErrorAction::IgnoreError
3138 if chan.context.get_short_channel_id().is_none() {
3139 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
3141 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", &chan.context.channel_id());
3142 self.get_channel_update_for_unicast(chan)
3145 /// Gets the current [`channel_update`] for the given channel. This does not check if the channel
3146 /// is public (only returning an `Err` if the channel does not yet have an assigned SCID),
3147 /// and thus MUST NOT be called unless the recipient of the resulting message has already
3148 /// provided evidence that they know about the existence of the channel.
3150 /// Note that through [`internal_closing_signed`], this function is called without the
3151 /// `peer_state` corresponding to the channel's counterparty locked, as the channel been
3152 /// removed from the 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_unicast(&self, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3157 log_trace!(self.logger, "Attempting to generate channel update for channel {}", &chan.context.channel_id());
3158 let short_channel_id = match chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias()) {
3159 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
3163 self.get_channel_update_for_onion(short_channel_id, chan)
3166 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<SP>) -> Result<msgs::ChannelUpdate, LightningError> {
3167 log_trace!(self.logger, "Generating channel update for channel {}", &chan.context.channel_id());
3168 let were_node_one = self.our_network_pubkey.serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
3170 let enabled = chan.context.is_usable() && match chan.channel_update_status() {
3171 ChannelUpdateStatus::Enabled => true,
3172 ChannelUpdateStatus::DisabledStaged(_) => true,
3173 ChannelUpdateStatus::Disabled => false,
3174 ChannelUpdateStatus::EnabledStaged(_) => false,
3177 let unsigned = msgs::UnsignedChannelUpdate {
3178 chain_hash: self.genesis_hash,
3180 timestamp: chan.context.get_update_time_counter(),
3181 flags: (!were_node_one) as u8 | ((!enabled as u8) << 1),
3182 cltv_expiry_delta: chan.context.get_cltv_expiry_delta(),
3183 htlc_minimum_msat: chan.context.get_counterparty_htlc_minimum_msat(),
3184 htlc_maximum_msat: chan.context.get_announced_htlc_max_msat(),
3185 fee_base_msat: chan.context.get_outbound_forwarding_fee_base_msat(),
3186 fee_proportional_millionths: chan.context.get_fee_proportional_millionths(),
3187 excess_data: Vec::new(),
3189 // Panic on failure to signal LDK should be restarted to retry signing the `ChannelUpdate`.
3190 // If we returned an error and the `node_signer` cannot provide a signature for whatever
3191 // reason`, we wouldn't be able to receive inbound payments through the corresponding
3193 let sig = self.node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelUpdate(&unsigned)).unwrap();
3195 Ok(msgs::ChannelUpdate {
3202 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> {
3203 let _lck = self.total_consistency_lock.read().unwrap();
3204 self.send_payment_along_path(SendAlongPathArgs {
3205 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3210 fn send_payment_along_path(&self, args: SendAlongPathArgs) -> Result<(), APIError> {
3211 let SendAlongPathArgs {
3212 path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage,
3215 // The top-level caller should hold the total_consistency_lock read lock.
3216 debug_assert!(self.total_consistency_lock.try_write().is_err());
3218 log_trace!(self.logger,
3219 "Attempting to send payment with payment hash {} along path with next hop {}",
3220 payment_hash, path.hops.first().unwrap().short_channel_id);
3221 let prng_seed = self.entropy_source.get_secure_random_bytes();
3222 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
3224 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
3225 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected".to_owned()})?;
3226 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, recipient_onion, cur_height, keysend_preimage)?;
3228 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash)
3229 .map_err(|_| APIError::InvalidRoute { err: "Route size too large considering onion data".to_owned()})?;
3231 let err: Result<(), _> = loop {
3232 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
3233 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
3234 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3237 let per_peer_state = self.per_peer_state.read().unwrap();
3238 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
3239 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
3240 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3241 let peer_state = &mut *peer_state_lock;
3242 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(id) {
3243 if !chan.get().context.is_live() {
3244 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected".to_owned()});
3246 let funding_txo = chan.get().context.get_funding_txo().unwrap();
3247 let send_res = chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(),
3248 htlc_cltv, HTLCSource::OutboundRoute {
3250 session_priv: session_priv.clone(),
3251 first_hop_htlc_msat: htlc_msat,
3253 }, onion_packet, None, &self.fee_estimator, &self.logger);
3254 match break_chan_entry!(self, send_res, chan) {
3255 Some(monitor_update) => {
3256 match handle_new_monitor_update!(self, funding_txo, monitor_update, peer_state_lock, peer_state, per_peer_state, chan) {
3257 Err(e) => break Err(e),
3259 // Note that MonitorUpdateInProgress here indicates (per function
3260 // docs) that we will resend the commitment update once monitor
3261 // updating completes. Therefore, we must return an error
3262 // indicating that it is unsafe to retry the payment wholesale,
3263 // which we do in the send_payment check for
3264 // MonitorUpdateInProgress, below.
3265 return Err(APIError::MonitorUpdateInProgress);
3273 // The channel was likely removed after we fetched the id from the
3274 // `short_to_chan_info` map, but before we successfully locked the
3275 // `channel_by_id` map.
3276 // This can occur as no consistency guarantees exists between the two maps.
3277 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
3282 match handle_error!(self, err, path.hops.first().unwrap().pubkey) {
3283 Ok(_) => unreachable!(),
3285 Err(APIError::ChannelUnavailable { err: e.err })
3290 /// Sends a payment along a given route.
3292 /// Value parameters are provided via the last hop in route, see documentation for [`RouteHop`]
3293 /// fields for more info.
3295 /// May generate [`UpdateHTLCs`] message(s) event on success, which should be relayed (e.g. via
3296 /// [`PeerManager::process_events`]).
3298 /// # Avoiding Duplicate Payments
3300 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
3301 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
3302 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
3303 /// [`Event::PaymentSent`] or [`Event::PaymentFailed`]) LDK will not stop you from sending a
3304 /// second payment with the same [`PaymentId`].
3306 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
3307 /// tracking of payments, including state to indicate once a payment has completed. Because you
3308 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
3309 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
3310 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
3312 /// Additionally, in the scenario where we begin the process of sending a payment, but crash
3313 /// before `send_payment` returns (or prior to [`ChannelMonitorUpdate`] persistence if you're
3314 /// using [`ChannelMonitorUpdateStatus::InProgress`]), the payment may be lost on restart. See
3315 /// [`ChannelManager::list_recent_payments`] for more information.
3317 /// # Possible Error States on [`PaymentSendFailure`]
3319 /// Each path may have a different return value, and [`PaymentSendFailure`] may return a `Vec` with
3320 /// each entry matching the corresponding-index entry in the route paths, see
3321 /// [`PaymentSendFailure`] for more info.
3323 /// In general, a path may raise:
3324 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
3325 /// node public key) is specified.
3326 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
3327 /// (including due to previous monitor update failure or new permanent monitor update
3329 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
3330 /// relevant updates.
3332 /// Note that depending on the type of the [`PaymentSendFailure`] the HTLC may have been
3333 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
3334 /// different route unless you intend to pay twice!
3336 /// [`RouteHop`]: crate::routing::router::RouteHop
3337 /// [`Event::PaymentSent`]: events::Event::PaymentSent
3338 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
3339 /// [`UpdateHTLCs`]: events::MessageSendEvent::UpdateHTLCs
3340 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
3341 /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
3342 pub fn send_payment_with_route(&self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
3343 let best_block_height = self.best_block.read().unwrap().height();
3344 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3345 self.pending_outbound_payments
3346 .send_payment_with_route(route, payment_hash, recipient_onion, payment_id,
3347 &self.entropy_source, &self.node_signer, best_block_height,
3348 |args| self.send_payment_along_path(args))
3351 /// Similar to [`ChannelManager::send_payment_with_route`], but will automatically find a route based on
3352 /// `route_params` and retry failed payment paths based on `retry_strategy`.
3353 pub fn send_payment(&self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<(), RetryableSendFailure> {
3354 let best_block_height = self.best_block.read().unwrap().height();
3355 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3356 self.pending_outbound_payments
3357 .send_payment(payment_hash, recipient_onion, payment_id, retry_strategy, route_params,
3358 &self.router, self.list_usable_channels(), || self.compute_inflight_htlcs(),
3359 &self.entropy_source, &self.node_signer, best_block_height, &self.logger,
3360 &self.pending_events, |args| self.send_payment_along_path(args))
3364 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> {
3365 let best_block_height = self.best_block.read().unwrap().height();
3366 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3367 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, recipient_onion,
3368 keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.node_signer,
3369 best_block_height, |args| self.send_payment_along_path(args))
3373 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> {
3374 let best_block_height = self.best_block.read().unwrap().height();
3375 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, recipient_onion, payment_id, route, None, &self.entropy_source, best_block_height)
3379 pub(crate) fn test_set_payment_metadata(&self, payment_id: PaymentId, new_payment_metadata: Option<Vec<u8>>) {
3380 self.pending_outbound_payments.test_set_payment_metadata(payment_id, new_payment_metadata);
3384 /// Signals that no further retries for the given payment should occur. Useful if you have a
3385 /// pending outbound payment with retries remaining, but wish to stop retrying the payment before
3386 /// retries are exhausted.
3388 /// If no [`Event::PaymentFailed`] event had been generated before, one will be generated as soon
3389 /// as there are no remaining pending HTLCs for this payment.
3391 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
3392 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
3393 /// determine the ultimate status of a payment.
3395 /// If an [`Event::PaymentFailed`] event is generated and we restart without this
3396 /// [`ChannelManager`] having been persisted, another [`Event::PaymentFailed`] may be generated.
3398 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
3399 /// [`Event::PaymentSent`]: events::Event::PaymentSent
3400 pub fn abandon_payment(&self, payment_id: PaymentId) {
3401 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3402 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
3405 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
3406 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
3407 /// the preimage, it must be a cryptographically secure random value that no intermediate node
3408 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
3409 /// never reach the recipient.
3411 /// See [`send_payment`] documentation for more details on the return value of this function
3412 /// and idempotency guarantees provided by the [`PaymentId`] key.
3414 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
3415 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
3417 /// [`send_payment`]: Self::send_payment
3418 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
3419 let best_block_height = self.best_block.read().unwrap().height();
3420 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3421 self.pending_outbound_payments.send_spontaneous_payment_with_route(
3422 route, payment_preimage, recipient_onion, payment_id, &self.entropy_source,
3423 &self.node_signer, best_block_height, |args| self.send_payment_along_path(args))
3426 /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
3427 /// based on `route_params` and retry failed payment paths based on `retry_strategy`.
3429 /// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous
3432 /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
3433 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> {
3434 let best_block_height = self.best_block.read().unwrap().height();
3435 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3436 self.pending_outbound_payments.send_spontaneous_payment(payment_preimage, recipient_onion,
3437 payment_id, retry_strategy, route_params, &self.router, self.list_usable_channels(),
3438 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
3439 &self.logger, &self.pending_events, |args| self.send_payment_along_path(args))
3442 /// Send a payment that is probing the given route for liquidity. We calculate the
3443 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
3444 /// us to easily discern them from real payments.
3445 pub fn send_probe(&self, path: Path) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
3446 let best_block_height = self.best_block.read().unwrap().height();
3447 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3448 self.pending_outbound_payments.send_probe(path, self.probing_cookie_secret,
3449 &self.entropy_source, &self.node_signer, best_block_height,
3450 |args| self.send_payment_along_path(args))
3453 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
3456 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
3457 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
3460 /// Handles the generation of a funding transaction, optionally (for tests) with a function
3461 /// which checks the correctness of the funding transaction given the associated channel.
3462 fn funding_transaction_generated_intern<FundingOutput: Fn(&OutboundV1Channel<SP>, &Transaction) -> Result<OutPoint, APIError>>(
3463 &self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
3464 ) -> Result<(), APIError> {
3465 let per_peer_state = self.per_peer_state.read().unwrap();
3466 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3467 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3469 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3470 let peer_state = &mut *peer_state_lock;
3471 let (chan, msg_opt) = match peer_state.outbound_v1_channel_by_id.remove(&temporary_channel_id) {
3473 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
3475 let funding_res = chan.get_funding_created(funding_transaction, funding_txo, &self.logger)
3476 .map_err(|(mut chan, e)| if let ChannelError::Close(msg) = e {
3477 let channel_id = chan.context.channel_id();
3478 let user_id = chan.context.get_user_id();
3479 let shutdown_res = chan.context.force_shutdown(false);
3480 let channel_capacity = chan.context.get_value_satoshis();
3481 (chan, MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, user_id, shutdown_res, None, channel_capacity))
3482 } else { unreachable!(); });
3484 Ok((chan, funding_msg)) => (chan, funding_msg),
3485 Err((chan, err)) => {
3486 mem::drop(peer_state_lock);
3487 mem::drop(per_peer_state);
3489 let _: Result<(), _> = handle_error!(self, Err(err), chan.context.get_counterparty_node_id());
3490 return Err(APIError::ChannelUnavailable {
3491 err: "Signer refused to sign the initial commitment transaction".to_owned()
3497 return Err(APIError::ChannelUnavailable {
3499 "Channel with id {} not found for the passed counterparty node_id {}",
3500 temporary_channel_id, counterparty_node_id),
3505 if let Some(msg) = msg_opt {
3506 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
3507 node_id: chan.context.get_counterparty_node_id(),
3511 match peer_state.channel_by_id.entry(chan.context.channel_id()) {
3512 hash_map::Entry::Occupied(_) => {
3513 panic!("Generated duplicate funding txid?");
3515 hash_map::Entry::Vacant(e) => {
3516 let mut id_to_peer = self.id_to_peer.lock().unwrap();
3517 if id_to_peer.insert(chan.context.channel_id(), chan.context.get_counterparty_node_id()).is_some() {
3518 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
3527 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
3528 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
3529 Ok(OutPoint { txid: tx.txid(), index: output_index })
3533 /// Call this upon creation of a funding transaction for the given channel.
3535 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
3536 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
3538 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
3539 /// across the p2p network.
3541 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
3542 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
3544 /// May panic if the output found in the funding transaction is duplicative with some other
3545 /// channel (note that this should be trivially prevented by using unique funding transaction
3546 /// keys per-channel).
3548 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
3549 /// counterparty's signature the funding transaction will automatically be broadcast via the
3550 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
3552 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
3553 /// not currently support replacing a funding transaction on an existing channel. Instead,
3554 /// create a new channel with a conflicting funding transaction.
3556 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
3557 /// the wallet software generating the funding transaction to apply anti-fee sniping as
3558 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
3559 /// for more details.
3561 /// [`Event::FundingGenerationReady`]: crate::events::Event::FundingGenerationReady
3562 /// [`Event::ChannelClosed`]: crate::events::Event::ChannelClosed
3563 pub fn funding_transaction_generated(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
3564 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3566 if !funding_transaction.is_coin_base() {
3567 for inp in funding_transaction.input.iter() {
3568 if inp.witness.is_empty() {
3569 return Err(APIError::APIMisuseError {
3570 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
3576 let height = self.best_block.read().unwrap().height();
3577 // Transactions are evaluated as final by network mempools if their locktime is strictly
3578 // lower than the next block height. However, the modules constituting our Lightning
3579 // node might not have perfect sync about their blockchain views. Thus, if the wallet
3580 // module is ahead of LDK, only allow one more block of headroom.
3581 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 {
3582 return Err(APIError::APIMisuseError {
3583 err: "Funding transaction absolute timelock is non-final".to_owned()
3587 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
3588 if tx.output.len() > u16::max_value() as usize {
3589 return Err(APIError::APIMisuseError {
3590 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
3594 let mut output_index = None;
3595 let expected_spk = chan.context.get_funding_redeemscript().to_v0_p2wsh();
3596 for (idx, outp) in tx.output.iter().enumerate() {
3597 if outp.script_pubkey == expected_spk && outp.value == chan.context.get_value_satoshis() {
3598 if output_index.is_some() {
3599 return Err(APIError::APIMisuseError {
3600 err: "Multiple outputs matched the expected script and value".to_owned()
3603 output_index = Some(idx as u16);
3606 if output_index.is_none() {
3607 return Err(APIError::APIMisuseError {
3608 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
3611 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
3615 /// Atomically applies partial updates to the [`ChannelConfig`] of the given channels.
3617 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3618 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3619 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3620 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3622 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3623 /// `counterparty_node_id` is provided.
3625 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3626 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3628 /// If an error is returned, none of the updates should be considered applied.
3630 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3631 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3632 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3633 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3634 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3635 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3636 /// [`APIMisuseError`]: APIError::APIMisuseError
3637 pub fn update_partial_channel_config(
3638 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config_update: &ChannelConfigUpdate,
3639 ) -> Result<(), APIError> {
3640 if config_update.cltv_expiry_delta.map(|delta| delta < MIN_CLTV_EXPIRY_DELTA).unwrap_or(false) {
3641 return Err(APIError::APIMisuseError {
3642 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
3646 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3647 let per_peer_state = self.per_peer_state.read().unwrap();
3648 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3649 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3650 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3651 let peer_state = &mut *peer_state_lock;
3652 for channel_id in channel_ids {
3653 if !peer_state.has_channel(channel_id) {
3654 return Err(APIError::ChannelUnavailable {
3655 err: format!("Channel with ID {} was not found for the passed counterparty_node_id {}", channel_id, counterparty_node_id),
3659 for channel_id in channel_ids {
3660 if let Some(channel) = peer_state.channel_by_id.get_mut(channel_id) {
3661 let mut config = channel.context.config();
3662 config.apply(config_update);
3663 if !channel.context.update_config(&config) {
3666 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
3667 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
3668 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
3669 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
3670 node_id: channel.context.get_counterparty_node_id(),
3677 let context = if let Some(channel) = peer_state.inbound_v1_channel_by_id.get_mut(channel_id) {
3678 &mut channel.context
3679 } else if let Some(channel) = peer_state.outbound_v1_channel_by_id.get_mut(channel_id) {
3680 &mut channel.context
3682 // This should not be reachable as we've already checked for non-existence in the previous channel_id loop.
3683 debug_assert!(false);
3684 return Err(APIError::ChannelUnavailable {
3686 "Channel with ID {} for passed counterparty_node_id {} disappeared after we confirmed its existence - this should not be reachable!",
3687 channel_id, counterparty_node_id),
3690 let mut config = context.config();
3691 config.apply(config_update);
3692 // We update the config, but we MUST NOT broadcast a `channel_update` before `channel_ready`
3693 // which would be the case for pending inbound/outbound channels.
3694 context.update_config(&config);
3699 /// Atomically updates the [`ChannelConfig`] for the given channels.
3701 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3702 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3703 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3704 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3706 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3707 /// `counterparty_node_id` is provided.
3709 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3710 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3712 /// If an error is returned, none of the updates should be considered applied.
3714 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3715 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3716 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3717 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3718 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3719 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3720 /// [`APIMisuseError`]: APIError::APIMisuseError
3721 pub fn update_channel_config(
3722 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config: &ChannelConfig,
3723 ) -> Result<(), APIError> {
3724 return self.update_partial_channel_config(counterparty_node_id, channel_ids, &(*config).into());
3727 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
3728 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
3730 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
3731 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
3733 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
3734 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
3735 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
3736 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
3737 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
3739 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
3740 /// you from forwarding more than you received. See
3741 /// [`HTLCIntercepted::expected_outbound_amount_msat`] for more on forwarding a different amount
3744 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
3747 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
3748 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
3749 /// [`HTLCIntercepted::expected_outbound_amount_msat`]: events::Event::HTLCIntercepted::expected_outbound_amount_msat
3750 // TODO: when we move to deciding the best outbound channel at forward time, only take
3751 // `next_node_id` and not `next_hop_channel_id`
3752 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> {
3753 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3755 let next_hop_scid = {
3756 let peer_state_lock = self.per_peer_state.read().unwrap();
3757 let peer_state_mutex = peer_state_lock.get(&next_node_id)
3758 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) })?;
3759 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3760 let peer_state = &mut *peer_state_lock;
3761 match peer_state.channel_by_id.get(&next_hop_channel_id) {
3763 if !chan.context.is_usable() {
3764 return Err(APIError::ChannelUnavailable {
3765 err: format!("Channel with id {} not fully established", next_hop_channel_id)
3768 chan.context.get_short_channel_id().unwrap_or(chan.context.outbound_scid_alias())
3770 None => return Err(APIError::ChannelUnavailable {
3771 err: format!("Funded channel with id {} not found for the passed counterparty node_id {}. Channel may still be opening.",
3772 next_hop_channel_id, next_node_id)
3777 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
3778 .ok_or_else(|| APIError::APIMisuseError {
3779 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
3782 let routing = match payment.forward_info.routing {
3783 PendingHTLCRouting::Forward { onion_packet, .. } => {
3784 PendingHTLCRouting::Forward { onion_packet, short_channel_id: next_hop_scid }
3786 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
3788 let skimmed_fee_msat =
3789 payment.forward_info.outgoing_amt_msat.saturating_sub(amt_to_forward_msat);
3790 let pending_htlc_info = PendingHTLCInfo {
3791 skimmed_fee_msat: if skimmed_fee_msat == 0 { None } else { Some(skimmed_fee_msat) },
3792 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
3795 let mut per_source_pending_forward = [(
3796 payment.prev_short_channel_id,
3797 payment.prev_funding_outpoint,
3798 payment.prev_user_channel_id,
3799 vec![(pending_htlc_info, payment.prev_htlc_id)]
3801 self.forward_htlcs(&mut per_source_pending_forward);
3805 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
3806 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
3808 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
3811 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
3812 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
3813 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
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 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
3821 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3822 short_channel_id: payment.prev_short_channel_id,
3823 user_channel_id: Some(payment.prev_user_channel_id),
3824 outpoint: payment.prev_funding_outpoint,
3825 htlc_id: payment.prev_htlc_id,
3826 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
3827 phantom_shared_secret: None,
3830 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
3831 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
3832 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
3833 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
3838 /// Processes HTLCs which are pending waiting on random forward delay.
3840 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
3841 /// Will likely generate further events.
3842 pub fn process_pending_htlc_forwards(&self) {
3843 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3845 let mut new_events = VecDeque::new();
3846 let mut failed_forwards = Vec::new();
3847 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
3849 let mut forward_htlcs = HashMap::new();
3850 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
3852 for (short_chan_id, mut pending_forwards) in forward_htlcs {
3853 if short_chan_id != 0 {
3854 macro_rules! forwarding_channel_not_found {
3856 for forward_info in pending_forwards.drain(..) {
3857 match forward_info {
3858 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3859 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3860 forward_info: PendingHTLCInfo {
3861 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
3862 outgoing_cltv_value, ..
3865 macro_rules! failure_handler {
3866 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
3867 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3869 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3870 short_channel_id: prev_short_channel_id,
3871 user_channel_id: Some(prev_user_channel_id),
3872 outpoint: prev_funding_outpoint,
3873 htlc_id: prev_htlc_id,
3874 incoming_packet_shared_secret: incoming_shared_secret,
3875 phantom_shared_secret: $phantom_ss,
3878 let reason = if $next_hop_unknown {
3879 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
3881 HTLCDestination::FailedPayment{ payment_hash }
3884 failed_forwards.push((htlc_source, payment_hash,
3885 HTLCFailReason::reason($err_code, $err_data),
3891 macro_rules! fail_forward {
3892 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3894 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
3898 macro_rules! failed_payment {
3899 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3901 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
3905 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
3906 let phantom_pubkey_res = self.node_signer.get_node_id(Recipient::PhantomNode);
3907 if phantom_pubkey_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.genesis_hash) {
3908 let phantom_shared_secret = self.node_signer.ecdh(Recipient::PhantomNode, &onion_packet.public_key.unwrap(), None).unwrap().secret_bytes();
3909 let next_hop = match onion_utils::decode_next_payment_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
3911 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
3912 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
3913 // In this scenario, the phantom would have sent us an
3914 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
3915 // if it came from us (the second-to-last hop) but contains the sha256
3917 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
3919 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3920 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
3924 onion_utils::Hop::Receive(hop_data) => {
3925 match self.construct_recv_pending_htlc_info(hop_data,
3926 incoming_shared_secret, payment_hash, outgoing_amt_msat,
3927 outgoing_cltv_value, Some(phantom_shared_secret), false, None)
3929 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
3930 Err(InboundOnionErr { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
3936 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3939 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3942 HTLCForwardInfo::FailHTLC { .. } => {
3943 // Channel went away before we could fail it. This implies
3944 // the channel is now on chain and our counterparty is
3945 // trying to broadcast the HTLC-Timeout, but that's their
3946 // problem, not ours.
3952 let (counterparty_node_id, forward_chan_id) = match self.short_to_chan_info.read().unwrap().get(&short_chan_id) {
3953 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3955 forwarding_channel_not_found!();
3959 let per_peer_state = self.per_peer_state.read().unwrap();
3960 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3961 if peer_state_mutex_opt.is_none() {
3962 forwarding_channel_not_found!();
3965 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
3966 let peer_state = &mut *peer_state_lock;
3967 match peer_state.channel_by_id.entry(forward_chan_id) {
3968 hash_map::Entry::Vacant(_) => {
3969 forwarding_channel_not_found!();
3972 hash_map::Entry::Occupied(mut chan) => {
3973 for forward_info in pending_forwards.drain(..) {
3974 match forward_info {
3975 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3976 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3977 forward_info: PendingHTLCInfo {
3978 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
3979 routing: PendingHTLCRouting::Forward { onion_packet, .. }, skimmed_fee_msat, ..
3982 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);
3983 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3984 short_channel_id: prev_short_channel_id,
3985 user_channel_id: Some(prev_user_channel_id),
3986 outpoint: prev_funding_outpoint,
3987 htlc_id: prev_htlc_id,
3988 incoming_packet_shared_secret: incoming_shared_secret,
3989 // Phantom payments are only PendingHTLCRouting::Receive.
3990 phantom_shared_secret: None,
3992 if let Err(e) = chan.get_mut().queue_add_htlc(outgoing_amt_msat,
3993 payment_hash, outgoing_cltv_value, htlc_source.clone(),
3994 onion_packet, skimmed_fee_msat, &self.fee_estimator,
3997 if let ChannelError::Ignore(msg) = e {
3998 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", &payment_hash, msg);
4000 panic!("Stated return value requirements in send_htlc() were not met");
4002 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan.get());
4003 failed_forwards.push((htlc_source, payment_hash,
4004 HTLCFailReason::reason(failure_code, data),
4005 HTLCDestination::NextHopChannel { node_id: Some(chan.get().context.get_counterparty_node_id()), channel_id: forward_chan_id }
4010 HTLCForwardInfo::AddHTLC { .. } => {
4011 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
4013 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
4014 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
4015 if let Err(e) = chan.get_mut().queue_fail_htlc(
4016 htlc_id, err_packet, &self.logger
4018 if let ChannelError::Ignore(msg) = e {
4019 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
4021 panic!("Stated return value requirements in queue_fail_htlc() were not met");
4023 // fail-backs are best-effort, we probably already have one
4024 // pending, and if not that's OK, if not, the channel is on
4025 // the chain and sending the HTLC-Timeout is their problem.
4034 'next_forwardable_htlc: for forward_info in pending_forwards.drain(..) {
4035 match forward_info {
4036 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4037 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4038 forward_info: PendingHTLCInfo {
4039 routing, incoming_shared_secret, payment_hash, incoming_amt_msat, outgoing_amt_msat,
4040 skimmed_fee_msat, ..
4043 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret, mut onion_fields) = match routing {
4044 PendingHTLCRouting::Receive { payment_data, payment_metadata, incoming_cltv_expiry, phantom_shared_secret, custom_tlvs } => {
4045 let _legacy_hop_data = Some(payment_data.clone());
4046 let onion_fields = RecipientOnionFields { payment_secret: Some(payment_data.payment_secret),
4047 payment_metadata, custom_tlvs };
4048 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data },
4049 Some(payment_data), phantom_shared_secret, onion_fields)
4051 PendingHTLCRouting::ReceiveKeysend { payment_data, payment_preimage, payment_metadata, incoming_cltv_expiry, custom_tlvs } => {
4052 let onion_fields = RecipientOnionFields {
4053 payment_secret: payment_data.as_ref().map(|data| data.payment_secret),
4057 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage),
4058 payment_data, None, onion_fields)
4061 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
4064 let claimable_htlc = ClaimableHTLC {
4065 prev_hop: HTLCPreviousHopData {
4066 short_channel_id: prev_short_channel_id,
4067 user_channel_id: Some(prev_user_channel_id),
4068 outpoint: prev_funding_outpoint,
4069 htlc_id: prev_htlc_id,
4070 incoming_packet_shared_secret: incoming_shared_secret,
4071 phantom_shared_secret,
4073 // We differentiate the received value from the sender intended value
4074 // if possible so that we don't prematurely mark MPP payments complete
4075 // if routing nodes overpay
4076 value: incoming_amt_msat.unwrap_or(outgoing_amt_msat),
4077 sender_intended_value: outgoing_amt_msat,
4079 total_value_received: None,
4080 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
4083 counterparty_skimmed_fee_msat: skimmed_fee_msat,
4086 let mut committed_to_claimable = false;
4088 macro_rules! fail_htlc {
4089 ($htlc: expr, $payment_hash: expr) => {
4090 debug_assert!(!committed_to_claimable);
4091 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
4092 htlc_msat_height_data.extend_from_slice(
4093 &self.best_block.read().unwrap().height().to_be_bytes(),
4095 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
4096 short_channel_id: $htlc.prev_hop.short_channel_id,
4097 user_channel_id: $htlc.prev_hop.user_channel_id,
4098 outpoint: prev_funding_outpoint,
4099 htlc_id: $htlc.prev_hop.htlc_id,
4100 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
4101 phantom_shared_secret,
4103 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
4104 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
4106 continue 'next_forwardable_htlc;
4109 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
4110 let mut receiver_node_id = self.our_network_pubkey;
4111 if phantom_shared_secret.is_some() {
4112 receiver_node_id = self.node_signer.get_node_id(Recipient::PhantomNode)
4113 .expect("Failed to get node_id for phantom node recipient");
4116 macro_rules! check_total_value {
4117 ($purpose: expr) => {{
4118 let mut payment_claimable_generated = false;
4119 let is_keysend = match $purpose {
4120 events::PaymentPurpose::SpontaneousPayment(_) => true,
4121 events::PaymentPurpose::InvoicePayment { .. } => false,
4123 let mut claimable_payments = self.claimable_payments.lock().unwrap();
4124 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
4125 fail_htlc!(claimable_htlc, payment_hash);
4127 let ref mut claimable_payment = claimable_payments.claimable_payments
4128 .entry(payment_hash)
4129 // Note that if we insert here we MUST NOT fail_htlc!()
4130 .or_insert_with(|| {
4131 committed_to_claimable = true;
4133 purpose: $purpose.clone(), htlcs: Vec::new(), onion_fields: None,
4136 if $purpose != claimable_payment.purpose {
4137 let log_keysend = |keysend| if keysend { "keysend" } else { "non-keysend" };
4138 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));
4139 fail_htlc!(claimable_htlc, payment_hash);
4141 if !self.default_configuration.accept_mpp_keysend && is_keysend && !claimable_payment.htlcs.is_empty() {
4142 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);
4143 fail_htlc!(claimable_htlc, payment_hash);
4145 if let Some(earlier_fields) = &mut claimable_payment.onion_fields {
4146 if earlier_fields.check_merge(&mut onion_fields).is_err() {
4147 fail_htlc!(claimable_htlc, payment_hash);
4150 claimable_payment.onion_fields = Some(onion_fields);
4152 let ref mut htlcs = &mut claimable_payment.htlcs;
4153 let mut total_value = claimable_htlc.sender_intended_value;
4154 let mut earliest_expiry = claimable_htlc.cltv_expiry;
4155 for htlc in htlcs.iter() {
4156 total_value += htlc.sender_intended_value;
4157 earliest_expiry = cmp::min(earliest_expiry, htlc.cltv_expiry);
4158 if htlc.total_msat != claimable_htlc.total_msat {
4159 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
4160 &payment_hash, claimable_htlc.total_msat, htlc.total_msat);
4161 total_value = msgs::MAX_VALUE_MSAT;
4163 if total_value >= msgs::MAX_VALUE_MSAT { break; }
4165 // The condition determining whether an MPP is complete must
4166 // match exactly the condition used in `timer_tick_occurred`
4167 if total_value >= msgs::MAX_VALUE_MSAT {
4168 fail_htlc!(claimable_htlc, payment_hash);
4169 } else if total_value - claimable_htlc.sender_intended_value >= claimable_htlc.total_msat {
4170 log_trace!(self.logger, "Failing HTLC with payment_hash {} as payment is already claimable",
4172 fail_htlc!(claimable_htlc, payment_hash);
4173 } else if total_value >= claimable_htlc.total_msat {
4174 #[allow(unused_assignments)] {
4175 committed_to_claimable = true;
4177 let prev_channel_id = prev_funding_outpoint.to_channel_id();
4178 htlcs.push(claimable_htlc);
4179 let amount_msat = htlcs.iter().map(|htlc| htlc.value).sum();
4180 htlcs.iter_mut().for_each(|htlc| htlc.total_value_received = Some(amount_msat));
4181 let counterparty_skimmed_fee_msat = htlcs.iter()
4182 .map(|htlc| htlc.counterparty_skimmed_fee_msat.unwrap_or(0)).sum();
4183 debug_assert!(total_value.saturating_sub(amount_msat) <=
4184 counterparty_skimmed_fee_msat);
4185 new_events.push_back((events::Event::PaymentClaimable {
4186 receiver_node_id: Some(receiver_node_id),
4190 counterparty_skimmed_fee_msat,
4191 via_channel_id: Some(prev_channel_id),
4192 via_user_channel_id: Some(prev_user_channel_id),
4193 claim_deadline: Some(earliest_expiry - HTLC_FAIL_BACK_BUFFER),
4194 onion_fields: claimable_payment.onion_fields.clone(),
4196 payment_claimable_generated = true;
4198 // Nothing to do - we haven't reached the total
4199 // payment value yet, wait until we receive more
4201 htlcs.push(claimable_htlc);
4202 #[allow(unused_assignments)] {
4203 committed_to_claimable = true;
4206 payment_claimable_generated
4210 // Check that the payment hash and secret are known. Note that we
4211 // MUST take care to handle the "unknown payment hash" and
4212 // "incorrect payment secret" cases here identically or we'd expose
4213 // that we are the ultimate recipient of the given payment hash.
4214 // Further, we must not expose whether we have any other HTLCs
4215 // associated with the same payment_hash pending or not.
4216 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4217 match payment_secrets.entry(payment_hash) {
4218 hash_map::Entry::Vacant(_) => {
4219 match claimable_htlc.onion_payload {
4220 OnionPayload::Invoice { .. } => {
4221 let payment_data = payment_data.unwrap();
4222 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) {
4223 Ok(result) => result,
4225 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as payment verification failed", &payment_hash);
4226 fail_htlc!(claimable_htlc, payment_hash);
4229 if let Some(min_final_cltv_expiry_delta) = min_final_cltv_expiry_delta {
4230 let expected_min_expiry_height = (self.current_best_block().height() + min_final_cltv_expiry_delta as u32) as u64;
4231 if (cltv_expiry as u64) < expected_min_expiry_height {
4232 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as its CLTV expiry was too soon (had {}, earliest expected {})",
4233 &payment_hash, cltv_expiry, expected_min_expiry_height);
4234 fail_htlc!(claimable_htlc, payment_hash);
4237 let purpose = events::PaymentPurpose::InvoicePayment {
4238 payment_preimage: payment_preimage.clone(),
4239 payment_secret: payment_data.payment_secret,
4241 check_total_value!(purpose);
4243 OnionPayload::Spontaneous(preimage) => {
4244 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
4245 check_total_value!(purpose);
4249 hash_map::Entry::Occupied(inbound_payment) => {
4250 if let OnionPayload::Spontaneous(_) = claimable_htlc.onion_payload {
4251 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);
4252 fail_htlc!(claimable_htlc, payment_hash);
4254 let payment_data = payment_data.unwrap();
4255 if inbound_payment.get().payment_secret != payment_data.payment_secret {
4256 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", &payment_hash);
4257 fail_htlc!(claimable_htlc, payment_hash);
4258 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
4259 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
4260 &payment_hash, payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
4261 fail_htlc!(claimable_htlc, payment_hash);
4263 let purpose = events::PaymentPurpose::InvoicePayment {
4264 payment_preimage: inbound_payment.get().payment_preimage,
4265 payment_secret: payment_data.payment_secret,
4267 let payment_claimable_generated = check_total_value!(purpose);
4268 if payment_claimable_generated {
4269 inbound_payment.remove_entry();
4275 HTLCForwardInfo::FailHTLC { .. } => {
4276 panic!("Got pending fail of our own HTLC");
4284 let best_block_height = self.best_block.read().unwrap().height();
4285 self.pending_outbound_payments.check_retry_payments(&self.router, || self.list_usable_channels(),
4286 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
4287 &self.pending_events, &self.logger, |args| self.send_payment_along_path(args));
4289 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
4290 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4292 self.forward_htlcs(&mut phantom_receives);
4294 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
4295 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
4296 // nice to do the work now if we can rather than while we're trying to get messages in the
4298 self.check_free_holding_cells();
4300 if new_events.is_empty() { return }
4301 let mut events = self.pending_events.lock().unwrap();
4302 events.append(&mut new_events);
4305 /// Free the background events, generally called from [`PersistenceNotifierGuard`] constructors.
4307 /// Expects the caller to have a total_consistency_lock read lock.
4308 fn process_background_events(&self) -> NotifyOption {
4309 debug_assert_ne!(self.total_consistency_lock.held_by_thread(), LockHeldState::NotHeldByThread);
4311 self.background_events_processed_since_startup.store(true, Ordering::Release);
4313 let mut background_events = Vec::new();
4314 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
4315 if background_events.is_empty() {
4316 return NotifyOption::SkipPersist;
4319 for event in background_events.drain(..) {
4321 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((funding_txo, update)) => {
4322 // The channel has already been closed, so no use bothering to care about the
4323 // monitor updating completing.
4324 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4326 BackgroundEvent::MonitorUpdateRegeneratedOnStartup { counterparty_node_id, funding_txo, update } => {
4327 let mut updated_chan = false;
4329 let per_peer_state = self.per_peer_state.read().unwrap();
4330 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4331 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4332 let peer_state = &mut *peer_state_lock;
4333 match peer_state.channel_by_id.entry(funding_txo.to_channel_id()) {
4334 hash_map::Entry::Occupied(mut chan) => {
4335 updated_chan = true;
4336 handle_new_monitor_update!(self, funding_txo, update.clone(),
4337 peer_state_lock, peer_state, per_peer_state, chan).map(|_| ())
4339 hash_map::Entry::Vacant(_) => Ok(()),
4344 // TODO: Track this as in-flight even though the channel is closed.
4345 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4347 // TODO: If this channel has since closed, we're likely providing a payment
4348 // preimage update, which we must ensure is durable! We currently don't,
4349 // however, ensure that.
4351 log_error!(self.logger,
4352 "Failed to provide ChannelMonitorUpdate to closed channel! This likely lost us a payment preimage!");
4354 let _ = handle_error!(self, res, counterparty_node_id);
4356 BackgroundEvent::MonitorUpdatesComplete { counterparty_node_id, channel_id } => {
4357 let per_peer_state = self.per_peer_state.read().unwrap();
4358 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4359 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4360 let peer_state = &mut *peer_state_lock;
4361 if let Some(chan) = peer_state.channel_by_id.get_mut(&channel_id) {
4362 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, chan);
4364 let update_actions = peer_state.monitor_update_blocked_actions
4365 .remove(&channel_id).unwrap_or(Vec::new());
4366 mem::drop(peer_state_lock);
4367 mem::drop(per_peer_state);
4368 self.handle_monitor_update_completion_actions(update_actions);
4374 NotifyOption::DoPersist
4377 #[cfg(any(test, feature = "_test_utils"))]
4378 /// Process background events, for functional testing
4379 pub fn test_process_background_events(&self) {
4380 let _lck = self.total_consistency_lock.read().unwrap();
4381 let _ = self.process_background_events();
4384 fn update_channel_fee(&self, chan_id: &ChannelId, chan: &mut Channel<SP>, new_feerate: u32) -> NotifyOption {
4385 if !chan.context.is_outbound() { return NotifyOption::SkipPersist; }
4386 // If the feerate has decreased by less than half, don't bother
4387 if new_feerate <= chan.context.get_feerate_sat_per_1000_weight() && new_feerate * 2 > chan.context.get_feerate_sat_per_1000_weight() {
4388 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
4389 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4390 return NotifyOption::SkipPersist;
4392 if !chan.context.is_live() {
4393 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).",
4394 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4395 return NotifyOption::SkipPersist;
4397 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
4398 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4400 chan.queue_update_fee(new_feerate, &self.fee_estimator, &self.logger);
4401 NotifyOption::DoPersist
4405 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
4406 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
4407 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
4408 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
4409 pub fn maybe_update_chan_fees(&self) {
4410 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4411 let mut should_persist = self.process_background_events();
4413 let normal_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4414 let min_mempool_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::MempoolMinimum);
4416 let per_peer_state = self.per_peer_state.read().unwrap();
4417 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
4418 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4419 let peer_state = &mut *peer_state_lock;
4420 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
4421 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4426 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4427 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4435 /// Performs actions which should happen on startup and roughly once per minute thereafter.
4437 /// This currently includes:
4438 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
4439 /// * Broadcasting [`ChannelUpdate`] messages if we've been disconnected from our peer for more
4440 /// than a minute, informing the network that they should no longer attempt to route over
4442 /// * Expiring a channel's previous [`ChannelConfig`] if necessary to only allow forwarding HTLCs
4443 /// with the current [`ChannelConfig`].
4444 /// * Removing peers which have disconnected but and no longer have any channels.
4445 /// * Force-closing and removing channels which have not completed establishment in a timely manner.
4447 /// Note that this may cause reentrancy through [`chain::Watch::update_channel`] calls or feerate
4448 /// estimate fetches.
4450 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4451 /// [`ChannelConfig`]: crate::util::config::ChannelConfig
4452 pub fn timer_tick_occurred(&self) {
4453 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4454 let mut should_persist = self.process_background_events();
4456 let normal_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4457 let min_mempool_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::MempoolMinimum);
4459 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
4460 let mut timed_out_mpp_htlcs = Vec::new();
4461 let mut pending_peers_awaiting_removal = Vec::new();
4463 let per_peer_state = self.per_peer_state.read().unwrap();
4464 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
4465 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4466 let peer_state = &mut *peer_state_lock;
4467 let pending_msg_events = &mut peer_state.pending_msg_events;
4468 let counterparty_node_id = *counterparty_node_id;
4469 peer_state.channel_by_id.retain(|chan_id, chan| {
4470 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4475 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4476 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4478 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
4479 let (needs_close, err) = convert_chan_err!(self, e, chan, chan_id);
4480 handle_errors.push((Err(err), counterparty_node_id));
4481 if needs_close { return false; }
4484 match chan.channel_update_status() {
4485 ChannelUpdateStatus::Enabled if !chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(0)),
4486 ChannelUpdateStatus::Disabled if chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(0)),
4487 ChannelUpdateStatus::DisabledStaged(_) if chan.context.is_live()
4488 => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
4489 ChannelUpdateStatus::EnabledStaged(_) if !chan.context.is_live()
4490 => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
4491 ChannelUpdateStatus::DisabledStaged(mut n) if !chan.context.is_live() => {
4493 if n >= DISABLE_GOSSIP_TICKS {
4494 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
4495 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4496 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4500 should_persist = NotifyOption::DoPersist;
4502 chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(n));
4505 ChannelUpdateStatus::EnabledStaged(mut n) if chan.context.is_live() => {
4507 if n >= ENABLE_GOSSIP_TICKS {
4508 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
4509 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4510 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4514 should_persist = NotifyOption::DoPersist;
4516 chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(n));
4522 chan.context.maybe_expire_prev_config();
4524 if chan.should_disconnect_peer_awaiting_response() {
4525 log_debug!(self.logger, "Disconnecting peer {} due to not making any progress on channel {}",
4526 counterparty_node_id, chan_id);
4527 pending_msg_events.push(MessageSendEvent::HandleError {
4528 node_id: counterparty_node_id,
4529 action: msgs::ErrorAction::DisconnectPeerWithWarning {
4530 msg: msgs::WarningMessage {
4531 channel_id: *chan_id,
4532 data: "Disconnecting due to timeout awaiting response".to_owned(),
4541 let process_unfunded_channel_tick = |
4542 chan_id: &ChannelId,
4543 chan_context: &mut ChannelContext<SP>,
4544 unfunded_chan_context: &mut UnfundedChannelContext,
4545 pending_msg_events: &mut Vec<MessageSendEvent>,
4547 chan_context.maybe_expire_prev_config();
4548 if unfunded_chan_context.should_expire_unfunded_channel() {
4549 log_error!(self.logger,
4550 "Force-closing pending channel with ID {} for not establishing in a timely manner",
4552 update_maps_on_chan_removal!(self, &chan_context);
4553 self.issue_channel_close_events(&chan_context, ClosureReason::HolderForceClosed);
4554 self.finish_force_close_channel(chan_context.force_shutdown(false));
4555 pending_msg_events.push(MessageSendEvent::HandleError {
4556 node_id: counterparty_node_id,
4557 action: msgs::ErrorAction::SendErrorMessage {
4558 msg: msgs::ErrorMessage {
4559 channel_id: *chan_id,
4560 data: "Force-closing pending channel due to timeout awaiting establishment handshake".to_owned(),
4569 peer_state.outbound_v1_channel_by_id.retain(|chan_id, chan| process_unfunded_channel_tick(
4570 chan_id, &mut chan.context, &mut chan.unfunded_context, pending_msg_events));
4571 peer_state.inbound_v1_channel_by_id.retain(|chan_id, chan| process_unfunded_channel_tick(
4572 chan_id, &mut chan.context, &mut chan.unfunded_context, pending_msg_events));
4574 for (chan_id, req) in peer_state.inbound_channel_request_by_id.iter_mut() {
4575 if { req.ticks_remaining -= 1 ; req.ticks_remaining } <= 0 {
4576 log_error!(self.logger, "Force-closing unaccepted inbound channel {} for not accepting in a timely manner", &chan_id);
4577 peer_state.pending_msg_events.push(
4578 events::MessageSendEvent::HandleError {
4579 node_id: counterparty_node_id,
4580 action: msgs::ErrorAction::SendErrorMessage {
4581 msg: msgs::ErrorMessage { channel_id: chan_id.clone(), data: "Channel force-closed".to_owned() }
4587 peer_state.inbound_channel_request_by_id.retain(|_, req| req.ticks_remaining > 0);
4589 if peer_state.ok_to_remove(true) {
4590 pending_peers_awaiting_removal.push(counterparty_node_id);
4595 // When a peer disconnects but still has channels, the peer's `peer_state` entry in the
4596 // `per_peer_state` is not removed by the `peer_disconnected` function. If the channels
4597 // of to that peer is later closed while still being disconnected (i.e. force closed),
4598 // we therefore need to remove the peer from `peer_state` separately.
4599 // To avoid having to take the `per_peer_state` `write` lock once the channels are
4600 // closed, we instead remove such peers awaiting removal here on a timer, to limit the
4601 // negative effects on parallelism as much as possible.
4602 if pending_peers_awaiting_removal.len() > 0 {
4603 let mut per_peer_state = self.per_peer_state.write().unwrap();
4604 for counterparty_node_id in pending_peers_awaiting_removal {
4605 match per_peer_state.entry(counterparty_node_id) {
4606 hash_map::Entry::Occupied(entry) => {
4607 // Remove the entry if the peer is still disconnected and we still
4608 // have no channels to the peer.
4609 let remove_entry = {
4610 let peer_state = entry.get().lock().unwrap();
4611 peer_state.ok_to_remove(true)
4614 entry.remove_entry();
4617 hash_map::Entry::Vacant(_) => { /* The PeerState has already been removed */ }
4622 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
4623 if payment.htlcs.is_empty() {
4624 // This should be unreachable
4625 debug_assert!(false);
4628 if let OnionPayload::Invoice { .. } = payment.htlcs[0].onion_payload {
4629 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
4630 // In this case we're not going to handle any timeouts of the parts here.
4631 // This condition determining whether the MPP is complete here must match
4632 // exactly the condition used in `process_pending_htlc_forwards`.
4633 if payment.htlcs[0].total_msat <= payment.htlcs.iter()
4634 .fold(0, |total, htlc| total + htlc.sender_intended_value)
4637 } else if payment.htlcs.iter_mut().any(|htlc| {
4638 htlc.timer_ticks += 1;
4639 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
4641 timed_out_mpp_htlcs.extend(payment.htlcs.drain(..)
4642 .map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
4649 for htlc_source in timed_out_mpp_htlcs.drain(..) {
4650 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
4651 let reason = HTLCFailReason::from_failure_code(23);
4652 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
4653 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
4656 for (err, counterparty_node_id) in handle_errors.drain(..) {
4657 let _ = handle_error!(self, err, counterparty_node_id);
4660 self.pending_outbound_payments.remove_stale_resolved_payments(&self.pending_events);
4662 // Technically we don't need to do this here, but if we have holding cell entries in a
4663 // channel that need freeing, it's better to do that here and block a background task
4664 // than block the message queueing pipeline.
4665 if self.check_free_holding_cells() {
4666 should_persist = NotifyOption::DoPersist;
4673 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
4674 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
4675 /// along the path (including in our own channel on which we received it).
4677 /// Note that in some cases around unclean shutdown, it is possible the payment may have
4678 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
4679 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
4680 /// may have already been failed automatically by LDK if it was nearing its expiration time.
4682 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
4683 /// [`ChannelManager::claim_funds`]), you should still monitor for
4684 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
4685 /// startup during which time claims that were in-progress at shutdown may be replayed.
4686 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
4687 self.fail_htlc_backwards_with_reason(payment_hash, FailureCode::IncorrectOrUnknownPaymentDetails);
4690 /// This is a variant of [`ChannelManager::fail_htlc_backwards`] that allows you to specify the
4691 /// reason for the failure.
4693 /// See [`FailureCode`] for valid failure codes.
4694 pub fn fail_htlc_backwards_with_reason(&self, payment_hash: &PaymentHash, failure_code: FailureCode) {
4695 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4697 let removed_source = self.claimable_payments.lock().unwrap().claimable_payments.remove(payment_hash);
4698 if let Some(payment) = removed_source {
4699 for htlc in payment.htlcs {
4700 let reason = self.get_htlc_fail_reason_from_failure_code(failure_code, &htlc);
4701 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
4702 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
4703 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
4708 /// Gets error data to form an [`HTLCFailReason`] given a [`FailureCode`] and [`ClaimableHTLC`].
4709 fn get_htlc_fail_reason_from_failure_code(&self, failure_code: FailureCode, htlc: &ClaimableHTLC) -> HTLCFailReason {
4710 match failure_code {
4711 FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(failure_code.into()),
4712 FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(failure_code.into()),
4713 FailureCode::IncorrectOrUnknownPaymentDetails => {
4714 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
4715 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
4716 HTLCFailReason::reason(failure_code.into(), htlc_msat_height_data)
4718 FailureCode::InvalidOnionPayload(data) => {
4719 let fail_data = match data {
4720 Some((typ, offset)) => [BigSize(typ).encode(), offset.encode()].concat(),
4723 HTLCFailReason::reason(failure_code.into(), fail_data)
4728 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
4729 /// that we want to return and a channel.
4731 /// This is for failures on the channel on which the HTLC was *received*, not failures
4733 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<SP>) -> (u16, Vec<u8>) {
4734 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
4735 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
4736 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
4737 // an inbound SCID alias before the real SCID.
4738 let scid_pref = if chan.context.should_announce() {
4739 chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias())
4741 chan.context.latest_inbound_scid_alias().or(chan.context.get_short_channel_id())
4743 if let Some(scid) = scid_pref {
4744 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
4746 (0x4000|10, Vec::new())
4751 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
4752 /// that we want to return and a channel.
4753 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<SP>) -> (u16, Vec<u8>) {
4754 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
4755 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
4756 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
4757 if desired_err_code == 0x1000 | 20 {
4758 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
4759 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
4760 0u16.write(&mut enc).expect("Writes cannot fail");
4762 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
4763 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
4764 upd.write(&mut enc).expect("Writes cannot fail");
4765 (desired_err_code, enc.0)
4767 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
4768 // which means we really shouldn't have gotten a payment to be forwarded over this
4769 // channel yet, or if we did it's from a route hint. Either way, returning an error of
4770 // PERM|no_such_channel should be fine.
4771 (0x4000|10, Vec::new())
4775 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
4776 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
4777 // be surfaced to the user.
4778 fn fail_holding_cell_htlcs(
4779 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: ChannelId,
4780 counterparty_node_id: &PublicKey
4782 let (failure_code, onion_failure_data) = {
4783 let per_peer_state = self.per_peer_state.read().unwrap();
4784 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4785 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4786 let peer_state = &mut *peer_state_lock;
4787 match peer_state.channel_by_id.entry(channel_id) {
4788 hash_map::Entry::Occupied(chan_entry) => {
4789 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan_entry.get())
4791 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
4793 } else { (0x4000|10, Vec::new()) }
4796 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
4797 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
4798 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
4799 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
4803 /// Fails an HTLC backwards to the sender of it to us.
4804 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
4805 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
4806 // Ensure that no peer state channel storage lock is held when calling this function.
4807 // This ensures that future code doesn't introduce a lock-order requirement for
4808 // `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
4809 // this function with any `per_peer_state` peer lock acquired would.
4810 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
4811 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
4814 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
4815 //identify whether we sent it or not based on the (I presume) very different runtime
4816 //between the branches here. We should make this async and move it into the forward HTLCs
4819 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4820 // from block_connected which may run during initialization prior to the chain_monitor
4821 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
4823 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, .. } => {
4824 if self.pending_outbound_payments.fail_htlc(source, payment_hash, onion_error, path,
4825 session_priv, payment_id, self.probing_cookie_secret, &self.secp_ctx,
4826 &self.pending_events, &self.logger)
4827 { self.push_pending_forwards_ev(); }
4829 HTLCSource::PreviousHopData(HTLCPreviousHopData { ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret, ref phantom_shared_secret, ref outpoint, .. }) => {
4830 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with {:?}", &payment_hash, onion_error);
4831 let err_packet = onion_error.get_encrypted_failure_packet(incoming_packet_shared_secret, phantom_shared_secret);
4833 let mut push_forward_ev = false;
4834 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
4835 if forward_htlcs.is_empty() {
4836 push_forward_ev = true;
4838 match forward_htlcs.entry(*short_channel_id) {
4839 hash_map::Entry::Occupied(mut entry) => {
4840 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet });
4842 hash_map::Entry::Vacant(entry) => {
4843 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }));
4846 mem::drop(forward_htlcs);
4847 if push_forward_ev { self.push_pending_forwards_ev(); }
4848 let mut pending_events = self.pending_events.lock().unwrap();
4849 pending_events.push_back((events::Event::HTLCHandlingFailed {
4850 prev_channel_id: outpoint.to_channel_id(),
4851 failed_next_destination: destination,
4857 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
4858 /// [`MessageSendEvent`]s needed to claim the payment.
4860 /// This method is guaranteed to ensure the payment has been claimed but only if the current
4861 /// height is strictly below [`Event::PaymentClaimable::claim_deadline`]. To avoid race
4862 /// conditions, you should wait for an [`Event::PaymentClaimed`] before considering the payment
4863 /// successful. It will generally be available in the next [`process_pending_events`] call.
4865 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
4866 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
4867 /// event matches your expectation. If you fail to do so and call this method, you may provide
4868 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
4870 /// This function will fail the payment if it has custom TLVs with even type numbers, as we
4871 /// will assume they are unknown. If you intend to accept even custom TLVs, you should use
4872 /// [`claim_funds_with_known_custom_tlvs`].
4874 /// [`Event::PaymentClaimable`]: crate::events::Event::PaymentClaimable
4875 /// [`Event::PaymentClaimable::claim_deadline`]: crate::events::Event::PaymentClaimable::claim_deadline
4876 /// [`Event::PaymentClaimed`]: crate::events::Event::PaymentClaimed
4877 /// [`process_pending_events`]: EventsProvider::process_pending_events
4878 /// [`create_inbound_payment`]: Self::create_inbound_payment
4879 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
4880 /// [`claim_funds_with_known_custom_tlvs`]: Self::claim_funds_with_known_custom_tlvs
4881 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
4882 self.claim_payment_internal(payment_preimage, false);
4885 /// This is a variant of [`claim_funds`] that allows accepting a payment with custom TLVs with
4886 /// even type numbers.
4890 /// You MUST check you've understood all even TLVs before using this to
4891 /// claim, otherwise you may unintentionally agree to some protocol you do not understand.
4893 /// [`claim_funds`]: Self::claim_funds
4894 pub fn claim_funds_with_known_custom_tlvs(&self, payment_preimage: PaymentPreimage) {
4895 self.claim_payment_internal(payment_preimage, true);
4898 fn claim_payment_internal(&self, payment_preimage: PaymentPreimage, custom_tlvs_known: bool) {
4899 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4901 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4904 let mut claimable_payments = self.claimable_payments.lock().unwrap();
4905 if let Some(payment) = claimable_payments.claimable_payments.remove(&payment_hash) {
4906 let mut receiver_node_id = self.our_network_pubkey;
4907 for htlc in payment.htlcs.iter() {
4908 if htlc.prev_hop.phantom_shared_secret.is_some() {
4909 let phantom_pubkey = self.node_signer.get_node_id(Recipient::PhantomNode)
4910 .expect("Failed to get node_id for phantom node recipient");
4911 receiver_node_id = phantom_pubkey;
4916 let htlcs = payment.htlcs.iter().map(events::ClaimedHTLC::from).collect();
4917 let sender_intended_value = payment.htlcs.first().map(|htlc| htlc.total_msat);
4918 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
4919 ClaimingPayment { amount_msat: payment.htlcs.iter().map(|source| source.value).sum(),
4920 payment_purpose: payment.purpose, receiver_node_id, htlcs, sender_intended_value
4922 if dup_purpose.is_some() {
4923 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
4924 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
4928 if let Some(RecipientOnionFields { ref custom_tlvs, .. }) = payment.onion_fields {
4929 if !custom_tlvs_known && custom_tlvs.iter().any(|(typ, _)| typ % 2 == 0) {
4930 log_info!(self.logger, "Rejecting payment with payment hash {} as we cannot accept payment with unknown even TLVs: {}",
4931 &payment_hash, log_iter!(custom_tlvs.iter().map(|(typ, _)| typ).filter(|typ| *typ % 2 == 0)));
4932 claimable_payments.pending_claiming_payments.remove(&payment_hash);
4933 mem::drop(claimable_payments);
4934 for htlc in payment.htlcs {
4935 let reason = self.get_htlc_fail_reason_from_failure_code(FailureCode::InvalidOnionPayload(None), &htlc);
4936 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
4937 let receiver = HTLCDestination::FailedPayment { payment_hash };
4938 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
4947 debug_assert!(!sources.is_empty());
4949 // Just in case one HTLC has been failed between when we generated the `PaymentClaimable`
4950 // and when we got here we need to check that the amount we're about to claim matches the
4951 // amount we told the user in the last `PaymentClaimable`. We also do a sanity-check that
4952 // the MPP parts all have the same `total_msat`.
4953 let mut claimable_amt_msat = 0;
4954 let mut prev_total_msat = None;
4955 let mut expected_amt_msat = None;
4956 let mut valid_mpp = true;
4957 let mut errs = Vec::new();
4958 let per_peer_state = self.per_peer_state.read().unwrap();
4959 for htlc in sources.iter() {
4960 if prev_total_msat.is_some() && prev_total_msat != Some(htlc.total_msat) {
4961 log_error!(self.logger, "Somehow ended up with an MPP payment with different expected total amounts - this should not be reachable!");
4962 debug_assert!(false);
4966 prev_total_msat = Some(htlc.total_msat);
4968 if expected_amt_msat.is_some() && expected_amt_msat != htlc.total_value_received {
4969 log_error!(self.logger, "Somehow ended up with an MPP payment with different received total amounts - this should not be reachable!");
4970 debug_assert!(false);
4974 expected_amt_msat = htlc.total_value_received;
4975 claimable_amt_msat += htlc.value;
4977 mem::drop(per_peer_state);
4978 if sources.is_empty() || expected_amt_msat.is_none() {
4979 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4980 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
4983 if claimable_amt_msat != expected_amt_msat.unwrap() {
4984 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4985 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
4986 expected_amt_msat.unwrap(), claimable_amt_msat);
4990 for htlc in sources.drain(..) {
4991 if let Err((pk, err)) = self.claim_funds_from_hop(
4992 htlc.prev_hop, payment_preimage,
4993 |_| Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash }))
4995 if let msgs::ErrorAction::IgnoreError = err.err.action {
4996 // We got a temporary failure updating monitor, but will claim the
4997 // HTLC when the monitor updating is restored (or on chain).
4998 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
4999 } else { errs.push((pk, err)); }
5004 for htlc in sources.drain(..) {
5005 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5006 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5007 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5008 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
5009 let receiver = HTLCDestination::FailedPayment { payment_hash };
5010 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5012 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5015 // Now we can handle any errors which were generated.
5016 for (counterparty_node_id, err) in errs.drain(..) {
5017 let res: Result<(), _> = Err(err);
5018 let _ = handle_error!(self, res, counterparty_node_id);
5022 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>) -> Option<MonitorUpdateCompletionAction>>(&self,
5023 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
5024 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
5025 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
5027 // If we haven't yet run background events assume we're still deserializing and shouldn't
5028 // actually pass `ChannelMonitorUpdate`s to users yet. Instead, queue them up as
5029 // `BackgroundEvent`s.
5030 let during_init = !self.background_events_processed_since_startup.load(Ordering::Acquire);
5033 let per_peer_state = self.per_peer_state.read().unwrap();
5034 let chan_id = prev_hop.outpoint.to_channel_id();
5035 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
5036 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
5040 let peer_state_opt = counterparty_node_id_opt.as_ref().map(
5041 |counterparty_node_id| per_peer_state.get(counterparty_node_id)
5042 .map(|peer_mutex| peer_mutex.lock().unwrap())
5045 if peer_state_opt.is_some() {
5046 let mut peer_state_lock = peer_state_opt.unwrap();
5047 let peer_state = &mut *peer_state_lock;
5048 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(chan_id) {
5049 let counterparty_node_id = chan.get().context.get_counterparty_node_id();
5050 let fulfill_res = chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger);
5052 if let UpdateFulfillCommitFetch::NewClaim { htlc_value_msat, monitor_update } = fulfill_res {
5053 if let Some(action) = completion_action(Some(htlc_value_msat)) {
5054 log_trace!(self.logger, "Tracking monitor update completion action for channel {}: {:?}",
5056 peer_state.monitor_update_blocked_actions.entry(chan_id).or_insert(Vec::new()).push(action);
5059 let res = handle_new_monitor_update!(self, prev_hop.outpoint, monitor_update, peer_state_lock,
5060 peer_state, per_peer_state, chan);
5061 if let Err(e) = res {
5062 // TODO: This is a *critical* error - we probably updated the outbound edge
5063 // of the HTLC's monitor with a preimage. We should retry this monitor
5064 // update over and over again until morale improves.
5065 log_error!(self.logger, "Failed to update channel monitor with preimage {:?}", payment_preimage);
5066 return Err((counterparty_node_id, e));
5069 // If we're running during init we cannot update a monitor directly -
5070 // they probably haven't actually been loaded yet. Instead, push the
5071 // monitor update as a background event.
5072 self.pending_background_events.lock().unwrap().push(
5073 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
5074 counterparty_node_id,
5075 funding_txo: prev_hop.outpoint,
5076 update: monitor_update.clone(),
5084 let preimage_update = ChannelMonitorUpdate {
5085 update_id: CLOSED_CHANNEL_UPDATE_ID,
5086 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
5092 // We update the ChannelMonitor on the backward link, after
5093 // receiving an `update_fulfill_htlc` from the forward link.
5094 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, &preimage_update);
5095 if update_res != ChannelMonitorUpdateStatus::Completed {
5096 // TODO: This needs to be handled somehow - if we receive a monitor update
5097 // with a preimage we *must* somehow manage to propagate it to the upstream
5098 // channel, or we must have an ability to receive the same event and try
5099 // again on restart.
5100 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
5101 payment_preimage, update_res);
5104 // If we're running during init we cannot update a monitor directly - they probably
5105 // haven't actually been loaded yet. Instead, push the monitor update as a background
5107 // Note that while it's safe to use `ClosedMonitorUpdateRegeneratedOnStartup` here (the
5108 // channel is already closed) we need to ultimately handle the monitor update
5109 // completion action only after we've completed the monitor update. This is the only
5110 // way to guarantee this update *will* be regenerated on startup (otherwise if this was
5111 // from a forwarded HTLC the downstream preimage may be deleted before we claim
5112 // upstream). Thus, we need to transition to some new `BackgroundEvent` type which will
5113 // complete the monitor update completion action from `completion_action`.
5114 self.pending_background_events.lock().unwrap().push(
5115 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((
5116 prev_hop.outpoint, preimage_update,
5119 // Note that we do process the completion action here. This totally could be a
5120 // duplicate claim, but we have no way of knowing without interrogating the
5121 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
5122 // generally always allowed to be duplicative (and it's specifically noted in
5123 // `PaymentForwarded`).
5124 self.handle_monitor_update_completion_actions(completion_action(None));
5128 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
5129 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
5132 fn claim_funds_internal(&self, source: HTLCSource, payment_preimage: PaymentPreimage, forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, next_channel_outpoint: OutPoint) {
5134 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
5135 debug_assert!(self.background_events_processed_since_startup.load(Ordering::Acquire),
5136 "We don't support claim_htlc claims during startup - monitors may not be available yet");
5137 let ev_completion_action = EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
5138 channel_funding_outpoint: next_channel_outpoint,
5139 counterparty_node_id: path.hops[0].pubkey,
5141 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage,
5142 session_priv, path, from_onchain, ev_completion_action, &self.pending_events,
5145 HTLCSource::PreviousHopData(hop_data) => {
5146 let prev_outpoint = hop_data.outpoint;
5147 let res = self.claim_funds_from_hop(hop_data, payment_preimage,
5148 |htlc_claim_value_msat| {
5149 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
5150 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
5151 Some(claimed_htlc_value - forwarded_htlc_value)
5154 Some(MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5155 event: events::Event::PaymentForwarded {
5157 claim_from_onchain_tx: from_onchain,
5158 prev_channel_id: Some(prev_outpoint.to_channel_id()),
5159 next_channel_id: Some(next_channel_outpoint.to_channel_id()),
5160 outbound_amount_forwarded_msat: forwarded_htlc_value_msat,
5162 downstream_counterparty_and_funding_outpoint: None,
5166 if let Err((pk, err)) = res {
5167 let result: Result<(), _> = Err(err);
5168 let _ = handle_error!(self, result, pk);
5174 /// Gets the node_id held by this ChannelManager
5175 pub fn get_our_node_id(&self) -> PublicKey {
5176 self.our_network_pubkey.clone()
5179 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
5180 for action in actions.into_iter() {
5182 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
5183 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5184 if let Some(ClaimingPayment {
5186 payment_purpose: purpose,
5189 sender_intended_value: sender_intended_total_msat,
5191 self.pending_events.lock().unwrap().push_back((events::Event::PaymentClaimed {
5195 receiver_node_id: Some(receiver_node_id),
5197 sender_intended_total_msat,
5201 MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5202 event, downstream_counterparty_and_funding_outpoint
5204 self.pending_events.lock().unwrap().push_back((event, None));
5205 if let Some((node_id, funding_outpoint, blocker)) = downstream_counterparty_and_funding_outpoint {
5206 self.handle_monitor_update_release(node_id, funding_outpoint, Some(blocker));
5213 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
5214 /// update completion.
5215 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
5216 channel: &mut Channel<SP>, raa: Option<msgs::RevokeAndACK>,
5217 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
5218 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
5219 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
5220 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
5221 log_trace!(self.logger, "Handling channel resumption for channel {} with {} RAA, {} commitment update, {} pending forwards, {}broadcasting funding, {} channel ready, {} announcement",
5222 &channel.context.channel_id(),
5223 if raa.is_some() { "an" } else { "no" },
5224 if commitment_update.is_some() { "a" } else { "no" }, pending_forwards.len(),
5225 if funding_broadcastable.is_some() { "" } else { "not " },
5226 if channel_ready.is_some() { "sending" } else { "without" },
5227 if announcement_sigs.is_some() { "sending" } else { "without" });
5229 let mut htlc_forwards = None;
5231 let counterparty_node_id = channel.context.get_counterparty_node_id();
5232 if !pending_forwards.is_empty() {
5233 htlc_forwards = Some((channel.context.get_short_channel_id().unwrap_or(channel.context.outbound_scid_alias()),
5234 channel.context.get_funding_txo().unwrap(), channel.context.get_user_id(), pending_forwards));
5237 if let Some(msg) = channel_ready {
5238 send_channel_ready!(self, pending_msg_events, channel, msg);
5240 if let Some(msg) = announcement_sigs {
5241 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5242 node_id: counterparty_node_id,
5247 macro_rules! handle_cs { () => {
5248 if let Some(update) = commitment_update {
5249 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5250 node_id: counterparty_node_id,
5255 macro_rules! handle_raa { () => {
5256 if let Some(revoke_and_ack) = raa {
5257 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
5258 node_id: counterparty_node_id,
5259 msg: revoke_and_ack,
5264 RAACommitmentOrder::CommitmentFirst => {
5268 RAACommitmentOrder::RevokeAndACKFirst => {
5274 if let Some(tx) = funding_broadcastable {
5275 log_info!(self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
5276 self.tx_broadcaster.broadcast_transactions(&[&tx]);
5280 let mut pending_events = self.pending_events.lock().unwrap();
5281 emit_channel_pending_event!(pending_events, channel);
5282 emit_channel_ready_event!(pending_events, channel);
5288 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
5289 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
5291 let counterparty_node_id = match counterparty_node_id {
5292 Some(cp_id) => cp_id.clone(),
5294 // TODO: Once we can rely on the counterparty_node_id from the
5295 // monitor event, this and the id_to_peer map should be removed.
5296 let id_to_peer = self.id_to_peer.lock().unwrap();
5297 match id_to_peer.get(&funding_txo.to_channel_id()) {
5298 Some(cp_id) => cp_id.clone(),
5303 let per_peer_state = self.per_peer_state.read().unwrap();
5304 let mut peer_state_lock;
5305 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
5306 if peer_state_mutex_opt.is_none() { return }
5307 peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5308 let peer_state = &mut *peer_state_lock;
5310 if let Some(chan) = peer_state.channel_by_id.get_mut(&funding_txo.to_channel_id()) {
5313 let update_actions = peer_state.monitor_update_blocked_actions
5314 .remove(&funding_txo.to_channel_id()).unwrap_or(Vec::new());
5315 mem::drop(peer_state_lock);
5316 mem::drop(per_peer_state);
5317 self.handle_monitor_update_completion_actions(update_actions);
5320 let remaining_in_flight =
5321 if let Some(pending) = peer_state.in_flight_monitor_updates.get_mut(funding_txo) {
5322 pending.retain(|upd| upd.update_id > highest_applied_update_id);
5325 log_trace!(self.logger, "ChannelMonitor updated to {}. Current highest is {}. {} pending in-flight updates.",
5326 highest_applied_update_id, channel.context.get_latest_monitor_update_id(),
5327 remaining_in_flight);
5328 if !channel.is_awaiting_monitor_update() || channel.context.get_latest_monitor_update_id() != highest_applied_update_id {
5331 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, channel);
5334 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
5336 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
5337 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
5340 /// The `user_channel_id` parameter will be provided back in
5341 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5342 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5344 /// Note that this method will return an error and reject the channel, if it requires support
5345 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
5346 /// used to accept such channels.
5348 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5349 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5350 pub fn accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5351 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
5354 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
5355 /// it as confirmed immediately.
5357 /// The `user_channel_id` parameter will be provided back in
5358 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5359 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5361 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
5362 /// and (if the counterparty agrees), enables forwarding of payments immediately.
5364 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
5365 /// transaction and blindly assumes that it will eventually confirm.
5367 /// If it does not confirm before we decide to close the channel, or if the funding transaction
5368 /// does not pay to the correct script the correct amount, *you will lose funds*.
5370 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5371 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5372 pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5373 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
5376 fn do_accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
5377 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5379 let peers_without_funded_channels =
5380 self.peers_without_funded_channels(|peer| { peer.total_channel_count() > 0 });
5381 let per_peer_state = self.per_peer_state.read().unwrap();
5382 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5383 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
5384 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5385 let peer_state = &mut *peer_state_lock;
5386 let is_only_peer_channel = peer_state.total_channel_count() == 1;
5388 // Find (and remove) the channel in the unaccepted table. If it's not there, something weird is
5389 // happening and return an error. N.B. that we create channel with an outbound SCID of zero so
5390 // that we can delay allocating the SCID until after we're sure that the checks below will
5392 let mut channel = match peer_state.inbound_channel_request_by_id.remove(temporary_channel_id) {
5393 Some(unaccepted_channel) => {
5394 let best_block_height = self.best_block.read().unwrap().height();
5395 InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
5396 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features,
5397 &unaccepted_channel.open_channel_msg, user_channel_id, &self.default_configuration, best_block_height,
5398 &self.logger, accept_0conf).map_err(|e| APIError::ChannelUnavailable { err: e.to_string() })
5400 _ => Err(APIError::APIMisuseError { err: "No such channel awaiting to be accepted.".to_owned() })
5404 // This should have been correctly configured by the call to InboundV1Channel::new.
5405 debug_assert!(channel.context.minimum_depth().unwrap() == 0);
5406 } else if channel.context.get_channel_type().requires_zero_conf() {
5407 let send_msg_err_event = events::MessageSendEvent::HandleError {
5408 node_id: channel.context.get_counterparty_node_id(),
5409 action: msgs::ErrorAction::SendErrorMessage{
5410 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
5413 peer_state.pending_msg_events.push(send_msg_err_event);
5414 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
5416 // If this peer already has some channels, a new channel won't increase our number of peers
5417 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
5418 // channels per-peer we can accept channels from a peer with existing ones.
5419 if is_only_peer_channel && peers_without_funded_channels >= MAX_UNFUNDED_CHANNEL_PEERS {
5420 let send_msg_err_event = events::MessageSendEvent::HandleError {
5421 node_id: channel.context.get_counterparty_node_id(),
5422 action: msgs::ErrorAction::SendErrorMessage{
5423 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "Have too many peers with unfunded channels, not accepting new ones".to_owned(), }
5426 peer_state.pending_msg_events.push(send_msg_err_event);
5427 return Err(APIError::APIMisuseError { err: "Too many peers with unfunded channels, refusing to accept new ones".to_owned() });
5431 // Now that we know we have a channel, assign an outbound SCID alias.
5432 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
5433 channel.context.set_outbound_scid_alias(outbound_scid_alias);
5435 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
5436 node_id: channel.context.get_counterparty_node_id(),
5437 msg: channel.accept_inbound_channel(),
5440 peer_state.inbound_v1_channel_by_id.insert(temporary_channel_id.clone(), channel);
5445 /// Gets the number of peers which match the given filter and do not have any funded, outbound,
5446 /// or 0-conf channels.
5448 /// The filter is called for each peer and provided with the number of unfunded, inbound, and
5449 /// non-0-conf channels we have with the peer.
5450 fn peers_without_funded_channels<Filter>(&self, maybe_count_peer: Filter) -> usize
5451 where Filter: Fn(&PeerState<SP>) -> bool {
5452 let mut peers_without_funded_channels = 0;
5453 let best_block_height = self.best_block.read().unwrap().height();
5455 let peer_state_lock = self.per_peer_state.read().unwrap();
5456 for (_, peer_mtx) in peer_state_lock.iter() {
5457 let peer = peer_mtx.lock().unwrap();
5458 if !maybe_count_peer(&*peer) { continue; }
5459 let num_unfunded_channels = Self::unfunded_channel_count(&peer, best_block_height);
5460 if num_unfunded_channels == peer.total_channel_count() {
5461 peers_without_funded_channels += 1;
5465 return peers_without_funded_channels;
5468 fn unfunded_channel_count(
5469 peer: &PeerState<SP>, best_block_height: u32
5471 let mut num_unfunded_channels = 0;
5472 for (_, chan) in peer.channel_by_id.iter() {
5473 // This covers non-zero-conf inbound `Channel`s that we are currently monitoring, but those
5474 // which have not yet had any confirmations on-chain.
5475 if !chan.context.is_outbound() && chan.context.minimum_depth().unwrap_or(1) != 0 &&
5476 chan.context.get_funding_tx_confirmations(best_block_height) == 0
5478 num_unfunded_channels += 1;
5481 for (_, chan) in peer.inbound_v1_channel_by_id.iter() {
5482 if chan.context.minimum_depth().unwrap_or(1) != 0 {
5483 num_unfunded_channels += 1;
5486 num_unfunded_channels + peer.inbound_channel_request_by_id.len()
5489 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
5490 if msg.chain_hash != self.genesis_hash {
5491 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
5494 if !self.default_configuration.accept_inbound_channels {
5495 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
5498 // Get the number of peers with channels, but without funded ones. We don't care too much
5499 // about peers that never open a channel, so we filter by peers that have at least one
5500 // channel, and then limit the number of those with unfunded channels.
5501 let channeled_peers_without_funding =
5502 self.peers_without_funded_channels(|node| node.total_channel_count() > 0);
5504 let per_peer_state = self.per_peer_state.read().unwrap();
5505 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5507 debug_assert!(false);
5508 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())
5510 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5511 let peer_state = &mut *peer_state_lock;
5513 // If this peer already has some channels, a new channel won't increase our number of peers
5514 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
5515 // channels per-peer we can accept channels from a peer with existing ones.
5516 if peer_state.total_channel_count() == 0 &&
5517 channeled_peers_without_funding >= MAX_UNFUNDED_CHANNEL_PEERS &&
5518 !self.default_configuration.manually_accept_inbound_channels
5520 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5521 "Have too many peers with unfunded channels, not accepting new ones".to_owned(),
5522 msg.temporary_channel_id.clone()));
5525 let best_block_height = self.best_block.read().unwrap().height();
5526 if Self::unfunded_channel_count(peer_state, best_block_height) >= MAX_UNFUNDED_CHANS_PER_PEER {
5527 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5528 format!("Refusing more than {} unfunded channels.", MAX_UNFUNDED_CHANS_PER_PEER),
5529 msg.temporary_channel_id.clone()));
5532 let channel_id = msg.temporary_channel_id;
5533 let channel_exists = peer_state.has_channel(&channel_id);
5535 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision for the same peer!".to_owned(), msg.temporary_channel_id.clone()));
5538 // If we're doing manual acceptance checks on the channel, then defer creation until we're sure we want to accept.
5539 if self.default_configuration.manually_accept_inbound_channels {
5540 let mut pending_events = self.pending_events.lock().unwrap();
5541 pending_events.push_back((events::Event::OpenChannelRequest {
5542 temporary_channel_id: msg.temporary_channel_id.clone(),
5543 counterparty_node_id: counterparty_node_id.clone(),
5544 funding_satoshis: msg.funding_satoshis,
5545 push_msat: msg.push_msat,
5546 channel_type: msg.channel_type.clone().unwrap(),
5548 peer_state.inbound_channel_request_by_id.insert(channel_id, InboundChannelRequest {
5549 open_channel_msg: msg.clone(),
5550 ticks_remaining: UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS,
5555 // Otherwise create the channel right now.
5556 let mut random_bytes = [0u8; 16];
5557 random_bytes.copy_from_slice(&self.entropy_source.get_secure_random_bytes()[..16]);
5558 let user_channel_id = u128::from_be_bytes(random_bytes);
5559 let mut channel = match InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
5560 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id,
5561 &self.default_configuration, best_block_height, &self.logger, /*is_0conf=*/false)
5564 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
5569 let channel_type = channel.context.get_channel_type();
5570 if channel_type.requires_zero_conf() {
5571 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
5573 if channel_type.requires_anchors_zero_fee_htlc_tx() {
5574 return Err(MsgHandleErrInternal::send_err_msg_no_close("No channels with anchor outputs accepted".to_owned(), msg.temporary_channel_id.clone()));
5577 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
5578 channel.context.set_outbound_scid_alias(outbound_scid_alias);
5580 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
5581 node_id: counterparty_node_id.clone(),
5582 msg: channel.accept_inbound_channel(),
5584 peer_state.inbound_v1_channel_by_id.insert(channel_id, channel);
5588 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
5589 let (value, output_script, user_id) = {
5590 let per_peer_state = self.per_peer_state.read().unwrap();
5591 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5593 debug_assert!(false);
5594 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)
5596 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5597 let peer_state = &mut *peer_state_lock;
5598 match peer_state.outbound_v1_channel_by_id.entry(msg.temporary_channel_id) {
5599 hash_map::Entry::Occupied(mut chan) => {
5600 try_v1_outbound_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &peer_state.latest_features), chan);
5601 (chan.get().context.get_value_satoshis(), chan.get().context.get_funding_redeemscript().to_v0_p2wsh(), chan.get().context.get_user_id())
5603 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))
5606 let mut pending_events = self.pending_events.lock().unwrap();
5607 pending_events.push_back((events::Event::FundingGenerationReady {
5608 temporary_channel_id: msg.temporary_channel_id,
5609 counterparty_node_id: *counterparty_node_id,
5610 channel_value_satoshis: value,
5612 user_channel_id: user_id,
5617 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
5618 let best_block = *self.best_block.read().unwrap();
5620 let per_peer_state = self.per_peer_state.read().unwrap();
5621 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5623 debug_assert!(false);
5624 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)
5627 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5628 let peer_state = &mut *peer_state_lock;
5629 let (chan, funding_msg_opt, monitor) =
5630 match peer_state.inbound_v1_channel_by_id.remove(&msg.temporary_channel_id) {
5631 Some(inbound_chan) => {
5632 match inbound_chan.funding_created(msg, best_block, &self.signer_provider, &self.logger) {
5634 Err((mut inbound_chan, err)) => {
5635 // We've already removed this inbound channel from the map in `PeerState`
5636 // above so at this point we just need to clean up any lingering entries
5637 // concerning this channel as it is safe to do so.
5638 update_maps_on_chan_removal!(self, &inbound_chan.context);
5639 let user_id = inbound_chan.context.get_user_id();
5640 let shutdown_res = inbound_chan.context.force_shutdown(false);
5641 return Err(MsgHandleErrInternal::from_finish_shutdown(format!("{}", err),
5642 msg.temporary_channel_id, user_id, shutdown_res, None, inbound_chan.context.get_value_satoshis()));
5646 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))
5649 match peer_state.channel_by_id.entry(chan.context.channel_id()) {
5650 hash_map::Entry::Occupied(_) => {
5651 Err(MsgHandleErrInternal::send_err_msg_no_close(
5652 "Already had channel with the new channel_id".to_owned(),
5653 chan.context.channel_id()
5656 hash_map::Entry::Vacant(e) => {
5657 match self.id_to_peer.lock().unwrap().entry(chan.context.channel_id()) {
5658 hash_map::Entry::Occupied(_) => {
5659 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5660 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
5661 chan.context.channel_id()))
5663 hash_map::Entry::Vacant(i_e) => {
5664 i_e.insert(chan.context.get_counterparty_node_id());
5668 // There's no problem signing a counterparty's funding transaction if our monitor
5669 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
5670 // accepted payment from yet. We do, however, need to wait to send our channel_ready
5671 // until we have persisted our monitor.
5672 let new_channel_id = chan.context.channel_id();
5673 if let Some(msg) = funding_msg_opt {
5674 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
5675 node_id: counterparty_node_id.clone(),
5680 let monitor_res = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
5682 let chan = e.insert(chan);
5683 let mut res = handle_new_monitor_update!(self, monitor_res, peer_state_lock, peer_state,
5684 per_peer_state, chan, MANUALLY_REMOVING_INITIAL_MONITOR,
5685 { peer_state.channel_by_id.remove(&new_channel_id) });
5687 // Note that we reply with the new channel_id in error messages if we gave up on the
5688 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
5689 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
5690 // any messages referencing a previously-closed channel anyway.
5691 // We do not propagate the monitor update to the user as it would be for a monitor
5692 // that we didn't manage to store (and that we don't care about - we don't respond
5693 // with the funding_signed so the channel can never go on chain).
5694 if let Err(MsgHandleErrInternal { shutdown_finish: Some((res, _)), .. }) = &mut res {
5702 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
5703 let best_block = *self.best_block.read().unwrap();
5704 let per_peer_state = self.per_peer_state.read().unwrap();
5705 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5707 debug_assert!(false);
5708 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5711 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5712 let peer_state = &mut *peer_state_lock;
5713 match peer_state.channel_by_id.entry(msg.channel_id) {
5714 hash_map::Entry::Occupied(mut chan) => {
5715 let monitor = try_chan_entry!(self,
5716 chan.get_mut().funding_signed(&msg, best_block, &self.signer_provider, &self.logger), chan);
5717 let update_res = self.chain_monitor.watch_channel(chan.get().context.get_funding_txo().unwrap(), monitor);
5718 let mut res = handle_new_monitor_update!(self, update_res, peer_state_lock, peer_state, per_peer_state, chan, INITIAL_MONITOR);
5719 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
5720 // We weren't able to watch the channel to begin with, so no updates should be made on
5721 // it. Previously, full_stack_target found an (unreachable) panic when the
5722 // monitor update contained within `shutdown_finish` was applied.
5723 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
5724 shutdown_finish.0.take();
5729 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5733 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
5734 let per_peer_state = self.per_peer_state.read().unwrap();
5735 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5737 debug_assert!(false);
5738 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5740 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5741 let peer_state = &mut *peer_state_lock;
5742 match peer_state.channel_by_id.entry(msg.channel_id) {
5743 hash_map::Entry::Occupied(mut chan) => {
5744 let announcement_sigs_opt = try_chan_entry!(self, chan.get_mut().channel_ready(&msg, &self.node_signer,
5745 self.genesis_hash.clone(), &self.default_configuration, &self.best_block.read().unwrap(), &self.logger), chan);
5746 if let Some(announcement_sigs) = announcement_sigs_opt {
5747 log_trace!(self.logger, "Sending announcement_signatures for channel {}", &chan.get().context.channel_id());
5748 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5749 node_id: counterparty_node_id.clone(),
5750 msg: announcement_sigs,
5752 } else if chan.get().context.is_usable() {
5753 // If we're sending an announcement_signatures, we'll send the (public)
5754 // channel_update after sending a channel_announcement when we receive our
5755 // counterparty's announcement_signatures. Thus, we only bother to send a
5756 // channel_update here if the channel is not public, i.e. we're not sending an
5757 // announcement_signatures.
5758 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", &chan.get().context.channel_id());
5759 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
5760 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
5761 node_id: counterparty_node_id.clone(),
5768 let mut pending_events = self.pending_events.lock().unwrap();
5769 emit_channel_ready_event!(pending_events, chan.get_mut());
5774 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
5778 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
5779 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
5780 let result: Result<(), _> = loop {
5781 let per_peer_state = self.per_peer_state.read().unwrap();
5782 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5784 debug_assert!(false);
5785 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5787 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5788 let peer_state = &mut *peer_state_lock;
5789 // TODO(dunxen): Fix this duplication when we switch to a single map with enums as per
5790 // https://github.com/lightningdevkit/rust-lightning/issues/2422
5791 if let hash_map::Entry::Occupied(chan_entry) = peer_state.outbound_v1_channel_by_id.entry(msg.channel_id.clone()) {
5792 log_error!(self.logger, "Immediately closing unfunded channel {} as peer asked to cooperatively shut it down (which is unnecessary)", &msg.channel_id);
5793 self.issue_channel_close_events(&chan_entry.get().context, ClosureReason::CounterpartyCoopClosedUnfundedChannel);
5794 let mut chan = remove_channel!(self, chan_entry);
5795 self.finish_force_close_channel(chan.context.force_shutdown(false));
5797 } else if let hash_map::Entry::Occupied(chan_entry) = peer_state.inbound_v1_channel_by_id.entry(msg.channel_id.clone()) {
5798 log_error!(self.logger, "Immediately closing unfunded channel {} as peer asked to cooperatively shut it down (which is unnecessary)", &msg.channel_id);
5799 self.issue_channel_close_events(&chan_entry.get().context, ClosureReason::CounterpartyCoopClosedUnfundedChannel);
5800 let mut chan = remove_channel!(self, chan_entry);
5801 self.finish_force_close_channel(chan.context.force_shutdown(false));
5803 } else if let hash_map::Entry::Occupied(mut chan_entry) = peer_state.channel_by_id.entry(msg.channel_id.clone()) {
5804 if !chan_entry.get().received_shutdown() {
5805 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
5807 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
5810 let funding_txo_opt = chan_entry.get().context.get_funding_txo();
5811 let (shutdown, monitor_update_opt, htlcs) = try_chan_entry!(self,
5812 chan_entry.get_mut().shutdown(&self.signer_provider, &peer_state.latest_features, &msg), chan_entry);
5813 dropped_htlcs = htlcs;
5815 if let Some(msg) = shutdown {
5816 // We can send the `shutdown` message before updating the `ChannelMonitor`
5817 // here as we don't need the monitor update to complete until we send a
5818 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
5819 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5820 node_id: *counterparty_node_id,
5825 // Update the monitor with the shutdown script if necessary.
5826 if let Some(monitor_update) = monitor_update_opt {
5827 break handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
5828 peer_state_lock, peer_state, per_peer_state, chan_entry).map(|_| ());
5832 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))
5835 for htlc_source in dropped_htlcs.drain(..) {
5836 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
5837 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
5838 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
5844 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
5845 let per_peer_state = self.per_peer_state.read().unwrap();
5846 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5848 debug_assert!(false);
5849 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5851 let (tx, chan_option) = {
5852 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5853 let peer_state = &mut *peer_state_lock;
5854 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
5855 hash_map::Entry::Occupied(mut chan_entry) => {
5856 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), chan_entry);
5857 if let Some(msg) = closing_signed {
5858 peer_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5859 node_id: counterparty_node_id.clone(),
5864 // We're done with this channel, we've got a signed closing transaction and
5865 // will send the closing_signed back to the remote peer upon return. This
5866 // also implies there are no pending HTLCs left on the channel, so we can
5867 // fully delete it from tracking (the channel monitor is still around to
5868 // watch for old state broadcasts)!
5869 (tx, Some(remove_channel!(self, chan_entry)))
5870 } else { (tx, None) }
5872 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
5875 if let Some(broadcast_tx) = tx {
5876 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
5877 self.tx_broadcaster.broadcast_transactions(&[&broadcast_tx]);
5879 if let Some(chan) = chan_option {
5880 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5881 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5882 let peer_state = &mut *peer_state_lock;
5883 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5887 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
5892 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
5893 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
5894 //determine the state of the payment based on our response/if we forward anything/the time
5895 //we take to respond. We should take care to avoid allowing such an attack.
5897 //TODO: There exists a further attack where a node may garble the onion data, forward it to
5898 //us repeatedly garbled in different ways, and compare our error messages, which are
5899 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
5900 //but we should prevent it anyway.
5902 let decoded_hop_res = self.decode_update_add_htlc_onion(msg);
5903 let per_peer_state = self.per_peer_state.read().unwrap();
5904 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5906 debug_assert!(false);
5907 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5909 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5910 let peer_state = &mut *peer_state_lock;
5911 match peer_state.channel_by_id.entry(msg.channel_id) {
5912 hash_map::Entry::Occupied(mut chan) => {
5914 let pending_forward_info = match decoded_hop_res {
5915 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
5916 self.construct_pending_htlc_status(msg, shared_secret, next_hop,
5917 chan.get().context.config().accept_underpaying_htlcs, next_packet_pk_opt),
5918 Err(e) => PendingHTLCStatus::Fail(e)
5920 let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
5921 // If the update_add is completely bogus, the call will Err and we will close,
5922 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
5923 // want to reject the new HTLC and fail it backwards instead of forwarding.
5924 match pending_forward_info {
5925 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
5926 let reason = if (error_code & 0x1000) != 0 {
5927 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
5928 HTLCFailReason::reason(real_code, error_data)
5930 HTLCFailReason::from_failure_code(error_code)
5931 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
5932 let msg = msgs::UpdateFailHTLC {
5933 channel_id: msg.channel_id,
5934 htlc_id: msg.htlc_id,
5937 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
5939 _ => pending_forward_info
5942 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.fee_estimator, &self.logger), chan);
5944 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))
5949 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
5951 let (htlc_source, forwarded_htlc_value) = {
5952 let per_peer_state = self.per_peer_state.read().unwrap();
5953 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5955 debug_assert!(false);
5956 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5958 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5959 let peer_state = &mut *peer_state_lock;
5960 match peer_state.channel_by_id.entry(msg.channel_id) {
5961 hash_map::Entry::Occupied(mut chan) => {
5962 let res = try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), chan);
5963 funding_txo = chan.get().context.get_funding_txo().expect("We won't accept a fulfill until funded");
5966 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))
5969 self.claim_funds_internal(htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, funding_txo);
5973 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
5974 let per_peer_state = self.per_peer_state.read().unwrap();
5975 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5977 debug_assert!(false);
5978 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5980 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5981 let peer_state = &mut *peer_state_lock;
5982 match peer_state.channel_by_id.entry(msg.channel_id) {
5983 hash_map::Entry::Occupied(mut chan) => {
5984 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan);
5986 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))
5991 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
5992 let per_peer_state = self.per_peer_state.read().unwrap();
5993 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5995 debug_assert!(false);
5996 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5998 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5999 let peer_state = &mut *peer_state_lock;
6000 match peer_state.channel_by_id.entry(msg.channel_id) {
6001 hash_map::Entry::Occupied(mut chan) => {
6002 if (msg.failure_code & 0x8000) == 0 {
6003 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
6004 try_chan_entry!(self, Err(chan_err), chan);
6006 try_chan_entry!(self, chan.get_mut().update_fail_malformed_htlc(&msg, HTLCFailReason::reason(msg.failure_code, msg.sha256_of_onion.to_vec())), chan);
6009 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))
6013 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
6014 let per_peer_state = self.per_peer_state.read().unwrap();
6015 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6017 debug_assert!(false);
6018 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6020 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6021 let peer_state = &mut *peer_state_lock;
6022 match peer_state.channel_by_id.entry(msg.channel_id) {
6023 hash_map::Entry::Occupied(mut chan) => {
6024 let funding_txo = chan.get().context.get_funding_txo();
6025 let monitor_update_opt = try_chan_entry!(self, chan.get_mut().commitment_signed(&msg, &self.logger), chan);
6026 if let Some(monitor_update) = monitor_update_opt {
6027 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update, peer_state_lock,
6028 peer_state, per_peer_state, chan).map(|_| ())
6031 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))
6036 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
6037 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
6038 let mut push_forward_event = false;
6039 let mut new_intercept_events = VecDeque::new();
6040 let mut failed_intercept_forwards = Vec::new();
6041 if !pending_forwards.is_empty() {
6042 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
6043 let scid = match forward_info.routing {
6044 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
6045 PendingHTLCRouting::Receive { .. } => 0,
6046 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
6048 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
6049 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
6051 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
6052 let forward_htlcs_empty = forward_htlcs.is_empty();
6053 match forward_htlcs.entry(scid) {
6054 hash_map::Entry::Occupied(mut entry) => {
6055 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6056 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
6058 hash_map::Entry::Vacant(entry) => {
6059 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
6060 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.genesis_hash)
6062 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).into_inner());
6063 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
6064 match pending_intercepts.entry(intercept_id) {
6065 hash_map::Entry::Vacant(entry) => {
6066 new_intercept_events.push_back((events::Event::HTLCIntercepted {
6067 requested_next_hop_scid: scid,
6068 payment_hash: forward_info.payment_hash,
6069 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
6070 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
6073 entry.insert(PendingAddHTLCInfo {
6074 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
6076 hash_map::Entry::Occupied(_) => {
6077 log_info!(self.logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
6078 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
6079 short_channel_id: prev_short_channel_id,
6080 user_channel_id: Some(prev_user_channel_id),
6081 outpoint: prev_funding_outpoint,
6082 htlc_id: prev_htlc_id,
6083 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
6084 phantom_shared_secret: None,
6087 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
6088 HTLCFailReason::from_failure_code(0x4000 | 10),
6089 HTLCDestination::InvalidForward { requested_forward_scid: scid },
6094 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
6095 // payments are being processed.
6096 if forward_htlcs_empty {
6097 push_forward_event = true;
6099 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6100 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
6107 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
6108 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
6111 if !new_intercept_events.is_empty() {
6112 let mut events = self.pending_events.lock().unwrap();
6113 events.append(&mut new_intercept_events);
6115 if push_forward_event { self.push_pending_forwards_ev() }
6119 fn push_pending_forwards_ev(&self) {
6120 let mut pending_events = self.pending_events.lock().unwrap();
6121 let is_processing_events = self.pending_events_processor.load(Ordering::Acquire);
6122 let num_forward_events = pending_events.iter().filter(|(ev, _)|
6123 if let events::Event::PendingHTLCsForwardable { .. } = ev { true } else { false }
6125 // We only want to push a PendingHTLCsForwardable event if no others are queued. Processing
6126 // events is done in batches and they are not removed until we're done processing each
6127 // batch. Since handling a `PendingHTLCsForwardable` event will call back into the
6128 // `ChannelManager`, we'll still see the original forwarding event not removed. Phantom
6129 // payments will need an additional forwarding event before being claimed to make them look
6130 // real by taking more time.
6131 if (is_processing_events && num_forward_events <= 1) || num_forward_events < 1 {
6132 pending_events.push_back((Event::PendingHTLCsForwardable {
6133 time_forwardable: Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
6138 /// Checks whether [`ChannelMonitorUpdate`]s generated by the receipt of a remote
6139 /// [`msgs::RevokeAndACK`] should be held for the given channel until some other action
6140 /// completes. Note that this needs to happen in the same [`PeerState`] mutex as any release of
6141 /// the [`ChannelMonitorUpdate`] in question.
6142 fn raa_monitor_updates_held(&self,
6143 actions_blocking_raa_monitor_updates: &BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
6144 channel_funding_outpoint: OutPoint, counterparty_node_id: PublicKey
6146 actions_blocking_raa_monitor_updates
6147 .get(&channel_funding_outpoint.to_channel_id()).map(|v| !v.is_empty()).unwrap_or(false)
6148 || self.pending_events.lock().unwrap().iter().any(|(_, action)| {
6149 action == &Some(EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
6150 channel_funding_outpoint,
6151 counterparty_node_id,
6156 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
6157 let (htlcs_to_fail, res) = {
6158 let per_peer_state = self.per_peer_state.read().unwrap();
6159 let mut peer_state_lock = per_peer_state.get(counterparty_node_id)
6161 debug_assert!(false);
6162 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6163 }).map(|mtx| mtx.lock().unwrap())?;
6164 let peer_state = &mut *peer_state_lock;
6165 match peer_state.channel_by_id.entry(msg.channel_id) {
6166 hash_map::Entry::Occupied(mut chan) => {
6167 let funding_txo_opt = chan.get().context.get_funding_txo();
6168 let mon_update_blocked = if let Some(funding_txo) = funding_txo_opt {
6169 self.raa_monitor_updates_held(
6170 &peer_state.actions_blocking_raa_monitor_updates, funding_txo,
6171 *counterparty_node_id)
6173 let (htlcs_to_fail, monitor_update_opt) = try_chan_entry!(self,
6174 chan.get_mut().revoke_and_ack(&msg, &self.fee_estimator, &self.logger, mon_update_blocked), chan);
6175 let res = if let Some(monitor_update) = monitor_update_opt {
6176 let funding_txo = funding_txo_opt
6177 .expect("Funding outpoint must have been set for RAA handling to succeed");
6178 handle_new_monitor_update!(self, funding_txo, monitor_update,
6179 peer_state_lock, peer_state, per_peer_state, chan).map(|_| ())
6181 (htlcs_to_fail, res)
6183 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))
6186 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
6190 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
6191 let per_peer_state = self.per_peer_state.read().unwrap();
6192 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6194 debug_assert!(false);
6195 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6197 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6198 let peer_state = &mut *peer_state_lock;
6199 match peer_state.channel_by_id.entry(msg.channel_id) {
6200 hash_map::Entry::Occupied(mut chan) => {
6201 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg, &self.logger), chan);
6203 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))
6208 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
6209 let per_peer_state = self.per_peer_state.read().unwrap();
6210 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6212 debug_assert!(false);
6213 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6215 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6216 let peer_state = &mut *peer_state_lock;
6217 match peer_state.channel_by_id.entry(msg.channel_id) {
6218 hash_map::Entry::Occupied(mut chan) => {
6219 if !chan.get().context.is_usable() {
6220 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
6223 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
6224 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(
6225 &self.node_signer, self.genesis_hash.clone(), self.best_block.read().unwrap().height(),
6226 msg, &self.default_configuration
6228 // Note that announcement_signatures fails if the channel cannot be announced,
6229 // so get_channel_update_for_broadcast will never fail by the time we get here.
6230 update_msg: Some(self.get_channel_update_for_broadcast(chan.get()).unwrap()),
6233 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))
6238 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
6239 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
6240 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
6241 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
6243 // It's not a local channel
6244 return Ok(NotifyOption::SkipPersist)
6247 let per_peer_state = self.per_peer_state.read().unwrap();
6248 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
6249 if peer_state_mutex_opt.is_none() {
6250 return Ok(NotifyOption::SkipPersist)
6252 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
6253 let peer_state = &mut *peer_state_lock;
6254 match peer_state.channel_by_id.entry(chan_id) {
6255 hash_map::Entry::Occupied(mut chan) => {
6256 if chan.get().context.get_counterparty_node_id() != *counterparty_node_id {
6257 if chan.get().context.should_announce() {
6258 // If the announcement is about a channel of ours which is public, some
6259 // other peer may simply be forwarding all its gossip to us. Don't provide
6260 // a scary-looking error message and return Ok instead.
6261 return Ok(NotifyOption::SkipPersist);
6263 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));
6265 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().context.get_counterparty_node_id().serialize()[..];
6266 let msg_from_node_one = msg.contents.flags & 1 == 0;
6267 if were_node_one == msg_from_node_one {
6268 return Ok(NotifyOption::SkipPersist);
6270 log_debug!(self.logger, "Received channel_update for channel {}.", &chan_id);
6271 try_chan_entry!(self, chan.get_mut().channel_update(&msg), chan);
6274 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersist)
6276 Ok(NotifyOption::DoPersist)
6279 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
6281 let need_lnd_workaround = {
6282 let per_peer_state = self.per_peer_state.read().unwrap();
6284 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6286 debug_assert!(false);
6287 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6289 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6290 let peer_state = &mut *peer_state_lock;
6291 match peer_state.channel_by_id.entry(msg.channel_id) {
6292 hash_map::Entry::Occupied(mut chan) => {
6293 // Currently, we expect all holding cell update_adds to be dropped on peer
6294 // disconnect, so Channel's reestablish will never hand us any holding cell
6295 // freed HTLCs to fail backwards. If in the future we no longer drop pending
6296 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
6297 let responses = try_chan_entry!(self, chan.get_mut().channel_reestablish(
6298 msg, &self.logger, &self.node_signer, self.genesis_hash,
6299 &self.default_configuration, &*self.best_block.read().unwrap()), chan);
6300 let mut channel_update = None;
6301 if let Some(msg) = responses.shutdown_msg {
6302 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
6303 node_id: counterparty_node_id.clone(),
6306 } else if chan.get().context.is_usable() {
6307 // If the channel is in a usable state (ie the channel is not being shut
6308 // down), send a unicast channel_update to our counterparty to make sure
6309 // they have the latest channel parameters.
6310 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
6311 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
6312 node_id: chan.get().context.get_counterparty_node_id(),
6317 let need_lnd_workaround = chan.get_mut().context.workaround_lnd_bug_4006.take();
6318 htlc_forwards = self.handle_channel_resumption(
6319 &mut peer_state.pending_msg_events, chan.get_mut(), responses.raa, responses.commitment_update, responses.order,
6320 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
6321 if let Some(upd) = channel_update {
6322 peer_state.pending_msg_events.push(upd);
6326 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))
6330 if let Some(forwards) = htlc_forwards {
6331 self.forward_htlcs(&mut [forwards][..]);
6334 if let Some(channel_ready_msg) = need_lnd_workaround {
6335 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
6340 /// Process pending events from the [`chain::Watch`], returning whether any events were processed.
6341 fn process_pending_monitor_events(&self) -> bool {
6342 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
6344 let mut failed_channels = Vec::new();
6345 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
6346 let has_pending_monitor_events = !pending_monitor_events.is_empty();
6347 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
6348 for monitor_event in monitor_events.drain(..) {
6349 match monitor_event {
6350 MonitorEvent::HTLCEvent(htlc_update) => {
6351 if let Some(preimage) = htlc_update.payment_preimage {
6352 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", &preimage);
6353 self.claim_funds_internal(htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, funding_outpoint);
6355 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", &htlc_update.payment_hash);
6356 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
6357 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
6358 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
6361 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
6362 MonitorEvent::UpdateFailed(funding_outpoint) => {
6363 let counterparty_node_id_opt = match counterparty_node_id {
6364 Some(cp_id) => Some(cp_id),
6366 // TODO: Once we can rely on the counterparty_node_id from the
6367 // monitor event, this and the id_to_peer map should be removed.
6368 let id_to_peer = self.id_to_peer.lock().unwrap();
6369 id_to_peer.get(&funding_outpoint.to_channel_id()).cloned()
6372 if let Some(counterparty_node_id) = counterparty_node_id_opt {
6373 let per_peer_state = self.per_peer_state.read().unwrap();
6374 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
6375 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6376 let peer_state = &mut *peer_state_lock;
6377 let pending_msg_events = &mut peer_state.pending_msg_events;
6378 if let hash_map::Entry::Occupied(chan_entry) = peer_state.channel_by_id.entry(funding_outpoint.to_channel_id()) {
6379 let mut chan = remove_channel!(self, chan_entry);
6380 failed_channels.push(chan.context.force_shutdown(false));
6381 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6382 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6386 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
6387 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
6389 ClosureReason::CommitmentTxConfirmed
6391 self.issue_channel_close_events(&chan.context, reason);
6392 pending_msg_events.push(events::MessageSendEvent::HandleError {
6393 node_id: chan.context.get_counterparty_node_id(),
6394 action: msgs::ErrorAction::SendErrorMessage {
6395 msg: msgs::ErrorMessage { channel_id: chan.context.channel_id(), data: "Channel force-closed".to_owned() }
6402 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
6403 self.channel_monitor_updated(&funding_txo, monitor_update_id, counterparty_node_id.as_ref());
6409 for failure in failed_channels.drain(..) {
6410 self.finish_force_close_channel(failure);
6413 has_pending_monitor_events
6416 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
6417 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
6418 /// update events as a separate process method here.
6420 pub fn process_monitor_events(&self) {
6421 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6422 self.process_pending_monitor_events();
6425 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
6426 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
6427 /// update was applied.
6428 fn check_free_holding_cells(&self) -> bool {
6429 let mut has_monitor_update = false;
6430 let mut failed_htlcs = Vec::new();
6431 let mut handle_errors = Vec::new();
6433 // Walk our list of channels and find any that need to update. Note that when we do find an
6434 // update, if it includes actions that must be taken afterwards, we have to drop the
6435 // per-peer state lock as well as the top level per_peer_state lock. Thus, we loop until we
6436 // manage to go through all our peers without finding a single channel to update.
6438 let per_peer_state = self.per_peer_state.read().unwrap();
6439 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6441 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6442 let peer_state: &mut PeerState<_> = &mut *peer_state_lock;
6443 for (channel_id, chan) in peer_state.channel_by_id.iter_mut() {
6444 let counterparty_node_id = chan.context.get_counterparty_node_id();
6445 let funding_txo = chan.context.get_funding_txo();
6446 let (monitor_opt, holding_cell_failed_htlcs) =
6447 chan.maybe_free_holding_cell_htlcs(&self.fee_estimator, &self.logger);
6448 if !holding_cell_failed_htlcs.is_empty() {
6449 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id, counterparty_node_id));
6451 if let Some(monitor_update) = monitor_opt {
6452 has_monitor_update = true;
6454 let channel_id: ChannelId = *channel_id;
6455 let res = handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update,
6456 peer_state_lock, peer_state, per_peer_state, chan, MANUALLY_REMOVING,
6457 peer_state.channel_by_id.remove(&channel_id));
6459 handle_errors.push((counterparty_node_id, res));
6461 continue 'peer_loop;
6470 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
6471 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
6472 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
6475 for (counterparty_node_id, err) in handle_errors.drain(..) {
6476 let _ = handle_error!(self, err, counterparty_node_id);
6482 /// When a call to a [`ChannelSigner`] method returns an error, this indicates that the signer
6483 /// is (temporarily) unavailable, and the operation should be retried later.
6485 /// This method allows for that retry - either checking for any signer-pending messages to be
6486 /// attempted in every channel, or in the specifically provided channel.
6487 #[cfg(test)] // This is only implemented for one signer method, and should be private until we
6488 // actually finish implementing it fully.
6489 pub fn signer_unblocked(&self, channel_opt: Option<(PublicKey, ChannelId)>) {
6490 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6492 let unblock_chan = |chan: &mut Channel<SP>, pending_msg_events: &mut Vec<MessageSendEvent>| {
6493 let msgs = chan.signer_maybe_unblocked(&self.logger);
6494 if let Some(updates) = msgs.commitment_update {
6495 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
6496 node_id: chan.context.get_counterparty_node_id(),
6500 if let Some(msg) = msgs.funding_signed {
6501 pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
6502 node_id: chan.context.get_counterparty_node_id(),
6506 if let Some(msg) = msgs.funding_created {
6507 pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
6508 node_id: chan.context.get_counterparty_node_id(),
6514 let per_peer_state = self.per_peer_state.read().unwrap();
6515 if let Some((counterparty_node_id, channel_id)) = channel_opt {
6516 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
6517 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6518 let peer_state = &mut *peer_state_lock;
6519 if let Some(chan) = peer_state.channel_by_id.get_mut(&channel_id) {
6520 unblock_chan(chan, &mut peer_state.pending_msg_events);
6524 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6525 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6526 let peer_state = &mut *peer_state_lock;
6527 for (_, chan) in peer_state.channel_by_id.iter_mut() {
6528 unblock_chan(chan, &mut peer_state.pending_msg_events);
6534 /// Check whether any channels have finished removing all pending updates after a shutdown
6535 /// exchange and can now send a closing_signed.
6536 /// Returns whether any closing_signed messages were generated.
6537 fn maybe_generate_initial_closing_signed(&self) -> bool {
6538 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
6539 let mut has_update = false;
6541 let per_peer_state = self.per_peer_state.read().unwrap();
6543 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6544 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6545 let peer_state = &mut *peer_state_lock;
6546 let pending_msg_events = &mut peer_state.pending_msg_events;
6547 peer_state.channel_by_id.retain(|channel_id, chan| {
6548 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
6549 Ok((msg_opt, tx_opt)) => {
6550 if let Some(msg) = msg_opt {
6552 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
6553 node_id: chan.context.get_counterparty_node_id(), msg,
6556 if let Some(tx) = tx_opt {
6557 // We're done with this channel. We got a closing_signed and sent back
6558 // a closing_signed with a closing transaction to broadcast.
6559 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6560 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6565 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
6567 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
6568 self.tx_broadcaster.broadcast_transactions(&[&tx]);
6569 update_maps_on_chan_removal!(self, &chan.context);
6575 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
6576 handle_errors.push((chan.context.get_counterparty_node_id(), Err(res)));
6584 for (counterparty_node_id, err) in handle_errors.drain(..) {
6585 let _ = handle_error!(self, err, counterparty_node_id);
6591 /// Handle a list of channel failures during a block_connected or block_disconnected call,
6592 /// pushing the channel monitor update (if any) to the background events queue and removing the
6594 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
6595 for mut failure in failed_channels.drain(..) {
6596 // Either a commitment transactions has been confirmed on-chain or
6597 // Channel::block_disconnected detected that the funding transaction has been
6598 // reorganized out of the main chain.
6599 // We cannot broadcast our latest local state via monitor update (as
6600 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
6601 // so we track the update internally and handle it when the user next calls
6602 // timer_tick_occurred, guaranteeing we're running normally.
6603 if let Some((counterparty_node_id, funding_txo, update)) = failure.0.take() {
6604 assert_eq!(update.updates.len(), 1);
6605 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
6606 assert!(should_broadcast);
6607 } else { unreachable!(); }
6608 self.pending_background_events.lock().unwrap().push(
6609 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
6610 counterparty_node_id, funding_txo, update
6613 self.finish_force_close_channel(failure);
6617 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
6620 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
6621 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
6623 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
6624 /// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
6625 /// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
6626 /// passed directly to [`claim_funds`].
6628 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
6630 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
6631 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
6635 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
6636 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
6638 /// Errors if `min_value_msat` is greater than total bitcoin supply.
6640 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
6641 /// on versions of LDK prior to 0.0.114.
6643 /// [`claim_funds`]: Self::claim_funds
6644 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
6645 /// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
6646 /// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
6647 /// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
6648 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
6649 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
6650 min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
6651 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs,
6652 &self.entropy_source, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
6653 min_final_cltv_expiry_delta)
6656 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
6657 /// stored external to LDK.
6659 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
6660 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
6661 /// the `min_value_msat` provided here, if one is provided.
6663 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
6664 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
6667 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
6668 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
6669 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
6670 /// sender "proof-of-payment" unless they have paid the required amount.
6672 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
6673 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
6674 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
6675 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
6676 /// invoices when no timeout is set.
6678 /// Note that we use block header time to time-out pending inbound payments (with some margin
6679 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
6680 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
6681 /// If you need exact expiry semantics, you should enforce them upon receipt of
6682 /// [`PaymentClaimable`].
6684 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
6685 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
6687 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
6688 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
6692 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
6693 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
6695 /// Errors if `min_value_msat` is greater than total bitcoin supply.
6697 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
6698 /// on versions of LDK prior to 0.0.114.
6700 /// [`create_inbound_payment`]: Self::create_inbound_payment
6701 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
6702 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>,
6703 invoice_expiry_delta_secs: u32, min_final_cltv_expiry: Option<u16>) -> Result<PaymentSecret, ()> {
6704 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash,
6705 invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
6706 min_final_cltv_expiry)
6709 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
6710 /// previously returned from [`create_inbound_payment`].
6712 /// [`create_inbound_payment`]: Self::create_inbound_payment
6713 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
6714 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
6717 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
6718 /// are used when constructing the phantom invoice's route hints.
6720 /// [phantom node payments]: crate::sign::PhantomKeysManager
6721 pub fn get_phantom_scid(&self) -> u64 {
6722 let best_block_height = self.best_block.read().unwrap().height();
6723 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
6725 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
6726 // Ensure the generated scid doesn't conflict with a real channel.
6727 match short_to_chan_info.get(&scid_candidate) {
6728 Some(_) => continue,
6729 None => return scid_candidate
6734 /// Gets route hints for use in receiving [phantom node payments].
6736 /// [phantom node payments]: crate::sign::PhantomKeysManager
6737 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
6739 channels: self.list_usable_channels(),
6740 phantom_scid: self.get_phantom_scid(),
6741 real_node_pubkey: self.get_our_node_id(),
6745 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
6746 /// used when constructing the route hints for HTLCs intended to be intercepted. See
6747 /// [`ChannelManager::forward_intercepted_htlc`].
6749 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
6750 /// times to get a unique scid.
6751 pub fn get_intercept_scid(&self) -> u64 {
6752 let best_block_height = self.best_block.read().unwrap().height();
6753 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
6755 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
6756 // Ensure the generated scid doesn't conflict with a real channel.
6757 if short_to_chan_info.contains_key(&scid_candidate) { continue }
6758 return scid_candidate
6762 /// Gets inflight HTLC information by processing pending outbound payments that are in
6763 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
6764 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
6765 let mut inflight_htlcs = InFlightHtlcs::new();
6767 let per_peer_state = self.per_peer_state.read().unwrap();
6768 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6769 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6770 let peer_state = &mut *peer_state_lock;
6771 for chan in peer_state.channel_by_id.values() {
6772 for (htlc_source, _) in chan.inflight_htlc_sources() {
6773 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
6774 inflight_htlcs.process_path(path, self.get_our_node_id());
6783 #[cfg(any(test, feature = "_test_utils"))]
6784 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
6785 let events = core::cell::RefCell::new(Vec::new());
6786 let event_handler = |event: events::Event| events.borrow_mut().push(event);
6787 self.process_pending_events(&event_handler);
6791 #[cfg(feature = "_test_utils")]
6792 pub fn push_pending_event(&self, event: events::Event) {
6793 let mut events = self.pending_events.lock().unwrap();
6794 events.push_back((event, None));
6798 pub fn pop_pending_event(&self) -> Option<events::Event> {
6799 let mut events = self.pending_events.lock().unwrap();
6800 events.pop_front().map(|(e, _)| e)
6804 pub fn has_pending_payments(&self) -> bool {
6805 self.pending_outbound_payments.has_pending_payments()
6809 pub fn clear_pending_payments(&self) {
6810 self.pending_outbound_payments.clear_pending_payments()
6813 /// When something which was blocking a channel from updating its [`ChannelMonitor`] (e.g. an
6814 /// [`Event`] being handled) completes, this should be called to restore the channel to normal
6815 /// operation. It will double-check that nothing *else* is also blocking the same channel from
6816 /// making progress and then let any blocked [`ChannelMonitorUpdate`]s fly.
6817 fn handle_monitor_update_release(&self, counterparty_node_id: PublicKey, channel_funding_outpoint: OutPoint, mut completed_blocker: Option<RAAMonitorUpdateBlockingAction>) {
6818 let mut errors = Vec::new();
6820 let per_peer_state = self.per_peer_state.read().unwrap();
6821 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
6822 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
6823 let peer_state = &mut *peer_state_lck;
6825 if let Some(blocker) = completed_blocker.take() {
6826 // Only do this on the first iteration of the loop.
6827 if let Some(blockers) = peer_state.actions_blocking_raa_monitor_updates
6828 .get_mut(&channel_funding_outpoint.to_channel_id())
6830 blockers.retain(|iter| iter != &blocker);
6834 if self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
6835 channel_funding_outpoint, counterparty_node_id) {
6836 // Check that, while holding the peer lock, we don't have anything else
6837 // blocking monitor updates for this channel. If we do, release the monitor
6838 // update(s) when those blockers complete.
6839 log_trace!(self.logger, "Delaying monitor unlock for channel {} as another channel's mon update needs to complete first",
6840 &channel_funding_outpoint.to_channel_id());
6844 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(channel_funding_outpoint.to_channel_id()) {
6845 debug_assert_eq!(chan.get().context.get_funding_txo().unwrap(), channel_funding_outpoint);
6846 if let Some((monitor_update, further_update_exists)) = chan.get_mut().unblock_next_blocked_monitor_update() {
6847 log_debug!(self.logger, "Unlocking monitor updating for channel {} and updating monitor",
6848 &channel_funding_outpoint.to_channel_id());
6849 if let Err(e) = handle_new_monitor_update!(self, channel_funding_outpoint, monitor_update,
6850 peer_state_lck, peer_state, per_peer_state, chan)
6852 errors.push((e, counterparty_node_id));
6854 if further_update_exists {
6855 // If there are more `ChannelMonitorUpdate`s to process, restart at the
6860 log_trace!(self.logger, "Unlocked monitor updating for channel {} without monitors to update",
6861 &channel_funding_outpoint.to_channel_id());
6865 log_debug!(self.logger,
6866 "Got a release post-RAA monitor update for peer {} but the channel is gone",
6867 log_pubkey!(counterparty_node_id));
6871 for (err, counterparty_node_id) in errors {
6872 let res = Err::<(), _>(err);
6873 let _ = handle_error!(self, res, counterparty_node_id);
6877 fn handle_post_event_actions(&self, actions: Vec<EventCompletionAction>) {
6878 for action in actions {
6880 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
6881 channel_funding_outpoint, counterparty_node_id
6883 self.handle_monitor_update_release(counterparty_node_id, channel_funding_outpoint, None);
6889 /// Processes any events asynchronously in the order they were generated since the last call
6890 /// using the given event handler.
6892 /// See the trait-level documentation of [`EventsProvider`] for requirements.
6893 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
6897 process_events_body!(self, ev, { handler(ev).await });
6901 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>
6903 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6904 T::Target: BroadcasterInterface,
6905 ES::Target: EntropySource,
6906 NS::Target: NodeSigner,
6907 SP::Target: SignerProvider,
6908 F::Target: FeeEstimator,
6912 /// Returns `MessageSendEvent`s strictly ordered per-peer, in the order they were generated.
6913 /// The returned array will contain `MessageSendEvent`s for different peers if
6914 /// `MessageSendEvent`s to more than one peer exists, but `MessageSendEvent`s to the same peer
6915 /// is always placed next to each other.
6917 /// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
6918 /// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
6919 /// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
6920 /// will randomly be placed first or last in the returned array.
6922 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
6923 /// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
6924 /// the `MessageSendEvent`s to the specific peer they were generated under.
6925 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
6926 let events = RefCell::new(Vec::new());
6927 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
6928 let mut result = self.process_background_events();
6930 // TODO: This behavior should be documented. It's unintuitive that we query
6931 // ChannelMonitors when clearing other events.
6932 if self.process_pending_monitor_events() {
6933 result = NotifyOption::DoPersist;
6936 if self.check_free_holding_cells() {
6937 result = NotifyOption::DoPersist;
6939 if self.maybe_generate_initial_closing_signed() {
6940 result = NotifyOption::DoPersist;
6943 let mut pending_events = Vec::new();
6944 let per_peer_state = self.per_peer_state.read().unwrap();
6945 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6946 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6947 let peer_state = &mut *peer_state_lock;
6948 if peer_state.pending_msg_events.len() > 0 {
6949 pending_events.append(&mut peer_state.pending_msg_events);
6953 if !pending_events.is_empty() {
6954 events.replace(pending_events);
6963 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>
6965 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6966 T::Target: BroadcasterInterface,
6967 ES::Target: EntropySource,
6968 NS::Target: NodeSigner,
6969 SP::Target: SignerProvider,
6970 F::Target: FeeEstimator,
6974 /// Processes events that must be periodically handled.
6976 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
6977 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
6978 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
6980 process_events_body!(self, ev, handler.handle_event(ev));
6984 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>
6986 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6987 T::Target: BroadcasterInterface,
6988 ES::Target: EntropySource,
6989 NS::Target: NodeSigner,
6990 SP::Target: SignerProvider,
6991 F::Target: FeeEstimator,
6995 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
6997 let best_block = self.best_block.read().unwrap();
6998 assert_eq!(best_block.block_hash(), header.prev_blockhash,
6999 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
7000 assert_eq!(best_block.height(), height - 1,
7001 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
7004 self.transactions_confirmed(header, txdata, height);
7005 self.best_block_updated(header, height);
7008 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
7009 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
7010 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
7011 let new_height = height - 1;
7013 let mut best_block = self.best_block.write().unwrap();
7014 assert_eq!(best_block.block_hash(), header.block_hash(),
7015 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
7016 assert_eq!(best_block.height(), height,
7017 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
7018 *best_block = BestBlock::new(header.prev_blockhash, new_height)
7021 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));
7025 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>
7027 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7028 T::Target: BroadcasterInterface,
7029 ES::Target: EntropySource,
7030 NS::Target: NodeSigner,
7031 SP::Target: SignerProvider,
7032 F::Target: FeeEstimator,
7036 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
7037 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
7038 // during initialization prior to the chain_monitor being fully configured in some cases.
7039 // See the docs for `ChannelManagerReadArgs` for more.
7041 let block_hash = header.block_hash();
7042 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
7044 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
7045 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
7046 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)
7047 .map(|(a, b)| (a, Vec::new(), b)));
7049 let last_best_block_height = self.best_block.read().unwrap().height();
7050 if height < last_best_block_height {
7051 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
7052 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));
7056 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
7057 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
7058 // during initialization prior to the chain_monitor being fully configured in some cases.
7059 // See the docs for `ChannelManagerReadArgs` for more.
7061 let block_hash = header.block_hash();
7062 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
7064 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
7065 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
7066 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
7068 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));
7070 macro_rules! max_time {
7071 ($timestamp: expr) => {
7073 // Update $timestamp to be the max of its current value and the block
7074 // timestamp. This should keep us close to the current time without relying on
7075 // having an explicit local time source.
7076 // Just in case we end up in a race, we loop until we either successfully
7077 // update $timestamp or decide we don't need to.
7078 let old_serial = $timestamp.load(Ordering::Acquire);
7079 if old_serial >= header.time as usize { break; }
7080 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
7086 max_time!(self.highest_seen_timestamp);
7087 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
7088 payment_secrets.retain(|_, inbound_payment| {
7089 inbound_payment.expiry_time > header.time as u64
7093 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
7094 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
7095 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
7096 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7097 let peer_state = &mut *peer_state_lock;
7098 for chan in peer_state.channel_by_id.values() {
7099 if let (Some(funding_txo), Some(block_hash)) = (chan.context.get_funding_txo(), chan.context.get_funding_tx_confirmed_in()) {
7100 res.push((funding_txo.txid, Some(block_hash)));
7107 fn transaction_unconfirmed(&self, txid: &Txid) {
7108 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
7109 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
7110 self.do_chain_event(None, |channel| {
7111 if let Some(funding_txo) = channel.context.get_funding_txo() {
7112 if funding_txo.txid == *txid {
7113 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
7114 } else { Ok((None, Vec::new(), None)) }
7115 } else { Ok((None, Vec::new(), None)) }
7120 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>
7122 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7123 T::Target: BroadcasterInterface,
7124 ES::Target: EntropySource,
7125 NS::Target: NodeSigner,
7126 SP::Target: SignerProvider,
7127 F::Target: FeeEstimator,
7131 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
7132 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
7134 fn do_chain_event<FN: Fn(&mut Channel<SP>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
7135 (&self, height_opt: Option<u32>, f: FN) {
7136 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
7137 // during initialization prior to the chain_monitor being fully configured in some cases.
7138 // See the docs for `ChannelManagerReadArgs` for more.
7140 let mut failed_channels = Vec::new();
7141 let mut timed_out_htlcs = Vec::new();
7143 let per_peer_state = self.per_peer_state.read().unwrap();
7144 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7145 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7146 let peer_state = &mut *peer_state_lock;
7147 let pending_msg_events = &mut peer_state.pending_msg_events;
7148 peer_state.channel_by_id.retain(|_, channel| {
7149 let res = f(channel);
7150 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
7151 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
7152 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
7153 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
7154 HTLCDestination::NextHopChannel { node_id: Some(channel.context.get_counterparty_node_id()), channel_id: channel.context.channel_id() }));
7156 if let Some(channel_ready) = channel_ready_opt {
7157 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
7158 if channel.context.is_usable() {
7159 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", &channel.context.channel_id());
7160 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
7161 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
7162 node_id: channel.context.get_counterparty_node_id(),
7167 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", &channel.context.channel_id());
7172 let mut pending_events = self.pending_events.lock().unwrap();
7173 emit_channel_ready_event!(pending_events, channel);
7176 if let Some(announcement_sigs) = announcement_sigs {
7177 log_trace!(self.logger, "Sending announcement_signatures for channel {}", &channel.context.channel_id());
7178 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
7179 node_id: channel.context.get_counterparty_node_id(),
7180 msg: announcement_sigs,
7182 if let Some(height) = height_opt {
7183 if let Some(announcement) = channel.get_signed_channel_announcement(&self.node_signer, self.genesis_hash, height, &self.default_configuration) {
7184 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
7186 // Note that announcement_signatures fails if the channel cannot be announced,
7187 // so get_channel_update_for_broadcast will never fail by the time we get here.
7188 update_msg: Some(self.get_channel_update_for_broadcast(channel).unwrap()),
7193 if channel.is_our_channel_ready() {
7194 if let Some(real_scid) = channel.context.get_short_channel_id() {
7195 // If we sent a 0conf channel_ready, and now have an SCID, we add it
7196 // to the short_to_chan_info map here. Note that we check whether we
7197 // can relay using the real SCID at relay-time (i.e.
7198 // enforce option_scid_alias then), and if the funding tx is ever
7199 // un-confirmed we force-close the channel, ensuring short_to_chan_info
7200 // is always consistent.
7201 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
7202 let scid_insert = short_to_chan_info.insert(real_scid, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
7203 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.context.get_counterparty_node_id(), channel.context.channel_id()),
7204 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
7205 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
7208 } else if let Err(reason) = res {
7209 update_maps_on_chan_removal!(self, &channel.context);
7210 // It looks like our counterparty went on-chain or funding transaction was
7211 // reorged out of the main chain. Close the channel.
7212 failed_channels.push(channel.context.force_shutdown(true));
7213 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
7214 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7218 let reason_message = format!("{}", reason);
7219 self.issue_channel_close_events(&channel.context, reason);
7220 pending_msg_events.push(events::MessageSendEvent::HandleError {
7221 node_id: channel.context.get_counterparty_node_id(),
7222 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
7223 channel_id: channel.context.channel_id(),
7224 data: reason_message,
7234 if let Some(height) = height_opt {
7235 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
7236 payment.htlcs.retain(|htlc| {
7237 // If height is approaching the number of blocks we think it takes us to get
7238 // our commitment transaction confirmed before the HTLC expires, plus the
7239 // number of blocks we generally consider it to take to do a commitment update,
7240 // just give up on it and fail the HTLC.
7241 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
7242 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
7243 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
7245 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
7246 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
7247 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
7251 !payment.htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
7254 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
7255 intercepted_htlcs.retain(|_, htlc| {
7256 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
7257 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
7258 short_channel_id: htlc.prev_short_channel_id,
7259 user_channel_id: Some(htlc.prev_user_channel_id),
7260 htlc_id: htlc.prev_htlc_id,
7261 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
7262 phantom_shared_secret: None,
7263 outpoint: htlc.prev_funding_outpoint,
7266 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
7267 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
7268 _ => unreachable!(),
7270 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
7271 HTLCFailReason::from_failure_code(0x2000 | 2),
7272 HTLCDestination::InvalidForward { requested_forward_scid }));
7273 log_trace!(self.logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
7279 self.handle_init_event_channel_failures(failed_channels);
7281 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
7282 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
7286 /// Gets a [`Future`] that completes when this [`ChannelManager`] needs to be persisted.
7288 /// Note that callbacks registered on the [`Future`] MUST NOT call back into this
7289 /// [`ChannelManager`] and should instead register actions to be taken later.
7291 pub fn get_persistable_update_future(&self) -> Future {
7292 self.persistence_notifier.get_future()
7295 #[cfg(any(test, feature = "_test_utils"))]
7296 pub fn get_persistence_condvar_value(&self) -> bool {
7297 self.persistence_notifier.notify_pending()
7300 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
7301 /// [`chain::Confirm`] interfaces.
7302 pub fn current_best_block(&self) -> BestBlock {
7303 self.best_block.read().unwrap().clone()
7306 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
7307 /// [`ChannelManager`].
7308 pub fn node_features(&self) -> NodeFeatures {
7309 provided_node_features(&self.default_configuration)
7312 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags which are provided by or required by
7313 /// [`ChannelManager`].
7315 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
7316 /// or not. Thus, this method is not public.
7317 #[cfg(any(feature = "_test_utils", test))]
7318 pub fn invoice_features(&self) -> Bolt11InvoiceFeatures {
7319 provided_invoice_features(&self.default_configuration)
7322 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
7323 /// [`ChannelManager`].
7324 pub fn channel_features(&self) -> ChannelFeatures {
7325 provided_channel_features(&self.default_configuration)
7328 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
7329 /// [`ChannelManager`].
7330 pub fn channel_type_features(&self) -> ChannelTypeFeatures {
7331 provided_channel_type_features(&self.default_configuration)
7334 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
7335 /// [`ChannelManager`].
7336 pub fn init_features(&self) -> InitFeatures {
7337 provided_init_features(&self.default_configuration)
7341 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7342 ChannelMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
7344 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7345 T::Target: BroadcasterInterface,
7346 ES::Target: EntropySource,
7347 NS::Target: NodeSigner,
7348 SP::Target: SignerProvider,
7349 F::Target: FeeEstimator,
7353 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) {
7354 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7355 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, msg), *counterparty_node_id);
7358 fn handle_open_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
7359 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7360 "Dual-funded channels not supported".to_owned(),
7361 msg.temporary_channel_id.clone())), *counterparty_node_id);
7364 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
7365 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7366 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, msg), *counterparty_node_id);
7369 fn handle_accept_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
7370 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7371 "Dual-funded channels not supported".to_owned(),
7372 msg.temporary_channel_id.clone())), *counterparty_node_id);
7375 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
7376 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7377 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
7380 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
7381 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7382 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
7385 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
7386 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7387 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
7390 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
7391 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7392 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
7395 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
7396 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7397 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
7400 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
7401 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7402 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
7405 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
7406 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7407 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
7410 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
7411 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7412 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
7415 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
7416 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7417 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
7420 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
7421 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7422 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
7425 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
7426 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7427 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
7430 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
7431 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7432 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
7435 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
7436 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7437 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
7440 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
7441 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
7442 let force_persist = self.process_background_events();
7443 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
7444 if force_persist == NotifyOption::DoPersist { NotifyOption::DoPersist } else { persist }
7446 NotifyOption::SkipPersist
7451 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
7452 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7453 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
7456 fn peer_disconnected(&self, counterparty_node_id: &PublicKey) {
7457 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7458 let mut failed_channels = Vec::new();
7459 let mut per_peer_state = self.per_peer_state.write().unwrap();
7461 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates.",
7462 log_pubkey!(counterparty_node_id));
7463 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
7464 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7465 let peer_state = &mut *peer_state_lock;
7466 let pending_msg_events = &mut peer_state.pending_msg_events;
7467 peer_state.channel_by_id.retain(|_, chan| {
7468 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
7469 if chan.is_shutdown() {
7470 update_maps_on_chan_removal!(self, &chan.context);
7471 self.issue_channel_close_events(&chan.context, ClosureReason::DisconnectedPeer);
7476 peer_state.inbound_v1_channel_by_id.retain(|_, chan| {
7477 update_maps_on_chan_removal!(self, &chan.context);
7478 self.issue_channel_close_events(&chan.context, ClosureReason::DisconnectedPeer);
7481 peer_state.outbound_v1_channel_by_id.retain(|_, chan| {
7482 update_maps_on_chan_removal!(self, &chan.context);
7483 self.issue_channel_close_events(&chan.context, ClosureReason::DisconnectedPeer);
7486 // Note that we don't bother generating any events for pre-accept channels -
7487 // they're not considered "channels" yet from the PoV of our events interface.
7488 peer_state.inbound_channel_request_by_id.clear();
7489 pending_msg_events.retain(|msg| {
7491 // V1 Channel Establishment
7492 &events::MessageSendEvent::SendAcceptChannel { .. } => false,
7493 &events::MessageSendEvent::SendOpenChannel { .. } => false,
7494 &events::MessageSendEvent::SendFundingCreated { .. } => false,
7495 &events::MessageSendEvent::SendFundingSigned { .. } => false,
7496 // V2 Channel Establishment
7497 &events::MessageSendEvent::SendAcceptChannelV2 { .. } => false,
7498 &events::MessageSendEvent::SendOpenChannelV2 { .. } => false,
7499 // Common Channel Establishment
7500 &events::MessageSendEvent::SendChannelReady { .. } => false,
7501 &events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
7502 // Interactive Transaction Construction
7503 &events::MessageSendEvent::SendTxAddInput { .. } => false,
7504 &events::MessageSendEvent::SendTxAddOutput { .. } => false,
7505 &events::MessageSendEvent::SendTxRemoveInput { .. } => false,
7506 &events::MessageSendEvent::SendTxRemoveOutput { .. } => false,
7507 &events::MessageSendEvent::SendTxComplete { .. } => false,
7508 &events::MessageSendEvent::SendTxSignatures { .. } => false,
7509 &events::MessageSendEvent::SendTxInitRbf { .. } => false,
7510 &events::MessageSendEvent::SendTxAckRbf { .. } => false,
7511 &events::MessageSendEvent::SendTxAbort { .. } => false,
7512 // Channel Operations
7513 &events::MessageSendEvent::UpdateHTLCs { .. } => false,
7514 &events::MessageSendEvent::SendRevokeAndACK { .. } => false,
7515 &events::MessageSendEvent::SendClosingSigned { .. } => false,
7516 &events::MessageSendEvent::SendShutdown { .. } => false,
7517 &events::MessageSendEvent::SendChannelReestablish { .. } => false,
7518 &events::MessageSendEvent::HandleError { .. } => false,
7520 &events::MessageSendEvent::SendChannelAnnouncement { .. } => false,
7521 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
7522 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
7523 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
7524 &events::MessageSendEvent::SendChannelUpdate { .. } => false,
7525 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
7526 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
7527 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
7528 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
7531 debug_assert!(peer_state.is_connected, "A disconnected peer cannot disconnect");
7532 peer_state.is_connected = false;
7533 peer_state.ok_to_remove(true)
7534 } else { debug_assert!(false, "Unconnected peer disconnected"); true }
7537 per_peer_state.remove(counterparty_node_id);
7539 mem::drop(per_peer_state);
7541 for failure in failed_channels.drain(..) {
7542 self.finish_force_close_channel(failure);
7546 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init, inbound: bool) -> Result<(), ()> {
7547 if !init_msg.features.supports_static_remote_key() {
7548 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting", log_pubkey!(counterparty_node_id));
7552 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7554 // If we have too many peers connected which don't have funded channels, disconnect the
7555 // peer immediately (as long as it doesn't have funded channels). If we have a bunch of
7556 // unfunded channels taking up space in memory for disconnected peers, we still let new
7557 // peers connect, but we'll reject new channels from them.
7558 let connected_peers_without_funded_channels = self.peers_without_funded_channels(|node| node.is_connected);
7559 let inbound_peer_limited = inbound && connected_peers_without_funded_channels >= MAX_NO_CHANNEL_PEERS;
7562 let mut peer_state_lock = self.per_peer_state.write().unwrap();
7563 match peer_state_lock.entry(counterparty_node_id.clone()) {
7564 hash_map::Entry::Vacant(e) => {
7565 if inbound_peer_limited {
7568 e.insert(Mutex::new(PeerState {
7569 channel_by_id: HashMap::new(),
7570 outbound_v1_channel_by_id: HashMap::new(),
7571 inbound_v1_channel_by_id: HashMap::new(),
7572 inbound_channel_request_by_id: HashMap::new(),
7573 latest_features: init_msg.features.clone(),
7574 pending_msg_events: Vec::new(),
7575 in_flight_monitor_updates: BTreeMap::new(),
7576 monitor_update_blocked_actions: BTreeMap::new(),
7577 actions_blocking_raa_monitor_updates: BTreeMap::new(),
7581 hash_map::Entry::Occupied(e) => {
7582 let mut peer_state = e.get().lock().unwrap();
7583 peer_state.latest_features = init_msg.features.clone();
7585 let best_block_height = self.best_block.read().unwrap().height();
7586 if inbound_peer_limited &&
7587 Self::unfunded_channel_count(&*peer_state, best_block_height) ==
7588 peer_state.channel_by_id.len()
7593 debug_assert!(!peer_state.is_connected, "A peer shouldn't be connected twice");
7594 peer_state.is_connected = true;
7599 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
7601 let per_peer_state = self.per_peer_state.read().unwrap();
7602 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
7603 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7604 let peer_state = &mut *peer_state_lock;
7605 let pending_msg_events = &mut peer_state.pending_msg_events;
7607 // Since unfunded channel maps are cleared upon disconnecting a peer, and they're not persisted
7608 // (so won't be recovered after a crash) we don't need to bother closing unfunded channels and
7609 // clearing their maps here. Instead we can just send queue channel_reestablish messages for
7610 // channels in the channel_by_id map.
7611 peer_state.channel_by_id.iter_mut().for_each(|(_, chan)| {
7612 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
7613 node_id: chan.context.get_counterparty_node_id(),
7614 msg: chan.get_channel_reestablish(&self.logger),
7618 //TODO: Also re-broadcast announcement_signatures
7622 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
7623 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7625 match &msg.data as &str {
7626 "cannot co-op close channel w/ active htlcs"|
7627 "link failed to shutdown" =>
7629 // LND hasn't properly handled shutdown messages ever, and force-closes any time we
7630 // send one while HTLCs are still present. The issue is tracked at
7631 // https://github.com/lightningnetwork/lnd/issues/6039 and has had multiple patches
7632 // to fix it but none so far have managed to land upstream. The issue appears to be
7633 // very low priority for the LND team despite being marked "P1".
7634 // We're not going to bother handling this in a sensible way, instead simply
7635 // repeating the Shutdown message on repeat until morale improves.
7636 if !msg.channel_id.is_zero() {
7637 let per_peer_state = self.per_peer_state.read().unwrap();
7638 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
7639 if peer_state_mutex_opt.is_none() { return; }
7640 let mut peer_state = peer_state_mutex_opt.unwrap().lock().unwrap();
7641 if let Some(chan) = peer_state.channel_by_id.get(&msg.channel_id) {
7642 if let Some(msg) = chan.get_outbound_shutdown() {
7643 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
7644 node_id: *counterparty_node_id,
7648 peer_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
7649 node_id: *counterparty_node_id,
7650 action: msgs::ErrorAction::SendWarningMessage {
7651 msg: msgs::WarningMessage {
7652 channel_id: msg.channel_id,
7653 data: "You appear to be exhibiting LND bug 6039, we'll keep sending you shutdown messages until you handle them correctly".to_owned()
7655 log_level: Level::Trace,
7665 if msg.channel_id.is_zero() {
7666 let channel_ids: Vec<ChannelId> = {
7667 let per_peer_state = self.per_peer_state.read().unwrap();
7668 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
7669 if peer_state_mutex_opt.is_none() { return; }
7670 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
7671 let peer_state = &mut *peer_state_lock;
7672 // Note that we don't bother generating any events for pre-accept channels -
7673 // they're not considered "channels" yet from the PoV of our events interface.
7674 peer_state.inbound_channel_request_by_id.clear();
7675 peer_state.channel_by_id.keys().cloned()
7676 .chain(peer_state.outbound_v1_channel_by_id.keys().cloned())
7677 .chain(peer_state.inbound_v1_channel_by_id.keys().cloned()).collect()
7679 for channel_id in channel_ids {
7680 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
7681 let _ = self.force_close_channel_with_peer(&channel_id, counterparty_node_id, Some(&msg.data), true);
7685 // First check if we can advance the channel type and try again.
7686 let per_peer_state = self.per_peer_state.read().unwrap();
7687 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
7688 if peer_state_mutex_opt.is_none() { return; }
7689 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
7690 let peer_state = &mut *peer_state_lock;
7691 if let Some(chan) = peer_state.outbound_v1_channel_by_id.get_mut(&msg.channel_id) {
7692 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash, &self.fee_estimator) {
7693 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
7694 node_id: *counterparty_node_id,
7702 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
7703 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
7707 fn provided_node_features(&self) -> NodeFeatures {
7708 provided_node_features(&self.default_configuration)
7711 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
7712 provided_init_features(&self.default_configuration)
7715 fn get_genesis_hashes(&self) -> Option<Vec<ChainHash>> {
7716 Some(vec![ChainHash::from(&self.genesis_hash[..])])
7719 fn handle_tx_add_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddInput) {
7720 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7721 "Dual-funded channels not supported".to_owned(),
7722 msg.channel_id.clone())), *counterparty_node_id);
7725 fn handle_tx_add_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
7726 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7727 "Dual-funded channels not supported".to_owned(),
7728 msg.channel_id.clone())), *counterparty_node_id);
7731 fn handle_tx_remove_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
7732 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7733 "Dual-funded channels not supported".to_owned(),
7734 msg.channel_id.clone())), *counterparty_node_id);
7737 fn handle_tx_remove_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
7738 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7739 "Dual-funded channels not supported".to_owned(),
7740 msg.channel_id.clone())), *counterparty_node_id);
7743 fn handle_tx_complete(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxComplete) {
7744 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7745 "Dual-funded channels not supported".to_owned(),
7746 msg.channel_id.clone())), *counterparty_node_id);
7749 fn handle_tx_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxSignatures) {
7750 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7751 "Dual-funded channels not supported".to_owned(),
7752 msg.channel_id.clone())), *counterparty_node_id);
7755 fn handle_tx_init_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
7756 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7757 "Dual-funded channels not supported".to_owned(),
7758 msg.channel_id.clone())), *counterparty_node_id);
7761 fn handle_tx_ack_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
7762 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7763 "Dual-funded channels not supported".to_owned(),
7764 msg.channel_id.clone())), *counterparty_node_id);
7767 fn handle_tx_abort(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAbort) {
7768 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7769 "Dual-funded channels not supported".to_owned(),
7770 msg.channel_id.clone())), *counterparty_node_id);
7774 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
7775 /// [`ChannelManager`].
7776 pub(crate) fn provided_node_features(config: &UserConfig) -> NodeFeatures {
7777 let mut node_features = provided_init_features(config).to_context();
7778 node_features.set_keysend_optional();
7782 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags which are provided by or required by
7783 /// [`ChannelManager`].
7785 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
7786 /// or not. Thus, this method is not public.
7787 #[cfg(any(feature = "_test_utils", test))]
7788 pub(crate) fn provided_invoice_features(config: &UserConfig) -> Bolt11InvoiceFeatures {
7789 provided_init_features(config).to_context()
7792 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
7793 /// [`ChannelManager`].
7794 pub(crate) fn provided_channel_features(config: &UserConfig) -> ChannelFeatures {
7795 provided_init_features(config).to_context()
7798 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
7799 /// [`ChannelManager`].
7800 pub(crate) fn provided_channel_type_features(config: &UserConfig) -> ChannelTypeFeatures {
7801 ChannelTypeFeatures::from_init(&provided_init_features(config))
7804 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
7805 /// [`ChannelManager`].
7806 pub fn provided_init_features(config: &UserConfig) -> InitFeatures {
7807 // Note that if new features are added here which other peers may (eventually) require, we
7808 // should also add the corresponding (optional) bit to the [`ChannelMessageHandler`] impl for
7809 // [`ErroringMessageHandler`].
7810 let mut features = InitFeatures::empty();
7811 features.set_data_loss_protect_required();
7812 features.set_upfront_shutdown_script_optional();
7813 features.set_variable_length_onion_required();
7814 features.set_static_remote_key_required();
7815 features.set_payment_secret_required();
7816 features.set_basic_mpp_optional();
7817 features.set_wumbo_optional();
7818 features.set_shutdown_any_segwit_optional();
7819 features.set_channel_type_optional();
7820 features.set_scid_privacy_optional();
7821 features.set_zero_conf_optional();
7822 if config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx {
7823 features.set_anchors_zero_fee_htlc_tx_optional();
7828 const SERIALIZATION_VERSION: u8 = 1;
7829 const MIN_SERIALIZATION_VERSION: u8 = 1;
7831 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
7832 (2, fee_base_msat, required),
7833 (4, fee_proportional_millionths, required),
7834 (6, cltv_expiry_delta, required),
7837 impl_writeable_tlv_based!(ChannelCounterparty, {
7838 (2, node_id, required),
7839 (4, features, required),
7840 (6, unspendable_punishment_reserve, required),
7841 (8, forwarding_info, option),
7842 (9, outbound_htlc_minimum_msat, option),
7843 (11, outbound_htlc_maximum_msat, option),
7846 impl Writeable for ChannelDetails {
7847 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
7848 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
7849 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
7850 let user_channel_id_low = self.user_channel_id as u64;
7851 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
7852 write_tlv_fields!(writer, {
7853 (1, self.inbound_scid_alias, option),
7854 (2, self.channel_id, required),
7855 (3, self.channel_type, option),
7856 (4, self.counterparty, required),
7857 (5, self.outbound_scid_alias, option),
7858 (6, self.funding_txo, option),
7859 (7, self.config, option),
7860 (8, self.short_channel_id, option),
7861 (9, self.confirmations, option),
7862 (10, self.channel_value_satoshis, required),
7863 (12, self.unspendable_punishment_reserve, option),
7864 (14, user_channel_id_low, required),
7865 (16, self.next_outbound_htlc_limit_msat, required), // Forwards compatibility for removed balance_msat field.
7866 (18, self.outbound_capacity_msat, required),
7867 (19, self.next_outbound_htlc_limit_msat, required),
7868 (20, self.inbound_capacity_msat, required),
7869 (21, self.next_outbound_htlc_minimum_msat, required),
7870 (22, self.confirmations_required, option),
7871 (24, self.force_close_spend_delay, option),
7872 (26, self.is_outbound, required),
7873 (28, self.is_channel_ready, required),
7874 (30, self.is_usable, required),
7875 (32, self.is_public, required),
7876 (33, self.inbound_htlc_minimum_msat, option),
7877 (35, self.inbound_htlc_maximum_msat, option),
7878 (37, user_channel_id_high_opt, option),
7879 (39, self.feerate_sat_per_1000_weight, option),
7880 (41, self.channel_shutdown_state, option),
7886 impl Readable for ChannelDetails {
7887 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
7888 _init_and_read_len_prefixed_tlv_fields!(reader, {
7889 (1, inbound_scid_alias, option),
7890 (2, channel_id, required),
7891 (3, channel_type, option),
7892 (4, counterparty, required),
7893 (5, outbound_scid_alias, option),
7894 (6, funding_txo, option),
7895 (7, config, option),
7896 (8, short_channel_id, option),
7897 (9, confirmations, option),
7898 (10, channel_value_satoshis, required),
7899 (12, unspendable_punishment_reserve, option),
7900 (14, user_channel_id_low, required),
7901 (16, _balance_msat, option), // Backwards compatibility for removed balance_msat field.
7902 (18, outbound_capacity_msat, required),
7903 // Note that by the time we get past the required read above, outbound_capacity_msat will be
7904 // filled in, so we can safely unwrap it here.
7905 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
7906 (20, inbound_capacity_msat, required),
7907 (21, next_outbound_htlc_minimum_msat, (default_value, 0)),
7908 (22, confirmations_required, option),
7909 (24, force_close_spend_delay, option),
7910 (26, is_outbound, required),
7911 (28, is_channel_ready, required),
7912 (30, is_usable, required),
7913 (32, is_public, required),
7914 (33, inbound_htlc_minimum_msat, option),
7915 (35, inbound_htlc_maximum_msat, option),
7916 (37, user_channel_id_high_opt, option),
7917 (39, feerate_sat_per_1000_weight, option),
7918 (41, channel_shutdown_state, option),
7921 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
7922 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
7923 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
7924 let user_channel_id = user_channel_id_low as u128 +
7925 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
7927 let _balance_msat: Option<u64> = _balance_msat;
7931 channel_id: channel_id.0.unwrap(),
7933 counterparty: counterparty.0.unwrap(),
7934 outbound_scid_alias,
7938 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
7939 unspendable_punishment_reserve,
7941 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
7942 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
7943 next_outbound_htlc_minimum_msat: next_outbound_htlc_minimum_msat.0.unwrap(),
7944 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
7945 confirmations_required,
7947 force_close_spend_delay,
7948 is_outbound: is_outbound.0.unwrap(),
7949 is_channel_ready: is_channel_ready.0.unwrap(),
7950 is_usable: is_usable.0.unwrap(),
7951 is_public: is_public.0.unwrap(),
7952 inbound_htlc_minimum_msat,
7953 inbound_htlc_maximum_msat,
7954 feerate_sat_per_1000_weight,
7955 channel_shutdown_state,
7960 impl_writeable_tlv_based!(PhantomRouteHints, {
7961 (2, channels, required_vec),
7962 (4, phantom_scid, required),
7963 (6, real_node_pubkey, required),
7966 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
7968 (0, onion_packet, required),
7969 (2, short_channel_id, required),
7972 (0, payment_data, required),
7973 (1, phantom_shared_secret, option),
7974 (2, incoming_cltv_expiry, required),
7975 (3, payment_metadata, option),
7976 (5, custom_tlvs, optional_vec),
7978 (2, ReceiveKeysend) => {
7979 (0, payment_preimage, required),
7980 (2, incoming_cltv_expiry, required),
7981 (3, payment_metadata, option),
7982 (4, payment_data, option), // Added in 0.0.116
7983 (5, custom_tlvs, optional_vec),
7987 impl_writeable_tlv_based!(PendingHTLCInfo, {
7988 (0, routing, required),
7989 (2, incoming_shared_secret, required),
7990 (4, payment_hash, required),
7991 (6, outgoing_amt_msat, required),
7992 (8, outgoing_cltv_value, required),
7993 (9, incoming_amt_msat, option),
7994 (10, skimmed_fee_msat, option),
7998 impl Writeable for HTLCFailureMsg {
7999 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8001 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
8003 channel_id.write(writer)?;
8004 htlc_id.write(writer)?;
8005 reason.write(writer)?;
8007 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
8008 channel_id, htlc_id, sha256_of_onion, failure_code
8011 channel_id.write(writer)?;
8012 htlc_id.write(writer)?;
8013 sha256_of_onion.write(writer)?;
8014 failure_code.write(writer)?;
8021 impl Readable for HTLCFailureMsg {
8022 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8023 let id: u8 = Readable::read(reader)?;
8026 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
8027 channel_id: Readable::read(reader)?,
8028 htlc_id: Readable::read(reader)?,
8029 reason: Readable::read(reader)?,
8033 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
8034 channel_id: Readable::read(reader)?,
8035 htlc_id: Readable::read(reader)?,
8036 sha256_of_onion: Readable::read(reader)?,
8037 failure_code: Readable::read(reader)?,
8040 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
8041 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
8042 // messages contained in the variants.
8043 // In version 0.0.101, support for reading the variants with these types was added, and
8044 // we should migrate to writing these variants when UpdateFailHTLC or
8045 // UpdateFailMalformedHTLC get TLV fields.
8047 let length: BigSize = Readable::read(reader)?;
8048 let mut s = FixedLengthReader::new(reader, length.0);
8049 let res = Readable::read(&mut s)?;
8050 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
8051 Ok(HTLCFailureMsg::Relay(res))
8054 let length: BigSize = Readable::read(reader)?;
8055 let mut s = FixedLengthReader::new(reader, length.0);
8056 let res = Readable::read(&mut s)?;
8057 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
8058 Ok(HTLCFailureMsg::Malformed(res))
8060 _ => Err(DecodeError::UnknownRequiredFeature),
8065 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
8070 impl_writeable_tlv_based!(HTLCPreviousHopData, {
8071 (0, short_channel_id, required),
8072 (1, phantom_shared_secret, option),
8073 (2, outpoint, required),
8074 (4, htlc_id, required),
8075 (6, incoming_packet_shared_secret, required),
8076 (7, user_channel_id, option),
8079 impl Writeable for ClaimableHTLC {
8080 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8081 let (payment_data, keysend_preimage) = match &self.onion_payload {
8082 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
8083 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
8085 write_tlv_fields!(writer, {
8086 (0, self.prev_hop, required),
8087 (1, self.total_msat, required),
8088 (2, self.value, required),
8089 (3, self.sender_intended_value, required),
8090 (4, payment_data, option),
8091 (5, self.total_value_received, option),
8092 (6, self.cltv_expiry, required),
8093 (8, keysend_preimage, option),
8094 (10, self.counterparty_skimmed_fee_msat, option),
8100 impl Readable for ClaimableHTLC {
8101 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8102 _init_and_read_len_prefixed_tlv_fields!(reader, {
8103 (0, prev_hop, required),
8104 (1, total_msat, option),
8105 (2, value_ser, required),
8106 (3, sender_intended_value, option),
8107 (4, payment_data_opt, option),
8108 (5, total_value_received, option),
8109 (6, cltv_expiry, required),
8110 (8, keysend_preimage, option),
8111 (10, counterparty_skimmed_fee_msat, option),
8113 let payment_data: Option<msgs::FinalOnionHopData> = payment_data_opt;
8114 let value = value_ser.0.unwrap();
8115 let onion_payload = match keysend_preimage {
8117 if payment_data.is_some() {
8118 return Err(DecodeError::InvalidValue)
8120 if total_msat.is_none() {
8121 total_msat = Some(value);
8123 OnionPayload::Spontaneous(p)
8126 if total_msat.is_none() {
8127 if payment_data.is_none() {
8128 return Err(DecodeError::InvalidValue)
8130 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
8132 OnionPayload::Invoice { _legacy_hop_data: payment_data }
8136 prev_hop: prev_hop.0.unwrap(),
8139 sender_intended_value: sender_intended_value.unwrap_or(value),
8140 total_value_received,
8141 total_msat: total_msat.unwrap(),
8143 cltv_expiry: cltv_expiry.0.unwrap(),
8144 counterparty_skimmed_fee_msat,
8149 impl Readable for HTLCSource {
8150 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8151 let id: u8 = Readable::read(reader)?;
8154 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
8155 let mut first_hop_htlc_msat: u64 = 0;
8156 let mut path_hops = Vec::new();
8157 let mut payment_id = None;
8158 let mut payment_params: Option<PaymentParameters> = None;
8159 let mut blinded_tail: Option<BlindedTail> = None;
8160 read_tlv_fields!(reader, {
8161 (0, session_priv, required),
8162 (1, payment_id, option),
8163 (2, first_hop_htlc_msat, required),
8164 (4, path_hops, required_vec),
8165 (5, payment_params, (option: ReadableArgs, 0)),
8166 (6, blinded_tail, option),
8168 if payment_id.is_none() {
8169 // For backwards compat, if there was no payment_id written, use the session_priv bytes
8171 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
8173 let path = Path { hops: path_hops, blinded_tail };
8174 if path.hops.len() == 0 {
8175 return Err(DecodeError::InvalidValue);
8177 if let Some(params) = payment_params.as_mut() {
8178 if let Payee::Clear { ref mut final_cltv_expiry_delta, .. } = params.payee {
8179 if final_cltv_expiry_delta == &0 {
8180 *final_cltv_expiry_delta = path.final_cltv_expiry_delta().ok_or(DecodeError::InvalidValue)?;
8184 Ok(HTLCSource::OutboundRoute {
8185 session_priv: session_priv.0.unwrap(),
8186 first_hop_htlc_msat,
8188 payment_id: payment_id.unwrap(),
8191 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
8192 _ => Err(DecodeError::UnknownRequiredFeature),
8197 impl Writeable for HTLCSource {
8198 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
8200 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id } => {
8202 let payment_id_opt = Some(payment_id);
8203 write_tlv_fields!(writer, {
8204 (0, session_priv, required),
8205 (1, payment_id_opt, option),
8206 (2, first_hop_htlc_msat, required),
8207 // 3 was previously used to write a PaymentSecret for the payment.
8208 (4, path.hops, required_vec),
8209 (5, None::<PaymentParameters>, option), // payment_params in LDK versions prior to 0.0.115
8210 (6, path.blinded_tail, option),
8213 HTLCSource::PreviousHopData(ref field) => {
8215 field.write(writer)?;
8222 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
8223 (0, forward_info, required),
8224 (1, prev_user_channel_id, (default_value, 0)),
8225 (2, prev_short_channel_id, required),
8226 (4, prev_htlc_id, required),
8227 (6, prev_funding_outpoint, required),
8230 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
8232 (0, htlc_id, required),
8233 (2, err_packet, required),
8238 impl_writeable_tlv_based!(PendingInboundPayment, {
8239 (0, payment_secret, required),
8240 (2, expiry_time, required),
8241 (4, user_payment_id, required),
8242 (6, payment_preimage, required),
8243 (8, min_value_msat, required),
8246 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>
8248 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8249 T::Target: BroadcasterInterface,
8250 ES::Target: EntropySource,
8251 NS::Target: NodeSigner,
8252 SP::Target: SignerProvider,
8253 F::Target: FeeEstimator,
8257 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8258 let _consistency_lock = self.total_consistency_lock.write().unwrap();
8260 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
8262 self.genesis_hash.write(writer)?;
8264 let best_block = self.best_block.read().unwrap();
8265 best_block.height().write(writer)?;
8266 best_block.block_hash().write(writer)?;
8269 let mut serializable_peer_count: u64 = 0;
8271 let per_peer_state = self.per_peer_state.read().unwrap();
8272 let mut unfunded_channels = 0;
8273 let mut number_of_channels = 0;
8274 for (_, peer_state_mutex) in per_peer_state.iter() {
8275 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8276 let peer_state = &mut *peer_state_lock;
8277 if !peer_state.ok_to_remove(false) {
8278 serializable_peer_count += 1;
8280 number_of_channels += peer_state.channel_by_id.len();
8281 for (_, channel) in peer_state.channel_by_id.iter() {
8282 if !channel.context.is_funding_initiated() {
8283 unfunded_channels += 1;
8288 ((number_of_channels - unfunded_channels) as u64).write(writer)?;
8290 for (_, peer_state_mutex) in per_peer_state.iter() {
8291 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8292 let peer_state = &mut *peer_state_lock;
8293 for (_, channel) in peer_state.channel_by_id.iter() {
8294 if channel.context.is_funding_initiated() {
8295 channel.write(writer)?;
8302 let forward_htlcs = self.forward_htlcs.lock().unwrap();
8303 (forward_htlcs.len() as u64).write(writer)?;
8304 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
8305 short_channel_id.write(writer)?;
8306 (pending_forwards.len() as u64).write(writer)?;
8307 for forward in pending_forwards {
8308 forward.write(writer)?;
8313 let per_peer_state = self.per_peer_state.write().unwrap();
8315 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
8316 let claimable_payments = self.claimable_payments.lock().unwrap();
8317 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
8319 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
8320 let mut htlc_onion_fields: Vec<&_> = Vec::new();
8321 (claimable_payments.claimable_payments.len() as u64).write(writer)?;
8322 for (payment_hash, payment) in claimable_payments.claimable_payments.iter() {
8323 payment_hash.write(writer)?;
8324 (payment.htlcs.len() as u64).write(writer)?;
8325 for htlc in payment.htlcs.iter() {
8326 htlc.write(writer)?;
8328 htlc_purposes.push(&payment.purpose);
8329 htlc_onion_fields.push(&payment.onion_fields);
8332 let mut monitor_update_blocked_actions_per_peer = None;
8333 let mut peer_states = Vec::new();
8334 for (_, peer_state_mutex) in per_peer_state.iter() {
8335 // Because we're holding the owning `per_peer_state` write lock here there's no chance
8336 // of a lockorder violation deadlock - no other thread can be holding any
8337 // per_peer_state lock at all.
8338 peer_states.push(peer_state_mutex.unsafe_well_ordered_double_lock_self());
8341 (serializable_peer_count).write(writer)?;
8342 for ((peer_pubkey, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
8343 // Peers which we have no channels to should be dropped once disconnected. As we
8344 // disconnect all peers when shutting down and serializing the ChannelManager, we
8345 // consider all peers as disconnected here. There's therefore no need write peers with
8347 if !peer_state.ok_to_remove(false) {
8348 peer_pubkey.write(writer)?;
8349 peer_state.latest_features.write(writer)?;
8350 if !peer_state.monitor_update_blocked_actions.is_empty() {
8351 monitor_update_blocked_actions_per_peer
8352 .get_or_insert_with(Vec::new)
8353 .push((*peer_pubkey, &peer_state.monitor_update_blocked_actions));
8358 let events = self.pending_events.lock().unwrap();
8359 // LDK versions prior to 0.0.115 don't support post-event actions, thus if there's no
8360 // actions at all, skip writing the required TLV. Otherwise, pre-0.0.115 versions will
8361 // refuse to read the new ChannelManager.
8362 let events_not_backwards_compatible = events.iter().any(|(_, action)| action.is_some());
8363 if events_not_backwards_compatible {
8364 // If we're gonna write a even TLV that will overwrite our events anyway we might as
8365 // well save the space and not write any events here.
8366 0u64.write(writer)?;
8368 (events.len() as u64).write(writer)?;
8369 for (event, _) in events.iter() {
8370 event.write(writer)?;
8374 // LDK versions prior to 0.0.116 wrote the `pending_background_events`
8375 // `MonitorUpdateRegeneratedOnStartup`s here, however there was never a reason to do so -
8376 // the closing monitor updates were always effectively replayed on startup (either directly
8377 // by calling `broadcast_latest_holder_commitment_txn` on a `ChannelMonitor` during
8378 // deserialization or, in 0.0.115, by regenerating the monitor update itself).
8379 0u64.write(writer)?;
8381 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
8382 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
8383 // likely to be identical.
8384 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
8385 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
8387 (pending_inbound_payments.len() as u64).write(writer)?;
8388 for (hash, pending_payment) in pending_inbound_payments.iter() {
8389 hash.write(writer)?;
8390 pending_payment.write(writer)?;
8393 // For backwards compat, write the session privs and their total length.
8394 let mut num_pending_outbounds_compat: u64 = 0;
8395 for (_, outbound) in pending_outbound_payments.iter() {
8396 if !outbound.is_fulfilled() && !outbound.abandoned() {
8397 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
8400 num_pending_outbounds_compat.write(writer)?;
8401 for (_, outbound) in pending_outbound_payments.iter() {
8403 PendingOutboundPayment::Legacy { session_privs } |
8404 PendingOutboundPayment::Retryable { session_privs, .. } => {
8405 for session_priv in session_privs.iter() {
8406 session_priv.write(writer)?;
8409 PendingOutboundPayment::Fulfilled { .. } => {},
8410 PendingOutboundPayment::Abandoned { .. } => {},
8414 // Encode without retry info for 0.0.101 compatibility.
8415 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
8416 for (id, outbound) in pending_outbound_payments.iter() {
8418 PendingOutboundPayment::Legacy { session_privs } |
8419 PendingOutboundPayment::Retryable { session_privs, .. } => {
8420 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
8426 let mut pending_intercepted_htlcs = None;
8427 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
8428 if our_pending_intercepts.len() != 0 {
8429 pending_intercepted_htlcs = Some(our_pending_intercepts);
8432 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
8433 if pending_claiming_payments.as_ref().unwrap().is_empty() {
8434 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
8435 // map. Thus, if there are no entries we skip writing a TLV for it.
8436 pending_claiming_payments = None;
8439 let mut in_flight_monitor_updates: Option<HashMap<(&PublicKey, &OutPoint), &Vec<ChannelMonitorUpdate>>> = None;
8440 for ((counterparty_id, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
8441 for (funding_outpoint, updates) in peer_state.in_flight_monitor_updates.iter() {
8442 if !updates.is_empty() {
8443 if in_flight_monitor_updates.is_none() { in_flight_monitor_updates = Some(HashMap::new()); }
8444 in_flight_monitor_updates.as_mut().unwrap().insert((counterparty_id, funding_outpoint), updates);
8449 write_tlv_fields!(writer, {
8450 (1, pending_outbound_payments_no_retry, required),
8451 (2, pending_intercepted_htlcs, option),
8452 (3, pending_outbound_payments, required),
8453 (4, pending_claiming_payments, option),
8454 (5, self.our_network_pubkey, required),
8455 (6, monitor_update_blocked_actions_per_peer, option),
8456 (7, self.fake_scid_rand_bytes, required),
8457 (8, if events_not_backwards_compatible { Some(&*events) } else { None }, option),
8458 (9, htlc_purposes, required_vec),
8459 (10, in_flight_monitor_updates, option),
8460 (11, self.probing_cookie_secret, required),
8461 (13, htlc_onion_fields, optional_vec),
8468 impl Writeable for VecDeque<(Event, Option<EventCompletionAction>)> {
8469 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
8470 (self.len() as u64).write(w)?;
8471 for (event, action) in self.iter() {
8474 #[cfg(debug_assertions)] {
8475 // Events are MaybeReadable, in some cases indicating that they shouldn't actually
8476 // be persisted and are regenerated on restart. However, if such an event has a
8477 // post-event-handling action we'll write nothing for the event and would have to
8478 // either forget the action or fail on deserialization (which we do below). Thus,
8479 // check that the event is sane here.
8480 let event_encoded = event.encode();
8481 let event_read: Option<Event> =
8482 MaybeReadable::read(&mut &event_encoded[..]).unwrap();
8483 if action.is_some() { assert!(event_read.is_some()); }
8489 impl Readable for VecDeque<(Event, Option<EventCompletionAction>)> {
8490 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8491 let len: u64 = Readable::read(reader)?;
8492 const MAX_ALLOC_SIZE: u64 = 1024 * 16;
8493 let mut events: Self = VecDeque::with_capacity(cmp::min(
8494 MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>() as u64,
8497 let ev_opt = MaybeReadable::read(reader)?;
8498 let action = Readable::read(reader)?;
8499 if let Some(ev) = ev_opt {
8500 events.push_back((ev, action));
8501 } else if action.is_some() {
8502 return Err(DecodeError::InvalidValue);
8509 impl_writeable_tlv_based_enum!(ChannelShutdownState,
8510 (0, NotShuttingDown) => {},
8511 (2, ShutdownInitiated) => {},
8512 (4, ResolvingHTLCs) => {},
8513 (6, NegotiatingClosingFee) => {},
8514 (8, ShutdownComplete) => {}, ;
8517 /// Arguments for the creation of a ChannelManager that are not deserialized.
8519 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
8521 /// 1) Deserialize all stored [`ChannelMonitor`]s.
8522 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
8523 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
8524 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
8525 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
8526 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
8527 /// same way you would handle a [`chain::Filter`] call using
8528 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
8529 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
8530 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
8531 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
8532 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
8533 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
8535 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
8536 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
8538 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
8539 /// call any other methods on the newly-deserialized [`ChannelManager`].
8541 /// Note that because some channels may be closed during deserialization, it is critical that you
8542 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
8543 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
8544 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
8545 /// not force-close the same channels but consider them live), you may end up revoking a state for
8546 /// which you've already broadcasted the transaction.
8548 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
8549 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8551 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8552 T::Target: BroadcasterInterface,
8553 ES::Target: EntropySource,
8554 NS::Target: NodeSigner,
8555 SP::Target: SignerProvider,
8556 F::Target: FeeEstimator,
8560 /// A cryptographically secure source of entropy.
8561 pub entropy_source: ES,
8563 /// A signer that is able to perform node-scoped cryptographic operations.
8564 pub node_signer: NS,
8566 /// The keys provider which will give us relevant keys. Some keys will be loaded during
8567 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
8569 pub signer_provider: SP,
8571 /// The fee_estimator for use in the ChannelManager in the future.
8573 /// No calls to the FeeEstimator will be made during deserialization.
8574 pub fee_estimator: F,
8575 /// The chain::Watch for use in the ChannelManager in the future.
8577 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
8578 /// you have deserialized ChannelMonitors separately and will add them to your
8579 /// chain::Watch after deserializing this ChannelManager.
8580 pub chain_monitor: M,
8582 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
8583 /// used to broadcast the latest local commitment transactions of channels which must be
8584 /// force-closed during deserialization.
8585 pub tx_broadcaster: T,
8586 /// The router which will be used in the ChannelManager in the future for finding routes
8587 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
8589 /// No calls to the router will be made during deserialization.
8591 /// The Logger for use in the ChannelManager and which may be used to log information during
8592 /// deserialization.
8594 /// Default settings used for new channels. Any existing channels will continue to use the
8595 /// runtime settings which were stored when the ChannelManager was serialized.
8596 pub default_config: UserConfig,
8598 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
8599 /// value.context.get_funding_txo() should be the key).
8601 /// If a monitor is inconsistent with the channel state during deserialization the channel will
8602 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
8603 /// is true for missing channels as well. If there is a monitor missing for which we find
8604 /// channel data Err(DecodeError::InvalidValue) will be returned.
8606 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
8609 /// This is not exported to bindings users because we have no HashMap bindings
8610 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>,
8613 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8614 ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>
8616 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8617 T::Target: BroadcasterInterface,
8618 ES::Target: EntropySource,
8619 NS::Target: NodeSigner,
8620 SP::Target: SignerProvider,
8621 F::Target: FeeEstimator,
8625 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
8626 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
8627 /// populate a HashMap directly from C.
8628 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,
8629 mut channel_monitors: Vec<&'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>) -> Self {
8631 entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
8632 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
8637 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
8638 // SipmleArcChannelManager type:
8639 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8640 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, ES, NS, SP, F, R, L>>)
8642 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8643 T::Target: BroadcasterInterface,
8644 ES::Target: EntropySource,
8645 NS::Target: NodeSigner,
8646 SP::Target: SignerProvider,
8647 F::Target: FeeEstimator,
8651 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
8652 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)>::read(reader, args)?;
8653 Ok((blockhash, Arc::new(chan_manager)))
8657 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8658 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)
8660 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8661 T::Target: BroadcasterInterface,
8662 ES::Target: EntropySource,
8663 NS::Target: NodeSigner,
8664 SP::Target: SignerProvider,
8665 F::Target: FeeEstimator,
8669 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
8670 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
8672 let genesis_hash: BlockHash = Readable::read(reader)?;
8673 let best_block_height: u32 = Readable::read(reader)?;
8674 let best_block_hash: BlockHash = Readable::read(reader)?;
8676 let mut failed_htlcs = Vec::new();
8678 let channel_count: u64 = Readable::read(reader)?;
8679 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
8680 let mut peer_channels: HashMap<PublicKey, HashMap<ChannelId, Channel<SP>>> = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8681 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8682 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8683 let mut channel_closures = VecDeque::new();
8684 let mut close_background_events = Vec::new();
8685 for _ in 0..channel_count {
8686 let mut channel: Channel<SP> = Channel::read(reader, (
8687 &args.entropy_source, &args.signer_provider, best_block_height, &provided_channel_type_features(&args.default_config)
8689 let funding_txo = channel.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
8690 funding_txo_set.insert(funding_txo.clone());
8691 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
8692 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
8693 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
8694 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
8695 channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
8696 // But if the channel is behind of the monitor, close the channel:
8697 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
8698 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
8699 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
8700 &channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
8701 let (monitor_update, mut new_failed_htlcs) = channel.context.force_shutdown(true);
8702 if let Some((counterparty_node_id, funding_txo, update)) = monitor_update {
8703 close_background_events.push(BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
8704 counterparty_node_id, funding_txo, update
8707 failed_htlcs.append(&mut new_failed_htlcs);
8708 channel_closures.push_back((events::Event::ChannelClosed {
8709 channel_id: channel.context.channel_id(),
8710 user_channel_id: channel.context.get_user_id(),
8711 reason: ClosureReason::OutdatedChannelManager,
8712 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
8713 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
8715 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
8716 let mut found_htlc = false;
8717 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
8718 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
8721 // If we have some HTLCs in the channel which are not present in the newer
8722 // ChannelMonitor, they have been removed and should be failed back to
8723 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
8724 // were actually claimed we'd have generated and ensured the previous-hop
8725 // claim update ChannelMonitor updates were persisted prior to persising
8726 // the ChannelMonitor update for the forward leg, so attempting to fail the
8727 // backwards leg of the HTLC will simply be rejected.
8728 log_info!(args.logger,
8729 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
8730 &channel.context.channel_id(), &payment_hash);
8731 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8735 log_info!(args.logger, "Successfully loaded channel {} at update_id {} against monitor at update id {}",
8736 &channel.context.channel_id(), channel.context.get_latest_monitor_update_id(),
8737 monitor.get_latest_update_id());
8738 if let Some(short_channel_id) = channel.context.get_short_channel_id() {
8739 short_to_chan_info.insert(short_channel_id, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8741 if channel.context.is_funding_initiated() {
8742 id_to_peer.insert(channel.context.channel_id(), channel.context.get_counterparty_node_id());
8744 match peer_channels.entry(channel.context.get_counterparty_node_id()) {
8745 hash_map::Entry::Occupied(mut entry) => {
8746 let by_id_map = entry.get_mut();
8747 by_id_map.insert(channel.context.channel_id(), channel);
8749 hash_map::Entry::Vacant(entry) => {
8750 let mut by_id_map = HashMap::new();
8751 by_id_map.insert(channel.context.channel_id(), channel);
8752 entry.insert(by_id_map);
8756 } else if channel.is_awaiting_initial_mon_persist() {
8757 // If we were persisted and shut down while the initial ChannelMonitor persistence
8758 // was in-progress, we never broadcasted the funding transaction and can still
8759 // safely discard the channel.
8760 let _ = channel.context.force_shutdown(false);
8761 channel_closures.push_back((events::Event::ChannelClosed {
8762 channel_id: channel.context.channel_id(),
8763 user_channel_id: channel.context.get_user_id(),
8764 reason: ClosureReason::DisconnectedPeer,
8765 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
8766 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
8769 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
8770 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
8771 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
8772 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
8773 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");
8774 return Err(DecodeError::InvalidValue);
8778 for (funding_txo, _) in args.channel_monitors.iter() {
8779 if !funding_txo_set.contains(funding_txo) {
8780 log_info!(args.logger, "Queueing monitor update to ensure missing channel {} is force closed",
8781 &funding_txo.to_channel_id());
8782 let monitor_update = ChannelMonitorUpdate {
8783 update_id: CLOSED_CHANNEL_UPDATE_ID,
8784 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast: true }],
8786 close_background_events.push(BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((*funding_txo, monitor_update)));
8790 const MAX_ALLOC_SIZE: usize = 1024 * 64;
8791 let forward_htlcs_count: u64 = Readable::read(reader)?;
8792 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
8793 for _ in 0..forward_htlcs_count {
8794 let short_channel_id = Readable::read(reader)?;
8795 let pending_forwards_count: u64 = Readable::read(reader)?;
8796 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
8797 for _ in 0..pending_forwards_count {
8798 pending_forwards.push(Readable::read(reader)?);
8800 forward_htlcs.insert(short_channel_id, pending_forwards);
8803 let claimable_htlcs_count: u64 = Readable::read(reader)?;
8804 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
8805 for _ in 0..claimable_htlcs_count {
8806 let payment_hash = Readable::read(reader)?;
8807 let previous_hops_len: u64 = Readable::read(reader)?;
8808 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
8809 for _ in 0..previous_hops_len {
8810 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
8812 claimable_htlcs_list.push((payment_hash, previous_hops));
8815 let peer_state_from_chans = |channel_by_id| {
8818 outbound_v1_channel_by_id: HashMap::new(),
8819 inbound_v1_channel_by_id: HashMap::new(),
8820 inbound_channel_request_by_id: HashMap::new(),
8821 latest_features: InitFeatures::empty(),
8822 pending_msg_events: Vec::new(),
8823 in_flight_monitor_updates: BTreeMap::new(),
8824 monitor_update_blocked_actions: BTreeMap::new(),
8825 actions_blocking_raa_monitor_updates: BTreeMap::new(),
8826 is_connected: false,
8830 let peer_count: u64 = Readable::read(reader)?;
8831 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<SP>>)>()));
8832 for _ in 0..peer_count {
8833 let peer_pubkey = Readable::read(reader)?;
8834 let peer_chans = peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new());
8835 let mut peer_state = peer_state_from_chans(peer_chans);
8836 peer_state.latest_features = Readable::read(reader)?;
8837 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
8840 let event_count: u64 = Readable::read(reader)?;
8841 let mut pending_events_read: VecDeque<(events::Event, Option<EventCompletionAction>)> =
8842 VecDeque::with_capacity(cmp::min(event_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>()));
8843 for _ in 0..event_count {
8844 match MaybeReadable::read(reader)? {
8845 Some(event) => pending_events_read.push_back((event, None)),
8850 let background_event_count: u64 = Readable::read(reader)?;
8851 for _ in 0..background_event_count {
8852 match <u8 as Readable>::read(reader)? {
8854 // LDK versions prior to 0.0.116 wrote pending `MonitorUpdateRegeneratedOnStartup`s here,
8855 // however we really don't (and never did) need them - we regenerate all
8856 // on-startup monitor updates.
8857 let _: OutPoint = Readable::read(reader)?;
8858 let _: ChannelMonitorUpdate = Readable::read(reader)?;
8860 _ => return Err(DecodeError::InvalidValue),
8864 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
8865 let highest_seen_timestamp: u32 = Readable::read(reader)?;
8867 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
8868 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
8869 for _ in 0..pending_inbound_payment_count {
8870 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
8871 return Err(DecodeError::InvalidValue);
8875 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
8876 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
8877 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
8878 for _ in 0..pending_outbound_payments_count_compat {
8879 let session_priv = Readable::read(reader)?;
8880 let payment = PendingOutboundPayment::Legacy {
8881 session_privs: [session_priv].iter().cloned().collect()
8883 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
8884 return Err(DecodeError::InvalidValue)
8888 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
8889 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
8890 let mut pending_outbound_payments = None;
8891 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
8892 let mut received_network_pubkey: Option<PublicKey> = None;
8893 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
8894 let mut probing_cookie_secret: Option<[u8; 32]> = None;
8895 let mut claimable_htlc_purposes = None;
8896 let mut claimable_htlc_onion_fields = None;
8897 let mut pending_claiming_payments = Some(HashMap::new());
8898 let mut monitor_update_blocked_actions_per_peer: Option<Vec<(_, BTreeMap<_, Vec<_>>)>> = Some(Vec::new());
8899 let mut events_override = None;
8900 let mut in_flight_monitor_updates: Option<HashMap<(PublicKey, OutPoint), Vec<ChannelMonitorUpdate>>> = None;
8901 read_tlv_fields!(reader, {
8902 (1, pending_outbound_payments_no_retry, option),
8903 (2, pending_intercepted_htlcs, option),
8904 (3, pending_outbound_payments, option),
8905 (4, pending_claiming_payments, option),
8906 (5, received_network_pubkey, option),
8907 (6, monitor_update_blocked_actions_per_peer, option),
8908 (7, fake_scid_rand_bytes, option),
8909 (8, events_override, option),
8910 (9, claimable_htlc_purposes, optional_vec),
8911 (10, in_flight_monitor_updates, option),
8912 (11, probing_cookie_secret, option),
8913 (13, claimable_htlc_onion_fields, optional_vec),
8915 if fake_scid_rand_bytes.is_none() {
8916 fake_scid_rand_bytes = Some(args.entropy_source.get_secure_random_bytes());
8919 if probing_cookie_secret.is_none() {
8920 probing_cookie_secret = Some(args.entropy_source.get_secure_random_bytes());
8923 if let Some(events) = events_override {
8924 pending_events_read = events;
8927 if !channel_closures.is_empty() {
8928 pending_events_read.append(&mut channel_closures);
8931 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
8932 pending_outbound_payments = Some(pending_outbound_payments_compat);
8933 } else if pending_outbound_payments.is_none() {
8934 let mut outbounds = HashMap::new();
8935 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
8936 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
8938 pending_outbound_payments = Some(outbounds);
8940 let pending_outbounds = OutboundPayments {
8941 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
8942 retry_lock: Mutex::new(())
8945 // We have to replay (or skip, if they were completed after we wrote the `ChannelManager`)
8946 // each `ChannelMonitorUpdate` in `in_flight_monitor_updates`. After doing so, we have to
8947 // check that each channel we have isn't newer than the latest `ChannelMonitorUpdate`(s) we
8948 // replayed, and for each monitor update we have to replay we have to ensure there's a
8949 // `ChannelMonitor` for it.
8951 // In order to do so we first walk all of our live channels (so that we can check their
8952 // state immediately after doing the update replays, when we have the `update_id`s
8953 // available) and then walk any remaining in-flight updates.
8955 // Because the actual handling of the in-flight updates is the same, it's macro'ized here:
8956 let mut pending_background_events = Vec::new();
8957 macro_rules! handle_in_flight_updates {
8958 ($counterparty_node_id: expr, $chan_in_flight_upds: expr, $funding_txo: expr,
8959 $monitor: expr, $peer_state: expr, $channel_info_log: expr
8961 let mut max_in_flight_update_id = 0;
8962 $chan_in_flight_upds.retain(|upd| upd.update_id > $monitor.get_latest_update_id());
8963 for update in $chan_in_flight_upds.iter() {
8964 log_trace!(args.logger, "Replaying ChannelMonitorUpdate {} for {}channel {}",
8965 update.update_id, $channel_info_log, &$funding_txo.to_channel_id());
8966 max_in_flight_update_id = cmp::max(max_in_flight_update_id, update.update_id);
8967 pending_background_events.push(
8968 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
8969 counterparty_node_id: $counterparty_node_id,
8970 funding_txo: $funding_txo,
8971 update: update.clone(),
8974 if $chan_in_flight_upds.is_empty() {
8975 // We had some updates to apply, but it turns out they had completed before we
8976 // were serialized, we just weren't notified of that. Thus, we may have to run
8977 // the completion actions for any monitor updates, but otherwise are done.
8978 pending_background_events.push(
8979 BackgroundEvent::MonitorUpdatesComplete {
8980 counterparty_node_id: $counterparty_node_id,
8981 channel_id: $funding_txo.to_channel_id(),
8984 if $peer_state.in_flight_monitor_updates.insert($funding_txo, $chan_in_flight_upds).is_some() {
8985 log_error!(args.logger, "Duplicate in-flight monitor update set for the same channel!");
8986 return Err(DecodeError::InvalidValue);
8988 max_in_flight_update_id
8992 for (counterparty_id, peer_state_mtx) in per_peer_state.iter_mut() {
8993 let mut peer_state_lock = peer_state_mtx.lock().unwrap();
8994 let peer_state = &mut *peer_state_lock;
8995 for (_, chan) in peer_state.channel_by_id.iter() {
8996 // Channels that were persisted have to be funded, otherwise they should have been
8998 let funding_txo = chan.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
8999 let monitor = args.channel_monitors.get(&funding_txo)
9000 .expect("We already checked for monitor presence when loading channels");
9001 let mut max_in_flight_update_id = monitor.get_latest_update_id();
9002 if let Some(in_flight_upds) = &mut in_flight_monitor_updates {
9003 if let Some(mut chan_in_flight_upds) = in_flight_upds.remove(&(*counterparty_id, funding_txo)) {
9004 max_in_flight_update_id = cmp::max(max_in_flight_update_id,
9005 handle_in_flight_updates!(*counterparty_id, chan_in_flight_upds,
9006 funding_txo, monitor, peer_state, ""));
9009 if chan.get_latest_unblocked_monitor_update_id() > max_in_flight_update_id {
9010 // If the channel is ahead of the monitor, return InvalidValue:
9011 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
9012 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} with update_id through {} in-flight",
9013 &chan.context.channel_id(), monitor.get_latest_update_id(), max_in_flight_update_id);
9014 log_error!(args.logger, " but the ChannelManager is at update_id {}.", chan.get_latest_unblocked_monitor_update_id());
9015 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
9016 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
9017 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
9018 log_error!(args.logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/lightningdevkit/rust-lightning");
9019 return Err(DecodeError::InvalidValue);
9024 if let Some(in_flight_upds) = in_flight_monitor_updates {
9025 for ((counterparty_id, funding_txo), mut chan_in_flight_updates) in in_flight_upds {
9026 if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
9027 // Now that we've removed all the in-flight monitor updates for channels that are
9028 // still open, we need to replay any monitor updates that are for closed channels,
9029 // creating the neccessary peer_state entries as we go.
9030 let peer_state_mutex = per_peer_state.entry(counterparty_id).or_insert_with(|| {
9031 Mutex::new(peer_state_from_chans(HashMap::new()))
9033 let mut peer_state = peer_state_mutex.lock().unwrap();
9034 handle_in_flight_updates!(counterparty_id, chan_in_flight_updates,
9035 funding_txo, monitor, peer_state, "closed ");
9037 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!");
9038 log_error!(args.logger, " The ChannelMonitor for channel {} is missing.",
9039 &funding_txo.to_channel_id());
9040 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
9041 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
9042 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
9043 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");
9044 return Err(DecodeError::InvalidValue);
9049 // Note that we have to do the above replays before we push new monitor updates.
9050 pending_background_events.append(&mut close_background_events);
9052 // If there's any preimages for forwarded HTLCs hanging around in ChannelMonitors we
9053 // should ensure we try them again on the inbound edge. We put them here and do so after we
9054 // have a fully-constructed `ChannelManager` at the end.
9055 let mut pending_claims_to_replay = Vec::new();
9058 // If we're tracking pending payments, ensure we haven't lost any by looking at the
9059 // ChannelMonitor data for any channels for which we do not have authorative state
9060 // (i.e. those for which we just force-closed above or we otherwise don't have a
9061 // corresponding `Channel` at all).
9062 // This avoids several edge-cases where we would otherwise "forget" about pending
9063 // payments which are still in-flight via their on-chain state.
9064 // We only rebuild the pending payments map if we were most recently serialized by
9066 for (_, monitor) in args.channel_monitors.iter() {
9067 let counterparty_opt = id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id());
9068 if counterparty_opt.is_none() {
9069 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
9070 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
9071 if path.hops.is_empty() {
9072 log_error!(args.logger, "Got an empty path for a pending payment");
9073 return Err(DecodeError::InvalidValue);
9076 let path_amt = path.final_value_msat();
9077 let mut session_priv_bytes = [0; 32];
9078 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
9079 match pending_outbounds.pending_outbound_payments.lock().unwrap().entry(payment_id) {
9080 hash_map::Entry::Occupied(mut entry) => {
9081 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
9082 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
9083 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), &htlc.payment_hash);
9085 hash_map::Entry::Vacant(entry) => {
9086 let path_fee = path.fee_msat();
9087 entry.insert(PendingOutboundPayment::Retryable {
9088 retry_strategy: None,
9089 attempts: PaymentAttempts::new(),
9090 payment_params: None,
9091 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
9092 payment_hash: htlc.payment_hash,
9093 payment_secret: None, // only used for retries, and we'll never retry on startup
9094 payment_metadata: None, // only used for retries, and we'll never retry on startup
9095 keysend_preimage: None, // only used for retries, and we'll never retry on startup
9096 custom_tlvs: Vec::new(), // only used for retries, and we'll never retry on startup
9097 pending_amt_msat: path_amt,
9098 pending_fee_msat: Some(path_fee),
9099 total_msat: path_amt,
9100 starting_block_height: best_block_height,
9102 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
9103 path_amt, &htlc.payment_hash, log_bytes!(session_priv_bytes));
9108 for (htlc_source, (htlc, preimage_opt)) in monitor.get_all_current_outbound_htlcs() {
9110 HTLCSource::PreviousHopData(prev_hop_data) => {
9111 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
9112 info.prev_funding_outpoint == prev_hop_data.outpoint &&
9113 info.prev_htlc_id == prev_hop_data.htlc_id
9115 // The ChannelMonitor is now responsible for this HTLC's
9116 // failure/success and will let us know what its outcome is. If we
9117 // still have an entry for this HTLC in `forward_htlcs` or
9118 // `pending_intercepted_htlcs`, we were apparently not persisted after
9119 // the monitor was when forwarding the payment.
9120 forward_htlcs.retain(|_, forwards| {
9121 forwards.retain(|forward| {
9122 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
9123 if pending_forward_matches_htlc(&htlc_info) {
9124 log_info!(args.logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
9125 &htlc.payment_hash, &monitor.get_funding_txo().0.to_channel_id());
9130 !forwards.is_empty()
9132 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
9133 if pending_forward_matches_htlc(&htlc_info) {
9134 log_info!(args.logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
9135 &htlc.payment_hash, &monitor.get_funding_txo().0.to_channel_id());
9136 pending_events_read.retain(|(event, _)| {
9137 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
9138 intercepted_id != ev_id
9145 HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } => {
9146 if let Some(preimage) = preimage_opt {
9147 let pending_events = Mutex::new(pending_events_read);
9148 // Note that we set `from_onchain` to "false" here,
9149 // deliberately keeping the pending payment around forever.
9150 // Given it should only occur when we have a channel we're
9151 // force-closing for being stale that's okay.
9152 // The alternative would be to wipe the state when claiming,
9153 // generating a `PaymentPathSuccessful` event but regenerating
9154 // it and the `PaymentSent` on every restart until the
9155 // `ChannelMonitor` is removed.
9157 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
9158 channel_funding_outpoint: monitor.get_funding_txo().0,
9159 counterparty_node_id: path.hops[0].pubkey,
9161 pending_outbounds.claim_htlc(payment_id, preimage, session_priv,
9162 path, false, compl_action, &pending_events, &args.logger);
9163 pending_events_read = pending_events.into_inner().unwrap();
9170 // Whether the downstream channel was closed or not, try to re-apply any payment
9171 // preimages from it which may be needed in upstream channels for forwarded
9173 let outbound_claimed_htlcs_iter = monitor.get_all_current_outbound_htlcs()
9175 .filter_map(|(htlc_source, (htlc, preimage_opt))| {
9176 if let HTLCSource::PreviousHopData(_) = htlc_source {
9177 if let Some(payment_preimage) = preimage_opt {
9178 Some((htlc_source, payment_preimage, htlc.amount_msat,
9179 // Check if `counterparty_opt.is_none()` to see if the
9180 // downstream chan is closed (because we don't have a
9181 // channel_id -> peer map entry).
9182 counterparty_opt.is_none(),
9183 monitor.get_funding_txo().0))
9186 // If it was an outbound payment, we've handled it above - if a preimage
9187 // came in and we persisted the `ChannelManager` we either handled it and
9188 // are good to go or the channel force-closed - we don't have to handle the
9189 // channel still live case here.
9193 for tuple in outbound_claimed_htlcs_iter {
9194 pending_claims_to_replay.push(tuple);
9199 if !forward_htlcs.is_empty() || pending_outbounds.needs_abandon() {
9200 // If we have pending HTLCs to forward, assume we either dropped a
9201 // `PendingHTLCsForwardable` or the user received it but never processed it as they
9202 // shut down before the timer hit. Either way, set the time_forwardable to a small
9203 // constant as enough time has likely passed that we should simply handle the forwards
9204 // now, or at least after the user gets a chance to reconnect to our peers.
9205 pending_events_read.push_back((events::Event::PendingHTLCsForwardable {
9206 time_forwardable: Duration::from_secs(2),
9210 let inbound_pmt_key_material = args.node_signer.get_inbound_payment_key_material();
9211 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
9213 let mut claimable_payments = HashMap::with_capacity(claimable_htlcs_list.len());
9214 if let Some(purposes) = claimable_htlc_purposes {
9215 if purposes.len() != claimable_htlcs_list.len() {
9216 return Err(DecodeError::InvalidValue);
9218 if let Some(onion_fields) = claimable_htlc_onion_fields {
9219 if onion_fields.len() != claimable_htlcs_list.len() {
9220 return Err(DecodeError::InvalidValue);
9222 for (purpose, (onion, (payment_hash, htlcs))) in
9223 purposes.into_iter().zip(onion_fields.into_iter().zip(claimable_htlcs_list.into_iter()))
9225 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
9226 purpose, htlcs, onion_fields: onion,
9228 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
9231 for (purpose, (payment_hash, htlcs)) in purposes.into_iter().zip(claimable_htlcs_list.into_iter()) {
9232 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
9233 purpose, htlcs, onion_fields: None,
9235 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
9239 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
9240 // include a `_legacy_hop_data` in the `OnionPayload`.
9241 for (payment_hash, htlcs) in claimable_htlcs_list.drain(..) {
9242 if htlcs.is_empty() {
9243 return Err(DecodeError::InvalidValue);
9245 let purpose = match &htlcs[0].onion_payload {
9246 OnionPayload::Invoice { _legacy_hop_data } => {
9247 if let Some(hop_data) = _legacy_hop_data {
9248 events::PaymentPurpose::InvoicePayment {
9249 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
9250 Some(inbound_payment) => inbound_payment.payment_preimage,
9251 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
9252 Ok((payment_preimage, _)) => payment_preimage,
9254 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);
9255 return Err(DecodeError::InvalidValue);
9259 payment_secret: hop_data.payment_secret,
9261 } else { return Err(DecodeError::InvalidValue); }
9263 OnionPayload::Spontaneous(payment_preimage) =>
9264 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
9266 claimable_payments.insert(payment_hash, ClaimablePayment {
9267 purpose, htlcs, onion_fields: None,
9272 let mut secp_ctx = Secp256k1::new();
9273 secp_ctx.seeded_randomize(&args.entropy_source.get_secure_random_bytes());
9275 let our_network_pubkey = match args.node_signer.get_node_id(Recipient::Node) {
9277 Err(()) => return Err(DecodeError::InvalidValue)
9279 if let Some(network_pubkey) = received_network_pubkey {
9280 if network_pubkey != our_network_pubkey {
9281 log_error!(args.logger, "Key that was generated does not match the existing key.");
9282 return Err(DecodeError::InvalidValue);
9286 let mut outbound_scid_aliases = HashSet::new();
9287 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
9288 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9289 let peer_state = &mut *peer_state_lock;
9290 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
9291 if chan.context.outbound_scid_alias() == 0 {
9292 let mut outbound_scid_alias;
9294 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
9295 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.entropy_source);
9296 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
9298 chan.context.set_outbound_scid_alias(outbound_scid_alias);
9299 } else if !outbound_scid_aliases.insert(chan.context.outbound_scid_alias()) {
9300 // Note that in rare cases its possible to hit this while reading an older
9301 // channel if we just happened to pick a colliding outbound alias above.
9302 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
9303 return Err(DecodeError::InvalidValue);
9305 if chan.context.is_usable() {
9306 if short_to_chan_info.insert(chan.context.outbound_scid_alias(), (chan.context.get_counterparty_node_id(), *chan_id)).is_some() {
9307 // Note that in rare cases its possible to hit this while reading an older
9308 // channel if we just happened to pick a colliding outbound alias above.
9309 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
9310 return Err(DecodeError::InvalidValue);
9316 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
9318 for (_, monitor) in args.channel_monitors.iter() {
9319 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
9320 if let Some(payment) = claimable_payments.remove(&payment_hash) {
9321 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", &payment_hash);
9322 let mut claimable_amt_msat = 0;
9323 let mut receiver_node_id = Some(our_network_pubkey);
9324 let phantom_shared_secret = payment.htlcs[0].prev_hop.phantom_shared_secret;
9325 if phantom_shared_secret.is_some() {
9326 let phantom_pubkey = args.node_signer.get_node_id(Recipient::PhantomNode)
9327 .expect("Failed to get node_id for phantom node recipient");
9328 receiver_node_id = Some(phantom_pubkey)
9330 for claimable_htlc in &payment.htlcs {
9331 claimable_amt_msat += claimable_htlc.value;
9333 // Add a holding-cell claim of the payment to the Channel, which should be
9334 // applied ~immediately on peer reconnection. Because it won't generate a
9335 // new commitment transaction we can just provide the payment preimage to
9336 // the corresponding ChannelMonitor and nothing else.
9338 // We do so directly instead of via the normal ChannelMonitor update
9339 // procedure as the ChainMonitor hasn't yet been initialized, implying
9340 // we're not allowed to call it directly yet. Further, we do the update
9341 // without incrementing the ChannelMonitor update ID as there isn't any
9343 // If we were to generate a new ChannelMonitor update ID here and then
9344 // crash before the user finishes block connect we'd end up force-closing
9345 // this channel as well. On the flip side, there's no harm in restarting
9346 // without the new monitor persisted - we'll end up right back here on
9348 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
9349 if let Some(peer_node_id) = id_to_peer.get(&previous_channel_id){
9350 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
9351 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9352 let peer_state = &mut *peer_state_lock;
9353 if let Some(channel) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
9354 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
9357 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
9358 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
9361 pending_events_read.push_back((events::Event::PaymentClaimed {
9364 purpose: payment.purpose,
9365 amount_msat: claimable_amt_msat,
9366 htlcs: payment.htlcs.iter().map(events::ClaimedHTLC::from).collect(),
9367 sender_intended_total_msat: payment.htlcs.first().map(|htlc| htlc.total_msat),
9373 for (node_id, monitor_update_blocked_actions) in monitor_update_blocked_actions_per_peer.unwrap() {
9374 if let Some(peer_state) = per_peer_state.get(&node_id) {
9375 for (_, actions) in monitor_update_blocked_actions.iter() {
9376 for action in actions.iter() {
9377 if let MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
9378 downstream_counterparty_and_funding_outpoint:
9379 Some((blocked_node_id, blocked_channel_outpoint, blocking_action)), ..
9381 if let Some(blocked_peer_state) = per_peer_state.get(&blocked_node_id) {
9382 blocked_peer_state.lock().unwrap().actions_blocking_raa_monitor_updates
9383 .entry(blocked_channel_outpoint.to_channel_id())
9384 .or_insert_with(Vec::new).push(blocking_action.clone());
9386 // If the channel we were blocking has closed, we don't need to
9387 // worry about it - the blocked monitor update should never have
9388 // been released from the `Channel` object so it can't have
9389 // completed, and if the channel closed there's no reason to bother
9395 peer_state.lock().unwrap().monitor_update_blocked_actions = monitor_update_blocked_actions;
9397 log_error!(args.logger, "Got blocked actions without a per-peer-state for {}", node_id);
9398 return Err(DecodeError::InvalidValue);
9402 let channel_manager = ChannelManager {
9404 fee_estimator: bounded_fee_estimator,
9405 chain_monitor: args.chain_monitor,
9406 tx_broadcaster: args.tx_broadcaster,
9407 router: args.router,
9409 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
9411 inbound_payment_key: expanded_inbound_key,
9412 pending_inbound_payments: Mutex::new(pending_inbound_payments),
9413 pending_outbound_payments: pending_outbounds,
9414 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
9416 forward_htlcs: Mutex::new(forward_htlcs),
9417 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments, pending_claiming_payments: pending_claiming_payments.unwrap() }),
9418 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
9419 id_to_peer: Mutex::new(id_to_peer),
9420 short_to_chan_info: FairRwLock::new(short_to_chan_info),
9421 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
9423 probing_cookie_secret: probing_cookie_secret.unwrap(),
9428 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
9430 per_peer_state: FairRwLock::new(per_peer_state),
9432 pending_events: Mutex::new(pending_events_read),
9433 pending_events_processor: AtomicBool::new(false),
9434 pending_background_events: Mutex::new(pending_background_events),
9435 total_consistency_lock: RwLock::new(()),
9436 background_events_processed_since_startup: AtomicBool::new(false),
9437 persistence_notifier: Notifier::new(),
9439 entropy_source: args.entropy_source,
9440 node_signer: args.node_signer,
9441 signer_provider: args.signer_provider,
9443 logger: args.logger,
9444 default_configuration: args.default_config,
9447 for htlc_source in failed_htlcs.drain(..) {
9448 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
9449 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
9450 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
9451 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
9454 for (source, preimage, downstream_value, downstream_closed, downstream_funding) in pending_claims_to_replay {
9455 // We use `downstream_closed` in place of `from_onchain` here just as a guess - we
9456 // don't remember in the `ChannelMonitor` where we got a preimage from, but if the
9457 // channel is closed we just assume that it probably came from an on-chain claim.
9458 channel_manager.claim_funds_internal(source, preimage, Some(downstream_value),
9459 downstream_closed, downstream_funding);
9462 //TODO: Broadcast channel update for closed channels, but only after we've made a
9463 //connection or two.
9465 Ok((best_block_hash.clone(), channel_manager))
9471 use bitcoin::hashes::Hash;
9472 use bitcoin::hashes::sha256::Hash as Sha256;
9473 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
9474 use core::sync::atomic::Ordering;
9475 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
9476 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
9477 use crate::ln::ChannelId;
9478 use crate::ln::channelmanager::{inbound_payment, PaymentId, PaymentSendFailure, RecipientOnionFields, InterceptId};
9479 use crate::ln::functional_test_utils::*;
9480 use crate::ln::msgs::{self, ErrorAction};
9481 use crate::ln::msgs::ChannelMessageHandler;
9482 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
9483 use crate::util::errors::APIError;
9484 use crate::util::test_utils;
9485 use crate::util::config::{ChannelConfig, ChannelConfigUpdate};
9486 use crate::sign::EntropySource;
9489 fn test_notify_limits() {
9490 // Check that a few cases which don't require the persistence of a new ChannelManager,
9491 // indeed, do not cause the persistence of a new ChannelManager.
9492 let chanmon_cfgs = create_chanmon_cfgs(3);
9493 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9494 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9495 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9497 // All nodes start with a persistable update pending as `create_network` connects each node
9498 // with all other nodes to make most tests simpler.
9499 assert!(nodes[0].node.get_persistable_update_future().poll_is_complete());
9500 assert!(nodes[1].node.get_persistable_update_future().poll_is_complete());
9501 assert!(nodes[2].node.get_persistable_update_future().poll_is_complete());
9503 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1);
9505 // We check that the channel info nodes have doesn't change too early, even though we try
9506 // to connect messages with new values
9507 chan.0.contents.fee_base_msat *= 2;
9508 chan.1.contents.fee_base_msat *= 2;
9509 let node_a_chan_info = nodes[0].node.list_channels_with_counterparty(
9510 &nodes[1].node.get_our_node_id()).pop().unwrap();
9511 let node_b_chan_info = nodes[1].node.list_channels_with_counterparty(
9512 &nodes[0].node.get_our_node_id()).pop().unwrap();
9514 // The first two nodes (which opened a channel) should now require fresh persistence
9515 assert!(nodes[0].node.get_persistable_update_future().poll_is_complete());
9516 assert!(nodes[1].node.get_persistable_update_future().poll_is_complete());
9517 // ... but the last node should not.
9518 assert!(!nodes[2].node.get_persistable_update_future().poll_is_complete());
9519 // After persisting the first two nodes they should no longer need fresh persistence.
9520 assert!(!nodes[0].node.get_persistable_update_future().poll_is_complete());
9521 assert!(!nodes[1].node.get_persistable_update_future().poll_is_complete());
9523 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
9524 // about the channel.
9525 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
9526 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
9527 assert!(!nodes[2].node.get_persistable_update_future().poll_is_complete());
9529 // The nodes which are a party to the channel should also ignore messages from unrelated
9531 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
9532 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
9533 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
9534 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
9535 assert!(!nodes[0].node.get_persistable_update_future().poll_is_complete());
9536 assert!(!nodes[1].node.get_persistable_update_future().poll_is_complete());
9538 // At this point the channel info given by peers should still be the same.
9539 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
9540 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
9542 // An earlier version of handle_channel_update didn't check the directionality of the
9543 // update message and would always update the local fee info, even if our peer was
9544 // (spuriously) forwarding us our own channel_update.
9545 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
9546 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
9547 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
9549 // First deliver each peers' own message, checking that the node doesn't need to be
9550 // persisted and that its channel info remains the same.
9551 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
9552 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
9553 assert!(!nodes[0].node.get_persistable_update_future().poll_is_complete());
9554 assert!(!nodes[1].node.get_persistable_update_future().poll_is_complete());
9555 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
9556 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
9558 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
9559 // the channel info has updated.
9560 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
9561 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
9562 assert!(nodes[0].node.get_persistable_update_future().poll_is_complete());
9563 assert!(nodes[1].node.get_persistable_update_future().poll_is_complete());
9564 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
9565 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
9569 fn test_keysend_dup_hash_partial_mpp() {
9570 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
9572 let chanmon_cfgs = create_chanmon_cfgs(2);
9573 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9574 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9575 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9576 create_announced_chan_between_nodes(&nodes, 0, 1);
9578 // First, send a partial MPP payment.
9579 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
9580 let mut mpp_route = route.clone();
9581 mpp_route.paths.push(mpp_route.paths[0].clone());
9583 let payment_id = PaymentId([42; 32]);
9584 // Use the utility function send_payment_along_path to send the payment with MPP data which
9585 // indicates there are more HTLCs coming.
9586 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.
9587 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
9588 RecipientOnionFields::secret_only(payment_secret), payment_id, &mpp_route).unwrap();
9589 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[0], &our_payment_hash,
9590 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
9591 check_added_monitors!(nodes[0], 1);
9592 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9593 assert_eq!(events.len(), 1);
9594 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
9596 // Next, send a keysend payment with the same payment_hash and make sure it fails.
9597 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9598 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9599 check_added_monitors!(nodes[0], 1);
9600 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9601 assert_eq!(events.len(), 1);
9602 let ev = events.drain(..).next().unwrap();
9603 let payment_event = SendEvent::from_event(ev);
9604 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9605 check_added_monitors!(nodes[1], 0);
9606 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9607 expect_pending_htlcs_forwardable!(nodes[1]);
9608 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
9609 check_added_monitors!(nodes[1], 1);
9610 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9611 assert!(updates.update_add_htlcs.is_empty());
9612 assert!(updates.update_fulfill_htlcs.is_empty());
9613 assert_eq!(updates.update_fail_htlcs.len(), 1);
9614 assert!(updates.update_fail_malformed_htlcs.is_empty());
9615 assert!(updates.update_fee.is_none());
9616 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9617 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9618 expect_payment_failed!(nodes[0], our_payment_hash, true);
9620 // Send the second half of the original MPP payment.
9621 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[1], &our_payment_hash,
9622 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
9623 check_added_monitors!(nodes[0], 1);
9624 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9625 assert_eq!(events.len(), 1);
9626 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
9628 // Claim the full MPP payment. Note that we can't use a test utility like
9629 // claim_funds_along_route because the ordering of the messages causes the second half of the
9630 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
9631 // lightning messages manually.
9632 nodes[1].node.claim_funds(payment_preimage);
9633 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
9634 check_added_monitors!(nodes[1], 2);
9636 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9637 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
9638 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
9639 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
9640 check_added_monitors!(nodes[0], 1);
9641 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9642 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
9643 check_added_monitors!(nodes[1], 1);
9644 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9645 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
9646 check_added_monitors!(nodes[1], 1);
9647 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
9648 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
9649 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
9650 check_added_monitors!(nodes[0], 1);
9651 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
9652 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
9653 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9654 check_added_monitors!(nodes[0], 1);
9655 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
9656 check_added_monitors!(nodes[1], 1);
9657 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
9658 check_added_monitors!(nodes[1], 1);
9659 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
9660 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
9661 check_added_monitors!(nodes[0], 1);
9663 // Note that successful MPP payments will generate a single PaymentSent event upon the first
9664 // path's success and a PaymentPathSuccessful event for each path's success.
9665 let events = nodes[0].node.get_and_clear_pending_events();
9666 assert_eq!(events.len(), 2);
9668 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
9669 assert_eq!(payment_id, *actual_payment_id);
9670 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
9671 assert_eq!(route.paths[0], *path);
9673 _ => panic!("Unexpected event"),
9676 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
9677 assert_eq!(payment_id, *actual_payment_id);
9678 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
9679 assert_eq!(route.paths[0], *path);
9681 _ => panic!("Unexpected event"),
9686 fn test_keysend_dup_payment_hash() {
9687 do_test_keysend_dup_payment_hash(false);
9688 do_test_keysend_dup_payment_hash(true);
9691 fn do_test_keysend_dup_payment_hash(accept_mpp_keysend: bool) {
9692 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
9693 // outbound regular payment fails as expected.
9694 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
9695 // fails as expected.
9696 // (3): Test that a keysend payment with a duplicate payment hash to an existing keysend
9697 // payment fails as expected. When `accept_mpp_keysend` is false, this tests that we
9698 // reject MPP keysend payments, since in this case where the payment has no payment
9699 // secret, a keysend payment with a duplicate hash is basically an MPP keysend. If
9700 // `accept_mpp_keysend` is true, this tests that we only accept MPP keysends with
9701 // payment secrets and reject otherwise.
9702 let chanmon_cfgs = create_chanmon_cfgs(2);
9703 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9704 let mut mpp_keysend_cfg = test_default_channel_config();
9705 mpp_keysend_cfg.accept_mpp_keysend = accept_mpp_keysend;
9706 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(mpp_keysend_cfg)]);
9707 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9708 create_announced_chan_between_nodes(&nodes, 0, 1);
9709 let scorer = test_utils::TestScorer::new();
9710 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9712 // To start (1), send a regular payment but don't claim it.
9713 let expected_route = [&nodes[1]];
9714 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
9716 // Next, attempt a keysend payment and make sure it fails.
9717 let route_params = RouteParameters {
9718 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
9719 final_value_msat: 100_000,
9721 let route = find_route(
9722 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
9723 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
9725 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9726 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9727 check_added_monitors!(nodes[0], 1);
9728 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9729 assert_eq!(events.len(), 1);
9730 let ev = events.drain(..).next().unwrap();
9731 let payment_event = SendEvent::from_event(ev);
9732 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9733 check_added_monitors!(nodes[1], 0);
9734 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9735 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
9736 // fails), the second will process the resulting failure and fail the HTLC backward
9737 expect_pending_htlcs_forwardable!(nodes[1]);
9738 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9739 check_added_monitors!(nodes[1], 1);
9740 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9741 assert!(updates.update_add_htlcs.is_empty());
9742 assert!(updates.update_fulfill_htlcs.is_empty());
9743 assert_eq!(updates.update_fail_htlcs.len(), 1);
9744 assert!(updates.update_fail_malformed_htlcs.is_empty());
9745 assert!(updates.update_fee.is_none());
9746 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9747 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9748 expect_payment_failed!(nodes[0], payment_hash, true);
9750 // Finally, claim the original payment.
9751 claim_payment(&nodes[0], &expected_route, payment_preimage);
9753 // To start (2), send a keysend payment but don't claim it.
9754 let payment_preimage = PaymentPreimage([42; 32]);
9755 let route = find_route(
9756 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
9757 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
9759 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9760 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9761 check_added_monitors!(nodes[0], 1);
9762 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9763 assert_eq!(events.len(), 1);
9764 let event = events.pop().unwrap();
9765 let path = vec![&nodes[1]];
9766 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
9768 // Next, attempt a regular payment and make sure it fails.
9769 let payment_secret = PaymentSecret([43; 32]);
9770 nodes[0].node.send_payment_with_route(&route, payment_hash,
9771 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
9772 check_added_monitors!(nodes[0], 1);
9773 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9774 assert_eq!(events.len(), 1);
9775 let ev = events.drain(..).next().unwrap();
9776 let payment_event = SendEvent::from_event(ev);
9777 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9778 check_added_monitors!(nodes[1], 0);
9779 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9780 expect_pending_htlcs_forwardable!(nodes[1]);
9781 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9782 check_added_monitors!(nodes[1], 1);
9783 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9784 assert!(updates.update_add_htlcs.is_empty());
9785 assert!(updates.update_fulfill_htlcs.is_empty());
9786 assert_eq!(updates.update_fail_htlcs.len(), 1);
9787 assert!(updates.update_fail_malformed_htlcs.is_empty());
9788 assert!(updates.update_fee.is_none());
9789 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9790 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9791 expect_payment_failed!(nodes[0], payment_hash, true);
9793 // Finally, succeed the keysend payment.
9794 claim_payment(&nodes[0], &expected_route, payment_preimage);
9796 // To start (3), send a keysend payment but don't claim it.
9797 let payment_id_1 = PaymentId([44; 32]);
9798 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9799 RecipientOnionFields::spontaneous_empty(), payment_id_1).unwrap();
9800 check_added_monitors!(nodes[0], 1);
9801 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9802 assert_eq!(events.len(), 1);
9803 let event = events.pop().unwrap();
9804 let path = vec![&nodes[1]];
9805 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
9807 // Next, attempt a keysend payment and make sure it fails.
9808 let route_params = RouteParameters {
9809 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
9810 final_value_msat: 100_000,
9812 let route = find_route(
9813 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
9814 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
9816 let payment_id_2 = PaymentId([45; 32]);
9817 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9818 RecipientOnionFields::spontaneous_empty(), payment_id_2).unwrap();
9819 check_added_monitors!(nodes[0], 1);
9820 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9821 assert_eq!(events.len(), 1);
9822 let ev = events.drain(..).next().unwrap();
9823 let payment_event = SendEvent::from_event(ev);
9824 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9825 check_added_monitors!(nodes[1], 0);
9826 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9827 expect_pending_htlcs_forwardable!(nodes[1]);
9828 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9829 check_added_monitors!(nodes[1], 1);
9830 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9831 assert!(updates.update_add_htlcs.is_empty());
9832 assert!(updates.update_fulfill_htlcs.is_empty());
9833 assert_eq!(updates.update_fail_htlcs.len(), 1);
9834 assert!(updates.update_fail_malformed_htlcs.is_empty());
9835 assert!(updates.update_fee.is_none());
9836 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9837 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9838 expect_payment_failed!(nodes[0], payment_hash, true);
9840 // Finally, claim the original payment.
9841 claim_payment(&nodes[0], &expected_route, payment_preimage);
9845 fn test_keysend_hash_mismatch() {
9846 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
9847 // preimage doesn't match the msg's payment hash.
9848 let chanmon_cfgs = create_chanmon_cfgs(2);
9849 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9850 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9851 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9853 let payer_pubkey = nodes[0].node.get_our_node_id();
9854 let payee_pubkey = nodes[1].node.get_our_node_id();
9856 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
9857 let route_params = RouteParameters {
9858 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
9859 final_value_msat: 10_000,
9861 let network_graph = nodes[0].network_graph.clone();
9862 let first_hops = nodes[0].node.list_usable_channels();
9863 let scorer = test_utils::TestScorer::new();
9864 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9865 let route = find_route(
9866 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
9867 nodes[0].logger, &scorer, &(), &random_seed_bytes
9870 let test_preimage = PaymentPreimage([42; 32]);
9871 let mismatch_payment_hash = PaymentHash([43; 32]);
9872 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash,
9873 RecipientOnionFields::spontaneous_empty(), PaymentId(mismatch_payment_hash.0), &route).unwrap();
9874 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash,
9875 RecipientOnionFields::spontaneous_empty(), Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
9876 check_added_monitors!(nodes[0], 1);
9878 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9879 assert_eq!(updates.update_add_htlcs.len(), 1);
9880 assert!(updates.update_fulfill_htlcs.is_empty());
9881 assert!(updates.update_fail_htlcs.is_empty());
9882 assert!(updates.update_fail_malformed_htlcs.is_empty());
9883 assert!(updates.update_fee.is_none());
9884 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
9886 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "Payment preimage didn't match payment hash", 1);
9890 fn test_keysend_msg_with_secret_err() {
9891 // Test that we error as expected if we receive a keysend payment that includes a payment
9892 // secret when we don't support MPP keysend.
9893 let mut reject_mpp_keysend_cfg = test_default_channel_config();
9894 reject_mpp_keysend_cfg.accept_mpp_keysend = false;
9895 let chanmon_cfgs = create_chanmon_cfgs(2);
9896 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9897 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(reject_mpp_keysend_cfg)]);
9898 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9900 let payer_pubkey = nodes[0].node.get_our_node_id();
9901 let payee_pubkey = nodes[1].node.get_our_node_id();
9903 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
9904 let route_params = RouteParameters {
9905 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
9906 final_value_msat: 10_000,
9908 let network_graph = nodes[0].network_graph.clone();
9909 let first_hops = nodes[0].node.list_usable_channels();
9910 let scorer = test_utils::TestScorer::new();
9911 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9912 let route = find_route(
9913 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
9914 nodes[0].logger, &scorer, &(), &random_seed_bytes
9917 let test_preimage = PaymentPreimage([42; 32]);
9918 let test_secret = PaymentSecret([43; 32]);
9919 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
9920 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash,
9921 RecipientOnionFields::secret_only(test_secret), PaymentId(payment_hash.0), &route).unwrap();
9922 nodes[0].node.test_send_payment_internal(&route, payment_hash,
9923 RecipientOnionFields::secret_only(test_secret), Some(test_preimage),
9924 PaymentId(payment_hash.0), None, session_privs).unwrap();
9925 check_added_monitors!(nodes[0], 1);
9927 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9928 assert_eq!(updates.update_add_htlcs.len(), 1);
9929 assert!(updates.update_fulfill_htlcs.is_empty());
9930 assert!(updates.update_fail_htlcs.is_empty());
9931 assert!(updates.update_fail_malformed_htlcs.is_empty());
9932 assert!(updates.update_fee.is_none());
9933 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
9935 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "We don't support MPP keysend payments", 1);
9939 fn test_multi_hop_missing_secret() {
9940 let chanmon_cfgs = create_chanmon_cfgs(4);
9941 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
9942 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
9943 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
9945 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
9946 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
9947 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
9948 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
9950 // Marshall an MPP route.
9951 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
9952 let path = route.paths[0].clone();
9953 route.paths.push(path);
9954 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
9955 route.paths[0].hops[0].short_channel_id = chan_1_id;
9956 route.paths[0].hops[1].short_channel_id = chan_3_id;
9957 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
9958 route.paths[1].hops[0].short_channel_id = chan_2_id;
9959 route.paths[1].hops[1].short_channel_id = chan_4_id;
9961 match nodes[0].node.send_payment_with_route(&route, payment_hash,
9962 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0))
9964 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
9965 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err))
9967 _ => panic!("unexpected error")
9972 fn test_drop_disconnected_peers_when_removing_channels() {
9973 let chanmon_cfgs = create_chanmon_cfgs(2);
9974 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9975 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9976 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9978 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
9980 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
9981 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
9983 nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
9984 check_closed_broadcast!(nodes[0], true);
9985 check_added_monitors!(nodes[0], 1);
9986 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
9989 // Assert that nodes[1] is awaiting removal for nodes[0] once nodes[1] has been
9990 // disconnected and the channel between has been force closed.
9991 let nodes_0_per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
9992 // Assert that nodes[1] isn't removed before `timer_tick_occurred` has been executed.
9993 assert_eq!(nodes_0_per_peer_state.len(), 1);
9994 assert!(nodes_0_per_peer_state.get(&nodes[1].node.get_our_node_id()).is_some());
9997 nodes[0].node.timer_tick_occurred();
10000 // Assert that nodes[1] has now been removed.
10001 assert_eq!(nodes[0].node.per_peer_state.read().unwrap().len(), 0);
10006 fn bad_inbound_payment_hash() {
10007 // Add coverage for checking that a user-provided payment hash matches the payment secret.
10008 let chanmon_cfgs = create_chanmon_cfgs(2);
10009 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10010 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10011 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10013 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
10014 let payment_data = msgs::FinalOnionHopData {
10016 total_msat: 100_000,
10019 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
10020 // payment verification fails as expected.
10021 let mut bad_payment_hash = payment_hash.clone();
10022 bad_payment_hash.0[0] += 1;
10023 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) {
10024 Ok(_) => panic!("Unexpected ok"),
10026 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment", "Failing HTLC with user-generated payment_hash", 1);
10030 // Check that using the original payment hash succeeds.
10031 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());
10035 fn test_id_to_peer_coverage() {
10036 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
10037 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
10038 // the channel is successfully closed.
10039 let chanmon_cfgs = create_chanmon_cfgs(2);
10040 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10041 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10042 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10044 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
10045 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10046 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
10047 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10048 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
10050 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
10051 let channel_id = ChannelId::from_bytes(tx.txid().into_inner());
10053 // Ensure that the `id_to_peer` map is empty until either party has received the
10054 // funding transaction, and have the real `channel_id`.
10055 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
10056 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
10059 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
10061 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
10062 // as it has the funding transaction.
10063 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
10064 assert_eq!(nodes_0_lock.len(), 1);
10065 assert!(nodes_0_lock.contains_key(&channel_id));
10068 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
10070 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
10072 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
10074 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
10075 assert_eq!(nodes_0_lock.len(), 1);
10076 assert!(nodes_0_lock.contains_key(&channel_id));
10078 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
10081 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
10082 // as it has the funding transaction.
10083 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
10084 assert_eq!(nodes_1_lock.len(), 1);
10085 assert!(nodes_1_lock.contains_key(&channel_id));
10087 check_added_monitors!(nodes[1], 1);
10088 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
10089 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
10090 check_added_monitors!(nodes[0], 1);
10091 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
10092 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
10093 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
10094 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
10096 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
10097 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()));
10098 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
10099 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &nodes_1_shutdown);
10101 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
10102 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
10104 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
10105 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
10106 // fee for the closing transaction has been negotiated and the parties has the other
10107 // party's signature for the fee negotiated closing transaction.)
10108 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
10109 assert_eq!(nodes_0_lock.len(), 1);
10110 assert!(nodes_0_lock.contains_key(&channel_id));
10114 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
10115 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
10116 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
10117 // kept in the `nodes[1]`'s `id_to_peer` map.
10118 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
10119 assert_eq!(nodes_1_lock.len(), 1);
10120 assert!(nodes_1_lock.contains_key(&channel_id));
10123 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()));
10125 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
10126 // therefore has all it needs to fully close the channel (both signatures for the
10127 // closing transaction).
10128 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
10129 // fully closed by `nodes[0]`.
10130 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
10132 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
10133 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
10134 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
10135 assert_eq!(nodes_1_lock.len(), 1);
10136 assert!(nodes_1_lock.contains_key(&channel_id));
10139 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
10141 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
10143 // Assert that the channel has now been removed from both parties `id_to_peer` map once
10144 // they both have everything required to fully close the channel.
10145 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
10147 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
10149 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
10150 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
10153 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
10154 let expected_message = format!("Not connected to node: {}", expected_public_key);
10155 check_api_error_message(expected_message, res_err)
10158 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
10159 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
10160 check_api_error_message(expected_message, res_err)
10163 fn check_api_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
10165 Err(APIError::APIMisuseError { err }) => {
10166 assert_eq!(err, expected_err_message);
10168 Err(APIError::ChannelUnavailable { err }) => {
10169 assert_eq!(err, expected_err_message);
10171 Ok(_) => panic!("Unexpected Ok"),
10172 Err(_) => panic!("Unexpected Error"),
10177 fn test_api_calls_with_unkown_counterparty_node() {
10178 // Tests that our API functions that expects a `counterparty_node_id` as input, behaves as
10179 // expected if the `counterparty_node_id` is an unkown peer in the
10180 // `ChannelManager::per_peer_state` map.
10181 let chanmon_cfg = create_chanmon_cfgs(2);
10182 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
10183 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
10184 let nodes = create_network(2, &node_cfg, &node_chanmgr);
10187 let channel_id = ChannelId::from_bytes([4; 32]);
10188 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
10189 let intercept_id = InterceptId([0; 32]);
10191 // Test the API functions.
10192 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);
10194 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&channel_id, &unkown_public_key, 42), unkown_public_key);
10196 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
10198 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
10200 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
10202 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
10204 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
10208 fn test_connection_limiting() {
10209 // Test that we limit un-channel'd peers and un-funded channels properly.
10210 let chanmon_cfgs = create_chanmon_cfgs(2);
10211 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10212 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10213 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10215 // Note that create_network connects the nodes together for us
10217 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10218 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10220 let mut funding_tx = None;
10221 for idx in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
10222 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10223 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10226 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
10227 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
10228 funding_tx = Some(tx.clone());
10229 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx).unwrap();
10230 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
10232 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
10233 check_added_monitors!(nodes[1], 1);
10234 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
10236 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
10238 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
10239 check_added_monitors!(nodes[0], 1);
10240 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
10242 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10245 // A MAX_UNFUNDED_CHANS_PER_PEER + 1 channel will be summarily rejected
10246 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10247 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10248 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
10249 open_channel_msg.temporary_channel_id);
10251 // Further, because all of our channels with nodes[0] are inbound, and none of them funded,
10252 // it doesn't count as a "protected" peer, i.e. it counts towards the MAX_NO_CHANNEL_PEERS
10254 let mut peer_pks = Vec::with_capacity(super::MAX_NO_CHANNEL_PEERS);
10255 for _ in 1..super::MAX_NO_CHANNEL_PEERS {
10256 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10257 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10258 peer_pks.push(random_pk);
10259 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
10260 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10263 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10264 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10265 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10266 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10267 }, true).unwrap_err();
10269 // Also importantly, because nodes[0] isn't "protected", we will refuse a reconnection from
10270 // them if we have too many un-channel'd peers.
10271 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10272 let chan_closed_events = nodes[1].node.get_and_clear_pending_events();
10273 assert_eq!(chan_closed_events.len(), super::MAX_UNFUNDED_CHANS_PER_PEER - 1);
10274 for ev in chan_closed_events {
10275 if let Event::ChannelClosed { .. } = ev { } else { panic!(); }
10277 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10278 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10280 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10281 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10282 }, true).unwrap_err();
10284 // but of course if the connection is outbound its allowed...
10285 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10286 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10287 }, false).unwrap();
10288 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10290 // Now nodes[0] is disconnected but still has a pending, un-funded channel lying around.
10291 // Even though we accept one more connection from new peers, we won't actually let them
10293 assert!(peer_pks.len() > super::MAX_UNFUNDED_CHANNEL_PEERS - 1);
10294 for i in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
10295 nodes[1].node.handle_open_channel(&peer_pks[i], &open_channel_msg);
10296 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, peer_pks[i]);
10297 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10299 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10300 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
10301 open_channel_msg.temporary_channel_id);
10303 // Of course, however, outbound channels are always allowed
10304 nodes[1].node.create_channel(last_random_pk, 100_000, 0, 42, None).unwrap();
10305 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, last_random_pk);
10307 // If we fund the first channel, nodes[0] has a live on-chain channel with us, it is now
10308 // "protected" and can connect again.
10309 mine_transaction(&nodes[1], funding_tx.as_ref().unwrap());
10310 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10311 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10313 get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
10315 // Further, because the first channel was funded, we can open another channel with
10317 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10318 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
10322 fn test_outbound_chans_unlimited() {
10323 // Test that we never refuse an outbound channel even if a peer is unfuned-channel-limited
10324 let chanmon_cfgs = create_chanmon_cfgs(2);
10325 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10326 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10327 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10329 // Note that create_network connects the nodes together for us
10331 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10332 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10334 for _ in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
10335 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10336 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10337 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10340 // Once we have MAX_UNFUNDED_CHANS_PER_PEER unfunded channels, new inbound channels will be
10342 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10343 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
10344 open_channel_msg.temporary_channel_id);
10346 // but we can still open an outbound channel.
10347 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10348 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
10350 // but even with such an outbound channel, additional inbound channels will still fail.
10351 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10352 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
10353 open_channel_msg.temporary_channel_id);
10357 fn test_0conf_limiting() {
10358 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
10359 // flag set and (sometimes) accept channels as 0conf.
10360 let chanmon_cfgs = create_chanmon_cfgs(2);
10361 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10362 let mut settings = test_default_channel_config();
10363 settings.manually_accept_inbound_channels = true;
10364 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(settings)]);
10365 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10367 // Note that create_network connects the nodes together for us
10369 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10370 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10372 // First, get us up to MAX_UNFUNDED_CHANNEL_PEERS so we can test at the edge
10373 for _ in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
10374 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10375 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10376 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
10377 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10380 nodes[1].node.handle_open_channel(&random_pk, &open_channel_msg);
10381 let events = nodes[1].node.get_and_clear_pending_events();
10383 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10384 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23).unwrap();
10386 _ => panic!("Unexpected event"),
10388 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, random_pk);
10389 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10392 // If we try to accept a channel from another peer non-0conf it will fail.
10393 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10394 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10395 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10396 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10398 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10399 let events = nodes[1].node.get_and_clear_pending_events();
10401 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10402 match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23) {
10403 Err(APIError::APIMisuseError { err }) =>
10404 assert_eq!(err, "Too many peers with unfunded channels, refusing to accept new ones"),
10408 _ => panic!("Unexpected event"),
10410 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
10411 open_channel_msg.temporary_channel_id);
10413 // ...however if we accept the same channel 0conf it should work just fine.
10414 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10415 let events = nodes[1].node.get_and_clear_pending_events();
10417 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10418 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23).unwrap();
10420 _ => panic!("Unexpected event"),
10422 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
10426 fn reject_excessively_underpaying_htlcs() {
10427 let chanmon_cfg = create_chanmon_cfgs(1);
10428 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
10429 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
10430 let node = create_network(1, &node_cfg, &node_chanmgr);
10431 let sender_intended_amt_msat = 100;
10432 let extra_fee_msat = 10;
10433 let hop_data = msgs::InboundOnionPayload::Receive {
10435 outgoing_cltv_value: 42,
10436 payment_metadata: None,
10437 keysend_preimage: None,
10438 payment_data: Some(msgs::FinalOnionHopData {
10439 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
10441 custom_tlvs: Vec::new(),
10443 // Check that if the amount we received + the penultimate hop extra fee is less than the sender
10444 // intended amount, we fail the payment.
10445 if let Err(crate::ln::channelmanager::InboundOnionErr { err_code, .. }) =
10446 node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
10447 sender_intended_amt_msat - extra_fee_msat - 1, 42, None, true, Some(extra_fee_msat))
10449 assert_eq!(err_code, 19);
10450 } else { panic!(); }
10452 // If amt_received + extra_fee is equal to the sender intended amount, we're fine.
10453 let hop_data = msgs::InboundOnionPayload::Receive { // This is the same payload as above, InboundOnionPayload doesn't implement Clone
10455 outgoing_cltv_value: 42,
10456 payment_metadata: None,
10457 keysend_preimage: None,
10458 payment_data: Some(msgs::FinalOnionHopData {
10459 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
10461 custom_tlvs: Vec::new(),
10463 assert!(node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
10464 sender_intended_amt_msat - extra_fee_msat, 42, None, true, Some(extra_fee_msat)).is_ok());
10468 fn test_inbound_anchors_manual_acceptance() {
10469 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
10470 // flag set and (sometimes) accept channels as 0conf.
10471 let mut anchors_cfg = test_default_channel_config();
10472 anchors_cfg.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
10474 let mut anchors_manual_accept_cfg = anchors_cfg.clone();
10475 anchors_manual_accept_cfg.manually_accept_inbound_channels = true;
10477 let chanmon_cfgs = create_chanmon_cfgs(3);
10478 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
10479 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs,
10480 &[Some(anchors_cfg.clone()), Some(anchors_cfg.clone()), Some(anchors_manual_accept_cfg.clone())]);
10481 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
10483 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10484 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10486 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10487 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
10488 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
10489 match &msg_events[0] {
10490 MessageSendEvent::HandleError { node_id, action } => {
10491 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
10493 ErrorAction::SendErrorMessage { msg } =>
10494 assert_eq!(msg.data, "No channels with anchor outputs accepted".to_owned()),
10495 _ => panic!("Unexpected error action"),
10498 _ => panic!("Unexpected event"),
10501 nodes[2].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10502 let events = nodes[2].node.get_and_clear_pending_events();
10504 Event::OpenChannelRequest { temporary_channel_id, .. } =>
10505 nodes[2].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap(),
10506 _ => panic!("Unexpected event"),
10508 get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10512 fn test_anchors_zero_fee_htlc_tx_fallback() {
10513 // Tests that if both nodes support anchors, but the remote node does not want to accept
10514 // anchor channels at the moment, an error it sent to the local node such that it can retry
10515 // the channel without the anchors feature.
10516 let chanmon_cfgs = create_chanmon_cfgs(2);
10517 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10518 let mut anchors_config = test_default_channel_config();
10519 anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
10520 anchors_config.manually_accept_inbound_channels = true;
10521 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config.clone()), Some(anchors_config.clone())]);
10522 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10524 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 0, None).unwrap();
10525 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10526 assert!(open_channel_msg.channel_type.as_ref().unwrap().supports_anchors_zero_fee_htlc_tx());
10528 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10529 let events = nodes[1].node.get_and_clear_pending_events();
10531 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10532 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
10534 _ => panic!("Unexpected event"),
10537 let error_msg = get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id());
10538 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &error_msg);
10540 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10541 assert!(!open_channel_msg.channel_type.unwrap().supports_anchors_zero_fee_htlc_tx());
10543 // Since nodes[1] should not have accepted the channel, it should
10544 // not have generated any events.
10545 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
10549 fn test_update_channel_config() {
10550 let chanmon_cfg = create_chanmon_cfgs(2);
10551 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
10552 let mut user_config = test_default_channel_config();
10553 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
10554 let nodes = create_network(2, &node_cfg, &node_chanmgr);
10555 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
10556 let channel = &nodes[0].node.list_channels()[0];
10558 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
10559 let events = nodes[0].node.get_and_clear_pending_msg_events();
10560 assert_eq!(events.len(), 0);
10562 user_config.channel_config.forwarding_fee_base_msat += 10;
10563 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
10564 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_base_msat, user_config.channel_config.forwarding_fee_base_msat);
10565 let events = nodes[0].node.get_and_clear_pending_msg_events();
10566 assert_eq!(events.len(), 1);
10568 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10569 _ => panic!("expected BroadcastChannelUpdate event"),
10572 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate::default()).unwrap();
10573 let events = nodes[0].node.get_and_clear_pending_msg_events();
10574 assert_eq!(events.len(), 0);
10576 let new_cltv_expiry_delta = user_config.channel_config.cltv_expiry_delta + 6;
10577 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
10578 cltv_expiry_delta: Some(new_cltv_expiry_delta),
10579 ..Default::default()
10581 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
10582 let events = nodes[0].node.get_and_clear_pending_msg_events();
10583 assert_eq!(events.len(), 1);
10585 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10586 _ => panic!("expected BroadcastChannelUpdate event"),
10589 let new_fee = user_config.channel_config.forwarding_fee_proportional_millionths + 100;
10590 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
10591 forwarding_fee_proportional_millionths: Some(new_fee),
10592 ..Default::default()
10594 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
10595 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, new_fee);
10596 let events = nodes[0].node.get_and_clear_pending_msg_events();
10597 assert_eq!(events.len(), 1);
10599 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10600 _ => panic!("expected BroadcastChannelUpdate event"),
10603 // If we provide a channel_id not associated with the peer, we should get an error and no updates
10604 // should be applied to ensure update atomicity as specified in the API docs.
10605 let bad_channel_id = ChannelId::v1_from_funding_txid(&[10; 32], 10);
10606 let current_fee = nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths;
10607 let new_fee = current_fee + 100;
10610 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id, bad_channel_id], &ChannelConfigUpdate {
10611 forwarding_fee_proportional_millionths: Some(new_fee),
10612 ..Default::default()
10614 Err(APIError::ChannelUnavailable { err: _ }),
10617 // Check that the fee hasn't changed for the channel that exists.
10618 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, current_fee);
10619 let events = nodes[0].node.get_and_clear_pending_msg_events();
10620 assert_eq!(events.len(), 0);
10624 fn test_payment_display() {
10625 let payment_id = PaymentId([42; 32]);
10626 assert_eq!(format!("{}", &payment_id), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
10627 let payment_hash = PaymentHash([42; 32]);
10628 assert_eq!(format!("{}", &payment_hash), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
10629 let payment_preimage = PaymentPreimage([42; 32]);
10630 assert_eq!(format!("{}", &payment_preimage), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
10636 use crate::chain::Listen;
10637 use crate::chain::chainmonitor::{ChainMonitor, Persist};
10638 use crate::sign::{KeysManager, InMemorySigner};
10639 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider};
10640 use crate::ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId, RecipientOnionFields, Retry};
10641 use crate::ln::functional_test_utils::*;
10642 use crate::ln::msgs::{ChannelMessageHandler, Init};
10643 use crate::routing::gossip::NetworkGraph;
10644 use crate::routing::router::{PaymentParameters, RouteParameters};
10645 use crate::util::test_utils;
10646 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
10648 use bitcoin::hashes::Hash;
10649 use bitcoin::hashes::sha256::Hash as Sha256;
10650 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
10652 use crate::sync::{Arc, Mutex, RwLock};
10654 use criterion::Criterion;
10656 type Manager<'a, P> = ChannelManager<
10657 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
10658 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
10659 &'a test_utils::TestLogger, &'a P>,
10660 &'a test_utils::TestBroadcaster, &'a KeysManager, &'a KeysManager, &'a KeysManager,
10661 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
10662 &'a test_utils::TestLogger>;
10664 struct ANodeHolder<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> {
10665 node: &'node_cfg Manager<'chan_mon_cfg, P>,
10667 impl<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> NodeHolder for ANodeHolder<'node_cfg, 'chan_mon_cfg, P> {
10668 type CM = Manager<'chan_mon_cfg, P>;
10670 fn node(&self) -> &Manager<'chan_mon_cfg, P> { self.node }
10672 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { None }
10675 pub fn bench_sends(bench: &mut Criterion) {
10676 bench_two_sends(bench, "bench_sends", test_utils::TestPersister::new(), test_utils::TestPersister::new());
10679 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Criterion, bench_name: &str, persister_a: P, persister_b: P) {
10680 // Do a simple benchmark of sending a payment back and forth between two nodes.
10681 // Note that this is unrealistic as each payment send will require at least two fsync
10683 let network = bitcoin::Network::Testnet;
10684 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
10686 let tx_broadcaster = test_utils::TestBroadcaster::new(network);
10687 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
10688 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
10689 let scorer = RwLock::new(test_utils::TestScorer::new());
10690 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(network, &logger_a)), &scorer);
10692 let mut config: UserConfig = Default::default();
10693 config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
10694 config.channel_handshake_config.minimum_depth = 1;
10696 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
10697 let seed_a = [1u8; 32];
10698 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
10699 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 {
10701 best_block: BestBlock::from_network(network),
10702 }, genesis_block.header.time);
10703 let node_a_holder = ANodeHolder { node: &node_a };
10705 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
10706 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
10707 let seed_b = [2u8; 32];
10708 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
10709 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 {
10711 best_block: BestBlock::from_network(network),
10712 }, genesis_block.header.time);
10713 let node_b_holder = ANodeHolder { node: &node_b };
10715 node_a.peer_connected(&node_b.get_our_node_id(), &Init {
10716 features: node_b.init_features(), networks: None, remote_network_address: None
10718 node_b.peer_connected(&node_a.get_our_node_id(), &Init {
10719 features: node_a.init_features(), networks: None, remote_network_address: None
10720 }, false).unwrap();
10721 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
10722 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()));
10723 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()));
10726 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
10727 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
10728 value: 8_000_000, script_pubkey: output_script,
10730 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
10731 } else { panic!(); }
10733 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()));
10734 let events_b = node_b.get_and_clear_pending_events();
10735 assert_eq!(events_b.len(), 1);
10736 match events_b[0] {
10737 Event::ChannelPending{ ref counterparty_node_id, .. } => {
10738 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
10740 _ => panic!("Unexpected event"),
10743 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()));
10744 let events_a = node_a.get_and_clear_pending_events();
10745 assert_eq!(events_a.len(), 1);
10746 match events_a[0] {
10747 Event::ChannelPending{ ref counterparty_node_id, .. } => {
10748 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
10750 _ => panic!("Unexpected event"),
10753 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
10755 let block = create_dummy_block(BestBlock::from_network(network).block_hash(), 42, vec![tx]);
10756 Listen::block_connected(&node_a, &block, 1);
10757 Listen::block_connected(&node_b, &block, 1);
10759 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()));
10760 let msg_events = node_a.get_and_clear_pending_msg_events();
10761 assert_eq!(msg_events.len(), 2);
10762 match msg_events[0] {
10763 MessageSendEvent::SendChannelReady { ref msg, .. } => {
10764 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
10765 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
10769 match msg_events[1] {
10770 MessageSendEvent::SendChannelUpdate { .. } => {},
10774 let events_a = node_a.get_and_clear_pending_events();
10775 assert_eq!(events_a.len(), 1);
10776 match events_a[0] {
10777 Event::ChannelReady{ ref counterparty_node_id, .. } => {
10778 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
10780 _ => panic!("Unexpected event"),
10783 let events_b = node_b.get_and_clear_pending_events();
10784 assert_eq!(events_b.len(), 1);
10785 match events_b[0] {
10786 Event::ChannelReady{ ref counterparty_node_id, .. } => {
10787 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
10789 _ => panic!("Unexpected event"),
10792 let mut payment_count: u64 = 0;
10793 macro_rules! send_payment {
10794 ($node_a: expr, $node_b: expr) => {
10795 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id(), TEST_FINAL_CLTV)
10796 .with_bolt11_features($node_b.invoice_features()).unwrap();
10797 let mut payment_preimage = PaymentPreimage([0; 32]);
10798 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
10799 payment_count += 1;
10800 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
10801 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
10803 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
10804 PaymentId(payment_hash.0), RouteParameters {
10805 payment_params, final_value_msat: 10_000,
10806 }, Retry::Attempts(0)).unwrap();
10807 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
10808 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
10809 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
10810 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_b }, &$node_a.get_our_node_id());
10811 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
10812 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
10813 $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()));
10815 expect_pending_htlcs_forwardable!(ANodeHolder { node: &$node_b });
10816 expect_payment_claimable!(ANodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
10817 $node_b.claim_funds(payment_preimage);
10818 expect_payment_claimed!(ANodeHolder { node: &$node_b }, payment_hash, 10_000);
10820 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
10821 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
10822 assert_eq!(node_id, $node_a.get_our_node_id());
10823 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
10824 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
10826 _ => panic!("Failed to generate claim event"),
10829 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_a }, &$node_b.get_our_node_id());
10830 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
10831 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
10832 $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()));
10834 expect_payment_sent!(ANodeHolder { node: &$node_a }, payment_preimage);
10838 bench.bench_function(bench_name, |b| b.iter(|| {
10839 send_payment!(node_a, node_b);
10840 send_payment!(node_b, node_a);