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 attempts 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 /// # Event Generation
3390 /// If no [`Event::PaymentFailed`] event had been generated before, one will be generated as soon
3391 /// as there are no remaining pending HTLCs for this payment.
3393 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
3394 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
3395 /// determine the ultimate status of a payment.
3397 /// # Requested Invoices
3399 /// In the case of paying a [`Bolt12Invoice`], abandoning the payment prior to receiving the
3400 /// invoice will result in an [`Event::InvoiceRequestFailed`] and prevent any attempts at paying
3401 /// it once received. The other events may only be generated once the invoice has been received.
3403 /// # Restart Behavior
3405 /// If an [`Event::PaymentFailed`] is generated and we restart without first persisting the
3406 /// [`ChannelManager`], another [`Event::PaymentFailed`] may be generated; likewise for
3407 /// [`Event::InvoiceRequestFailed`].
3409 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
3410 pub fn abandon_payment(&self, payment_id: PaymentId) {
3411 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3412 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
3415 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
3416 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
3417 /// the preimage, it must be a cryptographically secure random value that no intermediate node
3418 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
3419 /// never reach the recipient.
3421 /// See [`send_payment`] documentation for more details on the return value of this function
3422 /// and idempotency guarantees provided by the [`PaymentId`] key.
3424 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
3425 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
3427 /// [`send_payment`]: Self::send_payment
3428 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
3429 let best_block_height = self.best_block.read().unwrap().height();
3430 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3431 self.pending_outbound_payments.send_spontaneous_payment_with_route(
3432 route, payment_preimage, recipient_onion, payment_id, &self.entropy_source,
3433 &self.node_signer, best_block_height, |args| self.send_payment_along_path(args))
3436 /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
3437 /// based on `route_params` and retry failed payment paths based on `retry_strategy`.
3439 /// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous
3442 /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
3443 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> {
3444 let best_block_height = self.best_block.read().unwrap().height();
3445 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3446 self.pending_outbound_payments.send_spontaneous_payment(payment_preimage, recipient_onion,
3447 payment_id, retry_strategy, route_params, &self.router, self.list_usable_channels(),
3448 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
3449 &self.logger, &self.pending_events, |args| self.send_payment_along_path(args))
3452 /// Send a payment that is probing the given route for liquidity. We calculate the
3453 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
3454 /// us to easily discern them from real payments.
3455 pub fn send_probe(&self, path: Path) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
3456 let best_block_height = self.best_block.read().unwrap().height();
3457 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3458 self.pending_outbound_payments.send_probe(path, self.probing_cookie_secret,
3459 &self.entropy_source, &self.node_signer, best_block_height,
3460 |args| self.send_payment_along_path(args))
3463 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
3466 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
3467 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
3470 /// Handles the generation of a funding transaction, optionally (for tests) with a function
3471 /// which checks the correctness of the funding transaction given the associated channel.
3472 fn funding_transaction_generated_intern<FundingOutput: Fn(&OutboundV1Channel<SP>, &Transaction) -> Result<OutPoint, APIError>>(
3473 &self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
3474 ) -> Result<(), APIError> {
3475 let per_peer_state = self.per_peer_state.read().unwrap();
3476 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3477 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3479 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3480 let peer_state = &mut *peer_state_lock;
3481 let (chan, msg) = match peer_state.outbound_v1_channel_by_id.remove(&temporary_channel_id) {
3483 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
3485 let funding_res = chan.get_funding_created(funding_transaction, funding_txo, &self.logger)
3486 .map_err(|(mut chan, e)| if let ChannelError::Close(msg) = e {
3487 let channel_id = chan.context.channel_id();
3488 let user_id = chan.context.get_user_id();
3489 let shutdown_res = chan.context.force_shutdown(false);
3490 let channel_capacity = chan.context.get_value_satoshis();
3491 (chan, MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, user_id, shutdown_res, None, channel_capacity))
3492 } else { unreachable!(); });
3494 Ok((chan, funding_msg)) => (chan, funding_msg),
3495 Err((chan, err)) => {
3496 mem::drop(peer_state_lock);
3497 mem::drop(per_peer_state);
3499 let _: Result<(), _> = handle_error!(self, Err(err), chan.context.get_counterparty_node_id());
3500 return Err(APIError::ChannelUnavailable {
3501 err: "Signer refused to sign the initial commitment transaction".to_owned()
3507 return Err(APIError::ChannelUnavailable {
3509 "Channel with id {} not found for the passed counterparty node_id {}",
3510 temporary_channel_id, counterparty_node_id),
3515 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
3516 node_id: chan.context.get_counterparty_node_id(),
3519 match peer_state.channel_by_id.entry(chan.context.channel_id()) {
3520 hash_map::Entry::Occupied(_) => {
3521 panic!("Generated duplicate funding txid?");
3523 hash_map::Entry::Vacant(e) => {
3524 let mut id_to_peer = self.id_to_peer.lock().unwrap();
3525 if id_to_peer.insert(chan.context.channel_id(), chan.context.get_counterparty_node_id()).is_some() {
3526 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
3535 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
3536 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
3537 Ok(OutPoint { txid: tx.txid(), index: output_index })
3541 /// Call this upon creation of a funding transaction for the given channel.
3543 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
3544 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
3546 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
3547 /// across the p2p network.
3549 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
3550 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
3552 /// May panic if the output found in the funding transaction is duplicative with some other
3553 /// channel (note that this should be trivially prevented by using unique funding transaction
3554 /// keys per-channel).
3556 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
3557 /// counterparty's signature the funding transaction will automatically be broadcast via the
3558 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
3560 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
3561 /// not currently support replacing a funding transaction on an existing channel. Instead,
3562 /// create a new channel with a conflicting funding transaction.
3564 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
3565 /// the wallet software generating the funding transaction to apply anti-fee sniping as
3566 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
3567 /// for more details.
3569 /// [`Event::FundingGenerationReady`]: crate::events::Event::FundingGenerationReady
3570 /// [`Event::ChannelClosed`]: crate::events::Event::ChannelClosed
3571 pub fn funding_transaction_generated(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
3572 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3574 if !funding_transaction.is_coin_base() {
3575 for inp in funding_transaction.input.iter() {
3576 if inp.witness.is_empty() {
3577 return Err(APIError::APIMisuseError {
3578 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
3584 let height = self.best_block.read().unwrap().height();
3585 // Transactions are evaluated as final by network mempools if their locktime is strictly
3586 // lower than the next block height. However, the modules constituting our Lightning
3587 // node might not have perfect sync about their blockchain views. Thus, if the wallet
3588 // module is ahead of LDK, only allow one more block of headroom.
3589 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 {
3590 return Err(APIError::APIMisuseError {
3591 err: "Funding transaction absolute timelock is non-final".to_owned()
3595 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
3596 if tx.output.len() > u16::max_value() as usize {
3597 return Err(APIError::APIMisuseError {
3598 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
3602 let mut output_index = None;
3603 let expected_spk = chan.context.get_funding_redeemscript().to_v0_p2wsh();
3604 for (idx, outp) in tx.output.iter().enumerate() {
3605 if outp.script_pubkey == expected_spk && outp.value == chan.context.get_value_satoshis() {
3606 if output_index.is_some() {
3607 return Err(APIError::APIMisuseError {
3608 err: "Multiple outputs matched the expected script and value".to_owned()
3611 output_index = Some(idx as u16);
3614 if output_index.is_none() {
3615 return Err(APIError::APIMisuseError {
3616 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
3619 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
3623 /// Atomically applies partial updates to the [`ChannelConfig`] of the given channels.
3625 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3626 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3627 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3628 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3630 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3631 /// `counterparty_node_id` is provided.
3633 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3634 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3636 /// If an error is returned, none of the updates should be considered applied.
3638 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3639 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3640 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3641 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3642 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3643 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3644 /// [`APIMisuseError`]: APIError::APIMisuseError
3645 pub fn update_partial_channel_config(
3646 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config_update: &ChannelConfigUpdate,
3647 ) -> Result<(), APIError> {
3648 if config_update.cltv_expiry_delta.map(|delta| delta < MIN_CLTV_EXPIRY_DELTA).unwrap_or(false) {
3649 return Err(APIError::APIMisuseError {
3650 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
3654 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3655 let per_peer_state = self.per_peer_state.read().unwrap();
3656 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3657 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3658 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3659 let peer_state = &mut *peer_state_lock;
3660 for channel_id in channel_ids {
3661 if !peer_state.has_channel(channel_id) {
3662 return Err(APIError::ChannelUnavailable {
3663 err: format!("Channel with ID {} was not found for the passed counterparty_node_id {}", channel_id, counterparty_node_id),
3667 for channel_id in channel_ids {
3668 if let Some(channel) = peer_state.channel_by_id.get_mut(channel_id) {
3669 let mut config = channel.context.config();
3670 config.apply(config_update);
3671 if !channel.context.update_config(&config) {
3674 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
3675 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
3676 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
3677 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
3678 node_id: channel.context.get_counterparty_node_id(),
3685 let context = if let Some(channel) = peer_state.inbound_v1_channel_by_id.get_mut(channel_id) {
3686 &mut channel.context
3687 } else if let Some(channel) = peer_state.outbound_v1_channel_by_id.get_mut(channel_id) {
3688 &mut channel.context
3690 // This should not be reachable as we've already checked for non-existence in the previous channel_id loop.
3691 debug_assert!(false);
3692 return Err(APIError::ChannelUnavailable {
3694 "Channel with ID {} for passed counterparty_node_id {} disappeared after we confirmed its existence - this should not be reachable!",
3695 channel_id, counterparty_node_id),
3698 let mut config = context.config();
3699 config.apply(config_update);
3700 // We update the config, but we MUST NOT broadcast a `channel_update` before `channel_ready`
3701 // which would be the case for pending inbound/outbound channels.
3702 context.update_config(&config);
3707 /// Atomically updates the [`ChannelConfig`] for the given channels.
3709 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3710 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3711 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3712 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3714 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3715 /// `counterparty_node_id` is provided.
3717 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3718 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3720 /// If an error is returned, none of the updates should be considered applied.
3722 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3723 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3724 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3725 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3726 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3727 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3728 /// [`APIMisuseError`]: APIError::APIMisuseError
3729 pub fn update_channel_config(
3730 &self, counterparty_node_id: &PublicKey, channel_ids: &[ChannelId], config: &ChannelConfig,
3731 ) -> Result<(), APIError> {
3732 return self.update_partial_channel_config(counterparty_node_id, channel_ids, &(*config).into());
3735 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
3736 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
3738 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
3739 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
3741 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
3742 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
3743 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
3744 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
3745 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
3747 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
3748 /// you from forwarding more than you received. See
3749 /// [`HTLCIntercepted::expected_outbound_amount_msat`] for more on forwarding a different amount
3752 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
3755 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
3756 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
3757 /// [`HTLCIntercepted::expected_outbound_amount_msat`]: events::Event::HTLCIntercepted::expected_outbound_amount_msat
3758 // TODO: when we move to deciding the best outbound channel at forward time, only take
3759 // `next_node_id` and not `next_hop_channel_id`
3760 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> {
3761 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3763 let next_hop_scid = {
3764 let peer_state_lock = self.per_peer_state.read().unwrap();
3765 let peer_state_mutex = peer_state_lock.get(&next_node_id)
3766 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) })?;
3767 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3768 let peer_state = &mut *peer_state_lock;
3769 match peer_state.channel_by_id.get(&next_hop_channel_id) {
3771 if !chan.context.is_usable() {
3772 return Err(APIError::ChannelUnavailable {
3773 err: format!("Channel with id {} not fully established", next_hop_channel_id)
3776 chan.context.get_short_channel_id().unwrap_or(chan.context.outbound_scid_alias())
3778 None => return Err(APIError::ChannelUnavailable {
3779 err: format!("Funded channel with id {} not found for the passed counterparty node_id {}. Channel may still be opening.",
3780 next_hop_channel_id, next_node_id)
3785 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
3786 .ok_or_else(|| APIError::APIMisuseError {
3787 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
3790 let routing = match payment.forward_info.routing {
3791 PendingHTLCRouting::Forward { onion_packet, .. } => {
3792 PendingHTLCRouting::Forward { onion_packet, short_channel_id: next_hop_scid }
3794 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
3796 let skimmed_fee_msat =
3797 payment.forward_info.outgoing_amt_msat.saturating_sub(amt_to_forward_msat);
3798 let pending_htlc_info = PendingHTLCInfo {
3799 skimmed_fee_msat: if skimmed_fee_msat == 0 { None } else { Some(skimmed_fee_msat) },
3800 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
3803 let mut per_source_pending_forward = [(
3804 payment.prev_short_channel_id,
3805 payment.prev_funding_outpoint,
3806 payment.prev_user_channel_id,
3807 vec![(pending_htlc_info, payment.prev_htlc_id)]
3809 self.forward_htlcs(&mut per_source_pending_forward);
3813 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
3814 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
3816 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
3819 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
3820 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
3821 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3823 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
3824 .ok_or_else(|| APIError::APIMisuseError {
3825 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
3828 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
3829 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3830 short_channel_id: payment.prev_short_channel_id,
3831 user_channel_id: Some(payment.prev_user_channel_id),
3832 outpoint: payment.prev_funding_outpoint,
3833 htlc_id: payment.prev_htlc_id,
3834 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
3835 phantom_shared_secret: None,
3838 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
3839 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
3840 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
3841 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
3846 /// Processes HTLCs which are pending waiting on random forward delay.
3848 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
3849 /// Will likely generate further events.
3850 pub fn process_pending_htlc_forwards(&self) {
3851 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3853 let mut new_events = VecDeque::new();
3854 let mut failed_forwards = Vec::new();
3855 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
3857 let mut forward_htlcs = HashMap::new();
3858 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
3860 for (short_chan_id, mut pending_forwards) in forward_htlcs {
3861 if short_chan_id != 0 {
3862 macro_rules! forwarding_channel_not_found {
3864 for forward_info in pending_forwards.drain(..) {
3865 match forward_info {
3866 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3867 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3868 forward_info: PendingHTLCInfo {
3869 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
3870 outgoing_cltv_value, ..
3873 macro_rules! failure_handler {
3874 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
3875 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3877 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3878 short_channel_id: prev_short_channel_id,
3879 user_channel_id: Some(prev_user_channel_id),
3880 outpoint: prev_funding_outpoint,
3881 htlc_id: prev_htlc_id,
3882 incoming_packet_shared_secret: incoming_shared_secret,
3883 phantom_shared_secret: $phantom_ss,
3886 let reason = if $next_hop_unknown {
3887 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
3889 HTLCDestination::FailedPayment{ payment_hash }
3892 failed_forwards.push((htlc_source, payment_hash,
3893 HTLCFailReason::reason($err_code, $err_data),
3899 macro_rules! fail_forward {
3900 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3902 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
3906 macro_rules! failed_payment {
3907 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3909 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
3913 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
3914 let phantom_pubkey_res = self.node_signer.get_node_id(Recipient::PhantomNode);
3915 if phantom_pubkey_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.genesis_hash) {
3916 let phantom_shared_secret = self.node_signer.ecdh(Recipient::PhantomNode, &onion_packet.public_key.unwrap(), None).unwrap().secret_bytes();
3917 let next_hop = match onion_utils::decode_next_payment_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
3919 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
3920 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
3921 // In this scenario, the phantom would have sent us an
3922 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
3923 // if it came from us (the second-to-last hop) but contains the sha256
3925 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
3927 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3928 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
3932 onion_utils::Hop::Receive(hop_data) => {
3933 match self.construct_recv_pending_htlc_info(hop_data,
3934 incoming_shared_secret, payment_hash, outgoing_amt_msat,
3935 outgoing_cltv_value, Some(phantom_shared_secret), false, None)
3937 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
3938 Err(InboundOnionErr { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
3944 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3947 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3950 HTLCForwardInfo::FailHTLC { .. } => {
3951 // Channel went away before we could fail it. This implies
3952 // the channel is now on chain and our counterparty is
3953 // trying to broadcast the HTLC-Timeout, but that's their
3954 // problem, not ours.
3960 let (counterparty_node_id, forward_chan_id) = match self.short_to_chan_info.read().unwrap().get(&short_chan_id) {
3961 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3963 forwarding_channel_not_found!();
3967 let per_peer_state = self.per_peer_state.read().unwrap();
3968 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3969 if peer_state_mutex_opt.is_none() {
3970 forwarding_channel_not_found!();
3973 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
3974 let peer_state = &mut *peer_state_lock;
3975 match peer_state.channel_by_id.entry(forward_chan_id) {
3976 hash_map::Entry::Vacant(_) => {
3977 forwarding_channel_not_found!();
3980 hash_map::Entry::Occupied(mut chan) => {
3981 for forward_info in pending_forwards.drain(..) {
3982 match forward_info {
3983 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3984 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3985 forward_info: PendingHTLCInfo {
3986 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
3987 routing: PendingHTLCRouting::Forward { onion_packet, .. }, skimmed_fee_msat, ..
3990 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);
3991 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3992 short_channel_id: prev_short_channel_id,
3993 user_channel_id: Some(prev_user_channel_id),
3994 outpoint: prev_funding_outpoint,
3995 htlc_id: prev_htlc_id,
3996 incoming_packet_shared_secret: incoming_shared_secret,
3997 // Phantom payments are only PendingHTLCRouting::Receive.
3998 phantom_shared_secret: None,
4000 if let Err(e) = chan.get_mut().queue_add_htlc(outgoing_amt_msat,
4001 payment_hash, outgoing_cltv_value, htlc_source.clone(),
4002 onion_packet, skimmed_fee_msat, &self.fee_estimator,
4005 if let ChannelError::Ignore(msg) = e {
4006 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", &payment_hash, msg);
4008 panic!("Stated return value requirements in send_htlc() were not met");
4010 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan.get());
4011 failed_forwards.push((htlc_source, payment_hash,
4012 HTLCFailReason::reason(failure_code, data),
4013 HTLCDestination::NextHopChannel { node_id: Some(chan.get().context.get_counterparty_node_id()), channel_id: forward_chan_id }
4018 HTLCForwardInfo::AddHTLC { .. } => {
4019 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
4021 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
4022 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
4023 if let Err(e) = chan.get_mut().queue_fail_htlc(
4024 htlc_id, err_packet, &self.logger
4026 if let ChannelError::Ignore(msg) = e {
4027 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
4029 panic!("Stated return value requirements in queue_fail_htlc() were not met");
4031 // fail-backs are best-effort, we probably already have one
4032 // pending, and if not that's OK, if not, the channel is on
4033 // the chain and sending the HTLC-Timeout is their problem.
4042 'next_forwardable_htlc: for forward_info in pending_forwards.drain(..) {
4043 match forward_info {
4044 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4045 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
4046 forward_info: PendingHTLCInfo {
4047 routing, incoming_shared_secret, payment_hash, incoming_amt_msat, outgoing_amt_msat,
4048 skimmed_fee_msat, ..
4051 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret, mut onion_fields) = match routing {
4052 PendingHTLCRouting::Receive { payment_data, payment_metadata, incoming_cltv_expiry, phantom_shared_secret, custom_tlvs } => {
4053 let _legacy_hop_data = Some(payment_data.clone());
4054 let onion_fields = RecipientOnionFields { payment_secret: Some(payment_data.payment_secret),
4055 payment_metadata, custom_tlvs };
4056 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data },
4057 Some(payment_data), phantom_shared_secret, onion_fields)
4059 PendingHTLCRouting::ReceiveKeysend { payment_data, payment_preimage, payment_metadata, incoming_cltv_expiry, custom_tlvs } => {
4060 let onion_fields = RecipientOnionFields {
4061 payment_secret: payment_data.as_ref().map(|data| data.payment_secret),
4065 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage),
4066 payment_data, None, onion_fields)
4069 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
4072 let claimable_htlc = ClaimableHTLC {
4073 prev_hop: HTLCPreviousHopData {
4074 short_channel_id: prev_short_channel_id,
4075 user_channel_id: Some(prev_user_channel_id),
4076 outpoint: prev_funding_outpoint,
4077 htlc_id: prev_htlc_id,
4078 incoming_packet_shared_secret: incoming_shared_secret,
4079 phantom_shared_secret,
4081 // We differentiate the received value from the sender intended value
4082 // if possible so that we don't prematurely mark MPP payments complete
4083 // if routing nodes overpay
4084 value: incoming_amt_msat.unwrap_or(outgoing_amt_msat),
4085 sender_intended_value: outgoing_amt_msat,
4087 total_value_received: None,
4088 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
4091 counterparty_skimmed_fee_msat: skimmed_fee_msat,
4094 let mut committed_to_claimable = false;
4096 macro_rules! fail_htlc {
4097 ($htlc: expr, $payment_hash: expr) => {
4098 debug_assert!(!committed_to_claimable);
4099 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
4100 htlc_msat_height_data.extend_from_slice(
4101 &self.best_block.read().unwrap().height().to_be_bytes(),
4103 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
4104 short_channel_id: $htlc.prev_hop.short_channel_id,
4105 user_channel_id: $htlc.prev_hop.user_channel_id,
4106 outpoint: prev_funding_outpoint,
4107 htlc_id: $htlc.prev_hop.htlc_id,
4108 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
4109 phantom_shared_secret,
4111 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
4112 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
4114 continue 'next_forwardable_htlc;
4117 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
4118 let mut receiver_node_id = self.our_network_pubkey;
4119 if phantom_shared_secret.is_some() {
4120 receiver_node_id = self.node_signer.get_node_id(Recipient::PhantomNode)
4121 .expect("Failed to get node_id for phantom node recipient");
4124 macro_rules! check_total_value {
4125 ($purpose: expr) => {{
4126 let mut payment_claimable_generated = false;
4127 let is_keysend = match $purpose {
4128 events::PaymentPurpose::SpontaneousPayment(_) => true,
4129 events::PaymentPurpose::InvoicePayment { .. } => false,
4131 let mut claimable_payments = self.claimable_payments.lock().unwrap();
4132 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
4133 fail_htlc!(claimable_htlc, payment_hash);
4135 let ref mut claimable_payment = claimable_payments.claimable_payments
4136 .entry(payment_hash)
4137 // Note that if we insert here we MUST NOT fail_htlc!()
4138 .or_insert_with(|| {
4139 committed_to_claimable = true;
4141 purpose: $purpose.clone(), htlcs: Vec::new(), onion_fields: None,
4144 if $purpose != claimable_payment.purpose {
4145 let log_keysend = |keysend| if keysend { "keysend" } else { "non-keysend" };
4146 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));
4147 fail_htlc!(claimable_htlc, payment_hash);
4149 if !self.default_configuration.accept_mpp_keysend && is_keysend && !claimable_payment.htlcs.is_empty() {
4150 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);
4151 fail_htlc!(claimable_htlc, payment_hash);
4153 if let Some(earlier_fields) = &mut claimable_payment.onion_fields {
4154 if earlier_fields.check_merge(&mut onion_fields).is_err() {
4155 fail_htlc!(claimable_htlc, payment_hash);
4158 claimable_payment.onion_fields = Some(onion_fields);
4160 let ref mut htlcs = &mut claimable_payment.htlcs;
4161 let mut total_value = claimable_htlc.sender_intended_value;
4162 let mut earliest_expiry = claimable_htlc.cltv_expiry;
4163 for htlc in htlcs.iter() {
4164 total_value += htlc.sender_intended_value;
4165 earliest_expiry = cmp::min(earliest_expiry, htlc.cltv_expiry);
4166 if htlc.total_msat != claimable_htlc.total_msat {
4167 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
4168 &payment_hash, claimable_htlc.total_msat, htlc.total_msat);
4169 total_value = msgs::MAX_VALUE_MSAT;
4171 if total_value >= msgs::MAX_VALUE_MSAT { break; }
4173 // The condition determining whether an MPP is complete must
4174 // match exactly the condition used in `timer_tick_occurred`
4175 if total_value >= msgs::MAX_VALUE_MSAT {
4176 fail_htlc!(claimable_htlc, payment_hash);
4177 } else if total_value - claimable_htlc.sender_intended_value >= claimable_htlc.total_msat {
4178 log_trace!(self.logger, "Failing HTLC with payment_hash {} as payment is already claimable",
4180 fail_htlc!(claimable_htlc, payment_hash);
4181 } else if total_value >= claimable_htlc.total_msat {
4182 #[allow(unused_assignments)] {
4183 committed_to_claimable = true;
4185 let prev_channel_id = prev_funding_outpoint.to_channel_id();
4186 htlcs.push(claimable_htlc);
4187 let amount_msat = htlcs.iter().map(|htlc| htlc.value).sum();
4188 htlcs.iter_mut().for_each(|htlc| htlc.total_value_received = Some(amount_msat));
4189 let counterparty_skimmed_fee_msat = htlcs.iter()
4190 .map(|htlc| htlc.counterparty_skimmed_fee_msat.unwrap_or(0)).sum();
4191 debug_assert!(total_value.saturating_sub(amount_msat) <=
4192 counterparty_skimmed_fee_msat);
4193 new_events.push_back((events::Event::PaymentClaimable {
4194 receiver_node_id: Some(receiver_node_id),
4198 counterparty_skimmed_fee_msat,
4199 via_channel_id: Some(prev_channel_id),
4200 via_user_channel_id: Some(prev_user_channel_id),
4201 claim_deadline: Some(earliest_expiry - HTLC_FAIL_BACK_BUFFER),
4202 onion_fields: claimable_payment.onion_fields.clone(),
4204 payment_claimable_generated = true;
4206 // Nothing to do - we haven't reached the total
4207 // payment value yet, wait until we receive more
4209 htlcs.push(claimable_htlc);
4210 #[allow(unused_assignments)] {
4211 committed_to_claimable = true;
4214 payment_claimable_generated
4218 // Check that the payment hash and secret are known. Note that we
4219 // MUST take care to handle the "unknown payment hash" and
4220 // "incorrect payment secret" cases here identically or we'd expose
4221 // that we are the ultimate recipient of the given payment hash.
4222 // Further, we must not expose whether we have any other HTLCs
4223 // associated with the same payment_hash pending or not.
4224 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4225 match payment_secrets.entry(payment_hash) {
4226 hash_map::Entry::Vacant(_) => {
4227 match claimable_htlc.onion_payload {
4228 OnionPayload::Invoice { .. } => {
4229 let payment_data = payment_data.unwrap();
4230 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) {
4231 Ok(result) => result,
4233 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as payment verification failed", &payment_hash);
4234 fail_htlc!(claimable_htlc, payment_hash);
4237 if let Some(min_final_cltv_expiry_delta) = min_final_cltv_expiry_delta {
4238 let expected_min_expiry_height = (self.current_best_block().height() + min_final_cltv_expiry_delta as u32) as u64;
4239 if (cltv_expiry as u64) < expected_min_expiry_height {
4240 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as its CLTV expiry was too soon (had {}, earliest expected {})",
4241 &payment_hash, cltv_expiry, expected_min_expiry_height);
4242 fail_htlc!(claimable_htlc, payment_hash);
4245 let purpose = events::PaymentPurpose::InvoicePayment {
4246 payment_preimage: payment_preimage.clone(),
4247 payment_secret: payment_data.payment_secret,
4249 check_total_value!(purpose);
4251 OnionPayload::Spontaneous(preimage) => {
4252 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
4253 check_total_value!(purpose);
4257 hash_map::Entry::Occupied(inbound_payment) => {
4258 if let OnionPayload::Spontaneous(_) = claimable_htlc.onion_payload {
4259 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);
4260 fail_htlc!(claimable_htlc, payment_hash);
4262 let payment_data = payment_data.unwrap();
4263 if inbound_payment.get().payment_secret != payment_data.payment_secret {
4264 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", &payment_hash);
4265 fail_htlc!(claimable_htlc, payment_hash);
4266 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
4267 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
4268 &payment_hash, payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
4269 fail_htlc!(claimable_htlc, payment_hash);
4271 let purpose = events::PaymentPurpose::InvoicePayment {
4272 payment_preimage: inbound_payment.get().payment_preimage,
4273 payment_secret: payment_data.payment_secret,
4275 let payment_claimable_generated = check_total_value!(purpose);
4276 if payment_claimable_generated {
4277 inbound_payment.remove_entry();
4283 HTLCForwardInfo::FailHTLC { .. } => {
4284 panic!("Got pending fail of our own HTLC");
4292 let best_block_height = self.best_block.read().unwrap().height();
4293 self.pending_outbound_payments.check_retry_payments(&self.router, || self.list_usable_channels(),
4294 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
4295 &self.pending_events, &self.logger, |args| self.send_payment_along_path(args));
4297 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
4298 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4300 self.forward_htlcs(&mut phantom_receives);
4302 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
4303 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
4304 // nice to do the work now if we can rather than while we're trying to get messages in the
4306 self.check_free_holding_cells();
4308 if new_events.is_empty() { return }
4309 let mut events = self.pending_events.lock().unwrap();
4310 events.append(&mut new_events);
4313 /// Free the background events, generally called from [`PersistenceNotifierGuard`] constructors.
4315 /// Expects the caller to have a total_consistency_lock read lock.
4316 fn process_background_events(&self) -> NotifyOption {
4317 debug_assert_ne!(self.total_consistency_lock.held_by_thread(), LockHeldState::NotHeldByThread);
4319 self.background_events_processed_since_startup.store(true, Ordering::Release);
4321 let mut background_events = Vec::new();
4322 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
4323 if background_events.is_empty() {
4324 return NotifyOption::SkipPersist;
4327 for event in background_events.drain(..) {
4329 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((funding_txo, update)) => {
4330 // The channel has already been closed, so no use bothering to care about the
4331 // monitor updating completing.
4332 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4334 BackgroundEvent::MonitorUpdateRegeneratedOnStartup { counterparty_node_id, funding_txo, update } => {
4335 let mut updated_chan = false;
4337 let per_peer_state = self.per_peer_state.read().unwrap();
4338 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4339 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4340 let peer_state = &mut *peer_state_lock;
4341 match peer_state.channel_by_id.entry(funding_txo.to_channel_id()) {
4342 hash_map::Entry::Occupied(mut chan) => {
4343 updated_chan = true;
4344 handle_new_monitor_update!(self, funding_txo, update.clone(),
4345 peer_state_lock, peer_state, per_peer_state, chan).map(|_| ())
4347 hash_map::Entry::Vacant(_) => Ok(()),
4352 // TODO: Track this as in-flight even though the channel is closed.
4353 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4355 // TODO: If this channel has since closed, we're likely providing a payment
4356 // preimage update, which we must ensure is durable! We currently don't,
4357 // however, ensure that.
4359 log_error!(self.logger,
4360 "Failed to provide ChannelMonitorUpdate to closed channel! This likely lost us a payment preimage!");
4362 let _ = handle_error!(self, res, counterparty_node_id);
4364 BackgroundEvent::MonitorUpdatesComplete { counterparty_node_id, channel_id } => {
4365 let per_peer_state = self.per_peer_state.read().unwrap();
4366 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4367 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4368 let peer_state = &mut *peer_state_lock;
4369 if let Some(chan) = peer_state.channel_by_id.get_mut(&channel_id) {
4370 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, chan);
4372 let update_actions = peer_state.monitor_update_blocked_actions
4373 .remove(&channel_id).unwrap_or(Vec::new());
4374 mem::drop(peer_state_lock);
4375 mem::drop(per_peer_state);
4376 self.handle_monitor_update_completion_actions(update_actions);
4382 NotifyOption::DoPersist
4385 #[cfg(any(test, feature = "_test_utils"))]
4386 /// Process background events, for functional testing
4387 pub fn test_process_background_events(&self) {
4388 let _lck = self.total_consistency_lock.read().unwrap();
4389 let _ = self.process_background_events();
4392 fn update_channel_fee(&self, chan_id: &ChannelId, chan: &mut Channel<SP>, new_feerate: u32) -> NotifyOption {
4393 if !chan.context.is_outbound() { return NotifyOption::SkipPersist; }
4394 // If the feerate has decreased by less than half, don't bother
4395 if new_feerate <= chan.context.get_feerate_sat_per_1000_weight() && new_feerate * 2 > chan.context.get_feerate_sat_per_1000_weight() {
4396 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
4397 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4398 return NotifyOption::SkipPersist;
4400 if !chan.context.is_live() {
4401 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).",
4402 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4403 return NotifyOption::SkipPersist;
4405 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
4406 &chan_id, chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4408 chan.queue_update_fee(new_feerate, &self.fee_estimator, &self.logger);
4409 NotifyOption::DoPersist
4413 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
4414 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
4415 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
4416 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
4417 pub fn maybe_update_chan_fees(&self) {
4418 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4419 let mut should_persist = self.process_background_events();
4421 let normal_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4422 let min_mempool_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::MempoolMinimum);
4424 let per_peer_state = self.per_peer_state.read().unwrap();
4425 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
4426 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4427 let peer_state = &mut *peer_state_lock;
4428 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
4429 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4434 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4435 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4443 /// Performs actions which should happen on startup and roughly once per minute thereafter.
4445 /// This currently includes:
4446 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
4447 /// * Broadcasting [`ChannelUpdate`] messages if we've been disconnected from our peer for more
4448 /// than a minute, informing the network that they should no longer attempt to route over
4450 /// * Expiring a channel's previous [`ChannelConfig`] if necessary to only allow forwarding HTLCs
4451 /// with the current [`ChannelConfig`].
4452 /// * Removing peers which have disconnected but and no longer have any channels.
4453 /// * Force-closing and removing channels which have not completed establishment in a timely manner.
4455 /// Note that this may cause reentrancy through [`chain::Watch::update_channel`] calls or feerate
4456 /// estimate fetches.
4458 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4459 /// [`ChannelConfig`]: crate::util::config::ChannelConfig
4460 pub fn timer_tick_occurred(&self) {
4461 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4462 let mut should_persist = self.process_background_events();
4464 let normal_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4465 let min_mempool_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::MempoolMinimum);
4467 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
4468 let mut timed_out_mpp_htlcs = Vec::new();
4469 let mut pending_peers_awaiting_removal = Vec::new();
4471 let per_peer_state = self.per_peer_state.read().unwrap();
4472 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
4473 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4474 let peer_state = &mut *peer_state_lock;
4475 let pending_msg_events = &mut peer_state.pending_msg_events;
4476 let counterparty_node_id = *counterparty_node_id;
4477 peer_state.channel_by_id.retain(|chan_id, chan| {
4478 let new_feerate = if chan.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4483 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4484 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4486 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
4487 let (needs_close, err) = convert_chan_err!(self, e, chan, chan_id);
4488 handle_errors.push((Err(err), counterparty_node_id));
4489 if needs_close { return false; }
4492 match chan.channel_update_status() {
4493 ChannelUpdateStatus::Enabled if !chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(0)),
4494 ChannelUpdateStatus::Disabled if chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(0)),
4495 ChannelUpdateStatus::DisabledStaged(_) if chan.context.is_live()
4496 => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
4497 ChannelUpdateStatus::EnabledStaged(_) if !chan.context.is_live()
4498 => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
4499 ChannelUpdateStatus::DisabledStaged(mut n) if !chan.context.is_live() => {
4501 if n >= DISABLE_GOSSIP_TICKS {
4502 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
4503 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4504 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4508 should_persist = NotifyOption::DoPersist;
4510 chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(n));
4513 ChannelUpdateStatus::EnabledStaged(mut n) if chan.context.is_live() => {
4515 if n >= ENABLE_GOSSIP_TICKS {
4516 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
4517 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4518 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4522 should_persist = NotifyOption::DoPersist;
4524 chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(n));
4530 chan.context.maybe_expire_prev_config();
4532 if chan.should_disconnect_peer_awaiting_response() {
4533 log_debug!(self.logger, "Disconnecting peer {} due to not making any progress on channel {}",
4534 counterparty_node_id, chan_id);
4535 pending_msg_events.push(MessageSendEvent::HandleError {
4536 node_id: counterparty_node_id,
4537 action: msgs::ErrorAction::DisconnectPeerWithWarning {
4538 msg: msgs::WarningMessage {
4539 channel_id: *chan_id,
4540 data: "Disconnecting due to timeout awaiting response".to_owned(),
4549 let process_unfunded_channel_tick = |
4550 chan_id: &ChannelId,
4551 chan_context: &mut ChannelContext<SP>,
4552 unfunded_chan_context: &mut UnfundedChannelContext,
4553 pending_msg_events: &mut Vec<MessageSendEvent>,
4555 chan_context.maybe_expire_prev_config();
4556 if unfunded_chan_context.should_expire_unfunded_channel() {
4557 log_error!(self.logger,
4558 "Force-closing pending channel with ID {} for not establishing in a timely manner",
4560 update_maps_on_chan_removal!(self, &chan_context);
4561 self.issue_channel_close_events(&chan_context, ClosureReason::HolderForceClosed);
4562 self.finish_force_close_channel(chan_context.force_shutdown(false));
4563 pending_msg_events.push(MessageSendEvent::HandleError {
4564 node_id: counterparty_node_id,
4565 action: msgs::ErrorAction::SendErrorMessage {
4566 msg: msgs::ErrorMessage {
4567 channel_id: *chan_id,
4568 data: "Force-closing pending channel due to timeout awaiting establishment handshake".to_owned(),
4577 peer_state.outbound_v1_channel_by_id.retain(|chan_id, chan| process_unfunded_channel_tick(
4578 chan_id, &mut chan.context, &mut chan.unfunded_context, pending_msg_events));
4579 peer_state.inbound_v1_channel_by_id.retain(|chan_id, chan| process_unfunded_channel_tick(
4580 chan_id, &mut chan.context, &mut chan.unfunded_context, pending_msg_events));
4582 for (chan_id, req) in peer_state.inbound_channel_request_by_id.iter_mut() {
4583 if { req.ticks_remaining -= 1 ; req.ticks_remaining } <= 0 {
4584 log_error!(self.logger, "Force-closing unaccepted inbound channel {} for not accepting in a timely manner", &chan_id);
4585 peer_state.pending_msg_events.push(
4586 events::MessageSendEvent::HandleError {
4587 node_id: counterparty_node_id,
4588 action: msgs::ErrorAction::SendErrorMessage {
4589 msg: msgs::ErrorMessage { channel_id: chan_id.clone(), data: "Channel force-closed".to_owned() }
4595 peer_state.inbound_channel_request_by_id.retain(|_, req| req.ticks_remaining > 0);
4597 if peer_state.ok_to_remove(true) {
4598 pending_peers_awaiting_removal.push(counterparty_node_id);
4603 // When a peer disconnects but still has channels, the peer's `peer_state` entry in the
4604 // `per_peer_state` is not removed by the `peer_disconnected` function. If the channels
4605 // of to that peer is later closed while still being disconnected (i.e. force closed),
4606 // we therefore need to remove the peer from `peer_state` separately.
4607 // To avoid having to take the `per_peer_state` `write` lock once the channels are
4608 // closed, we instead remove such peers awaiting removal here on a timer, to limit the
4609 // negative effects on parallelism as much as possible.
4610 if pending_peers_awaiting_removal.len() > 0 {
4611 let mut per_peer_state = self.per_peer_state.write().unwrap();
4612 for counterparty_node_id in pending_peers_awaiting_removal {
4613 match per_peer_state.entry(counterparty_node_id) {
4614 hash_map::Entry::Occupied(entry) => {
4615 // Remove the entry if the peer is still disconnected and we still
4616 // have no channels to the peer.
4617 let remove_entry = {
4618 let peer_state = entry.get().lock().unwrap();
4619 peer_state.ok_to_remove(true)
4622 entry.remove_entry();
4625 hash_map::Entry::Vacant(_) => { /* The PeerState has already been removed */ }
4630 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
4631 if payment.htlcs.is_empty() {
4632 // This should be unreachable
4633 debug_assert!(false);
4636 if let OnionPayload::Invoice { .. } = payment.htlcs[0].onion_payload {
4637 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
4638 // In this case we're not going to handle any timeouts of the parts here.
4639 // This condition determining whether the MPP is complete here must match
4640 // exactly the condition used in `process_pending_htlc_forwards`.
4641 if payment.htlcs[0].total_msat <= payment.htlcs.iter()
4642 .fold(0, |total, htlc| total + htlc.sender_intended_value)
4645 } else if payment.htlcs.iter_mut().any(|htlc| {
4646 htlc.timer_ticks += 1;
4647 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
4649 timed_out_mpp_htlcs.extend(payment.htlcs.drain(..)
4650 .map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
4657 for htlc_source in timed_out_mpp_htlcs.drain(..) {
4658 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
4659 let reason = HTLCFailReason::from_failure_code(23);
4660 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
4661 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
4664 for (err, counterparty_node_id) in handle_errors.drain(..) {
4665 let _ = handle_error!(self, err, counterparty_node_id);
4668 self.pending_outbound_payments.remove_stale_resolved_payments(&self.pending_events);
4670 // Technically we don't need to do this here, but if we have holding cell entries in a
4671 // channel that need freeing, it's better to do that here and block a background task
4672 // than block the message queueing pipeline.
4673 if self.check_free_holding_cells() {
4674 should_persist = NotifyOption::DoPersist;
4681 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
4682 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
4683 /// along the path (including in our own channel on which we received it).
4685 /// Note that in some cases around unclean shutdown, it is possible the payment may have
4686 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
4687 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
4688 /// may have already been failed automatically by LDK if it was nearing its expiration time.
4690 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
4691 /// [`ChannelManager::claim_funds`]), you should still monitor for
4692 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
4693 /// startup during which time claims that were in-progress at shutdown may be replayed.
4694 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
4695 self.fail_htlc_backwards_with_reason(payment_hash, FailureCode::IncorrectOrUnknownPaymentDetails);
4698 /// This is a variant of [`ChannelManager::fail_htlc_backwards`] that allows you to specify the
4699 /// reason for the failure.
4701 /// See [`FailureCode`] for valid failure codes.
4702 pub fn fail_htlc_backwards_with_reason(&self, payment_hash: &PaymentHash, failure_code: FailureCode) {
4703 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4705 let removed_source = self.claimable_payments.lock().unwrap().claimable_payments.remove(payment_hash);
4706 if let Some(payment) = removed_source {
4707 for htlc in payment.htlcs {
4708 let reason = self.get_htlc_fail_reason_from_failure_code(failure_code, &htlc);
4709 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
4710 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
4711 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
4716 /// Gets error data to form an [`HTLCFailReason`] given a [`FailureCode`] and [`ClaimableHTLC`].
4717 fn get_htlc_fail_reason_from_failure_code(&self, failure_code: FailureCode, htlc: &ClaimableHTLC) -> HTLCFailReason {
4718 match failure_code {
4719 FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(failure_code.into()),
4720 FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(failure_code.into()),
4721 FailureCode::IncorrectOrUnknownPaymentDetails => {
4722 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
4723 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
4724 HTLCFailReason::reason(failure_code.into(), htlc_msat_height_data)
4726 FailureCode::InvalidOnionPayload(data) => {
4727 let fail_data = match data {
4728 Some((typ, offset)) => [BigSize(typ).encode(), offset.encode()].concat(),
4731 HTLCFailReason::reason(failure_code.into(), fail_data)
4736 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
4737 /// that we want to return and a channel.
4739 /// This is for failures on the channel on which the HTLC was *received*, not failures
4741 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<SP>) -> (u16, Vec<u8>) {
4742 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
4743 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
4744 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
4745 // an inbound SCID alias before the real SCID.
4746 let scid_pref = if chan.context.should_announce() {
4747 chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias())
4749 chan.context.latest_inbound_scid_alias().or(chan.context.get_short_channel_id())
4751 if let Some(scid) = scid_pref {
4752 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
4754 (0x4000|10, Vec::new())
4759 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
4760 /// that we want to return and a channel.
4761 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<SP>) -> (u16, Vec<u8>) {
4762 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
4763 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
4764 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
4765 if desired_err_code == 0x1000 | 20 {
4766 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
4767 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
4768 0u16.write(&mut enc).expect("Writes cannot fail");
4770 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
4771 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
4772 upd.write(&mut enc).expect("Writes cannot fail");
4773 (desired_err_code, enc.0)
4775 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
4776 // which means we really shouldn't have gotten a payment to be forwarded over this
4777 // channel yet, or if we did it's from a route hint. Either way, returning an error of
4778 // PERM|no_such_channel should be fine.
4779 (0x4000|10, Vec::new())
4783 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
4784 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
4785 // be surfaced to the user.
4786 fn fail_holding_cell_htlcs(
4787 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: ChannelId,
4788 counterparty_node_id: &PublicKey
4790 let (failure_code, onion_failure_data) = {
4791 let per_peer_state = self.per_peer_state.read().unwrap();
4792 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4793 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4794 let peer_state = &mut *peer_state_lock;
4795 match peer_state.channel_by_id.entry(channel_id) {
4796 hash_map::Entry::Occupied(chan_entry) => {
4797 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan_entry.get())
4799 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
4801 } else { (0x4000|10, Vec::new()) }
4804 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
4805 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
4806 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
4807 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
4811 /// Fails an HTLC backwards to the sender of it to us.
4812 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
4813 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
4814 // Ensure that no peer state channel storage lock is held when calling this function.
4815 // This ensures that future code doesn't introduce a lock-order requirement for
4816 // `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
4817 // this function with any `per_peer_state` peer lock acquired would.
4818 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
4819 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
4822 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
4823 //identify whether we sent it or not based on the (I presume) very different runtime
4824 //between the branches here. We should make this async and move it into the forward HTLCs
4827 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4828 // from block_connected which may run during initialization prior to the chain_monitor
4829 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
4831 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, .. } => {
4832 if self.pending_outbound_payments.fail_htlc(source, payment_hash, onion_error, path,
4833 session_priv, payment_id, self.probing_cookie_secret, &self.secp_ctx,
4834 &self.pending_events, &self.logger)
4835 { self.push_pending_forwards_ev(); }
4837 HTLCSource::PreviousHopData(HTLCPreviousHopData { ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret, ref phantom_shared_secret, ref outpoint, .. }) => {
4838 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with {:?}", &payment_hash, onion_error);
4839 let err_packet = onion_error.get_encrypted_failure_packet(incoming_packet_shared_secret, phantom_shared_secret);
4841 let mut push_forward_ev = false;
4842 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
4843 if forward_htlcs.is_empty() {
4844 push_forward_ev = true;
4846 match forward_htlcs.entry(*short_channel_id) {
4847 hash_map::Entry::Occupied(mut entry) => {
4848 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet });
4850 hash_map::Entry::Vacant(entry) => {
4851 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }));
4854 mem::drop(forward_htlcs);
4855 if push_forward_ev { self.push_pending_forwards_ev(); }
4856 let mut pending_events = self.pending_events.lock().unwrap();
4857 pending_events.push_back((events::Event::HTLCHandlingFailed {
4858 prev_channel_id: outpoint.to_channel_id(),
4859 failed_next_destination: destination,
4865 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
4866 /// [`MessageSendEvent`]s needed to claim the payment.
4868 /// This method is guaranteed to ensure the payment has been claimed but only if the current
4869 /// height is strictly below [`Event::PaymentClaimable::claim_deadline`]. To avoid race
4870 /// conditions, you should wait for an [`Event::PaymentClaimed`] before considering the payment
4871 /// successful. It will generally be available in the next [`process_pending_events`] call.
4873 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
4874 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
4875 /// event matches your expectation. If you fail to do so and call this method, you may provide
4876 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
4878 /// This function will fail the payment if it has custom TLVs with even type numbers, as we
4879 /// will assume they are unknown. If you intend to accept even custom TLVs, you should use
4880 /// [`claim_funds_with_known_custom_tlvs`].
4882 /// [`Event::PaymentClaimable`]: crate::events::Event::PaymentClaimable
4883 /// [`Event::PaymentClaimable::claim_deadline`]: crate::events::Event::PaymentClaimable::claim_deadline
4884 /// [`Event::PaymentClaimed`]: crate::events::Event::PaymentClaimed
4885 /// [`process_pending_events`]: EventsProvider::process_pending_events
4886 /// [`create_inbound_payment`]: Self::create_inbound_payment
4887 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
4888 /// [`claim_funds_with_known_custom_tlvs`]: Self::claim_funds_with_known_custom_tlvs
4889 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
4890 self.claim_payment_internal(payment_preimage, false);
4893 /// This is a variant of [`claim_funds`] that allows accepting a payment with custom TLVs with
4894 /// even type numbers.
4898 /// You MUST check you've understood all even TLVs before using this to
4899 /// claim, otherwise you may unintentionally agree to some protocol you do not understand.
4901 /// [`claim_funds`]: Self::claim_funds
4902 pub fn claim_funds_with_known_custom_tlvs(&self, payment_preimage: PaymentPreimage) {
4903 self.claim_payment_internal(payment_preimage, true);
4906 fn claim_payment_internal(&self, payment_preimage: PaymentPreimage, custom_tlvs_known: bool) {
4907 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4909 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4912 let mut claimable_payments = self.claimable_payments.lock().unwrap();
4913 if let Some(payment) = claimable_payments.claimable_payments.remove(&payment_hash) {
4914 let mut receiver_node_id = self.our_network_pubkey;
4915 for htlc in payment.htlcs.iter() {
4916 if htlc.prev_hop.phantom_shared_secret.is_some() {
4917 let phantom_pubkey = self.node_signer.get_node_id(Recipient::PhantomNode)
4918 .expect("Failed to get node_id for phantom node recipient");
4919 receiver_node_id = phantom_pubkey;
4924 let htlcs = payment.htlcs.iter().map(events::ClaimedHTLC::from).collect();
4925 let sender_intended_value = payment.htlcs.first().map(|htlc| htlc.total_msat);
4926 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
4927 ClaimingPayment { amount_msat: payment.htlcs.iter().map(|source| source.value).sum(),
4928 payment_purpose: payment.purpose, receiver_node_id, htlcs, sender_intended_value
4930 if dup_purpose.is_some() {
4931 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
4932 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
4936 if let Some(RecipientOnionFields { ref custom_tlvs, .. }) = payment.onion_fields {
4937 if !custom_tlvs_known && custom_tlvs.iter().any(|(typ, _)| typ % 2 == 0) {
4938 log_info!(self.logger, "Rejecting payment with payment hash {} as we cannot accept payment with unknown even TLVs: {}",
4939 &payment_hash, log_iter!(custom_tlvs.iter().map(|(typ, _)| typ).filter(|typ| *typ % 2 == 0)));
4940 claimable_payments.pending_claiming_payments.remove(&payment_hash);
4941 mem::drop(claimable_payments);
4942 for htlc in payment.htlcs {
4943 let reason = self.get_htlc_fail_reason_from_failure_code(FailureCode::InvalidOnionPayload(None), &htlc);
4944 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
4945 let receiver = HTLCDestination::FailedPayment { payment_hash };
4946 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
4955 debug_assert!(!sources.is_empty());
4957 // Just in case one HTLC has been failed between when we generated the `PaymentClaimable`
4958 // and when we got here we need to check that the amount we're about to claim matches the
4959 // amount we told the user in the last `PaymentClaimable`. We also do a sanity-check that
4960 // the MPP parts all have the same `total_msat`.
4961 let mut claimable_amt_msat = 0;
4962 let mut prev_total_msat = None;
4963 let mut expected_amt_msat = None;
4964 let mut valid_mpp = true;
4965 let mut errs = Vec::new();
4966 let per_peer_state = self.per_peer_state.read().unwrap();
4967 for htlc in sources.iter() {
4968 if prev_total_msat.is_some() && prev_total_msat != Some(htlc.total_msat) {
4969 log_error!(self.logger, "Somehow ended up with an MPP payment with different expected total amounts - this should not be reachable!");
4970 debug_assert!(false);
4974 prev_total_msat = Some(htlc.total_msat);
4976 if expected_amt_msat.is_some() && expected_amt_msat != htlc.total_value_received {
4977 log_error!(self.logger, "Somehow ended up with an MPP payment with different received total amounts - this should not be reachable!");
4978 debug_assert!(false);
4982 expected_amt_msat = htlc.total_value_received;
4983 claimable_amt_msat += htlc.value;
4985 mem::drop(per_peer_state);
4986 if sources.is_empty() || expected_amt_msat.is_none() {
4987 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4988 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
4991 if claimable_amt_msat != expected_amt_msat.unwrap() {
4992 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4993 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
4994 expected_amt_msat.unwrap(), claimable_amt_msat);
4998 for htlc in sources.drain(..) {
4999 if let Err((pk, err)) = self.claim_funds_from_hop(
5000 htlc.prev_hop, payment_preimage,
5001 |_| Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash }))
5003 if let msgs::ErrorAction::IgnoreError = err.err.action {
5004 // We got a temporary failure updating monitor, but will claim the
5005 // HTLC when the monitor updating is restored (or on chain).
5006 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
5007 } else { errs.push((pk, err)); }
5012 for htlc in sources.drain(..) {
5013 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5014 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
5015 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
5016 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
5017 let receiver = HTLCDestination::FailedPayment { payment_hash };
5018 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
5020 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5023 // Now we can handle any errors which were generated.
5024 for (counterparty_node_id, err) in errs.drain(..) {
5025 let res: Result<(), _> = Err(err);
5026 let _ = handle_error!(self, res, counterparty_node_id);
5030 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>) -> Option<MonitorUpdateCompletionAction>>(&self,
5031 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
5032 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
5033 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
5035 // If we haven't yet run background events assume we're still deserializing and shouldn't
5036 // actually pass `ChannelMonitorUpdate`s to users yet. Instead, queue them up as
5037 // `BackgroundEvent`s.
5038 let during_init = !self.background_events_processed_since_startup.load(Ordering::Acquire);
5041 let per_peer_state = self.per_peer_state.read().unwrap();
5042 let chan_id = prev_hop.outpoint.to_channel_id();
5043 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
5044 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
5048 let peer_state_opt = counterparty_node_id_opt.as_ref().map(
5049 |counterparty_node_id| per_peer_state.get(counterparty_node_id)
5050 .map(|peer_mutex| peer_mutex.lock().unwrap())
5053 if peer_state_opt.is_some() {
5054 let mut peer_state_lock = peer_state_opt.unwrap();
5055 let peer_state = &mut *peer_state_lock;
5056 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(chan_id) {
5057 let counterparty_node_id = chan.get().context.get_counterparty_node_id();
5058 let fulfill_res = chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger);
5060 if let UpdateFulfillCommitFetch::NewClaim { htlc_value_msat, monitor_update } = fulfill_res {
5061 if let Some(action) = completion_action(Some(htlc_value_msat)) {
5062 log_trace!(self.logger, "Tracking monitor update completion action for channel {}: {:?}",
5064 peer_state.monitor_update_blocked_actions.entry(chan_id).or_insert(Vec::new()).push(action);
5067 let res = handle_new_monitor_update!(self, prev_hop.outpoint, monitor_update, peer_state_lock,
5068 peer_state, per_peer_state, chan);
5069 if let Err(e) = res {
5070 // TODO: This is a *critical* error - we probably updated the outbound edge
5071 // of the HTLC's monitor with a preimage. We should retry this monitor
5072 // update over and over again until morale improves.
5073 log_error!(self.logger, "Failed to update channel monitor with preimage {:?}", payment_preimage);
5074 return Err((counterparty_node_id, e));
5077 // If we're running during init we cannot update a monitor directly -
5078 // they probably haven't actually been loaded yet. Instead, push the
5079 // monitor update as a background event.
5080 self.pending_background_events.lock().unwrap().push(
5081 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
5082 counterparty_node_id,
5083 funding_txo: prev_hop.outpoint,
5084 update: monitor_update.clone(),
5092 let preimage_update = ChannelMonitorUpdate {
5093 update_id: CLOSED_CHANNEL_UPDATE_ID,
5094 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
5100 // We update the ChannelMonitor on the backward link, after
5101 // receiving an `update_fulfill_htlc` from the forward link.
5102 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, &preimage_update);
5103 if update_res != ChannelMonitorUpdateStatus::Completed {
5104 // TODO: This needs to be handled somehow - if we receive a monitor update
5105 // with a preimage we *must* somehow manage to propagate it to the upstream
5106 // channel, or we must have an ability to receive the same event and try
5107 // again on restart.
5108 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
5109 payment_preimage, update_res);
5112 // If we're running during init we cannot update a monitor directly - they probably
5113 // haven't actually been loaded yet. Instead, push the monitor update as a background
5115 // Note that while it's safe to use `ClosedMonitorUpdateRegeneratedOnStartup` here (the
5116 // channel is already closed) we need to ultimately handle the monitor update
5117 // completion action only after we've completed the monitor update. This is the only
5118 // way to guarantee this update *will* be regenerated on startup (otherwise if this was
5119 // from a forwarded HTLC the downstream preimage may be deleted before we claim
5120 // upstream). Thus, we need to transition to some new `BackgroundEvent` type which will
5121 // complete the monitor update completion action from `completion_action`.
5122 self.pending_background_events.lock().unwrap().push(
5123 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((
5124 prev_hop.outpoint, preimage_update,
5127 // Note that we do process the completion action here. This totally could be a
5128 // duplicate claim, but we have no way of knowing without interrogating the
5129 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
5130 // generally always allowed to be duplicative (and it's specifically noted in
5131 // `PaymentForwarded`).
5132 self.handle_monitor_update_completion_actions(completion_action(None));
5136 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
5137 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
5140 fn claim_funds_internal(&self, source: HTLCSource, payment_preimage: PaymentPreimage, forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, next_channel_outpoint: OutPoint) {
5142 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
5143 debug_assert!(self.background_events_processed_since_startup.load(Ordering::Acquire),
5144 "We don't support claim_htlc claims during startup - monitors may not be available yet");
5145 let ev_completion_action = EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
5146 channel_funding_outpoint: next_channel_outpoint,
5147 counterparty_node_id: path.hops[0].pubkey,
5149 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage,
5150 session_priv, path, from_onchain, ev_completion_action, &self.pending_events,
5153 HTLCSource::PreviousHopData(hop_data) => {
5154 let prev_outpoint = hop_data.outpoint;
5155 let res = self.claim_funds_from_hop(hop_data, payment_preimage,
5156 |htlc_claim_value_msat| {
5157 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
5158 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
5159 Some(claimed_htlc_value - forwarded_htlc_value)
5162 Some(MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5163 event: events::Event::PaymentForwarded {
5165 claim_from_onchain_tx: from_onchain,
5166 prev_channel_id: Some(prev_outpoint.to_channel_id()),
5167 next_channel_id: Some(next_channel_outpoint.to_channel_id()),
5168 outbound_amount_forwarded_msat: forwarded_htlc_value_msat,
5170 downstream_counterparty_and_funding_outpoint: None,
5174 if let Err((pk, err)) = res {
5175 let result: Result<(), _> = Err(err);
5176 let _ = handle_error!(self, result, pk);
5182 /// Gets the node_id held by this ChannelManager
5183 pub fn get_our_node_id(&self) -> PublicKey {
5184 self.our_network_pubkey.clone()
5187 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
5188 for action in actions.into_iter() {
5190 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
5191 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
5192 if let Some(ClaimingPayment {
5194 payment_purpose: purpose,
5197 sender_intended_value: sender_intended_total_msat,
5199 self.pending_events.lock().unwrap().push_back((events::Event::PaymentClaimed {
5203 receiver_node_id: Some(receiver_node_id),
5205 sender_intended_total_msat,
5209 MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
5210 event, downstream_counterparty_and_funding_outpoint
5212 self.pending_events.lock().unwrap().push_back((event, None));
5213 if let Some((node_id, funding_outpoint, blocker)) = downstream_counterparty_and_funding_outpoint {
5214 self.handle_monitor_update_release(node_id, funding_outpoint, Some(blocker));
5221 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
5222 /// update completion.
5223 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
5224 channel: &mut Channel<SP>, raa: Option<msgs::RevokeAndACK>,
5225 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
5226 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
5227 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
5228 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
5229 log_trace!(self.logger, "Handling channel resumption for channel {} with {} RAA, {} commitment update, {} pending forwards, {}broadcasting funding, {} channel ready, {} announcement",
5230 &channel.context.channel_id(),
5231 if raa.is_some() { "an" } else { "no" },
5232 if commitment_update.is_some() { "a" } else { "no" }, pending_forwards.len(),
5233 if funding_broadcastable.is_some() { "" } else { "not " },
5234 if channel_ready.is_some() { "sending" } else { "without" },
5235 if announcement_sigs.is_some() { "sending" } else { "without" });
5237 let mut htlc_forwards = None;
5239 let counterparty_node_id = channel.context.get_counterparty_node_id();
5240 if !pending_forwards.is_empty() {
5241 htlc_forwards = Some((channel.context.get_short_channel_id().unwrap_or(channel.context.outbound_scid_alias()),
5242 channel.context.get_funding_txo().unwrap(), channel.context.get_user_id(), pending_forwards));
5245 if let Some(msg) = channel_ready {
5246 send_channel_ready!(self, pending_msg_events, channel, msg);
5248 if let Some(msg) = announcement_sigs {
5249 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5250 node_id: counterparty_node_id,
5255 macro_rules! handle_cs { () => {
5256 if let Some(update) = commitment_update {
5257 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5258 node_id: counterparty_node_id,
5263 macro_rules! handle_raa { () => {
5264 if let Some(revoke_and_ack) = raa {
5265 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
5266 node_id: counterparty_node_id,
5267 msg: revoke_and_ack,
5272 RAACommitmentOrder::CommitmentFirst => {
5276 RAACommitmentOrder::RevokeAndACKFirst => {
5282 if let Some(tx) = funding_broadcastable {
5283 log_info!(self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
5284 self.tx_broadcaster.broadcast_transactions(&[&tx]);
5288 let mut pending_events = self.pending_events.lock().unwrap();
5289 emit_channel_pending_event!(pending_events, channel);
5290 emit_channel_ready_event!(pending_events, channel);
5296 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
5297 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
5299 let counterparty_node_id = match counterparty_node_id {
5300 Some(cp_id) => cp_id.clone(),
5302 // TODO: Once we can rely on the counterparty_node_id from the
5303 // monitor event, this and the id_to_peer map should be removed.
5304 let id_to_peer = self.id_to_peer.lock().unwrap();
5305 match id_to_peer.get(&funding_txo.to_channel_id()) {
5306 Some(cp_id) => cp_id.clone(),
5311 let per_peer_state = self.per_peer_state.read().unwrap();
5312 let mut peer_state_lock;
5313 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
5314 if peer_state_mutex_opt.is_none() { return }
5315 peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5316 let peer_state = &mut *peer_state_lock;
5318 if let Some(chan) = peer_state.channel_by_id.get_mut(&funding_txo.to_channel_id()) {
5321 let update_actions = peer_state.monitor_update_blocked_actions
5322 .remove(&funding_txo.to_channel_id()).unwrap_or(Vec::new());
5323 mem::drop(peer_state_lock);
5324 mem::drop(per_peer_state);
5325 self.handle_monitor_update_completion_actions(update_actions);
5328 let remaining_in_flight =
5329 if let Some(pending) = peer_state.in_flight_monitor_updates.get_mut(funding_txo) {
5330 pending.retain(|upd| upd.update_id > highest_applied_update_id);
5333 log_trace!(self.logger, "ChannelMonitor updated to {}. Current highest is {}. {} pending in-flight updates.",
5334 highest_applied_update_id, channel.context.get_latest_monitor_update_id(),
5335 remaining_in_flight);
5336 if !channel.is_awaiting_monitor_update() || channel.context.get_latest_monitor_update_id() != highest_applied_update_id {
5339 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, channel);
5342 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
5344 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
5345 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
5348 /// The `user_channel_id` parameter will be provided back in
5349 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5350 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5352 /// Note that this method will return an error and reject the channel, if it requires support
5353 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
5354 /// used to accept such channels.
5356 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5357 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5358 pub fn accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5359 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
5362 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
5363 /// it as confirmed immediately.
5365 /// The `user_channel_id` parameter will be provided back in
5366 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5367 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5369 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
5370 /// and (if the counterparty agrees), enables forwarding of payments immediately.
5372 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
5373 /// transaction and blindly assumes that it will eventually confirm.
5375 /// If it does not confirm before we decide to close the channel, or if the funding transaction
5376 /// does not pay to the correct script the correct amount, *you will lose funds*.
5378 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5379 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5380 pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5381 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
5384 fn do_accept_inbound_channel(&self, temporary_channel_id: &ChannelId, counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
5385 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5387 let peers_without_funded_channels =
5388 self.peers_without_funded_channels(|peer| { peer.total_channel_count() > 0 });
5389 let per_peer_state = self.per_peer_state.read().unwrap();
5390 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5391 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
5392 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5393 let peer_state = &mut *peer_state_lock;
5394 let is_only_peer_channel = peer_state.total_channel_count() == 1;
5396 // Find (and remove) the channel in the unaccepted table. If it's not there, something weird is
5397 // happening and return an error. N.B. that we create channel with an outbound SCID of zero so
5398 // that we can delay allocating the SCID until after we're sure that the checks below will
5400 let mut channel = match peer_state.inbound_channel_request_by_id.remove(temporary_channel_id) {
5401 Some(unaccepted_channel) => {
5402 let best_block_height = self.best_block.read().unwrap().height();
5403 InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
5404 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features,
5405 &unaccepted_channel.open_channel_msg, user_channel_id, &self.default_configuration, best_block_height,
5406 &self.logger, accept_0conf).map_err(|e| APIError::ChannelUnavailable { err: e.to_string() })
5408 _ => Err(APIError::APIMisuseError { err: "No such channel awaiting to be accepted.".to_owned() })
5412 // This should have been correctly configured by the call to InboundV1Channel::new.
5413 debug_assert!(channel.context.minimum_depth().unwrap() == 0);
5414 } else if channel.context.get_channel_type().requires_zero_conf() {
5415 let send_msg_err_event = events::MessageSendEvent::HandleError {
5416 node_id: channel.context.get_counterparty_node_id(),
5417 action: msgs::ErrorAction::SendErrorMessage{
5418 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
5421 peer_state.pending_msg_events.push(send_msg_err_event);
5422 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
5424 // If this peer already has some channels, a new channel won't increase our number of peers
5425 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
5426 // channels per-peer we can accept channels from a peer with existing ones.
5427 if is_only_peer_channel && peers_without_funded_channels >= MAX_UNFUNDED_CHANNEL_PEERS {
5428 let send_msg_err_event = events::MessageSendEvent::HandleError {
5429 node_id: channel.context.get_counterparty_node_id(),
5430 action: msgs::ErrorAction::SendErrorMessage{
5431 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "Have too many peers with unfunded channels, not accepting new ones".to_owned(), }
5434 peer_state.pending_msg_events.push(send_msg_err_event);
5435 return Err(APIError::APIMisuseError { err: "Too many peers with unfunded channels, refusing to accept new ones".to_owned() });
5439 // Now that we know we have a channel, assign an outbound SCID alias.
5440 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
5441 channel.context.set_outbound_scid_alias(outbound_scid_alias);
5443 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
5444 node_id: channel.context.get_counterparty_node_id(),
5445 msg: channel.accept_inbound_channel(),
5448 peer_state.inbound_v1_channel_by_id.insert(temporary_channel_id.clone(), channel);
5453 /// Gets the number of peers which match the given filter and do not have any funded, outbound,
5454 /// or 0-conf channels.
5456 /// The filter is called for each peer and provided with the number of unfunded, inbound, and
5457 /// non-0-conf channels we have with the peer.
5458 fn peers_without_funded_channels<Filter>(&self, maybe_count_peer: Filter) -> usize
5459 where Filter: Fn(&PeerState<SP>) -> bool {
5460 let mut peers_without_funded_channels = 0;
5461 let best_block_height = self.best_block.read().unwrap().height();
5463 let peer_state_lock = self.per_peer_state.read().unwrap();
5464 for (_, peer_mtx) in peer_state_lock.iter() {
5465 let peer = peer_mtx.lock().unwrap();
5466 if !maybe_count_peer(&*peer) { continue; }
5467 let num_unfunded_channels = Self::unfunded_channel_count(&peer, best_block_height);
5468 if num_unfunded_channels == peer.total_channel_count() {
5469 peers_without_funded_channels += 1;
5473 return peers_without_funded_channels;
5476 fn unfunded_channel_count(
5477 peer: &PeerState<SP>, best_block_height: u32
5479 let mut num_unfunded_channels = 0;
5480 for (_, chan) in peer.channel_by_id.iter() {
5481 // This covers non-zero-conf inbound `Channel`s that we are currently monitoring, but those
5482 // which have not yet had any confirmations on-chain.
5483 if !chan.context.is_outbound() && chan.context.minimum_depth().unwrap_or(1) != 0 &&
5484 chan.context.get_funding_tx_confirmations(best_block_height) == 0
5486 num_unfunded_channels += 1;
5489 for (_, chan) in peer.inbound_v1_channel_by_id.iter() {
5490 if chan.context.minimum_depth().unwrap_or(1) != 0 {
5491 num_unfunded_channels += 1;
5494 num_unfunded_channels + peer.inbound_channel_request_by_id.len()
5497 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
5498 if msg.chain_hash != self.genesis_hash {
5499 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
5502 if !self.default_configuration.accept_inbound_channels {
5503 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
5506 // Get the number of peers with channels, but without funded ones. We don't care too much
5507 // about peers that never open a channel, so we filter by peers that have at least one
5508 // channel, and then limit the number of those with unfunded channels.
5509 let channeled_peers_without_funding =
5510 self.peers_without_funded_channels(|node| node.total_channel_count() > 0);
5512 let per_peer_state = self.per_peer_state.read().unwrap();
5513 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5515 debug_assert!(false);
5516 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())
5518 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5519 let peer_state = &mut *peer_state_lock;
5521 // If this peer already has some channels, a new channel won't increase our number of peers
5522 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
5523 // channels per-peer we can accept channels from a peer with existing ones.
5524 if peer_state.total_channel_count() == 0 &&
5525 channeled_peers_without_funding >= MAX_UNFUNDED_CHANNEL_PEERS &&
5526 !self.default_configuration.manually_accept_inbound_channels
5528 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5529 "Have too many peers with unfunded channels, not accepting new ones".to_owned(),
5530 msg.temporary_channel_id.clone()));
5533 let best_block_height = self.best_block.read().unwrap().height();
5534 if Self::unfunded_channel_count(peer_state, best_block_height) >= MAX_UNFUNDED_CHANS_PER_PEER {
5535 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5536 format!("Refusing more than {} unfunded channels.", MAX_UNFUNDED_CHANS_PER_PEER),
5537 msg.temporary_channel_id.clone()));
5540 let channel_id = msg.temporary_channel_id;
5541 let channel_exists = peer_state.has_channel(&channel_id);
5543 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision for the same peer!".to_owned(), msg.temporary_channel_id.clone()));
5546 // If we're doing manual acceptance checks on the channel, then defer creation until we're sure we want to accept.
5547 if self.default_configuration.manually_accept_inbound_channels {
5548 let mut pending_events = self.pending_events.lock().unwrap();
5549 pending_events.push_back((events::Event::OpenChannelRequest {
5550 temporary_channel_id: msg.temporary_channel_id.clone(),
5551 counterparty_node_id: counterparty_node_id.clone(),
5552 funding_satoshis: msg.funding_satoshis,
5553 push_msat: msg.push_msat,
5554 channel_type: msg.channel_type.clone().unwrap(),
5556 peer_state.inbound_channel_request_by_id.insert(channel_id, InboundChannelRequest {
5557 open_channel_msg: msg.clone(),
5558 ticks_remaining: UNACCEPTED_INBOUND_CHANNEL_AGE_LIMIT_TICKS,
5563 // Otherwise create the channel right now.
5564 let mut random_bytes = [0u8; 16];
5565 random_bytes.copy_from_slice(&self.entropy_source.get_secure_random_bytes()[..16]);
5566 let user_channel_id = u128::from_be_bytes(random_bytes);
5567 let mut channel = match InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
5568 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id,
5569 &self.default_configuration, best_block_height, &self.logger, /*is_0conf=*/false)
5572 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
5577 let channel_type = channel.context.get_channel_type();
5578 if channel_type.requires_zero_conf() {
5579 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
5581 if channel_type.requires_anchors_zero_fee_htlc_tx() {
5582 return Err(MsgHandleErrInternal::send_err_msg_no_close("No channels with anchor outputs accepted".to_owned(), msg.temporary_channel_id.clone()));
5585 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
5586 channel.context.set_outbound_scid_alias(outbound_scid_alias);
5588 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
5589 node_id: counterparty_node_id.clone(),
5590 msg: channel.accept_inbound_channel(),
5592 peer_state.inbound_v1_channel_by_id.insert(channel_id, channel);
5596 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
5597 let (value, output_script, user_id) = {
5598 let per_peer_state = self.per_peer_state.read().unwrap();
5599 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5601 debug_assert!(false);
5602 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)
5604 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5605 let peer_state = &mut *peer_state_lock;
5606 match peer_state.outbound_v1_channel_by_id.entry(msg.temporary_channel_id) {
5607 hash_map::Entry::Occupied(mut chan) => {
5608 try_v1_outbound_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &peer_state.latest_features), chan);
5609 (chan.get().context.get_value_satoshis(), chan.get().context.get_funding_redeemscript().to_v0_p2wsh(), chan.get().context.get_user_id())
5611 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))
5614 let mut pending_events = self.pending_events.lock().unwrap();
5615 pending_events.push_back((events::Event::FundingGenerationReady {
5616 temporary_channel_id: msg.temporary_channel_id,
5617 counterparty_node_id: *counterparty_node_id,
5618 channel_value_satoshis: value,
5620 user_channel_id: user_id,
5625 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
5626 let best_block = *self.best_block.read().unwrap();
5628 let per_peer_state = self.per_peer_state.read().unwrap();
5629 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5631 debug_assert!(false);
5632 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)
5635 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5636 let peer_state = &mut *peer_state_lock;
5637 let (chan, funding_msg, monitor) =
5638 match peer_state.inbound_v1_channel_by_id.remove(&msg.temporary_channel_id) {
5639 Some(inbound_chan) => {
5640 match inbound_chan.funding_created(msg, best_block, &self.signer_provider, &self.logger) {
5642 Err((mut inbound_chan, err)) => {
5643 // We've already removed this inbound channel from the map in `PeerState`
5644 // above so at this point we just need to clean up any lingering entries
5645 // concerning this channel as it is safe to do so.
5646 update_maps_on_chan_removal!(self, &inbound_chan.context);
5647 let user_id = inbound_chan.context.get_user_id();
5648 let shutdown_res = inbound_chan.context.force_shutdown(false);
5649 return Err(MsgHandleErrInternal::from_finish_shutdown(format!("{}", err),
5650 msg.temporary_channel_id, user_id, shutdown_res, None, inbound_chan.context.get_value_satoshis()));
5654 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))
5657 match peer_state.channel_by_id.entry(funding_msg.channel_id) {
5658 hash_map::Entry::Occupied(_) => {
5659 Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
5661 hash_map::Entry::Vacant(e) => {
5662 match self.id_to_peer.lock().unwrap().entry(chan.context.channel_id()) {
5663 hash_map::Entry::Occupied(_) => {
5664 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5665 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
5666 funding_msg.channel_id))
5668 hash_map::Entry::Vacant(i_e) => {
5669 i_e.insert(chan.context.get_counterparty_node_id());
5673 // There's no problem signing a counterparty's funding transaction if our monitor
5674 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
5675 // accepted payment from yet. We do, however, need to wait to send our channel_ready
5676 // until we have persisted our monitor.
5677 let new_channel_id = funding_msg.channel_id;
5678 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
5679 node_id: counterparty_node_id.clone(),
5683 let monitor_res = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
5685 let chan = e.insert(chan);
5686 let mut res = handle_new_monitor_update!(self, monitor_res, peer_state_lock, peer_state,
5687 per_peer_state, chan, MANUALLY_REMOVING_INITIAL_MONITOR,
5688 { peer_state.channel_by_id.remove(&new_channel_id) });
5690 // Note that we reply with the new channel_id in error messages if we gave up on the
5691 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
5692 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
5693 // any messages referencing a previously-closed channel anyway.
5694 // We do not propagate the monitor update to the user as it would be for a monitor
5695 // that we didn't manage to store (and that we don't care about - we don't respond
5696 // with the funding_signed so the channel can never go on chain).
5697 if let Err(MsgHandleErrInternal { shutdown_finish: Some((res, _)), .. }) = &mut res {
5705 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
5706 let best_block = *self.best_block.read().unwrap();
5707 let per_peer_state = self.per_peer_state.read().unwrap();
5708 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5710 debug_assert!(false);
5711 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5714 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5715 let peer_state = &mut *peer_state_lock;
5716 match peer_state.channel_by_id.entry(msg.channel_id) {
5717 hash_map::Entry::Occupied(mut chan) => {
5718 let monitor = try_chan_entry!(self,
5719 chan.get_mut().funding_signed(&msg, best_block, &self.signer_provider, &self.logger), chan);
5720 let update_res = self.chain_monitor.watch_channel(chan.get().context.get_funding_txo().unwrap(), monitor);
5721 let mut res = handle_new_monitor_update!(self, update_res, peer_state_lock, peer_state, per_peer_state, chan, INITIAL_MONITOR);
5722 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
5723 // We weren't able to watch the channel to begin with, so no updates should be made on
5724 // it. Previously, full_stack_target found an (unreachable) panic when the
5725 // monitor update contained within `shutdown_finish` was applied.
5726 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
5727 shutdown_finish.0.take();
5732 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5736 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
5737 let per_peer_state = self.per_peer_state.read().unwrap();
5738 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5740 debug_assert!(false);
5741 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5743 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5744 let peer_state = &mut *peer_state_lock;
5745 match peer_state.channel_by_id.entry(msg.channel_id) {
5746 hash_map::Entry::Occupied(mut chan) => {
5747 let announcement_sigs_opt = try_chan_entry!(self, chan.get_mut().channel_ready(&msg, &self.node_signer,
5748 self.genesis_hash.clone(), &self.default_configuration, &self.best_block.read().unwrap(), &self.logger), chan);
5749 if let Some(announcement_sigs) = announcement_sigs_opt {
5750 log_trace!(self.logger, "Sending announcement_signatures for channel {}", &chan.get().context.channel_id());
5751 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5752 node_id: counterparty_node_id.clone(),
5753 msg: announcement_sigs,
5755 } else if chan.get().context.is_usable() {
5756 // If we're sending an announcement_signatures, we'll send the (public)
5757 // channel_update after sending a channel_announcement when we receive our
5758 // counterparty's announcement_signatures. Thus, we only bother to send a
5759 // channel_update here if the channel is not public, i.e. we're not sending an
5760 // announcement_signatures.
5761 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", &chan.get().context.channel_id());
5762 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
5763 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
5764 node_id: counterparty_node_id.clone(),
5771 let mut pending_events = self.pending_events.lock().unwrap();
5772 emit_channel_ready_event!(pending_events, chan.get_mut());
5777 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))
5781 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
5782 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
5783 let result: Result<(), _> = loop {
5784 let per_peer_state = self.per_peer_state.read().unwrap();
5785 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5787 debug_assert!(false);
5788 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5790 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5791 let peer_state = &mut *peer_state_lock;
5792 // TODO(dunxen): Fix this duplication when we switch to a single map with enums as per
5793 // https://github.com/lightningdevkit/rust-lightning/issues/2422
5794 if let hash_map::Entry::Occupied(chan_entry) = peer_state.outbound_v1_channel_by_id.entry(msg.channel_id.clone()) {
5795 log_error!(self.logger, "Immediately closing unfunded channel {} as peer asked to cooperatively shut it down (which is unnecessary)", &msg.channel_id);
5796 self.issue_channel_close_events(&chan_entry.get().context, ClosureReason::CounterpartyCoopClosedUnfundedChannel);
5797 let mut chan = remove_channel!(self, chan_entry);
5798 self.finish_force_close_channel(chan.context.force_shutdown(false));
5800 } else if let hash_map::Entry::Occupied(chan_entry) = peer_state.inbound_v1_channel_by_id.entry(msg.channel_id.clone()) {
5801 log_error!(self.logger, "Immediately closing unfunded channel {} as peer asked to cooperatively shut it down (which is unnecessary)", &msg.channel_id);
5802 self.issue_channel_close_events(&chan_entry.get().context, ClosureReason::CounterpartyCoopClosedUnfundedChannel);
5803 let mut chan = remove_channel!(self, chan_entry);
5804 self.finish_force_close_channel(chan.context.force_shutdown(false));
5806 } else if let hash_map::Entry::Occupied(mut chan_entry) = peer_state.channel_by_id.entry(msg.channel_id.clone()) {
5807 if !chan_entry.get().received_shutdown() {
5808 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
5810 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
5813 let funding_txo_opt = chan_entry.get().context.get_funding_txo();
5814 let (shutdown, monitor_update_opt, htlcs) = try_chan_entry!(self,
5815 chan_entry.get_mut().shutdown(&self.signer_provider, &peer_state.latest_features, &msg), chan_entry);
5816 dropped_htlcs = htlcs;
5818 if let Some(msg) = shutdown {
5819 // We can send the `shutdown` message before updating the `ChannelMonitor`
5820 // here as we don't need the monitor update to complete until we send a
5821 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
5822 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5823 node_id: *counterparty_node_id,
5828 // Update the monitor with the shutdown script if necessary.
5829 if let Some(monitor_update) = monitor_update_opt {
5830 break handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
5831 peer_state_lock, peer_state, per_peer_state, chan_entry).map(|_| ());
5835 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))
5838 for htlc_source in dropped_htlcs.drain(..) {
5839 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
5840 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
5841 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
5847 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
5848 let per_peer_state = self.per_peer_state.read().unwrap();
5849 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5851 debug_assert!(false);
5852 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5854 let (tx, chan_option) = {
5855 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5856 let peer_state = &mut *peer_state_lock;
5857 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
5858 hash_map::Entry::Occupied(mut chan_entry) => {
5859 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), chan_entry);
5860 if let Some(msg) = closing_signed {
5861 peer_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5862 node_id: counterparty_node_id.clone(),
5867 // We're done with this channel, we've got a signed closing transaction and
5868 // will send the closing_signed back to the remote peer upon return. This
5869 // also implies there are no pending HTLCs left on the channel, so we can
5870 // fully delete it from tracking (the channel monitor is still around to
5871 // watch for old state broadcasts)!
5872 (tx, Some(remove_channel!(self, chan_entry)))
5873 } else { (tx, None) }
5875 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))
5878 if let Some(broadcast_tx) = tx {
5879 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
5880 self.tx_broadcaster.broadcast_transactions(&[&broadcast_tx]);
5882 if let Some(chan) = chan_option {
5883 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5884 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5885 let peer_state = &mut *peer_state_lock;
5886 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5890 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
5895 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
5896 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
5897 //determine the state of the payment based on our response/if we forward anything/the time
5898 //we take to respond. We should take care to avoid allowing such an attack.
5900 //TODO: There exists a further attack where a node may garble the onion data, forward it to
5901 //us repeatedly garbled in different ways, and compare our error messages, which are
5902 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
5903 //but we should prevent it anyway.
5905 let decoded_hop_res = self.decode_update_add_htlc_onion(msg);
5906 let per_peer_state = self.per_peer_state.read().unwrap();
5907 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5909 debug_assert!(false);
5910 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5912 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5913 let peer_state = &mut *peer_state_lock;
5914 match peer_state.channel_by_id.entry(msg.channel_id) {
5915 hash_map::Entry::Occupied(mut chan) => {
5917 let pending_forward_info = match decoded_hop_res {
5918 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
5919 self.construct_pending_htlc_status(msg, shared_secret, next_hop,
5920 chan.get().context.config().accept_underpaying_htlcs, next_packet_pk_opt),
5921 Err(e) => PendingHTLCStatus::Fail(e)
5923 let create_pending_htlc_status = |chan: &Channel<SP>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
5924 // If the update_add is completely bogus, the call will Err and we will close,
5925 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
5926 // want to reject the new HTLC and fail it backwards instead of forwarding.
5927 match pending_forward_info {
5928 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
5929 let reason = if (error_code & 0x1000) != 0 {
5930 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
5931 HTLCFailReason::reason(real_code, error_data)
5933 HTLCFailReason::from_failure_code(error_code)
5934 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
5935 let msg = msgs::UpdateFailHTLC {
5936 channel_id: msg.channel_id,
5937 htlc_id: msg.htlc_id,
5940 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
5942 _ => pending_forward_info
5945 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.fee_estimator, &self.logger), chan);
5947 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))
5952 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
5954 let (htlc_source, forwarded_htlc_value) = {
5955 let per_peer_state = self.per_peer_state.read().unwrap();
5956 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5958 debug_assert!(false);
5959 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5961 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5962 let peer_state = &mut *peer_state_lock;
5963 match peer_state.channel_by_id.entry(msg.channel_id) {
5964 hash_map::Entry::Occupied(mut chan) => {
5965 let res = try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), chan);
5966 funding_txo = chan.get().context.get_funding_txo().expect("We won't accept a fulfill until funded");
5969 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))
5972 self.claim_funds_internal(htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, funding_txo);
5976 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
5977 let per_peer_state = self.per_peer_state.read().unwrap();
5978 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5980 debug_assert!(false);
5981 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5983 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5984 let peer_state = &mut *peer_state_lock;
5985 match peer_state.channel_by_id.entry(msg.channel_id) {
5986 hash_map::Entry::Occupied(mut chan) => {
5987 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan);
5989 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))
5994 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
5995 let per_peer_state = self.per_peer_state.read().unwrap();
5996 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5998 debug_assert!(false);
5999 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6001 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6002 let peer_state = &mut *peer_state_lock;
6003 match peer_state.channel_by_id.entry(msg.channel_id) {
6004 hash_map::Entry::Occupied(mut chan) => {
6005 if (msg.failure_code & 0x8000) == 0 {
6006 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
6007 try_chan_entry!(self, Err(chan_err), chan);
6009 try_chan_entry!(self, chan.get_mut().update_fail_malformed_htlc(&msg, HTLCFailReason::reason(msg.failure_code, msg.sha256_of_onion.to_vec())), chan);
6012 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))
6016 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
6017 let per_peer_state = self.per_peer_state.read().unwrap();
6018 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6020 debug_assert!(false);
6021 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6023 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6024 let peer_state = &mut *peer_state_lock;
6025 match peer_state.channel_by_id.entry(msg.channel_id) {
6026 hash_map::Entry::Occupied(mut chan) => {
6027 let funding_txo = chan.get().context.get_funding_txo();
6028 let monitor_update_opt = try_chan_entry!(self, chan.get_mut().commitment_signed(&msg, &self.logger), chan);
6029 if let Some(monitor_update) = monitor_update_opt {
6030 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update, peer_state_lock,
6031 peer_state, per_peer_state, chan).map(|_| ())
6034 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))
6039 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
6040 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
6041 let mut push_forward_event = false;
6042 let mut new_intercept_events = VecDeque::new();
6043 let mut failed_intercept_forwards = Vec::new();
6044 if !pending_forwards.is_empty() {
6045 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
6046 let scid = match forward_info.routing {
6047 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
6048 PendingHTLCRouting::Receive { .. } => 0,
6049 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
6051 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
6052 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
6054 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
6055 let forward_htlcs_empty = forward_htlcs.is_empty();
6056 match forward_htlcs.entry(scid) {
6057 hash_map::Entry::Occupied(mut entry) => {
6058 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6059 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
6061 hash_map::Entry::Vacant(entry) => {
6062 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
6063 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.genesis_hash)
6065 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).into_inner());
6066 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
6067 match pending_intercepts.entry(intercept_id) {
6068 hash_map::Entry::Vacant(entry) => {
6069 new_intercept_events.push_back((events::Event::HTLCIntercepted {
6070 requested_next_hop_scid: scid,
6071 payment_hash: forward_info.payment_hash,
6072 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
6073 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
6076 entry.insert(PendingAddHTLCInfo {
6077 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
6079 hash_map::Entry::Occupied(_) => {
6080 log_info!(self.logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
6081 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
6082 short_channel_id: prev_short_channel_id,
6083 user_channel_id: Some(prev_user_channel_id),
6084 outpoint: prev_funding_outpoint,
6085 htlc_id: prev_htlc_id,
6086 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
6087 phantom_shared_secret: None,
6090 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
6091 HTLCFailReason::from_failure_code(0x4000 | 10),
6092 HTLCDestination::InvalidForward { requested_forward_scid: scid },
6097 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
6098 // payments are being processed.
6099 if forward_htlcs_empty {
6100 push_forward_event = true;
6102 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
6103 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
6110 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
6111 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
6114 if !new_intercept_events.is_empty() {
6115 let mut events = self.pending_events.lock().unwrap();
6116 events.append(&mut new_intercept_events);
6118 if push_forward_event { self.push_pending_forwards_ev() }
6122 fn push_pending_forwards_ev(&self) {
6123 let mut pending_events = self.pending_events.lock().unwrap();
6124 let is_processing_events = self.pending_events_processor.load(Ordering::Acquire);
6125 let num_forward_events = pending_events.iter().filter(|(ev, _)|
6126 if let events::Event::PendingHTLCsForwardable { .. } = ev { true } else { false }
6128 // We only want to push a PendingHTLCsForwardable event if no others are queued. Processing
6129 // events is done in batches and they are not removed until we're done processing each
6130 // batch. Since handling a `PendingHTLCsForwardable` event will call back into the
6131 // `ChannelManager`, we'll still see the original forwarding event not removed. Phantom
6132 // payments will need an additional forwarding event before being claimed to make them look
6133 // real by taking more time.
6134 if (is_processing_events && num_forward_events <= 1) || num_forward_events < 1 {
6135 pending_events.push_back((Event::PendingHTLCsForwardable {
6136 time_forwardable: Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
6141 /// Checks whether [`ChannelMonitorUpdate`]s generated by the receipt of a remote
6142 /// [`msgs::RevokeAndACK`] should be held for the given channel until some other action
6143 /// completes. Note that this needs to happen in the same [`PeerState`] mutex as any release of
6144 /// the [`ChannelMonitorUpdate`] in question.
6145 fn raa_monitor_updates_held(&self,
6146 actions_blocking_raa_monitor_updates: &BTreeMap<ChannelId, Vec<RAAMonitorUpdateBlockingAction>>,
6147 channel_funding_outpoint: OutPoint, counterparty_node_id: PublicKey
6149 actions_blocking_raa_monitor_updates
6150 .get(&channel_funding_outpoint.to_channel_id()).map(|v| !v.is_empty()).unwrap_or(false)
6151 || self.pending_events.lock().unwrap().iter().any(|(_, action)| {
6152 action == &Some(EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
6153 channel_funding_outpoint,
6154 counterparty_node_id,
6159 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
6160 let (htlcs_to_fail, res) = {
6161 let per_peer_state = self.per_peer_state.read().unwrap();
6162 let mut peer_state_lock = per_peer_state.get(counterparty_node_id)
6164 debug_assert!(false);
6165 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6166 }).map(|mtx| mtx.lock().unwrap())?;
6167 let peer_state = &mut *peer_state_lock;
6168 match peer_state.channel_by_id.entry(msg.channel_id) {
6169 hash_map::Entry::Occupied(mut chan) => {
6170 let funding_txo_opt = chan.get().context.get_funding_txo();
6171 let mon_update_blocked = if let Some(funding_txo) = funding_txo_opt {
6172 self.raa_monitor_updates_held(
6173 &peer_state.actions_blocking_raa_monitor_updates, funding_txo,
6174 *counterparty_node_id)
6176 let (htlcs_to_fail, monitor_update_opt) = try_chan_entry!(self,
6177 chan.get_mut().revoke_and_ack(&msg, &self.fee_estimator, &self.logger, mon_update_blocked), chan);
6178 let res = if let Some(monitor_update) = monitor_update_opt {
6179 let funding_txo = funding_txo_opt
6180 .expect("Funding outpoint must have been set for RAA handling to succeed");
6181 handle_new_monitor_update!(self, funding_txo, monitor_update,
6182 peer_state_lock, peer_state, per_peer_state, chan).map(|_| ())
6184 (htlcs_to_fail, res)
6186 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))
6189 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
6193 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
6194 let per_peer_state = self.per_peer_state.read().unwrap();
6195 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6197 debug_assert!(false);
6198 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6200 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6201 let peer_state = &mut *peer_state_lock;
6202 match peer_state.channel_by_id.entry(msg.channel_id) {
6203 hash_map::Entry::Occupied(mut chan) => {
6204 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg, &self.logger), chan);
6206 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))
6211 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
6212 let per_peer_state = self.per_peer_state.read().unwrap();
6213 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6215 debug_assert!(false);
6216 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6218 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6219 let peer_state = &mut *peer_state_lock;
6220 match peer_state.channel_by_id.entry(msg.channel_id) {
6221 hash_map::Entry::Occupied(mut chan) => {
6222 if !chan.get().context.is_usable() {
6223 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
6226 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
6227 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(
6228 &self.node_signer, self.genesis_hash.clone(), self.best_block.read().unwrap().height(),
6229 msg, &self.default_configuration
6231 // Note that announcement_signatures fails if the channel cannot be announced,
6232 // so get_channel_update_for_broadcast will never fail by the time we get here.
6233 update_msg: Some(self.get_channel_update_for_broadcast(chan.get()).unwrap()),
6236 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))
6241 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
6242 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
6243 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
6244 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
6246 // It's not a local channel
6247 return Ok(NotifyOption::SkipPersist)
6250 let per_peer_state = self.per_peer_state.read().unwrap();
6251 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
6252 if peer_state_mutex_opt.is_none() {
6253 return Ok(NotifyOption::SkipPersist)
6255 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
6256 let peer_state = &mut *peer_state_lock;
6257 match peer_state.channel_by_id.entry(chan_id) {
6258 hash_map::Entry::Occupied(mut chan) => {
6259 if chan.get().context.get_counterparty_node_id() != *counterparty_node_id {
6260 if chan.get().context.should_announce() {
6261 // If the announcement is about a channel of ours which is public, some
6262 // other peer may simply be forwarding all its gossip to us. Don't provide
6263 // a scary-looking error message and return Ok instead.
6264 return Ok(NotifyOption::SkipPersist);
6266 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));
6268 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().context.get_counterparty_node_id().serialize()[..];
6269 let msg_from_node_one = msg.contents.flags & 1 == 0;
6270 if were_node_one == msg_from_node_one {
6271 return Ok(NotifyOption::SkipPersist);
6273 log_debug!(self.logger, "Received channel_update for channel {}.", &chan_id);
6274 try_chan_entry!(self, chan.get_mut().channel_update(&msg), chan);
6277 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersist)
6279 Ok(NotifyOption::DoPersist)
6282 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
6284 let need_lnd_workaround = {
6285 let per_peer_state = self.per_peer_state.read().unwrap();
6287 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
6289 debug_assert!(false);
6290 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
6292 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6293 let peer_state = &mut *peer_state_lock;
6294 match peer_state.channel_by_id.entry(msg.channel_id) {
6295 hash_map::Entry::Occupied(mut chan) => {
6296 // Currently, we expect all holding cell update_adds to be dropped on peer
6297 // disconnect, so Channel's reestablish will never hand us any holding cell
6298 // freed HTLCs to fail backwards. If in the future we no longer drop pending
6299 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
6300 let responses = try_chan_entry!(self, chan.get_mut().channel_reestablish(
6301 msg, &self.logger, &self.node_signer, self.genesis_hash,
6302 &self.default_configuration, &*self.best_block.read().unwrap()), chan);
6303 let mut channel_update = None;
6304 if let Some(msg) = responses.shutdown_msg {
6305 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
6306 node_id: counterparty_node_id.clone(),
6309 } else if chan.get().context.is_usable() {
6310 // If the channel is in a usable state (ie the channel is not being shut
6311 // down), send a unicast channel_update to our counterparty to make sure
6312 // they have the latest channel parameters.
6313 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
6314 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
6315 node_id: chan.get().context.get_counterparty_node_id(),
6320 let need_lnd_workaround = chan.get_mut().context.workaround_lnd_bug_4006.take();
6321 htlc_forwards = self.handle_channel_resumption(
6322 &mut peer_state.pending_msg_events, chan.get_mut(), responses.raa, responses.commitment_update, responses.order,
6323 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
6324 if let Some(upd) = channel_update {
6325 peer_state.pending_msg_events.push(upd);
6329 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))
6333 if let Some(forwards) = htlc_forwards {
6334 self.forward_htlcs(&mut [forwards][..]);
6337 if let Some(channel_ready_msg) = need_lnd_workaround {
6338 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
6343 /// Process pending events from the [`chain::Watch`], returning whether any events were processed.
6344 fn process_pending_monitor_events(&self) -> bool {
6345 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
6347 let mut failed_channels = Vec::new();
6348 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
6349 let has_pending_monitor_events = !pending_monitor_events.is_empty();
6350 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
6351 for monitor_event in monitor_events.drain(..) {
6352 match monitor_event {
6353 MonitorEvent::HTLCEvent(htlc_update) => {
6354 if let Some(preimage) = htlc_update.payment_preimage {
6355 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", &preimage);
6356 self.claim_funds_internal(htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, funding_outpoint);
6358 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", &htlc_update.payment_hash);
6359 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
6360 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
6361 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
6364 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
6365 MonitorEvent::UpdateFailed(funding_outpoint) => {
6366 let counterparty_node_id_opt = match counterparty_node_id {
6367 Some(cp_id) => Some(cp_id),
6369 // TODO: Once we can rely on the counterparty_node_id from the
6370 // monitor event, this and the id_to_peer map should be removed.
6371 let id_to_peer = self.id_to_peer.lock().unwrap();
6372 id_to_peer.get(&funding_outpoint.to_channel_id()).cloned()
6375 if let Some(counterparty_node_id) = counterparty_node_id_opt {
6376 let per_peer_state = self.per_peer_state.read().unwrap();
6377 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
6378 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6379 let peer_state = &mut *peer_state_lock;
6380 let pending_msg_events = &mut peer_state.pending_msg_events;
6381 if let hash_map::Entry::Occupied(chan_entry) = peer_state.channel_by_id.entry(funding_outpoint.to_channel_id()) {
6382 let mut chan = remove_channel!(self, chan_entry);
6383 failed_channels.push(chan.context.force_shutdown(false));
6384 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6385 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6389 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
6390 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
6392 ClosureReason::CommitmentTxConfirmed
6394 self.issue_channel_close_events(&chan.context, reason);
6395 pending_msg_events.push(events::MessageSendEvent::HandleError {
6396 node_id: chan.context.get_counterparty_node_id(),
6397 action: msgs::ErrorAction::SendErrorMessage {
6398 msg: msgs::ErrorMessage { channel_id: chan.context.channel_id(), data: "Channel force-closed".to_owned() }
6405 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
6406 self.channel_monitor_updated(&funding_txo, monitor_update_id, counterparty_node_id.as_ref());
6412 for failure in failed_channels.drain(..) {
6413 self.finish_force_close_channel(failure);
6416 has_pending_monitor_events
6419 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
6420 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
6421 /// update events as a separate process method here.
6423 pub fn process_monitor_events(&self) {
6424 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6425 self.process_pending_monitor_events();
6428 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
6429 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
6430 /// update was applied.
6431 fn check_free_holding_cells(&self) -> bool {
6432 let mut has_monitor_update = false;
6433 let mut failed_htlcs = Vec::new();
6434 let mut handle_errors = Vec::new();
6436 // Walk our list of channels and find any that need to update. Note that when we do find an
6437 // update, if it includes actions that must be taken afterwards, we have to drop the
6438 // per-peer state lock as well as the top level per_peer_state lock. Thus, we loop until we
6439 // manage to go through all our peers without finding a single channel to update.
6441 let per_peer_state = self.per_peer_state.read().unwrap();
6442 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6444 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6445 let peer_state: &mut PeerState<_> = &mut *peer_state_lock;
6446 for (channel_id, chan) in peer_state.channel_by_id.iter_mut() {
6447 let counterparty_node_id = chan.context.get_counterparty_node_id();
6448 let funding_txo = chan.context.get_funding_txo();
6449 let (monitor_opt, holding_cell_failed_htlcs) =
6450 chan.maybe_free_holding_cell_htlcs(&self.fee_estimator, &self.logger);
6451 if !holding_cell_failed_htlcs.is_empty() {
6452 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id, counterparty_node_id));
6454 if let Some(monitor_update) = monitor_opt {
6455 has_monitor_update = true;
6457 let channel_id: ChannelId = *channel_id;
6458 let res = handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update,
6459 peer_state_lock, peer_state, per_peer_state, chan, MANUALLY_REMOVING,
6460 peer_state.channel_by_id.remove(&channel_id));
6462 handle_errors.push((counterparty_node_id, res));
6464 continue 'peer_loop;
6473 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
6474 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
6475 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
6478 for (counterparty_node_id, err) in handle_errors.drain(..) {
6479 let _ = handle_error!(self, err, counterparty_node_id);
6485 /// Check whether any channels have finished removing all pending updates after a shutdown
6486 /// exchange and can now send a closing_signed.
6487 /// Returns whether any closing_signed messages were generated.
6488 fn maybe_generate_initial_closing_signed(&self) -> bool {
6489 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
6490 let mut has_update = false;
6492 let per_peer_state = self.per_peer_state.read().unwrap();
6494 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6495 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6496 let peer_state = &mut *peer_state_lock;
6497 let pending_msg_events = &mut peer_state.pending_msg_events;
6498 peer_state.channel_by_id.retain(|channel_id, chan| {
6499 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
6500 Ok((msg_opt, tx_opt)) => {
6501 if let Some(msg) = msg_opt {
6503 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
6504 node_id: chan.context.get_counterparty_node_id(), msg,
6507 if let Some(tx) = tx_opt {
6508 // We're done with this channel. We got a closing_signed and sent back
6509 // a closing_signed with a closing transaction to broadcast.
6510 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6511 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6516 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
6518 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
6519 self.tx_broadcaster.broadcast_transactions(&[&tx]);
6520 update_maps_on_chan_removal!(self, &chan.context);
6526 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
6527 handle_errors.push((chan.context.get_counterparty_node_id(), Err(res)));
6535 for (counterparty_node_id, err) in handle_errors.drain(..) {
6536 let _ = handle_error!(self, err, counterparty_node_id);
6542 /// Handle a list of channel failures during a block_connected or block_disconnected call,
6543 /// pushing the channel monitor update (if any) to the background events queue and removing the
6545 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
6546 for mut failure in failed_channels.drain(..) {
6547 // Either a commitment transactions has been confirmed on-chain or
6548 // Channel::block_disconnected detected that the funding transaction has been
6549 // reorganized out of the main chain.
6550 // We cannot broadcast our latest local state via monitor update (as
6551 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
6552 // so we track the update internally and handle it when the user next calls
6553 // timer_tick_occurred, guaranteeing we're running normally.
6554 if let Some((counterparty_node_id, funding_txo, update)) = failure.0.take() {
6555 assert_eq!(update.updates.len(), 1);
6556 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
6557 assert!(should_broadcast);
6558 } else { unreachable!(); }
6559 self.pending_background_events.lock().unwrap().push(
6560 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
6561 counterparty_node_id, funding_txo, update
6564 self.finish_force_close_channel(failure);
6568 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
6571 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
6572 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
6574 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
6575 /// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
6576 /// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
6577 /// passed directly to [`claim_funds`].
6579 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
6581 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
6582 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
6586 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
6587 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
6589 /// Errors if `min_value_msat` is greater than total bitcoin supply.
6591 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
6592 /// on versions of LDK prior to 0.0.114.
6594 /// [`claim_funds`]: Self::claim_funds
6595 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
6596 /// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
6597 /// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
6598 /// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
6599 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
6600 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
6601 min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
6602 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs,
6603 &self.entropy_source, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
6604 min_final_cltv_expiry_delta)
6607 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
6608 /// stored external to LDK.
6610 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
6611 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
6612 /// the `min_value_msat` provided here, if one is provided.
6614 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
6615 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
6618 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
6619 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
6620 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
6621 /// sender "proof-of-payment" unless they have paid the required amount.
6623 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
6624 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
6625 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
6626 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
6627 /// invoices when no timeout is set.
6629 /// Note that we use block header time to time-out pending inbound payments (with some margin
6630 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
6631 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
6632 /// If you need exact expiry semantics, you should enforce them upon receipt of
6633 /// [`PaymentClaimable`].
6635 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
6636 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
6638 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
6639 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
6643 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
6644 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
6646 /// Errors if `min_value_msat` is greater than total bitcoin supply.
6648 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
6649 /// on versions of LDK prior to 0.0.114.
6651 /// [`create_inbound_payment`]: Self::create_inbound_payment
6652 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
6653 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>,
6654 invoice_expiry_delta_secs: u32, min_final_cltv_expiry: Option<u16>) -> Result<PaymentSecret, ()> {
6655 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash,
6656 invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
6657 min_final_cltv_expiry)
6660 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
6661 /// previously returned from [`create_inbound_payment`].
6663 /// [`create_inbound_payment`]: Self::create_inbound_payment
6664 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
6665 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
6668 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
6669 /// are used when constructing the phantom invoice's route hints.
6671 /// [phantom node payments]: crate::sign::PhantomKeysManager
6672 pub fn get_phantom_scid(&self) -> u64 {
6673 let best_block_height = self.best_block.read().unwrap().height();
6674 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
6676 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
6677 // Ensure the generated scid doesn't conflict with a real channel.
6678 match short_to_chan_info.get(&scid_candidate) {
6679 Some(_) => continue,
6680 None => return scid_candidate
6685 /// Gets route hints for use in receiving [phantom node payments].
6687 /// [phantom node payments]: crate::sign::PhantomKeysManager
6688 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
6690 channels: self.list_usable_channels(),
6691 phantom_scid: self.get_phantom_scid(),
6692 real_node_pubkey: self.get_our_node_id(),
6696 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
6697 /// used when constructing the route hints for HTLCs intended to be intercepted. See
6698 /// [`ChannelManager::forward_intercepted_htlc`].
6700 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
6701 /// times to get a unique scid.
6702 pub fn get_intercept_scid(&self) -> u64 {
6703 let best_block_height = self.best_block.read().unwrap().height();
6704 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
6706 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
6707 // Ensure the generated scid doesn't conflict with a real channel.
6708 if short_to_chan_info.contains_key(&scid_candidate) { continue }
6709 return scid_candidate
6713 /// Gets inflight HTLC information by processing pending outbound payments that are in
6714 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
6715 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
6716 let mut inflight_htlcs = InFlightHtlcs::new();
6718 let per_peer_state = self.per_peer_state.read().unwrap();
6719 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6720 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6721 let peer_state = &mut *peer_state_lock;
6722 for chan in peer_state.channel_by_id.values() {
6723 for (htlc_source, _) in chan.inflight_htlc_sources() {
6724 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
6725 inflight_htlcs.process_path(path, self.get_our_node_id());
6734 #[cfg(any(test, feature = "_test_utils"))]
6735 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
6736 let events = core::cell::RefCell::new(Vec::new());
6737 let event_handler = |event: events::Event| events.borrow_mut().push(event);
6738 self.process_pending_events(&event_handler);
6742 #[cfg(feature = "_test_utils")]
6743 pub fn push_pending_event(&self, event: events::Event) {
6744 let mut events = self.pending_events.lock().unwrap();
6745 events.push_back((event, None));
6749 pub fn pop_pending_event(&self) -> Option<events::Event> {
6750 let mut events = self.pending_events.lock().unwrap();
6751 events.pop_front().map(|(e, _)| e)
6755 pub fn has_pending_payments(&self) -> bool {
6756 self.pending_outbound_payments.has_pending_payments()
6760 pub fn clear_pending_payments(&self) {
6761 self.pending_outbound_payments.clear_pending_payments()
6764 /// When something which was blocking a channel from updating its [`ChannelMonitor`] (e.g. an
6765 /// [`Event`] being handled) completes, this should be called to restore the channel to normal
6766 /// operation. It will double-check that nothing *else* is also blocking the same channel from
6767 /// making progress and then let any blocked [`ChannelMonitorUpdate`]s fly.
6768 fn handle_monitor_update_release(&self, counterparty_node_id: PublicKey, channel_funding_outpoint: OutPoint, mut completed_blocker: Option<RAAMonitorUpdateBlockingAction>) {
6769 let mut errors = Vec::new();
6771 let per_peer_state = self.per_peer_state.read().unwrap();
6772 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
6773 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
6774 let peer_state = &mut *peer_state_lck;
6776 if let Some(blocker) = completed_blocker.take() {
6777 // Only do this on the first iteration of the loop.
6778 if let Some(blockers) = peer_state.actions_blocking_raa_monitor_updates
6779 .get_mut(&channel_funding_outpoint.to_channel_id())
6781 blockers.retain(|iter| iter != &blocker);
6785 if self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
6786 channel_funding_outpoint, counterparty_node_id) {
6787 // Check that, while holding the peer lock, we don't have anything else
6788 // blocking monitor updates for this channel. If we do, release the monitor
6789 // update(s) when those blockers complete.
6790 log_trace!(self.logger, "Delaying monitor unlock for channel {} as another channel's mon update needs to complete first",
6791 &channel_funding_outpoint.to_channel_id());
6795 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(channel_funding_outpoint.to_channel_id()) {
6796 debug_assert_eq!(chan.get().context.get_funding_txo().unwrap(), channel_funding_outpoint);
6797 if let Some((monitor_update, further_update_exists)) = chan.get_mut().unblock_next_blocked_monitor_update() {
6798 log_debug!(self.logger, "Unlocking monitor updating for channel {} and updating monitor",
6799 &channel_funding_outpoint.to_channel_id());
6800 if let Err(e) = handle_new_monitor_update!(self, channel_funding_outpoint, monitor_update,
6801 peer_state_lck, peer_state, per_peer_state, chan)
6803 errors.push((e, counterparty_node_id));
6805 if further_update_exists {
6806 // If there are more `ChannelMonitorUpdate`s to process, restart at the
6811 log_trace!(self.logger, "Unlocked monitor updating for channel {} without monitors to update",
6812 &channel_funding_outpoint.to_channel_id());
6816 log_debug!(self.logger,
6817 "Got a release post-RAA monitor update for peer {} but the channel is gone",
6818 log_pubkey!(counterparty_node_id));
6822 for (err, counterparty_node_id) in errors {
6823 let res = Err::<(), _>(err);
6824 let _ = handle_error!(self, res, counterparty_node_id);
6828 fn handle_post_event_actions(&self, actions: Vec<EventCompletionAction>) {
6829 for action in actions {
6831 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
6832 channel_funding_outpoint, counterparty_node_id
6834 self.handle_monitor_update_release(counterparty_node_id, channel_funding_outpoint, None);
6840 /// Processes any events asynchronously in the order they were generated since the last call
6841 /// using the given event handler.
6843 /// See the trait-level documentation of [`EventsProvider`] for requirements.
6844 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
6848 process_events_body!(self, ev, { handler(ev).await });
6852 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>
6854 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6855 T::Target: BroadcasterInterface,
6856 ES::Target: EntropySource,
6857 NS::Target: NodeSigner,
6858 SP::Target: SignerProvider,
6859 F::Target: FeeEstimator,
6863 /// Returns `MessageSendEvent`s strictly ordered per-peer, in the order they were generated.
6864 /// The returned array will contain `MessageSendEvent`s for different peers if
6865 /// `MessageSendEvent`s to more than one peer exists, but `MessageSendEvent`s to the same peer
6866 /// is always placed next to each other.
6868 /// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
6869 /// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
6870 /// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
6871 /// will randomly be placed first or last in the returned array.
6873 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
6874 /// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
6875 /// the `MessageSendEvent`s to the specific peer they were generated under.
6876 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
6877 let events = RefCell::new(Vec::new());
6878 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
6879 let mut result = self.process_background_events();
6881 // TODO: This behavior should be documented. It's unintuitive that we query
6882 // ChannelMonitors when clearing other events.
6883 if self.process_pending_monitor_events() {
6884 result = NotifyOption::DoPersist;
6887 if self.check_free_holding_cells() {
6888 result = NotifyOption::DoPersist;
6890 if self.maybe_generate_initial_closing_signed() {
6891 result = NotifyOption::DoPersist;
6894 let mut pending_events = Vec::new();
6895 let per_peer_state = self.per_peer_state.read().unwrap();
6896 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6897 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6898 let peer_state = &mut *peer_state_lock;
6899 if peer_state.pending_msg_events.len() > 0 {
6900 pending_events.append(&mut peer_state.pending_msg_events);
6904 if !pending_events.is_empty() {
6905 events.replace(pending_events);
6914 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>
6916 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6917 T::Target: BroadcasterInterface,
6918 ES::Target: EntropySource,
6919 NS::Target: NodeSigner,
6920 SP::Target: SignerProvider,
6921 F::Target: FeeEstimator,
6925 /// Processes events that must be periodically handled.
6927 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
6928 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
6929 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
6931 process_events_body!(self, ev, handler.handle_event(ev));
6935 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>
6937 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6938 T::Target: BroadcasterInterface,
6939 ES::Target: EntropySource,
6940 NS::Target: NodeSigner,
6941 SP::Target: SignerProvider,
6942 F::Target: FeeEstimator,
6946 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
6948 let best_block = self.best_block.read().unwrap();
6949 assert_eq!(best_block.block_hash(), header.prev_blockhash,
6950 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
6951 assert_eq!(best_block.height(), height - 1,
6952 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
6955 self.transactions_confirmed(header, txdata, height);
6956 self.best_block_updated(header, height);
6959 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
6960 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
6961 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
6962 let new_height = height - 1;
6964 let mut best_block = self.best_block.write().unwrap();
6965 assert_eq!(best_block.block_hash(), header.block_hash(),
6966 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
6967 assert_eq!(best_block.height(), height,
6968 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
6969 *best_block = BestBlock::new(header.prev_blockhash, new_height)
6972 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));
6976 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>
6978 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6979 T::Target: BroadcasterInterface,
6980 ES::Target: EntropySource,
6981 NS::Target: NodeSigner,
6982 SP::Target: SignerProvider,
6983 F::Target: FeeEstimator,
6987 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
6988 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
6989 // during initialization prior to the chain_monitor being fully configured in some cases.
6990 // See the docs for `ChannelManagerReadArgs` for more.
6992 let block_hash = header.block_hash();
6993 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
6995 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
6996 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
6997 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)
6998 .map(|(a, b)| (a, Vec::new(), b)));
7000 let last_best_block_height = self.best_block.read().unwrap().height();
7001 if height < last_best_block_height {
7002 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
7003 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));
7007 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
7008 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
7009 // during initialization prior to the chain_monitor being fully configured in some cases.
7010 // See the docs for `ChannelManagerReadArgs` for more.
7012 let block_hash = header.block_hash();
7013 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
7015 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
7016 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
7017 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
7019 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));
7021 macro_rules! max_time {
7022 ($timestamp: expr) => {
7024 // Update $timestamp to be the max of its current value and the block
7025 // timestamp. This should keep us close to the current time without relying on
7026 // having an explicit local time source.
7027 // Just in case we end up in a race, we loop until we either successfully
7028 // update $timestamp or decide we don't need to.
7029 let old_serial = $timestamp.load(Ordering::Acquire);
7030 if old_serial >= header.time as usize { break; }
7031 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
7037 max_time!(self.highest_seen_timestamp);
7038 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
7039 payment_secrets.retain(|_, inbound_payment| {
7040 inbound_payment.expiry_time > header.time as u64
7044 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
7045 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
7046 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
7047 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7048 let peer_state = &mut *peer_state_lock;
7049 for chan in peer_state.channel_by_id.values() {
7050 if let (Some(funding_txo), Some(block_hash)) = (chan.context.get_funding_txo(), chan.context.get_funding_tx_confirmed_in()) {
7051 res.push((funding_txo.txid, Some(block_hash)));
7058 fn transaction_unconfirmed(&self, txid: &Txid) {
7059 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
7060 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
7061 self.do_chain_event(None, |channel| {
7062 if let Some(funding_txo) = channel.context.get_funding_txo() {
7063 if funding_txo.txid == *txid {
7064 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
7065 } else { Ok((None, Vec::new(), None)) }
7066 } else { Ok((None, Vec::new(), None)) }
7071 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>
7073 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7074 T::Target: BroadcasterInterface,
7075 ES::Target: EntropySource,
7076 NS::Target: NodeSigner,
7077 SP::Target: SignerProvider,
7078 F::Target: FeeEstimator,
7082 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
7083 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
7085 fn do_chain_event<FN: Fn(&mut Channel<SP>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
7086 (&self, height_opt: Option<u32>, f: FN) {
7087 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
7088 // during initialization prior to the chain_monitor being fully configured in some cases.
7089 // See the docs for `ChannelManagerReadArgs` for more.
7091 let mut failed_channels = Vec::new();
7092 let mut timed_out_htlcs = Vec::new();
7094 let per_peer_state = self.per_peer_state.read().unwrap();
7095 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7096 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7097 let peer_state = &mut *peer_state_lock;
7098 let pending_msg_events = &mut peer_state.pending_msg_events;
7099 peer_state.channel_by_id.retain(|_, channel| {
7100 let res = f(channel);
7101 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
7102 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
7103 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
7104 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
7105 HTLCDestination::NextHopChannel { node_id: Some(channel.context.get_counterparty_node_id()), channel_id: channel.context.channel_id() }));
7107 if let Some(channel_ready) = channel_ready_opt {
7108 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
7109 if channel.context.is_usable() {
7110 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", &channel.context.channel_id());
7111 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
7112 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
7113 node_id: channel.context.get_counterparty_node_id(),
7118 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", &channel.context.channel_id());
7123 let mut pending_events = self.pending_events.lock().unwrap();
7124 emit_channel_ready_event!(pending_events, channel);
7127 if let Some(announcement_sigs) = announcement_sigs {
7128 log_trace!(self.logger, "Sending announcement_signatures for channel {}", &channel.context.channel_id());
7129 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
7130 node_id: channel.context.get_counterparty_node_id(),
7131 msg: announcement_sigs,
7133 if let Some(height) = height_opt {
7134 if let Some(announcement) = channel.get_signed_channel_announcement(&self.node_signer, self.genesis_hash, height, &self.default_configuration) {
7135 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
7137 // Note that announcement_signatures fails if the channel cannot be announced,
7138 // so get_channel_update_for_broadcast will never fail by the time we get here.
7139 update_msg: Some(self.get_channel_update_for_broadcast(channel).unwrap()),
7144 if channel.is_our_channel_ready() {
7145 if let Some(real_scid) = channel.context.get_short_channel_id() {
7146 // If we sent a 0conf channel_ready, and now have an SCID, we add it
7147 // to the short_to_chan_info map here. Note that we check whether we
7148 // can relay using the real SCID at relay-time (i.e.
7149 // enforce option_scid_alias then), and if the funding tx is ever
7150 // un-confirmed we force-close the channel, ensuring short_to_chan_info
7151 // is always consistent.
7152 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
7153 let scid_insert = short_to_chan_info.insert(real_scid, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
7154 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.context.get_counterparty_node_id(), channel.context.channel_id()),
7155 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
7156 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
7159 } else if let Err(reason) = res {
7160 update_maps_on_chan_removal!(self, &channel.context);
7161 // It looks like our counterparty went on-chain or funding transaction was
7162 // reorged out of the main chain. Close the channel.
7163 failed_channels.push(channel.context.force_shutdown(true));
7164 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
7165 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
7169 let reason_message = format!("{}", reason);
7170 self.issue_channel_close_events(&channel.context, reason);
7171 pending_msg_events.push(events::MessageSendEvent::HandleError {
7172 node_id: channel.context.get_counterparty_node_id(),
7173 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
7174 channel_id: channel.context.channel_id(),
7175 data: reason_message,
7185 if let Some(height) = height_opt {
7186 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
7187 payment.htlcs.retain(|htlc| {
7188 // If height is approaching the number of blocks we think it takes us to get
7189 // our commitment transaction confirmed before the HTLC expires, plus the
7190 // number of blocks we generally consider it to take to do a commitment update,
7191 // just give up on it and fail the HTLC.
7192 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
7193 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
7194 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
7196 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
7197 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
7198 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
7202 !payment.htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
7205 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
7206 intercepted_htlcs.retain(|_, htlc| {
7207 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
7208 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
7209 short_channel_id: htlc.prev_short_channel_id,
7210 user_channel_id: Some(htlc.prev_user_channel_id),
7211 htlc_id: htlc.prev_htlc_id,
7212 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
7213 phantom_shared_secret: None,
7214 outpoint: htlc.prev_funding_outpoint,
7217 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
7218 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
7219 _ => unreachable!(),
7221 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
7222 HTLCFailReason::from_failure_code(0x2000 | 2),
7223 HTLCDestination::InvalidForward { requested_forward_scid }));
7224 log_trace!(self.logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
7230 self.handle_init_event_channel_failures(failed_channels);
7232 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
7233 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
7237 /// Gets a [`Future`] that completes when this [`ChannelManager`] needs to be persisted.
7239 /// Note that callbacks registered on the [`Future`] MUST NOT call back into this
7240 /// [`ChannelManager`] and should instead register actions to be taken later.
7242 pub fn get_persistable_update_future(&self) -> Future {
7243 self.persistence_notifier.get_future()
7246 #[cfg(any(test, feature = "_test_utils"))]
7247 pub fn get_persistence_condvar_value(&self) -> bool {
7248 self.persistence_notifier.notify_pending()
7251 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
7252 /// [`chain::Confirm`] interfaces.
7253 pub fn current_best_block(&self) -> BestBlock {
7254 self.best_block.read().unwrap().clone()
7257 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
7258 /// [`ChannelManager`].
7259 pub fn node_features(&self) -> NodeFeatures {
7260 provided_node_features(&self.default_configuration)
7263 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags which are provided by or required by
7264 /// [`ChannelManager`].
7266 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
7267 /// or not. Thus, this method is not public.
7268 #[cfg(any(feature = "_test_utils", test))]
7269 pub fn invoice_features(&self) -> Bolt11InvoiceFeatures {
7270 provided_invoice_features(&self.default_configuration)
7273 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
7274 /// [`ChannelManager`].
7275 pub fn channel_features(&self) -> ChannelFeatures {
7276 provided_channel_features(&self.default_configuration)
7279 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
7280 /// [`ChannelManager`].
7281 pub fn channel_type_features(&self) -> ChannelTypeFeatures {
7282 provided_channel_type_features(&self.default_configuration)
7285 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
7286 /// [`ChannelManager`].
7287 pub fn init_features(&self) -> InitFeatures {
7288 provided_init_features(&self.default_configuration)
7292 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7293 ChannelMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
7295 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7296 T::Target: BroadcasterInterface,
7297 ES::Target: EntropySource,
7298 NS::Target: NodeSigner,
7299 SP::Target: SignerProvider,
7300 F::Target: FeeEstimator,
7304 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) {
7305 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7306 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, msg), *counterparty_node_id);
7309 fn handle_open_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
7310 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7311 "Dual-funded channels not supported".to_owned(),
7312 msg.temporary_channel_id.clone())), *counterparty_node_id);
7315 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
7316 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7317 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, msg), *counterparty_node_id);
7320 fn handle_accept_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
7321 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7322 "Dual-funded channels not supported".to_owned(),
7323 msg.temporary_channel_id.clone())), *counterparty_node_id);
7326 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
7327 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7328 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
7331 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
7332 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7333 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
7336 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
7337 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7338 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
7341 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
7342 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7343 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
7346 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
7347 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7348 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
7351 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
7352 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7353 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
7356 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
7357 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7358 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
7361 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
7362 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7363 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
7366 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
7367 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7368 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
7371 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
7372 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7373 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
7376 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
7377 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7378 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
7381 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
7382 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7383 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
7386 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
7387 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7388 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
7391 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
7392 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
7393 let force_persist = self.process_background_events();
7394 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
7395 if force_persist == NotifyOption::DoPersist { NotifyOption::DoPersist } else { persist }
7397 NotifyOption::SkipPersist
7402 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
7403 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7404 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
7407 fn peer_disconnected(&self, counterparty_node_id: &PublicKey) {
7408 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7409 let mut failed_channels = Vec::new();
7410 let mut per_peer_state = self.per_peer_state.write().unwrap();
7412 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates.",
7413 log_pubkey!(counterparty_node_id));
7414 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
7415 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7416 let peer_state = &mut *peer_state_lock;
7417 let pending_msg_events = &mut peer_state.pending_msg_events;
7418 peer_state.channel_by_id.retain(|_, chan| {
7419 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
7420 if chan.is_shutdown() {
7421 update_maps_on_chan_removal!(self, &chan.context);
7422 self.issue_channel_close_events(&chan.context, ClosureReason::DisconnectedPeer);
7427 peer_state.inbound_v1_channel_by_id.retain(|_, chan| {
7428 update_maps_on_chan_removal!(self, &chan.context);
7429 self.issue_channel_close_events(&chan.context, ClosureReason::DisconnectedPeer);
7432 peer_state.outbound_v1_channel_by_id.retain(|_, chan| {
7433 update_maps_on_chan_removal!(self, &chan.context);
7434 self.issue_channel_close_events(&chan.context, ClosureReason::DisconnectedPeer);
7437 // Note that we don't bother generating any events for pre-accept channels -
7438 // they're not considered "channels" yet from the PoV of our events interface.
7439 peer_state.inbound_channel_request_by_id.clear();
7440 pending_msg_events.retain(|msg| {
7442 // V1 Channel Establishment
7443 &events::MessageSendEvent::SendAcceptChannel { .. } => false,
7444 &events::MessageSendEvent::SendOpenChannel { .. } => false,
7445 &events::MessageSendEvent::SendFundingCreated { .. } => false,
7446 &events::MessageSendEvent::SendFundingSigned { .. } => false,
7447 // V2 Channel Establishment
7448 &events::MessageSendEvent::SendAcceptChannelV2 { .. } => false,
7449 &events::MessageSendEvent::SendOpenChannelV2 { .. } => false,
7450 // Common Channel Establishment
7451 &events::MessageSendEvent::SendChannelReady { .. } => false,
7452 &events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
7453 // Interactive Transaction Construction
7454 &events::MessageSendEvent::SendTxAddInput { .. } => false,
7455 &events::MessageSendEvent::SendTxAddOutput { .. } => false,
7456 &events::MessageSendEvent::SendTxRemoveInput { .. } => false,
7457 &events::MessageSendEvent::SendTxRemoveOutput { .. } => false,
7458 &events::MessageSendEvent::SendTxComplete { .. } => false,
7459 &events::MessageSendEvent::SendTxSignatures { .. } => false,
7460 &events::MessageSendEvent::SendTxInitRbf { .. } => false,
7461 &events::MessageSendEvent::SendTxAckRbf { .. } => false,
7462 &events::MessageSendEvent::SendTxAbort { .. } => false,
7463 // Channel Operations
7464 &events::MessageSendEvent::UpdateHTLCs { .. } => false,
7465 &events::MessageSendEvent::SendRevokeAndACK { .. } => false,
7466 &events::MessageSendEvent::SendClosingSigned { .. } => false,
7467 &events::MessageSendEvent::SendShutdown { .. } => false,
7468 &events::MessageSendEvent::SendChannelReestablish { .. } => false,
7469 &events::MessageSendEvent::HandleError { .. } => false,
7471 &events::MessageSendEvent::SendChannelAnnouncement { .. } => false,
7472 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
7473 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
7474 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
7475 &events::MessageSendEvent::SendChannelUpdate { .. } => false,
7476 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
7477 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
7478 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
7479 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
7482 debug_assert!(peer_state.is_connected, "A disconnected peer cannot disconnect");
7483 peer_state.is_connected = false;
7484 peer_state.ok_to_remove(true)
7485 } else { debug_assert!(false, "Unconnected peer disconnected"); true }
7488 per_peer_state.remove(counterparty_node_id);
7490 mem::drop(per_peer_state);
7492 for failure in failed_channels.drain(..) {
7493 self.finish_force_close_channel(failure);
7497 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init, inbound: bool) -> Result<(), ()> {
7498 if !init_msg.features.supports_static_remote_key() {
7499 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting", log_pubkey!(counterparty_node_id));
7503 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7505 // If we have too many peers connected which don't have funded channels, disconnect the
7506 // peer immediately (as long as it doesn't have funded channels). If we have a bunch of
7507 // unfunded channels taking up space in memory for disconnected peers, we still let new
7508 // peers connect, but we'll reject new channels from them.
7509 let connected_peers_without_funded_channels = self.peers_without_funded_channels(|node| node.is_connected);
7510 let inbound_peer_limited = inbound && connected_peers_without_funded_channels >= MAX_NO_CHANNEL_PEERS;
7513 let mut peer_state_lock = self.per_peer_state.write().unwrap();
7514 match peer_state_lock.entry(counterparty_node_id.clone()) {
7515 hash_map::Entry::Vacant(e) => {
7516 if inbound_peer_limited {
7519 e.insert(Mutex::new(PeerState {
7520 channel_by_id: HashMap::new(),
7521 outbound_v1_channel_by_id: HashMap::new(),
7522 inbound_v1_channel_by_id: HashMap::new(),
7523 inbound_channel_request_by_id: HashMap::new(),
7524 latest_features: init_msg.features.clone(),
7525 pending_msg_events: Vec::new(),
7526 in_flight_monitor_updates: BTreeMap::new(),
7527 monitor_update_blocked_actions: BTreeMap::new(),
7528 actions_blocking_raa_monitor_updates: BTreeMap::new(),
7532 hash_map::Entry::Occupied(e) => {
7533 let mut peer_state = e.get().lock().unwrap();
7534 peer_state.latest_features = init_msg.features.clone();
7536 let best_block_height = self.best_block.read().unwrap().height();
7537 if inbound_peer_limited &&
7538 Self::unfunded_channel_count(&*peer_state, best_block_height) ==
7539 peer_state.channel_by_id.len()
7544 debug_assert!(!peer_state.is_connected, "A peer shouldn't be connected twice");
7545 peer_state.is_connected = true;
7550 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
7552 let per_peer_state = self.per_peer_state.read().unwrap();
7553 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
7554 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7555 let peer_state = &mut *peer_state_lock;
7556 let pending_msg_events = &mut peer_state.pending_msg_events;
7558 // Since unfunded channel maps are cleared upon disconnecting a peer, and they're not persisted
7559 // (so won't be recovered after a crash) we don't need to bother closing unfunded channels and
7560 // clearing their maps here. Instead we can just send queue channel_reestablish messages for
7561 // channels in the channel_by_id map.
7562 peer_state.channel_by_id.iter_mut().for_each(|(_, chan)| {
7563 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
7564 node_id: chan.context.get_counterparty_node_id(),
7565 msg: chan.get_channel_reestablish(&self.logger),
7569 //TODO: Also re-broadcast announcement_signatures
7573 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
7574 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7576 match &msg.data as &str {
7577 "cannot co-op close channel w/ active htlcs"|
7578 "link failed to shutdown" =>
7580 // LND hasn't properly handled shutdown messages ever, and force-closes any time we
7581 // send one while HTLCs are still present. The issue is tracked at
7582 // https://github.com/lightningnetwork/lnd/issues/6039 and has had multiple patches
7583 // to fix it but none so far have managed to land upstream. The issue appears to be
7584 // very low priority for the LND team despite being marked "P1".
7585 // We're not going to bother handling this in a sensible way, instead simply
7586 // repeating the Shutdown message on repeat until morale improves.
7587 if !msg.channel_id.is_zero() {
7588 let per_peer_state = self.per_peer_state.read().unwrap();
7589 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
7590 if peer_state_mutex_opt.is_none() { return; }
7591 let mut peer_state = peer_state_mutex_opt.unwrap().lock().unwrap();
7592 if let Some(chan) = peer_state.channel_by_id.get(&msg.channel_id) {
7593 if let Some(msg) = chan.get_outbound_shutdown() {
7594 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
7595 node_id: *counterparty_node_id,
7599 peer_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
7600 node_id: *counterparty_node_id,
7601 action: msgs::ErrorAction::SendWarningMessage {
7602 msg: msgs::WarningMessage {
7603 channel_id: msg.channel_id,
7604 data: "You appear to be exhibiting LND bug 6039, we'll keep sending you shutdown messages until you handle them correctly".to_owned()
7606 log_level: Level::Trace,
7616 if msg.channel_id.is_zero() {
7617 let channel_ids: Vec<ChannelId> = {
7618 let per_peer_state = self.per_peer_state.read().unwrap();
7619 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
7620 if peer_state_mutex_opt.is_none() { return; }
7621 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
7622 let peer_state = &mut *peer_state_lock;
7623 // Note that we don't bother generating any events for pre-accept channels -
7624 // they're not considered "channels" yet from the PoV of our events interface.
7625 peer_state.inbound_channel_request_by_id.clear();
7626 peer_state.channel_by_id.keys().cloned()
7627 .chain(peer_state.outbound_v1_channel_by_id.keys().cloned())
7628 .chain(peer_state.inbound_v1_channel_by_id.keys().cloned()).collect()
7630 for channel_id in channel_ids {
7631 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
7632 let _ = self.force_close_channel_with_peer(&channel_id, counterparty_node_id, Some(&msg.data), true);
7636 // First check if we can advance the channel type and try again.
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_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
7641 let peer_state = &mut *peer_state_lock;
7642 if let Some(chan) = peer_state.outbound_v1_channel_by_id.get_mut(&msg.channel_id) {
7643 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash, &self.fee_estimator) {
7644 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
7645 node_id: *counterparty_node_id,
7653 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
7654 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
7658 fn provided_node_features(&self) -> NodeFeatures {
7659 provided_node_features(&self.default_configuration)
7662 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
7663 provided_init_features(&self.default_configuration)
7666 fn get_genesis_hashes(&self) -> Option<Vec<ChainHash>> {
7667 Some(vec![ChainHash::from(&self.genesis_hash[..])])
7670 fn handle_tx_add_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddInput) {
7671 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7672 "Dual-funded channels not supported".to_owned(),
7673 msg.channel_id.clone())), *counterparty_node_id);
7676 fn handle_tx_add_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
7677 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7678 "Dual-funded channels not supported".to_owned(),
7679 msg.channel_id.clone())), *counterparty_node_id);
7682 fn handle_tx_remove_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
7683 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7684 "Dual-funded channels not supported".to_owned(),
7685 msg.channel_id.clone())), *counterparty_node_id);
7688 fn handle_tx_remove_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
7689 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7690 "Dual-funded channels not supported".to_owned(),
7691 msg.channel_id.clone())), *counterparty_node_id);
7694 fn handle_tx_complete(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxComplete) {
7695 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7696 "Dual-funded channels not supported".to_owned(),
7697 msg.channel_id.clone())), *counterparty_node_id);
7700 fn handle_tx_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxSignatures) {
7701 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7702 "Dual-funded channels not supported".to_owned(),
7703 msg.channel_id.clone())), *counterparty_node_id);
7706 fn handle_tx_init_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
7707 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7708 "Dual-funded channels not supported".to_owned(),
7709 msg.channel_id.clone())), *counterparty_node_id);
7712 fn handle_tx_ack_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
7713 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7714 "Dual-funded channels not supported".to_owned(),
7715 msg.channel_id.clone())), *counterparty_node_id);
7718 fn handle_tx_abort(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAbort) {
7719 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7720 "Dual-funded channels not supported".to_owned(),
7721 msg.channel_id.clone())), *counterparty_node_id);
7725 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
7726 /// [`ChannelManager`].
7727 pub(crate) fn provided_node_features(config: &UserConfig) -> NodeFeatures {
7728 let mut node_features = provided_init_features(config).to_context();
7729 node_features.set_keysend_optional();
7733 /// Fetches the set of [`Bolt11InvoiceFeatures`] flags which are provided by or required by
7734 /// [`ChannelManager`].
7736 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
7737 /// or not. Thus, this method is not public.
7738 #[cfg(any(feature = "_test_utils", test))]
7739 pub(crate) fn provided_invoice_features(config: &UserConfig) -> Bolt11InvoiceFeatures {
7740 provided_init_features(config).to_context()
7743 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
7744 /// [`ChannelManager`].
7745 pub(crate) fn provided_channel_features(config: &UserConfig) -> ChannelFeatures {
7746 provided_init_features(config).to_context()
7749 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
7750 /// [`ChannelManager`].
7751 pub(crate) fn provided_channel_type_features(config: &UserConfig) -> ChannelTypeFeatures {
7752 ChannelTypeFeatures::from_init(&provided_init_features(config))
7755 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
7756 /// [`ChannelManager`].
7757 pub fn provided_init_features(config: &UserConfig) -> InitFeatures {
7758 // Note that if new features are added here which other peers may (eventually) require, we
7759 // should also add the corresponding (optional) bit to the [`ChannelMessageHandler`] impl for
7760 // [`ErroringMessageHandler`].
7761 let mut features = InitFeatures::empty();
7762 features.set_data_loss_protect_required();
7763 features.set_upfront_shutdown_script_optional();
7764 features.set_variable_length_onion_required();
7765 features.set_static_remote_key_required();
7766 features.set_payment_secret_required();
7767 features.set_basic_mpp_optional();
7768 features.set_wumbo_optional();
7769 features.set_shutdown_any_segwit_optional();
7770 features.set_channel_type_optional();
7771 features.set_scid_privacy_optional();
7772 features.set_zero_conf_optional();
7773 if config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx {
7774 features.set_anchors_zero_fee_htlc_tx_optional();
7779 const SERIALIZATION_VERSION: u8 = 1;
7780 const MIN_SERIALIZATION_VERSION: u8 = 1;
7782 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
7783 (2, fee_base_msat, required),
7784 (4, fee_proportional_millionths, required),
7785 (6, cltv_expiry_delta, required),
7788 impl_writeable_tlv_based!(ChannelCounterparty, {
7789 (2, node_id, required),
7790 (4, features, required),
7791 (6, unspendable_punishment_reserve, required),
7792 (8, forwarding_info, option),
7793 (9, outbound_htlc_minimum_msat, option),
7794 (11, outbound_htlc_maximum_msat, option),
7797 impl Writeable for ChannelDetails {
7798 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
7799 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
7800 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
7801 let user_channel_id_low = self.user_channel_id as u64;
7802 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
7803 write_tlv_fields!(writer, {
7804 (1, self.inbound_scid_alias, option),
7805 (2, self.channel_id, required),
7806 (3, self.channel_type, option),
7807 (4, self.counterparty, required),
7808 (5, self.outbound_scid_alias, option),
7809 (6, self.funding_txo, option),
7810 (7, self.config, option),
7811 (8, self.short_channel_id, option),
7812 (9, self.confirmations, option),
7813 (10, self.channel_value_satoshis, required),
7814 (12, self.unspendable_punishment_reserve, option),
7815 (14, user_channel_id_low, required),
7816 (16, self.next_outbound_htlc_limit_msat, required), // Forwards compatibility for removed balance_msat field.
7817 (18, self.outbound_capacity_msat, required),
7818 (19, self.next_outbound_htlc_limit_msat, required),
7819 (20, self.inbound_capacity_msat, required),
7820 (21, self.next_outbound_htlc_minimum_msat, required),
7821 (22, self.confirmations_required, option),
7822 (24, self.force_close_spend_delay, option),
7823 (26, self.is_outbound, required),
7824 (28, self.is_channel_ready, required),
7825 (30, self.is_usable, required),
7826 (32, self.is_public, required),
7827 (33, self.inbound_htlc_minimum_msat, option),
7828 (35, self.inbound_htlc_maximum_msat, option),
7829 (37, user_channel_id_high_opt, option),
7830 (39, self.feerate_sat_per_1000_weight, option),
7831 (41, self.channel_shutdown_state, option),
7837 impl Readable for ChannelDetails {
7838 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
7839 _init_and_read_len_prefixed_tlv_fields!(reader, {
7840 (1, inbound_scid_alias, option),
7841 (2, channel_id, required),
7842 (3, channel_type, option),
7843 (4, counterparty, required),
7844 (5, outbound_scid_alias, option),
7845 (6, funding_txo, option),
7846 (7, config, option),
7847 (8, short_channel_id, option),
7848 (9, confirmations, option),
7849 (10, channel_value_satoshis, required),
7850 (12, unspendable_punishment_reserve, option),
7851 (14, user_channel_id_low, required),
7852 (16, _balance_msat, option), // Backwards compatibility for removed balance_msat field.
7853 (18, outbound_capacity_msat, required),
7854 // Note that by the time we get past the required read above, outbound_capacity_msat will be
7855 // filled in, so we can safely unwrap it here.
7856 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
7857 (20, inbound_capacity_msat, required),
7858 (21, next_outbound_htlc_minimum_msat, (default_value, 0)),
7859 (22, confirmations_required, option),
7860 (24, force_close_spend_delay, option),
7861 (26, is_outbound, required),
7862 (28, is_channel_ready, required),
7863 (30, is_usable, required),
7864 (32, is_public, required),
7865 (33, inbound_htlc_minimum_msat, option),
7866 (35, inbound_htlc_maximum_msat, option),
7867 (37, user_channel_id_high_opt, option),
7868 (39, feerate_sat_per_1000_weight, option),
7869 (41, channel_shutdown_state, option),
7872 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
7873 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
7874 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
7875 let user_channel_id = user_channel_id_low as u128 +
7876 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
7878 let _balance_msat: Option<u64> = _balance_msat;
7882 channel_id: channel_id.0.unwrap(),
7884 counterparty: counterparty.0.unwrap(),
7885 outbound_scid_alias,
7889 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
7890 unspendable_punishment_reserve,
7892 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
7893 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
7894 next_outbound_htlc_minimum_msat: next_outbound_htlc_minimum_msat.0.unwrap(),
7895 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
7896 confirmations_required,
7898 force_close_spend_delay,
7899 is_outbound: is_outbound.0.unwrap(),
7900 is_channel_ready: is_channel_ready.0.unwrap(),
7901 is_usable: is_usable.0.unwrap(),
7902 is_public: is_public.0.unwrap(),
7903 inbound_htlc_minimum_msat,
7904 inbound_htlc_maximum_msat,
7905 feerate_sat_per_1000_weight,
7906 channel_shutdown_state,
7911 impl_writeable_tlv_based!(PhantomRouteHints, {
7912 (2, channels, required_vec),
7913 (4, phantom_scid, required),
7914 (6, real_node_pubkey, required),
7917 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
7919 (0, onion_packet, required),
7920 (2, short_channel_id, required),
7923 (0, payment_data, required),
7924 (1, phantom_shared_secret, option),
7925 (2, incoming_cltv_expiry, required),
7926 (3, payment_metadata, option),
7927 (5, custom_tlvs, optional_vec),
7929 (2, ReceiveKeysend) => {
7930 (0, payment_preimage, required),
7931 (2, incoming_cltv_expiry, required),
7932 (3, payment_metadata, option),
7933 (4, payment_data, option), // Added in 0.0.116
7934 (5, custom_tlvs, optional_vec),
7938 impl_writeable_tlv_based!(PendingHTLCInfo, {
7939 (0, routing, required),
7940 (2, incoming_shared_secret, required),
7941 (4, payment_hash, required),
7942 (6, outgoing_amt_msat, required),
7943 (8, outgoing_cltv_value, required),
7944 (9, incoming_amt_msat, option),
7945 (10, skimmed_fee_msat, option),
7949 impl Writeable for HTLCFailureMsg {
7950 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
7952 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
7954 channel_id.write(writer)?;
7955 htlc_id.write(writer)?;
7956 reason.write(writer)?;
7958 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
7959 channel_id, htlc_id, sha256_of_onion, failure_code
7962 channel_id.write(writer)?;
7963 htlc_id.write(writer)?;
7964 sha256_of_onion.write(writer)?;
7965 failure_code.write(writer)?;
7972 impl Readable for HTLCFailureMsg {
7973 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
7974 let id: u8 = Readable::read(reader)?;
7977 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
7978 channel_id: Readable::read(reader)?,
7979 htlc_id: Readable::read(reader)?,
7980 reason: Readable::read(reader)?,
7984 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
7985 channel_id: Readable::read(reader)?,
7986 htlc_id: Readable::read(reader)?,
7987 sha256_of_onion: Readable::read(reader)?,
7988 failure_code: Readable::read(reader)?,
7991 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
7992 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
7993 // messages contained in the variants.
7994 // In version 0.0.101, support for reading the variants with these types was added, and
7995 // we should migrate to writing these variants when UpdateFailHTLC or
7996 // UpdateFailMalformedHTLC get TLV fields.
7998 let length: BigSize = Readable::read(reader)?;
7999 let mut s = FixedLengthReader::new(reader, length.0);
8000 let res = Readable::read(&mut s)?;
8001 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
8002 Ok(HTLCFailureMsg::Relay(res))
8005 let length: BigSize = Readable::read(reader)?;
8006 let mut s = FixedLengthReader::new(reader, length.0);
8007 let res = Readable::read(&mut s)?;
8008 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
8009 Ok(HTLCFailureMsg::Malformed(res))
8011 _ => Err(DecodeError::UnknownRequiredFeature),
8016 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
8021 impl_writeable_tlv_based!(HTLCPreviousHopData, {
8022 (0, short_channel_id, required),
8023 (1, phantom_shared_secret, option),
8024 (2, outpoint, required),
8025 (4, htlc_id, required),
8026 (6, incoming_packet_shared_secret, required),
8027 (7, user_channel_id, option),
8030 impl Writeable for ClaimableHTLC {
8031 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8032 let (payment_data, keysend_preimage) = match &self.onion_payload {
8033 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
8034 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
8036 write_tlv_fields!(writer, {
8037 (0, self.prev_hop, required),
8038 (1, self.total_msat, required),
8039 (2, self.value, required),
8040 (3, self.sender_intended_value, required),
8041 (4, payment_data, option),
8042 (5, self.total_value_received, option),
8043 (6, self.cltv_expiry, required),
8044 (8, keysend_preimage, option),
8045 (10, self.counterparty_skimmed_fee_msat, option),
8051 impl Readable for ClaimableHTLC {
8052 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8053 _init_and_read_len_prefixed_tlv_fields!(reader, {
8054 (0, prev_hop, required),
8055 (1, total_msat, option),
8056 (2, value_ser, required),
8057 (3, sender_intended_value, option),
8058 (4, payment_data_opt, option),
8059 (5, total_value_received, option),
8060 (6, cltv_expiry, required),
8061 (8, keysend_preimage, option),
8062 (10, counterparty_skimmed_fee_msat, option),
8064 let payment_data: Option<msgs::FinalOnionHopData> = payment_data_opt;
8065 let value = value_ser.0.unwrap();
8066 let onion_payload = match keysend_preimage {
8068 if payment_data.is_some() {
8069 return Err(DecodeError::InvalidValue)
8071 if total_msat.is_none() {
8072 total_msat = Some(value);
8074 OnionPayload::Spontaneous(p)
8077 if total_msat.is_none() {
8078 if payment_data.is_none() {
8079 return Err(DecodeError::InvalidValue)
8081 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
8083 OnionPayload::Invoice { _legacy_hop_data: payment_data }
8087 prev_hop: prev_hop.0.unwrap(),
8090 sender_intended_value: sender_intended_value.unwrap_or(value),
8091 total_value_received,
8092 total_msat: total_msat.unwrap(),
8094 cltv_expiry: cltv_expiry.0.unwrap(),
8095 counterparty_skimmed_fee_msat,
8100 impl Readable for HTLCSource {
8101 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8102 let id: u8 = Readable::read(reader)?;
8105 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
8106 let mut first_hop_htlc_msat: u64 = 0;
8107 let mut path_hops = Vec::new();
8108 let mut payment_id = None;
8109 let mut payment_params: Option<PaymentParameters> = None;
8110 let mut blinded_tail: Option<BlindedTail> = None;
8111 read_tlv_fields!(reader, {
8112 (0, session_priv, required),
8113 (1, payment_id, option),
8114 (2, first_hop_htlc_msat, required),
8115 (4, path_hops, required_vec),
8116 (5, payment_params, (option: ReadableArgs, 0)),
8117 (6, blinded_tail, option),
8119 if payment_id.is_none() {
8120 // For backwards compat, if there was no payment_id written, use the session_priv bytes
8122 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
8124 let path = Path { hops: path_hops, blinded_tail };
8125 if path.hops.len() == 0 {
8126 return Err(DecodeError::InvalidValue);
8128 if let Some(params) = payment_params.as_mut() {
8129 if let Payee::Clear { ref mut final_cltv_expiry_delta, .. } = params.payee {
8130 if final_cltv_expiry_delta == &0 {
8131 *final_cltv_expiry_delta = path.final_cltv_expiry_delta().ok_or(DecodeError::InvalidValue)?;
8135 Ok(HTLCSource::OutboundRoute {
8136 session_priv: session_priv.0.unwrap(),
8137 first_hop_htlc_msat,
8139 payment_id: payment_id.unwrap(),
8142 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
8143 _ => Err(DecodeError::UnknownRequiredFeature),
8148 impl Writeable for HTLCSource {
8149 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
8151 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id } => {
8153 let payment_id_opt = Some(payment_id);
8154 write_tlv_fields!(writer, {
8155 (0, session_priv, required),
8156 (1, payment_id_opt, option),
8157 (2, first_hop_htlc_msat, required),
8158 // 3 was previously used to write a PaymentSecret for the payment.
8159 (4, path.hops, required_vec),
8160 (5, None::<PaymentParameters>, option), // payment_params in LDK versions prior to 0.0.115
8161 (6, path.blinded_tail, option),
8164 HTLCSource::PreviousHopData(ref field) => {
8166 field.write(writer)?;
8173 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
8174 (0, forward_info, required),
8175 (1, prev_user_channel_id, (default_value, 0)),
8176 (2, prev_short_channel_id, required),
8177 (4, prev_htlc_id, required),
8178 (6, prev_funding_outpoint, required),
8181 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
8183 (0, htlc_id, required),
8184 (2, err_packet, required),
8189 impl_writeable_tlv_based!(PendingInboundPayment, {
8190 (0, payment_secret, required),
8191 (2, expiry_time, required),
8192 (4, user_payment_id, required),
8193 (6, payment_preimage, required),
8194 (8, min_value_msat, required),
8197 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>
8199 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8200 T::Target: BroadcasterInterface,
8201 ES::Target: EntropySource,
8202 NS::Target: NodeSigner,
8203 SP::Target: SignerProvider,
8204 F::Target: FeeEstimator,
8208 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8209 let _consistency_lock = self.total_consistency_lock.write().unwrap();
8211 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
8213 self.genesis_hash.write(writer)?;
8215 let best_block = self.best_block.read().unwrap();
8216 best_block.height().write(writer)?;
8217 best_block.block_hash().write(writer)?;
8220 let mut serializable_peer_count: u64 = 0;
8222 let per_peer_state = self.per_peer_state.read().unwrap();
8223 let mut unfunded_channels = 0;
8224 let mut number_of_channels = 0;
8225 for (_, peer_state_mutex) in per_peer_state.iter() {
8226 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8227 let peer_state = &mut *peer_state_lock;
8228 if !peer_state.ok_to_remove(false) {
8229 serializable_peer_count += 1;
8231 number_of_channels += peer_state.channel_by_id.len();
8232 for (_, channel) in peer_state.channel_by_id.iter() {
8233 if !channel.context.is_funding_initiated() {
8234 unfunded_channels += 1;
8239 ((number_of_channels - unfunded_channels) as u64).write(writer)?;
8241 for (_, peer_state_mutex) in per_peer_state.iter() {
8242 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8243 let peer_state = &mut *peer_state_lock;
8244 for (_, channel) in peer_state.channel_by_id.iter() {
8245 if channel.context.is_funding_initiated() {
8246 channel.write(writer)?;
8253 let forward_htlcs = self.forward_htlcs.lock().unwrap();
8254 (forward_htlcs.len() as u64).write(writer)?;
8255 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
8256 short_channel_id.write(writer)?;
8257 (pending_forwards.len() as u64).write(writer)?;
8258 for forward in pending_forwards {
8259 forward.write(writer)?;
8264 let per_peer_state = self.per_peer_state.write().unwrap();
8266 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
8267 let claimable_payments = self.claimable_payments.lock().unwrap();
8268 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
8270 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
8271 let mut htlc_onion_fields: Vec<&_> = Vec::new();
8272 (claimable_payments.claimable_payments.len() as u64).write(writer)?;
8273 for (payment_hash, payment) in claimable_payments.claimable_payments.iter() {
8274 payment_hash.write(writer)?;
8275 (payment.htlcs.len() as u64).write(writer)?;
8276 for htlc in payment.htlcs.iter() {
8277 htlc.write(writer)?;
8279 htlc_purposes.push(&payment.purpose);
8280 htlc_onion_fields.push(&payment.onion_fields);
8283 let mut monitor_update_blocked_actions_per_peer = None;
8284 let mut peer_states = Vec::new();
8285 for (_, peer_state_mutex) in per_peer_state.iter() {
8286 // Because we're holding the owning `per_peer_state` write lock here there's no chance
8287 // of a lockorder violation deadlock - no other thread can be holding any
8288 // per_peer_state lock at all.
8289 peer_states.push(peer_state_mutex.unsafe_well_ordered_double_lock_self());
8292 (serializable_peer_count).write(writer)?;
8293 for ((peer_pubkey, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
8294 // Peers which we have no channels to should be dropped once disconnected. As we
8295 // disconnect all peers when shutting down and serializing the ChannelManager, we
8296 // consider all peers as disconnected here. There's therefore no need write peers with
8298 if !peer_state.ok_to_remove(false) {
8299 peer_pubkey.write(writer)?;
8300 peer_state.latest_features.write(writer)?;
8301 if !peer_state.monitor_update_blocked_actions.is_empty() {
8302 monitor_update_blocked_actions_per_peer
8303 .get_or_insert_with(Vec::new)
8304 .push((*peer_pubkey, &peer_state.monitor_update_blocked_actions));
8309 let events = self.pending_events.lock().unwrap();
8310 // LDK versions prior to 0.0.115 don't support post-event actions, thus if there's no
8311 // actions at all, skip writing the required TLV. Otherwise, pre-0.0.115 versions will
8312 // refuse to read the new ChannelManager.
8313 let events_not_backwards_compatible = events.iter().any(|(_, action)| action.is_some());
8314 if events_not_backwards_compatible {
8315 // If we're gonna write a even TLV that will overwrite our events anyway we might as
8316 // well save the space and not write any events here.
8317 0u64.write(writer)?;
8319 (events.len() as u64).write(writer)?;
8320 for (event, _) in events.iter() {
8321 event.write(writer)?;
8325 // LDK versions prior to 0.0.116 wrote the `pending_background_events`
8326 // `MonitorUpdateRegeneratedOnStartup`s here, however there was never a reason to do so -
8327 // the closing monitor updates were always effectively replayed on startup (either directly
8328 // by calling `broadcast_latest_holder_commitment_txn` on a `ChannelMonitor` during
8329 // deserialization or, in 0.0.115, by regenerating the monitor update itself).
8330 0u64.write(writer)?;
8332 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
8333 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
8334 // likely to be identical.
8335 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
8336 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
8338 (pending_inbound_payments.len() as u64).write(writer)?;
8339 for (hash, pending_payment) in pending_inbound_payments.iter() {
8340 hash.write(writer)?;
8341 pending_payment.write(writer)?;
8344 // For backwards compat, write the session privs and their total length.
8345 let mut num_pending_outbounds_compat: u64 = 0;
8346 for (_, outbound) in pending_outbound_payments.iter() {
8347 if !outbound.is_fulfilled() && !outbound.abandoned() {
8348 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
8351 num_pending_outbounds_compat.write(writer)?;
8352 for (_, outbound) in pending_outbound_payments.iter() {
8354 PendingOutboundPayment::Legacy { session_privs } |
8355 PendingOutboundPayment::Retryable { session_privs, .. } => {
8356 for session_priv in session_privs.iter() {
8357 session_priv.write(writer)?;
8360 PendingOutboundPayment::Fulfilled { .. } => {},
8361 PendingOutboundPayment::Abandoned { .. } => {},
8365 // Encode without retry info for 0.0.101 compatibility.
8366 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
8367 for (id, outbound) in pending_outbound_payments.iter() {
8369 PendingOutboundPayment::Legacy { session_privs } |
8370 PendingOutboundPayment::Retryable { session_privs, .. } => {
8371 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
8377 let mut pending_intercepted_htlcs = None;
8378 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
8379 if our_pending_intercepts.len() != 0 {
8380 pending_intercepted_htlcs = Some(our_pending_intercepts);
8383 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
8384 if pending_claiming_payments.as_ref().unwrap().is_empty() {
8385 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
8386 // map. Thus, if there are no entries we skip writing a TLV for it.
8387 pending_claiming_payments = None;
8390 let mut in_flight_monitor_updates: Option<HashMap<(&PublicKey, &OutPoint), &Vec<ChannelMonitorUpdate>>> = None;
8391 for ((counterparty_id, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
8392 for (funding_outpoint, updates) in peer_state.in_flight_monitor_updates.iter() {
8393 if !updates.is_empty() {
8394 if in_flight_monitor_updates.is_none() { in_flight_monitor_updates = Some(HashMap::new()); }
8395 in_flight_monitor_updates.as_mut().unwrap().insert((counterparty_id, funding_outpoint), updates);
8400 write_tlv_fields!(writer, {
8401 (1, pending_outbound_payments_no_retry, required),
8402 (2, pending_intercepted_htlcs, option),
8403 (3, pending_outbound_payments, required),
8404 (4, pending_claiming_payments, option),
8405 (5, self.our_network_pubkey, required),
8406 (6, monitor_update_blocked_actions_per_peer, option),
8407 (7, self.fake_scid_rand_bytes, required),
8408 (8, if events_not_backwards_compatible { Some(&*events) } else { None }, option),
8409 (9, htlc_purposes, required_vec),
8410 (10, in_flight_monitor_updates, option),
8411 (11, self.probing_cookie_secret, required),
8412 (13, htlc_onion_fields, optional_vec),
8419 impl Writeable for VecDeque<(Event, Option<EventCompletionAction>)> {
8420 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
8421 (self.len() as u64).write(w)?;
8422 for (event, action) in self.iter() {
8425 #[cfg(debug_assertions)] {
8426 // Events are MaybeReadable, in some cases indicating that they shouldn't actually
8427 // be persisted and are regenerated on restart. However, if such an event has a
8428 // post-event-handling action we'll write nothing for the event and would have to
8429 // either forget the action or fail on deserialization (which we do below). Thus,
8430 // check that the event is sane here.
8431 let event_encoded = event.encode();
8432 let event_read: Option<Event> =
8433 MaybeReadable::read(&mut &event_encoded[..]).unwrap();
8434 if action.is_some() { assert!(event_read.is_some()); }
8440 impl Readable for VecDeque<(Event, Option<EventCompletionAction>)> {
8441 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8442 let len: u64 = Readable::read(reader)?;
8443 const MAX_ALLOC_SIZE: u64 = 1024 * 16;
8444 let mut events: Self = VecDeque::with_capacity(cmp::min(
8445 MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>() as u64,
8448 let ev_opt = MaybeReadable::read(reader)?;
8449 let action = Readable::read(reader)?;
8450 if let Some(ev) = ev_opt {
8451 events.push_back((ev, action));
8452 } else if action.is_some() {
8453 return Err(DecodeError::InvalidValue);
8460 impl_writeable_tlv_based_enum!(ChannelShutdownState,
8461 (0, NotShuttingDown) => {},
8462 (2, ShutdownInitiated) => {},
8463 (4, ResolvingHTLCs) => {},
8464 (6, NegotiatingClosingFee) => {},
8465 (8, ShutdownComplete) => {}, ;
8468 /// Arguments for the creation of a ChannelManager that are not deserialized.
8470 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
8472 /// 1) Deserialize all stored [`ChannelMonitor`]s.
8473 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
8474 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
8475 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
8476 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
8477 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
8478 /// same way you would handle a [`chain::Filter`] call using
8479 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
8480 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
8481 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
8482 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
8483 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
8484 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
8486 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
8487 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
8489 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
8490 /// call any other methods on the newly-deserialized [`ChannelManager`].
8492 /// Note that because some channels may be closed during deserialization, it is critical that you
8493 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
8494 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
8495 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
8496 /// not force-close the same channels but consider them live), you may end up revoking a state for
8497 /// which you've already broadcasted the transaction.
8499 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
8500 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8502 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8503 T::Target: BroadcasterInterface,
8504 ES::Target: EntropySource,
8505 NS::Target: NodeSigner,
8506 SP::Target: SignerProvider,
8507 F::Target: FeeEstimator,
8511 /// A cryptographically secure source of entropy.
8512 pub entropy_source: ES,
8514 /// A signer that is able to perform node-scoped cryptographic operations.
8515 pub node_signer: NS,
8517 /// The keys provider which will give us relevant keys. Some keys will be loaded during
8518 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
8520 pub signer_provider: SP,
8522 /// The fee_estimator for use in the ChannelManager in the future.
8524 /// No calls to the FeeEstimator will be made during deserialization.
8525 pub fee_estimator: F,
8526 /// The chain::Watch for use in the ChannelManager in the future.
8528 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
8529 /// you have deserialized ChannelMonitors separately and will add them to your
8530 /// chain::Watch after deserializing this ChannelManager.
8531 pub chain_monitor: M,
8533 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
8534 /// used to broadcast the latest local commitment transactions of channels which must be
8535 /// force-closed during deserialization.
8536 pub tx_broadcaster: T,
8537 /// The router which will be used in the ChannelManager in the future for finding routes
8538 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
8540 /// No calls to the router will be made during deserialization.
8542 /// The Logger for use in the ChannelManager and which may be used to log information during
8543 /// deserialization.
8545 /// Default settings used for new channels. Any existing channels will continue to use the
8546 /// runtime settings which were stored when the ChannelManager was serialized.
8547 pub default_config: UserConfig,
8549 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
8550 /// value.context.get_funding_txo() should be the key).
8552 /// If a monitor is inconsistent with the channel state during deserialization the channel will
8553 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
8554 /// is true for missing channels as well. If there is a monitor missing for which we find
8555 /// channel data Err(DecodeError::InvalidValue) will be returned.
8557 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
8560 /// This is not exported to bindings users because we have no HashMap bindings
8561 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>,
8564 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8565 ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>
8567 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8568 T::Target: BroadcasterInterface,
8569 ES::Target: EntropySource,
8570 NS::Target: NodeSigner,
8571 SP::Target: SignerProvider,
8572 F::Target: FeeEstimator,
8576 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
8577 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
8578 /// populate a HashMap directly from C.
8579 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,
8580 mut channel_monitors: Vec<&'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>) -> Self {
8582 entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
8583 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
8588 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
8589 // SipmleArcChannelManager type:
8590 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8591 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, ES, NS, SP, F, R, L>>)
8593 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8594 T::Target: BroadcasterInterface,
8595 ES::Target: EntropySource,
8596 NS::Target: NodeSigner,
8597 SP::Target: SignerProvider,
8598 F::Target: FeeEstimator,
8602 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
8603 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)>::read(reader, args)?;
8604 Ok((blockhash, Arc::new(chan_manager)))
8608 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8609 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)
8611 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8612 T::Target: BroadcasterInterface,
8613 ES::Target: EntropySource,
8614 NS::Target: NodeSigner,
8615 SP::Target: SignerProvider,
8616 F::Target: FeeEstimator,
8620 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
8621 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
8623 let genesis_hash: BlockHash = Readable::read(reader)?;
8624 let best_block_height: u32 = Readable::read(reader)?;
8625 let best_block_hash: BlockHash = Readable::read(reader)?;
8627 let mut failed_htlcs = Vec::new();
8629 let channel_count: u64 = Readable::read(reader)?;
8630 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
8631 let mut peer_channels: HashMap<PublicKey, HashMap<ChannelId, Channel<SP>>> = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8632 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8633 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8634 let mut channel_closures = VecDeque::new();
8635 let mut close_background_events = Vec::new();
8636 for _ in 0..channel_count {
8637 let mut channel: Channel<SP> = Channel::read(reader, (
8638 &args.entropy_source, &args.signer_provider, best_block_height, &provided_channel_type_features(&args.default_config)
8640 let funding_txo = channel.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
8641 funding_txo_set.insert(funding_txo.clone());
8642 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
8643 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
8644 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
8645 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
8646 channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
8647 // But if the channel is behind of the monitor, close the channel:
8648 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
8649 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
8650 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
8651 &channel.context.channel_id(), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
8652 let (monitor_update, mut new_failed_htlcs) = channel.context.force_shutdown(true);
8653 if let Some((counterparty_node_id, funding_txo, update)) = monitor_update {
8654 close_background_events.push(BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
8655 counterparty_node_id, funding_txo, update
8658 failed_htlcs.append(&mut new_failed_htlcs);
8659 channel_closures.push_back((events::Event::ChannelClosed {
8660 channel_id: channel.context.channel_id(),
8661 user_channel_id: channel.context.get_user_id(),
8662 reason: ClosureReason::OutdatedChannelManager,
8663 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
8664 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
8666 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
8667 let mut found_htlc = false;
8668 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
8669 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
8672 // If we have some HTLCs in the channel which are not present in the newer
8673 // ChannelMonitor, they have been removed and should be failed back to
8674 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
8675 // were actually claimed we'd have generated and ensured the previous-hop
8676 // claim update ChannelMonitor updates were persisted prior to persising
8677 // the ChannelMonitor update for the forward leg, so attempting to fail the
8678 // backwards leg of the HTLC will simply be rejected.
8679 log_info!(args.logger,
8680 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
8681 &channel.context.channel_id(), &payment_hash);
8682 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8686 log_info!(args.logger, "Successfully loaded channel {} at update_id {} against monitor at update id {}",
8687 &channel.context.channel_id(), channel.context.get_latest_monitor_update_id(),
8688 monitor.get_latest_update_id());
8689 if let Some(short_channel_id) = channel.context.get_short_channel_id() {
8690 short_to_chan_info.insert(short_channel_id, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8692 if channel.context.is_funding_initiated() {
8693 id_to_peer.insert(channel.context.channel_id(), channel.context.get_counterparty_node_id());
8695 match peer_channels.entry(channel.context.get_counterparty_node_id()) {
8696 hash_map::Entry::Occupied(mut entry) => {
8697 let by_id_map = entry.get_mut();
8698 by_id_map.insert(channel.context.channel_id(), channel);
8700 hash_map::Entry::Vacant(entry) => {
8701 let mut by_id_map = HashMap::new();
8702 by_id_map.insert(channel.context.channel_id(), channel);
8703 entry.insert(by_id_map);
8707 } else if channel.is_awaiting_initial_mon_persist() {
8708 // If we were persisted and shut down while the initial ChannelMonitor persistence
8709 // was in-progress, we never broadcasted the funding transaction and can still
8710 // safely discard the channel.
8711 let _ = channel.context.force_shutdown(false);
8712 channel_closures.push_back((events::Event::ChannelClosed {
8713 channel_id: channel.context.channel_id(),
8714 user_channel_id: channel.context.get_user_id(),
8715 reason: ClosureReason::DisconnectedPeer,
8716 counterparty_node_id: Some(channel.context.get_counterparty_node_id()),
8717 channel_capacity_sats: Some(channel.context.get_value_satoshis()),
8720 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", &channel.context.channel_id());
8721 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
8722 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
8723 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
8724 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");
8725 return Err(DecodeError::InvalidValue);
8729 for (funding_txo, _) in args.channel_monitors.iter() {
8730 if !funding_txo_set.contains(funding_txo) {
8731 log_info!(args.logger, "Queueing monitor update to ensure missing channel {} is force closed",
8732 &funding_txo.to_channel_id());
8733 let monitor_update = ChannelMonitorUpdate {
8734 update_id: CLOSED_CHANNEL_UPDATE_ID,
8735 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast: true }],
8737 close_background_events.push(BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((*funding_txo, monitor_update)));
8741 const MAX_ALLOC_SIZE: usize = 1024 * 64;
8742 let forward_htlcs_count: u64 = Readable::read(reader)?;
8743 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
8744 for _ in 0..forward_htlcs_count {
8745 let short_channel_id = Readable::read(reader)?;
8746 let pending_forwards_count: u64 = Readable::read(reader)?;
8747 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
8748 for _ in 0..pending_forwards_count {
8749 pending_forwards.push(Readable::read(reader)?);
8751 forward_htlcs.insert(short_channel_id, pending_forwards);
8754 let claimable_htlcs_count: u64 = Readable::read(reader)?;
8755 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
8756 for _ in 0..claimable_htlcs_count {
8757 let payment_hash = Readable::read(reader)?;
8758 let previous_hops_len: u64 = Readable::read(reader)?;
8759 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
8760 for _ in 0..previous_hops_len {
8761 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
8763 claimable_htlcs_list.push((payment_hash, previous_hops));
8766 let peer_state_from_chans = |channel_by_id| {
8769 outbound_v1_channel_by_id: HashMap::new(),
8770 inbound_v1_channel_by_id: HashMap::new(),
8771 inbound_channel_request_by_id: HashMap::new(),
8772 latest_features: InitFeatures::empty(),
8773 pending_msg_events: Vec::new(),
8774 in_flight_monitor_updates: BTreeMap::new(),
8775 monitor_update_blocked_actions: BTreeMap::new(),
8776 actions_blocking_raa_monitor_updates: BTreeMap::new(),
8777 is_connected: false,
8781 let peer_count: u64 = Readable::read(reader)?;
8782 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<SP>>)>()));
8783 for _ in 0..peer_count {
8784 let peer_pubkey = Readable::read(reader)?;
8785 let peer_chans = peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new());
8786 let mut peer_state = peer_state_from_chans(peer_chans);
8787 peer_state.latest_features = Readable::read(reader)?;
8788 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
8791 let event_count: u64 = Readable::read(reader)?;
8792 let mut pending_events_read: VecDeque<(events::Event, Option<EventCompletionAction>)> =
8793 VecDeque::with_capacity(cmp::min(event_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>()));
8794 for _ in 0..event_count {
8795 match MaybeReadable::read(reader)? {
8796 Some(event) => pending_events_read.push_back((event, None)),
8801 let background_event_count: u64 = Readable::read(reader)?;
8802 for _ in 0..background_event_count {
8803 match <u8 as Readable>::read(reader)? {
8805 // LDK versions prior to 0.0.116 wrote pending `MonitorUpdateRegeneratedOnStartup`s here,
8806 // however we really don't (and never did) need them - we regenerate all
8807 // on-startup monitor updates.
8808 let _: OutPoint = Readable::read(reader)?;
8809 let _: ChannelMonitorUpdate = Readable::read(reader)?;
8811 _ => return Err(DecodeError::InvalidValue),
8815 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
8816 let highest_seen_timestamp: u32 = Readable::read(reader)?;
8818 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
8819 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
8820 for _ in 0..pending_inbound_payment_count {
8821 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
8822 return Err(DecodeError::InvalidValue);
8826 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
8827 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
8828 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
8829 for _ in 0..pending_outbound_payments_count_compat {
8830 let session_priv = Readable::read(reader)?;
8831 let payment = PendingOutboundPayment::Legacy {
8832 session_privs: [session_priv].iter().cloned().collect()
8834 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
8835 return Err(DecodeError::InvalidValue)
8839 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
8840 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
8841 let mut pending_outbound_payments = None;
8842 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
8843 let mut received_network_pubkey: Option<PublicKey> = None;
8844 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
8845 let mut probing_cookie_secret: Option<[u8; 32]> = None;
8846 let mut claimable_htlc_purposes = None;
8847 let mut claimable_htlc_onion_fields = None;
8848 let mut pending_claiming_payments = Some(HashMap::new());
8849 let mut monitor_update_blocked_actions_per_peer: Option<Vec<(_, BTreeMap<_, Vec<_>>)>> = Some(Vec::new());
8850 let mut events_override = None;
8851 let mut in_flight_monitor_updates: Option<HashMap<(PublicKey, OutPoint), Vec<ChannelMonitorUpdate>>> = None;
8852 read_tlv_fields!(reader, {
8853 (1, pending_outbound_payments_no_retry, option),
8854 (2, pending_intercepted_htlcs, option),
8855 (3, pending_outbound_payments, option),
8856 (4, pending_claiming_payments, option),
8857 (5, received_network_pubkey, option),
8858 (6, monitor_update_blocked_actions_per_peer, option),
8859 (7, fake_scid_rand_bytes, option),
8860 (8, events_override, option),
8861 (9, claimable_htlc_purposes, optional_vec),
8862 (10, in_flight_monitor_updates, option),
8863 (11, probing_cookie_secret, option),
8864 (13, claimable_htlc_onion_fields, optional_vec),
8866 if fake_scid_rand_bytes.is_none() {
8867 fake_scid_rand_bytes = Some(args.entropy_source.get_secure_random_bytes());
8870 if probing_cookie_secret.is_none() {
8871 probing_cookie_secret = Some(args.entropy_source.get_secure_random_bytes());
8874 if let Some(events) = events_override {
8875 pending_events_read = events;
8878 if !channel_closures.is_empty() {
8879 pending_events_read.append(&mut channel_closures);
8882 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
8883 pending_outbound_payments = Some(pending_outbound_payments_compat);
8884 } else if pending_outbound_payments.is_none() {
8885 let mut outbounds = HashMap::new();
8886 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
8887 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
8889 pending_outbound_payments = Some(outbounds);
8891 let pending_outbounds = OutboundPayments {
8892 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
8893 retry_lock: Mutex::new(())
8896 // We have to replay (or skip, if they were completed after we wrote the `ChannelManager`)
8897 // each `ChannelMonitorUpdate` in `in_flight_monitor_updates`. After doing so, we have to
8898 // check that each channel we have isn't newer than the latest `ChannelMonitorUpdate`(s) we
8899 // replayed, and for each monitor update we have to replay we have to ensure there's a
8900 // `ChannelMonitor` for it.
8902 // In order to do so we first walk all of our live channels (so that we can check their
8903 // state immediately after doing the update replays, when we have the `update_id`s
8904 // available) and then walk any remaining in-flight updates.
8906 // Because the actual handling of the in-flight updates is the same, it's macro'ized here:
8907 let mut pending_background_events = Vec::new();
8908 macro_rules! handle_in_flight_updates {
8909 ($counterparty_node_id: expr, $chan_in_flight_upds: expr, $funding_txo: expr,
8910 $monitor: expr, $peer_state: expr, $channel_info_log: expr
8912 let mut max_in_flight_update_id = 0;
8913 $chan_in_flight_upds.retain(|upd| upd.update_id > $monitor.get_latest_update_id());
8914 for update in $chan_in_flight_upds.iter() {
8915 log_trace!(args.logger, "Replaying ChannelMonitorUpdate {} for {}channel {}",
8916 update.update_id, $channel_info_log, &$funding_txo.to_channel_id());
8917 max_in_flight_update_id = cmp::max(max_in_flight_update_id, update.update_id);
8918 pending_background_events.push(
8919 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
8920 counterparty_node_id: $counterparty_node_id,
8921 funding_txo: $funding_txo,
8922 update: update.clone(),
8925 if $chan_in_flight_upds.is_empty() {
8926 // We had some updates to apply, but it turns out they had completed before we
8927 // were serialized, we just weren't notified of that. Thus, we may have to run
8928 // the completion actions for any monitor updates, but otherwise are done.
8929 pending_background_events.push(
8930 BackgroundEvent::MonitorUpdatesComplete {
8931 counterparty_node_id: $counterparty_node_id,
8932 channel_id: $funding_txo.to_channel_id(),
8935 if $peer_state.in_flight_monitor_updates.insert($funding_txo, $chan_in_flight_upds).is_some() {
8936 log_error!(args.logger, "Duplicate in-flight monitor update set for the same channel!");
8937 return Err(DecodeError::InvalidValue);
8939 max_in_flight_update_id
8943 for (counterparty_id, peer_state_mtx) in per_peer_state.iter_mut() {
8944 let mut peer_state_lock = peer_state_mtx.lock().unwrap();
8945 let peer_state = &mut *peer_state_lock;
8946 for (_, chan) in peer_state.channel_by_id.iter() {
8947 // Channels that were persisted have to be funded, otherwise they should have been
8949 let funding_txo = chan.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
8950 let monitor = args.channel_monitors.get(&funding_txo)
8951 .expect("We already checked for monitor presence when loading channels");
8952 let mut max_in_flight_update_id = monitor.get_latest_update_id();
8953 if let Some(in_flight_upds) = &mut in_flight_monitor_updates {
8954 if let Some(mut chan_in_flight_upds) = in_flight_upds.remove(&(*counterparty_id, funding_txo)) {
8955 max_in_flight_update_id = cmp::max(max_in_flight_update_id,
8956 handle_in_flight_updates!(*counterparty_id, chan_in_flight_upds,
8957 funding_txo, monitor, peer_state, ""));
8960 if chan.get_latest_unblocked_monitor_update_id() > max_in_flight_update_id {
8961 // If the channel is ahead of the monitor, return InvalidValue:
8962 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
8963 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} with update_id through {} in-flight",
8964 &chan.context.channel_id(), monitor.get_latest_update_id(), max_in_flight_update_id);
8965 log_error!(args.logger, " but the ChannelManager is at update_id {}.", chan.get_latest_unblocked_monitor_update_id());
8966 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
8967 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
8968 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
8969 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");
8970 return Err(DecodeError::InvalidValue);
8975 if let Some(in_flight_upds) = in_flight_monitor_updates {
8976 for ((counterparty_id, funding_txo), mut chan_in_flight_updates) in in_flight_upds {
8977 if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
8978 // Now that we've removed all the in-flight monitor updates for channels that are
8979 // still open, we need to replay any monitor updates that are for closed channels,
8980 // creating the neccessary peer_state entries as we go.
8981 let peer_state_mutex = per_peer_state.entry(counterparty_id).or_insert_with(|| {
8982 Mutex::new(peer_state_from_chans(HashMap::new()))
8984 let mut peer_state = peer_state_mutex.lock().unwrap();
8985 handle_in_flight_updates!(counterparty_id, chan_in_flight_updates,
8986 funding_txo, monitor, peer_state, "closed ");
8988 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!");
8989 log_error!(args.logger, " The ChannelMonitor for channel {} is missing.",
8990 &funding_txo.to_channel_id());
8991 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
8992 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
8993 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
8994 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");
8995 return Err(DecodeError::InvalidValue);
9000 // Note that we have to do the above replays before we push new monitor updates.
9001 pending_background_events.append(&mut close_background_events);
9003 // If there's any preimages for forwarded HTLCs hanging around in ChannelMonitors we
9004 // should ensure we try them again on the inbound edge. We put them here and do so after we
9005 // have a fully-constructed `ChannelManager` at the end.
9006 let mut pending_claims_to_replay = Vec::new();
9009 // If we're tracking pending payments, ensure we haven't lost any by looking at the
9010 // ChannelMonitor data for any channels for which we do not have authorative state
9011 // (i.e. those for which we just force-closed above or we otherwise don't have a
9012 // corresponding `Channel` at all).
9013 // This avoids several edge-cases where we would otherwise "forget" about pending
9014 // payments which are still in-flight via their on-chain state.
9015 // We only rebuild the pending payments map if we were most recently serialized by
9017 for (_, monitor) in args.channel_monitors.iter() {
9018 let counterparty_opt = id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id());
9019 if counterparty_opt.is_none() {
9020 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
9021 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
9022 if path.hops.is_empty() {
9023 log_error!(args.logger, "Got an empty path for a pending payment");
9024 return Err(DecodeError::InvalidValue);
9027 let path_amt = path.final_value_msat();
9028 let mut session_priv_bytes = [0; 32];
9029 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
9030 match pending_outbounds.pending_outbound_payments.lock().unwrap().entry(payment_id) {
9031 hash_map::Entry::Occupied(mut entry) => {
9032 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
9033 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
9034 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), &htlc.payment_hash);
9036 hash_map::Entry::Vacant(entry) => {
9037 let path_fee = path.fee_msat();
9038 entry.insert(PendingOutboundPayment::Retryable {
9039 retry_strategy: None,
9040 attempts: PaymentAttempts::new(),
9041 payment_params: None,
9042 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
9043 payment_hash: htlc.payment_hash,
9044 payment_secret: None, // only used for retries, and we'll never retry on startup
9045 payment_metadata: None, // only used for retries, and we'll never retry on startup
9046 keysend_preimage: None, // only used for retries, and we'll never retry on startup
9047 custom_tlvs: Vec::new(), // only used for retries, and we'll never retry on startup
9048 pending_amt_msat: path_amt,
9049 pending_fee_msat: Some(path_fee),
9050 total_msat: path_amt,
9051 starting_block_height: best_block_height,
9053 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
9054 path_amt, &htlc.payment_hash, log_bytes!(session_priv_bytes));
9059 for (htlc_source, (htlc, preimage_opt)) in monitor.get_all_current_outbound_htlcs() {
9061 HTLCSource::PreviousHopData(prev_hop_data) => {
9062 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
9063 info.prev_funding_outpoint == prev_hop_data.outpoint &&
9064 info.prev_htlc_id == prev_hop_data.htlc_id
9066 // The ChannelMonitor is now responsible for this HTLC's
9067 // failure/success and will let us know what its outcome is. If we
9068 // still have an entry for this HTLC in `forward_htlcs` or
9069 // `pending_intercepted_htlcs`, we were apparently not persisted after
9070 // the monitor was when forwarding the payment.
9071 forward_htlcs.retain(|_, forwards| {
9072 forwards.retain(|forward| {
9073 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
9074 if pending_forward_matches_htlc(&htlc_info) {
9075 log_info!(args.logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
9076 &htlc.payment_hash, &monitor.get_funding_txo().0.to_channel_id());
9081 !forwards.is_empty()
9083 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
9084 if pending_forward_matches_htlc(&htlc_info) {
9085 log_info!(args.logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
9086 &htlc.payment_hash, &monitor.get_funding_txo().0.to_channel_id());
9087 pending_events_read.retain(|(event, _)| {
9088 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
9089 intercepted_id != ev_id
9096 HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } => {
9097 if let Some(preimage) = preimage_opt {
9098 let pending_events = Mutex::new(pending_events_read);
9099 // Note that we set `from_onchain` to "false" here,
9100 // deliberately keeping the pending payment around forever.
9101 // Given it should only occur when we have a channel we're
9102 // force-closing for being stale that's okay.
9103 // The alternative would be to wipe the state when claiming,
9104 // generating a `PaymentPathSuccessful` event but regenerating
9105 // it and the `PaymentSent` on every restart until the
9106 // `ChannelMonitor` is removed.
9108 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
9109 channel_funding_outpoint: monitor.get_funding_txo().0,
9110 counterparty_node_id: path.hops[0].pubkey,
9112 pending_outbounds.claim_htlc(payment_id, preimage, session_priv,
9113 path, false, compl_action, &pending_events, &args.logger);
9114 pending_events_read = pending_events.into_inner().unwrap();
9121 // Whether the downstream channel was closed or not, try to re-apply any payment
9122 // preimages from it which may be needed in upstream channels for forwarded
9124 let outbound_claimed_htlcs_iter = monitor.get_all_current_outbound_htlcs()
9126 .filter_map(|(htlc_source, (htlc, preimage_opt))| {
9127 if let HTLCSource::PreviousHopData(_) = htlc_source {
9128 if let Some(payment_preimage) = preimage_opt {
9129 Some((htlc_source, payment_preimage, htlc.amount_msat,
9130 // Check if `counterparty_opt.is_none()` to see if the
9131 // downstream chan is closed (because we don't have a
9132 // channel_id -> peer map entry).
9133 counterparty_opt.is_none(),
9134 monitor.get_funding_txo().0))
9137 // If it was an outbound payment, we've handled it above - if a preimage
9138 // came in and we persisted the `ChannelManager` we either handled it and
9139 // are good to go or the channel force-closed - we don't have to handle the
9140 // channel still live case here.
9144 for tuple in outbound_claimed_htlcs_iter {
9145 pending_claims_to_replay.push(tuple);
9150 if !forward_htlcs.is_empty() || pending_outbounds.needs_abandon() {
9151 // If we have pending HTLCs to forward, assume we either dropped a
9152 // `PendingHTLCsForwardable` or the user received it but never processed it as they
9153 // shut down before the timer hit. Either way, set the time_forwardable to a small
9154 // constant as enough time has likely passed that we should simply handle the forwards
9155 // now, or at least after the user gets a chance to reconnect to our peers.
9156 pending_events_read.push_back((events::Event::PendingHTLCsForwardable {
9157 time_forwardable: Duration::from_secs(2),
9161 let inbound_pmt_key_material = args.node_signer.get_inbound_payment_key_material();
9162 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
9164 let mut claimable_payments = HashMap::with_capacity(claimable_htlcs_list.len());
9165 if let Some(purposes) = claimable_htlc_purposes {
9166 if purposes.len() != claimable_htlcs_list.len() {
9167 return Err(DecodeError::InvalidValue);
9169 if let Some(onion_fields) = claimable_htlc_onion_fields {
9170 if onion_fields.len() != claimable_htlcs_list.len() {
9171 return Err(DecodeError::InvalidValue);
9173 for (purpose, (onion, (payment_hash, htlcs))) in
9174 purposes.into_iter().zip(onion_fields.into_iter().zip(claimable_htlcs_list.into_iter()))
9176 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
9177 purpose, htlcs, onion_fields: onion,
9179 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
9182 for (purpose, (payment_hash, htlcs)) in purposes.into_iter().zip(claimable_htlcs_list.into_iter()) {
9183 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
9184 purpose, htlcs, onion_fields: None,
9186 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
9190 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
9191 // include a `_legacy_hop_data` in the `OnionPayload`.
9192 for (payment_hash, htlcs) in claimable_htlcs_list.drain(..) {
9193 if htlcs.is_empty() {
9194 return Err(DecodeError::InvalidValue);
9196 let purpose = match &htlcs[0].onion_payload {
9197 OnionPayload::Invoice { _legacy_hop_data } => {
9198 if let Some(hop_data) = _legacy_hop_data {
9199 events::PaymentPurpose::InvoicePayment {
9200 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
9201 Some(inbound_payment) => inbound_payment.payment_preimage,
9202 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
9203 Ok((payment_preimage, _)) => payment_preimage,
9205 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);
9206 return Err(DecodeError::InvalidValue);
9210 payment_secret: hop_data.payment_secret,
9212 } else { return Err(DecodeError::InvalidValue); }
9214 OnionPayload::Spontaneous(payment_preimage) =>
9215 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
9217 claimable_payments.insert(payment_hash, ClaimablePayment {
9218 purpose, htlcs, onion_fields: None,
9223 let mut secp_ctx = Secp256k1::new();
9224 secp_ctx.seeded_randomize(&args.entropy_source.get_secure_random_bytes());
9226 let our_network_pubkey = match args.node_signer.get_node_id(Recipient::Node) {
9228 Err(()) => return Err(DecodeError::InvalidValue)
9230 if let Some(network_pubkey) = received_network_pubkey {
9231 if network_pubkey != our_network_pubkey {
9232 log_error!(args.logger, "Key that was generated does not match the existing key.");
9233 return Err(DecodeError::InvalidValue);
9237 let mut outbound_scid_aliases = HashSet::new();
9238 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
9239 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9240 let peer_state = &mut *peer_state_lock;
9241 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
9242 if chan.context.outbound_scid_alias() == 0 {
9243 let mut outbound_scid_alias;
9245 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
9246 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.entropy_source);
9247 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
9249 chan.context.set_outbound_scid_alias(outbound_scid_alias);
9250 } else if !outbound_scid_aliases.insert(chan.context.outbound_scid_alias()) {
9251 // Note that in rare cases its possible to hit this while reading an older
9252 // channel if we just happened to pick a colliding outbound alias above.
9253 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
9254 return Err(DecodeError::InvalidValue);
9256 if chan.context.is_usable() {
9257 if short_to_chan_info.insert(chan.context.outbound_scid_alias(), (chan.context.get_counterparty_node_id(), *chan_id)).is_some() {
9258 // Note that in rare cases its possible to hit this while reading an older
9259 // channel if we just happened to pick a colliding outbound alias above.
9260 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
9261 return Err(DecodeError::InvalidValue);
9267 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
9269 for (_, monitor) in args.channel_monitors.iter() {
9270 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
9271 if let Some(payment) = claimable_payments.remove(&payment_hash) {
9272 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", &payment_hash);
9273 let mut claimable_amt_msat = 0;
9274 let mut receiver_node_id = Some(our_network_pubkey);
9275 let phantom_shared_secret = payment.htlcs[0].prev_hop.phantom_shared_secret;
9276 if phantom_shared_secret.is_some() {
9277 let phantom_pubkey = args.node_signer.get_node_id(Recipient::PhantomNode)
9278 .expect("Failed to get node_id for phantom node recipient");
9279 receiver_node_id = Some(phantom_pubkey)
9281 for claimable_htlc in &payment.htlcs {
9282 claimable_amt_msat += claimable_htlc.value;
9284 // Add a holding-cell claim of the payment to the Channel, which should be
9285 // applied ~immediately on peer reconnection. Because it won't generate a
9286 // new commitment transaction we can just provide the payment preimage to
9287 // the corresponding ChannelMonitor and nothing else.
9289 // We do so directly instead of via the normal ChannelMonitor update
9290 // procedure as the ChainMonitor hasn't yet been initialized, implying
9291 // we're not allowed to call it directly yet. Further, we do the update
9292 // without incrementing the ChannelMonitor update ID as there isn't any
9294 // If we were to generate a new ChannelMonitor update ID here and then
9295 // crash before the user finishes block connect we'd end up force-closing
9296 // this channel as well. On the flip side, there's no harm in restarting
9297 // without the new monitor persisted - we'll end up right back here on
9299 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
9300 if let Some(peer_node_id) = id_to_peer.get(&previous_channel_id){
9301 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
9302 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
9303 let peer_state = &mut *peer_state_lock;
9304 if let Some(channel) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
9305 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
9308 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
9309 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
9312 pending_events_read.push_back((events::Event::PaymentClaimed {
9315 purpose: payment.purpose,
9316 amount_msat: claimable_amt_msat,
9317 htlcs: payment.htlcs.iter().map(events::ClaimedHTLC::from).collect(),
9318 sender_intended_total_msat: payment.htlcs.first().map(|htlc| htlc.total_msat),
9324 for (node_id, monitor_update_blocked_actions) in monitor_update_blocked_actions_per_peer.unwrap() {
9325 if let Some(peer_state) = per_peer_state.get(&node_id) {
9326 for (_, actions) in monitor_update_blocked_actions.iter() {
9327 for action in actions.iter() {
9328 if let MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
9329 downstream_counterparty_and_funding_outpoint:
9330 Some((blocked_node_id, blocked_channel_outpoint, blocking_action)), ..
9332 if let Some(blocked_peer_state) = per_peer_state.get(&blocked_node_id) {
9333 blocked_peer_state.lock().unwrap().actions_blocking_raa_monitor_updates
9334 .entry(blocked_channel_outpoint.to_channel_id())
9335 .or_insert_with(Vec::new).push(blocking_action.clone());
9337 // If the channel we were blocking has closed, we don't need to
9338 // worry about it - the blocked monitor update should never have
9339 // been released from the `Channel` object so it can't have
9340 // completed, and if the channel closed there's no reason to bother
9346 peer_state.lock().unwrap().monitor_update_blocked_actions = monitor_update_blocked_actions;
9348 log_error!(args.logger, "Got blocked actions without a per-peer-state for {}", node_id);
9349 return Err(DecodeError::InvalidValue);
9353 let channel_manager = ChannelManager {
9355 fee_estimator: bounded_fee_estimator,
9356 chain_monitor: args.chain_monitor,
9357 tx_broadcaster: args.tx_broadcaster,
9358 router: args.router,
9360 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
9362 inbound_payment_key: expanded_inbound_key,
9363 pending_inbound_payments: Mutex::new(pending_inbound_payments),
9364 pending_outbound_payments: pending_outbounds,
9365 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
9367 forward_htlcs: Mutex::new(forward_htlcs),
9368 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments, pending_claiming_payments: pending_claiming_payments.unwrap() }),
9369 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
9370 id_to_peer: Mutex::new(id_to_peer),
9371 short_to_chan_info: FairRwLock::new(short_to_chan_info),
9372 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
9374 probing_cookie_secret: probing_cookie_secret.unwrap(),
9379 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
9381 per_peer_state: FairRwLock::new(per_peer_state),
9383 pending_events: Mutex::new(pending_events_read),
9384 pending_events_processor: AtomicBool::new(false),
9385 pending_background_events: Mutex::new(pending_background_events),
9386 total_consistency_lock: RwLock::new(()),
9387 background_events_processed_since_startup: AtomicBool::new(false),
9388 persistence_notifier: Notifier::new(),
9390 entropy_source: args.entropy_source,
9391 node_signer: args.node_signer,
9392 signer_provider: args.signer_provider,
9394 logger: args.logger,
9395 default_configuration: args.default_config,
9398 for htlc_source in failed_htlcs.drain(..) {
9399 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
9400 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
9401 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
9402 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
9405 for (source, preimage, downstream_value, downstream_closed, downstream_funding) in pending_claims_to_replay {
9406 // We use `downstream_closed` in place of `from_onchain` here just as a guess - we
9407 // don't remember in the `ChannelMonitor` where we got a preimage from, but if the
9408 // channel is closed we just assume that it probably came from an on-chain claim.
9409 channel_manager.claim_funds_internal(source, preimage, Some(downstream_value),
9410 downstream_closed, downstream_funding);
9413 //TODO: Broadcast channel update for closed channels, but only after we've made a
9414 //connection or two.
9416 Ok((best_block_hash.clone(), channel_manager))
9422 use bitcoin::hashes::Hash;
9423 use bitcoin::hashes::sha256::Hash as Sha256;
9424 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
9425 use core::sync::atomic::Ordering;
9426 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
9427 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
9428 use crate::ln::ChannelId;
9429 use crate::ln::channelmanager::{inbound_payment, PaymentId, PaymentSendFailure, RecipientOnionFields, InterceptId};
9430 use crate::ln::functional_test_utils::*;
9431 use crate::ln::msgs::{self, ErrorAction};
9432 use crate::ln::msgs::ChannelMessageHandler;
9433 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
9434 use crate::util::errors::APIError;
9435 use crate::util::test_utils;
9436 use crate::util::config::{ChannelConfig, ChannelConfigUpdate};
9437 use crate::sign::EntropySource;
9440 fn test_notify_limits() {
9441 // Check that a few cases which don't require the persistence of a new ChannelManager,
9442 // indeed, do not cause the persistence of a new ChannelManager.
9443 let chanmon_cfgs = create_chanmon_cfgs(3);
9444 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9445 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9446 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9448 // All nodes start with a persistable update pending as `create_network` connects each node
9449 // with all other nodes to make most tests simpler.
9450 assert!(nodes[0].node.get_persistable_update_future().poll_is_complete());
9451 assert!(nodes[1].node.get_persistable_update_future().poll_is_complete());
9452 assert!(nodes[2].node.get_persistable_update_future().poll_is_complete());
9454 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1);
9456 // We check that the channel info nodes have doesn't change too early, even though we try
9457 // to connect messages with new values
9458 chan.0.contents.fee_base_msat *= 2;
9459 chan.1.contents.fee_base_msat *= 2;
9460 let node_a_chan_info = nodes[0].node.list_channels_with_counterparty(
9461 &nodes[1].node.get_our_node_id()).pop().unwrap();
9462 let node_b_chan_info = nodes[1].node.list_channels_with_counterparty(
9463 &nodes[0].node.get_our_node_id()).pop().unwrap();
9465 // The first two nodes (which opened a channel) should now require fresh persistence
9466 assert!(nodes[0].node.get_persistable_update_future().poll_is_complete());
9467 assert!(nodes[1].node.get_persistable_update_future().poll_is_complete());
9468 // ... but the last node should not.
9469 assert!(!nodes[2].node.get_persistable_update_future().poll_is_complete());
9470 // After persisting the first two nodes they should no longer need fresh persistence.
9471 assert!(!nodes[0].node.get_persistable_update_future().poll_is_complete());
9472 assert!(!nodes[1].node.get_persistable_update_future().poll_is_complete());
9474 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
9475 // about the channel.
9476 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
9477 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
9478 assert!(!nodes[2].node.get_persistable_update_future().poll_is_complete());
9480 // The nodes which are a party to the channel should also ignore messages from unrelated
9482 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
9483 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
9484 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
9485 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
9486 assert!(!nodes[0].node.get_persistable_update_future().poll_is_complete());
9487 assert!(!nodes[1].node.get_persistable_update_future().poll_is_complete());
9489 // At this point the channel info given by peers should still be the same.
9490 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
9491 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
9493 // An earlier version of handle_channel_update didn't check the directionality of the
9494 // update message and would always update the local fee info, even if our peer was
9495 // (spuriously) forwarding us our own channel_update.
9496 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
9497 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
9498 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
9500 // First deliver each peers' own message, checking that the node doesn't need to be
9501 // persisted and that its channel info remains the same.
9502 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
9503 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
9504 assert!(!nodes[0].node.get_persistable_update_future().poll_is_complete());
9505 assert!(!nodes[1].node.get_persistable_update_future().poll_is_complete());
9506 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
9507 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
9509 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
9510 // the channel info has updated.
9511 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
9512 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
9513 assert!(nodes[0].node.get_persistable_update_future().poll_is_complete());
9514 assert!(nodes[1].node.get_persistable_update_future().poll_is_complete());
9515 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
9516 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
9520 fn test_keysend_dup_hash_partial_mpp() {
9521 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
9523 let chanmon_cfgs = create_chanmon_cfgs(2);
9524 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9525 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9526 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9527 create_announced_chan_between_nodes(&nodes, 0, 1);
9529 // First, send a partial MPP payment.
9530 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
9531 let mut mpp_route = route.clone();
9532 mpp_route.paths.push(mpp_route.paths[0].clone());
9534 let payment_id = PaymentId([42; 32]);
9535 // Use the utility function send_payment_along_path to send the payment with MPP data which
9536 // indicates there are more HTLCs coming.
9537 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.
9538 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
9539 RecipientOnionFields::secret_only(payment_secret), payment_id, &mpp_route).unwrap();
9540 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[0], &our_payment_hash,
9541 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
9542 check_added_monitors!(nodes[0], 1);
9543 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9544 assert_eq!(events.len(), 1);
9545 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
9547 // Next, send a keysend payment with the same payment_hash and make sure it fails.
9548 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9549 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9550 check_added_monitors!(nodes[0], 1);
9551 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9552 assert_eq!(events.len(), 1);
9553 let ev = events.drain(..).next().unwrap();
9554 let payment_event = SendEvent::from_event(ev);
9555 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9556 check_added_monitors!(nodes[1], 0);
9557 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9558 expect_pending_htlcs_forwardable!(nodes[1]);
9559 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
9560 check_added_monitors!(nodes[1], 1);
9561 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9562 assert!(updates.update_add_htlcs.is_empty());
9563 assert!(updates.update_fulfill_htlcs.is_empty());
9564 assert_eq!(updates.update_fail_htlcs.len(), 1);
9565 assert!(updates.update_fail_malformed_htlcs.is_empty());
9566 assert!(updates.update_fee.is_none());
9567 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9568 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9569 expect_payment_failed!(nodes[0], our_payment_hash, true);
9571 // Send the second half of the original MPP payment.
9572 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[1], &our_payment_hash,
9573 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
9574 check_added_monitors!(nodes[0], 1);
9575 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9576 assert_eq!(events.len(), 1);
9577 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
9579 // Claim the full MPP payment. Note that we can't use a test utility like
9580 // claim_funds_along_route because the ordering of the messages causes the second half of the
9581 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
9582 // lightning messages manually.
9583 nodes[1].node.claim_funds(payment_preimage);
9584 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
9585 check_added_monitors!(nodes[1], 2);
9587 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9588 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
9589 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
9590 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
9591 check_added_monitors!(nodes[0], 1);
9592 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9593 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
9594 check_added_monitors!(nodes[1], 1);
9595 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9596 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
9597 check_added_monitors!(nodes[1], 1);
9598 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
9599 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
9600 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
9601 check_added_monitors!(nodes[0], 1);
9602 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
9603 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
9604 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9605 check_added_monitors!(nodes[0], 1);
9606 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
9607 check_added_monitors!(nodes[1], 1);
9608 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
9609 check_added_monitors!(nodes[1], 1);
9610 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
9611 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
9612 check_added_monitors!(nodes[0], 1);
9614 // Note that successful MPP payments will generate a single PaymentSent event upon the first
9615 // path's success and a PaymentPathSuccessful event for each path's success.
9616 let events = nodes[0].node.get_and_clear_pending_events();
9617 assert_eq!(events.len(), 2);
9619 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
9620 assert_eq!(payment_id, *actual_payment_id);
9621 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
9622 assert_eq!(route.paths[0], *path);
9624 _ => panic!("Unexpected event"),
9627 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
9628 assert_eq!(payment_id, *actual_payment_id);
9629 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
9630 assert_eq!(route.paths[0], *path);
9632 _ => panic!("Unexpected event"),
9637 fn test_keysend_dup_payment_hash() {
9638 do_test_keysend_dup_payment_hash(false);
9639 do_test_keysend_dup_payment_hash(true);
9642 fn do_test_keysend_dup_payment_hash(accept_mpp_keysend: bool) {
9643 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
9644 // outbound regular payment fails as expected.
9645 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
9646 // fails as expected.
9647 // (3): Test that a keysend payment with a duplicate payment hash to an existing keysend
9648 // payment fails as expected. When `accept_mpp_keysend` is false, this tests that we
9649 // reject MPP keysend payments, since in this case where the payment has no payment
9650 // secret, a keysend payment with a duplicate hash is basically an MPP keysend. If
9651 // `accept_mpp_keysend` is true, this tests that we only accept MPP keysends with
9652 // payment secrets and reject otherwise.
9653 let chanmon_cfgs = create_chanmon_cfgs(2);
9654 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9655 let mut mpp_keysend_cfg = test_default_channel_config();
9656 mpp_keysend_cfg.accept_mpp_keysend = accept_mpp_keysend;
9657 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(mpp_keysend_cfg)]);
9658 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9659 create_announced_chan_between_nodes(&nodes, 0, 1);
9660 let scorer = test_utils::TestScorer::new();
9661 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9663 // To start (1), send a regular payment but don't claim it.
9664 let expected_route = [&nodes[1]];
9665 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
9667 // Next, attempt a keysend payment and make sure it fails.
9668 let route_params = RouteParameters::from_payment_params_and_value(
9669 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(),
9670 TEST_FINAL_CLTV, false), 100_000);
9671 let route = find_route(
9672 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
9673 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
9675 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9676 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9677 check_added_monitors!(nodes[0], 1);
9678 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9679 assert_eq!(events.len(), 1);
9680 let ev = events.drain(..).next().unwrap();
9681 let payment_event = SendEvent::from_event(ev);
9682 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9683 check_added_monitors!(nodes[1], 0);
9684 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9685 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
9686 // fails), the second will process the resulting failure and fail the HTLC backward
9687 expect_pending_htlcs_forwardable!(nodes[1]);
9688 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9689 check_added_monitors!(nodes[1], 1);
9690 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9691 assert!(updates.update_add_htlcs.is_empty());
9692 assert!(updates.update_fulfill_htlcs.is_empty());
9693 assert_eq!(updates.update_fail_htlcs.len(), 1);
9694 assert!(updates.update_fail_malformed_htlcs.is_empty());
9695 assert!(updates.update_fee.is_none());
9696 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9697 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9698 expect_payment_failed!(nodes[0], payment_hash, true);
9700 // Finally, claim the original payment.
9701 claim_payment(&nodes[0], &expected_route, payment_preimage);
9703 // To start (2), send a keysend payment but don't claim it.
9704 let payment_preimage = PaymentPreimage([42; 32]);
9705 let route = find_route(
9706 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
9707 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
9709 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9710 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9711 check_added_monitors!(nodes[0], 1);
9712 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9713 assert_eq!(events.len(), 1);
9714 let event = events.pop().unwrap();
9715 let path = vec![&nodes[1]];
9716 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
9718 // Next, attempt a regular payment and make sure it fails.
9719 let payment_secret = PaymentSecret([43; 32]);
9720 nodes[0].node.send_payment_with_route(&route, payment_hash,
9721 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
9722 check_added_monitors!(nodes[0], 1);
9723 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9724 assert_eq!(events.len(), 1);
9725 let ev = events.drain(..).next().unwrap();
9726 let payment_event = SendEvent::from_event(ev);
9727 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9728 check_added_monitors!(nodes[1], 0);
9729 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9730 expect_pending_htlcs_forwardable!(nodes[1]);
9731 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9732 check_added_monitors!(nodes[1], 1);
9733 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9734 assert!(updates.update_add_htlcs.is_empty());
9735 assert!(updates.update_fulfill_htlcs.is_empty());
9736 assert_eq!(updates.update_fail_htlcs.len(), 1);
9737 assert!(updates.update_fail_malformed_htlcs.is_empty());
9738 assert!(updates.update_fee.is_none());
9739 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9740 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9741 expect_payment_failed!(nodes[0], payment_hash, true);
9743 // Finally, succeed the keysend payment.
9744 claim_payment(&nodes[0], &expected_route, payment_preimage);
9746 // To start (3), send a keysend payment but don't claim it.
9747 let payment_id_1 = PaymentId([44; 32]);
9748 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9749 RecipientOnionFields::spontaneous_empty(), payment_id_1).unwrap();
9750 check_added_monitors!(nodes[0], 1);
9751 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9752 assert_eq!(events.len(), 1);
9753 let event = events.pop().unwrap();
9754 let path = vec![&nodes[1]];
9755 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
9757 // Next, attempt a keysend payment and make sure it fails.
9758 let route_params = RouteParameters::from_payment_params_and_value(
9759 PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
9762 let route = find_route(
9763 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
9764 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
9766 let payment_id_2 = PaymentId([45; 32]);
9767 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9768 RecipientOnionFields::spontaneous_empty(), payment_id_2).unwrap();
9769 check_added_monitors!(nodes[0], 1);
9770 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9771 assert_eq!(events.len(), 1);
9772 let ev = events.drain(..).next().unwrap();
9773 let payment_event = SendEvent::from_event(ev);
9774 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9775 check_added_monitors!(nodes[1], 0);
9776 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9777 expect_pending_htlcs_forwardable!(nodes[1]);
9778 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9779 check_added_monitors!(nodes[1], 1);
9780 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9781 assert!(updates.update_add_htlcs.is_empty());
9782 assert!(updates.update_fulfill_htlcs.is_empty());
9783 assert_eq!(updates.update_fail_htlcs.len(), 1);
9784 assert!(updates.update_fail_malformed_htlcs.is_empty());
9785 assert!(updates.update_fee.is_none());
9786 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9787 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9788 expect_payment_failed!(nodes[0], payment_hash, true);
9790 // Finally, claim the original payment.
9791 claim_payment(&nodes[0], &expected_route, payment_preimage);
9795 fn test_keysend_hash_mismatch() {
9796 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
9797 // preimage doesn't match the msg's payment hash.
9798 let chanmon_cfgs = create_chanmon_cfgs(2);
9799 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9800 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9801 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9803 let payer_pubkey = nodes[0].node.get_our_node_id();
9804 let payee_pubkey = nodes[1].node.get_our_node_id();
9806 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
9807 let route_params = RouteParameters::from_payment_params_and_value(
9808 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
9809 let network_graph = nodes[0].network_graph.clone();
9810 let first_hops = nodes[0].node.list_usable_channels();
9811 let scorer = test_utils::TestScorer::new();
9812 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9813 let route = find_route(
9814 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
9815 nodes[0].logger, &scorer, &(), &random_seed_bytes
9818 let test_preimage = PaymentPreimage([42; 32]);
9819 let mismatch_payment_hash = PaymentHash([43; 32]);
9820 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash,
9821 RecipientOnionFields::spontaneous_empty(), PaymentId(mismatch_payment_hash.0), &route).unwrap();
9822 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash,
9823 RecipientOnionFields::spontaneous_empty(), Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
9824 check_added_monitors!(nodes[0], 1);
9826 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9827 assert_eq!(updates.update_add_htlcs.len(), 1);
9828 assert!(updates.update_fulfill_htlcs.is_empty());
9829 assert!(updates.update_fail_htlcs.is_empty());
9830 assert!(updates.update_fail_malformed_htlcs.is_empty());
9831 assert!(updates.update_fee.is_none());
9832 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
9834 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "Payment preimage didn't match payment hash", 1);
9838 fn test_keysend_msg_with_secret_err() {
9839 // Test that we error as expected if we receive a keysend payment that includes a payment
9840 // secret when we don't support MPP keysend.
9841 let mut reject_mpp_keysend_cfg = test_default_channel_config();
9842 reject_mpp_keysend_cfg.accept_mpp_keysend = false;
9843 let chanmon_cfgs = create_chanmon_cfgs(2);
9844 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9845 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(reject_mpp_keysend_cfg)]);
9846 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9848 let payer_pubkey = nodes[0].node.get_our_node_id();
9849 let payee_pubkey = nodes[1].node.get_our_node_id();
9851 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
9852 let route_params = RouteParameters::from_payment_params_and_value(
9853 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10_000);
9854 let network_graph = nodes[0].network_graph.clone();
9855 let first_hops = nodes[0].node.list_usable_channels();
9856 let scorer = test_utils::TestScorer::new();
9857 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9858 let route = find_route(
9859 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
9860 nodes[0].logger, &scorer, &(), &random_seed_bytes
9863 let test_preimage = PaymentPreimage([42; 32]);
9864 let test_secret = PaymentSecret([43; 32]);
9865 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
9866 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash,
9867 RecipientOnionFields::secret_only(test_secret), PaymentId(payment_hash.0), &route).unwrap();
9868 nodes[0].node.test_send_payment_internal(&route, payment_hash,
9869 RecipientOnionFields::secret_only(test_secret), Some(test_preimage),
9870 PaymentId(payment_hash.0), None, session_privs).unwrap();
9871 check_added_monitors!(nodes[0], 1);
9873 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9874 assert_eq!(updates.update_add_htlcs.len(), 1);
9875 assert!(updates.update_fulfill_htlcs.is_empty());
9876 assert!(updates.update_fail_htlcs.is_empty());
9877 assert!(updates.update_fail_malformed_htlcs.is_empty());
9878 assert!(updates.update_fee.is_none());
9879 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
9881 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "We don't support MPP keysend payments", 1);
9885 fn test_multi_hop_missing_secret() {
9886 let chanmon_cfgs = create_chanmon_cfgs(4);
9887 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
9888 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
9889 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
9891 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
9892 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
9893 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
9894 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
9896 // Marshall an MPP route.
9897 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
9898 let path = route.paths[0].clone();
9899 route.paths.push(path);
9900 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
9901 route.paths[0].hops[0].short_channel_id = chan_1_id;
9902 route.paths[0].hops[1].short_channel_id = chan_3_id;
9903 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
9904 route.paths[1].hops[0].short_channel_id = chan_2_id;
9905 route.paths[1].hops[1].short_channel_id = chan_4_id;
9907 match nodes[0].node.send_payment_with_route(&route, payment_hash,
9908 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0))
9910 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
9911 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err))
9913 _ => panic!("unexpected error")
9918 fn test_drop_disconnected_peers_when_removing_channels() {
9919 let chanmon_cfgs = create_chanmon_cfgs(2);
9920 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9921 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9922 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9924 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
9926 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
9927 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
9929 nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
9930 check_closed_broadcast!(nodes[0], true);
9931 check_added_monitors!(nodes[0], 1);
9932 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
9935 // Assert that nodes[1] is awaiting removal for nodes[0] once nodes[1] has been
9936 // disconnected and the channel between has been force closed.
9937 let nodes_0_per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
9938 // Assert that nodes[1] isn't removed before `timer_tick_occurred` has been executed.
9939 assert_eq!(nodes_0_per_peer_state.len(), 1);
9940 assert!(nodes_0_per_peer_state.get(&nodes[1].node.get_our_node_id()).is_some());
9943 nodes[0].node.timer_tick_occurred();
9946 // Assert that nodes[1] has now been removed.
9947 assert_eq!(nodes[0].node.per_peer_state.read().unwrap().len(), 0);
9952 fn bad_inbound_payment_hash() {
9953 // Add coverage for checking that a user-provided payment hash matches the payment secret.
9954 let chanmon_cfgs = create_chanmon_cfgs(2);
9955 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9956 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9957 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9959 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
9960 let payment_data = msgs::FinalOnionHopData {
9962 total_msat: 100_000,
9965 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
9966 // payment verification fails as expected.
9967 let mut bad_payment_hash = payment_hash.clone();
9968 bad_payment_hash.0[0] += 1;
9969 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) {
9970 Ok(_) => panic!("Unexpected ok"),
9972 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment", "Failing HTLC with user-generated payment_hash", 1);
9976 // Check that using the original payment hash succeeds.
9977 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());
9981 fn test_id_to_peer_coverage() {
9982 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
9983 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
9984 // the channel is successfully closed.
9985 let chanmon_cfgs = create_chanmon_cfgs(2);
9986 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9987 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9988 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9990 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
9991 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9992 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
9993 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9994 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
9996 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
9997 let channel_id = ChannelId::from_bytes(tx.txid().into_inner());
9999 // Ensure that the `id_to_peer` map is empty until either party has received the
10000 // funding transaction, and have the real `channel_id`.
10001 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
10002 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
10005 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
10007 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
10008 // as it has the funding transaction.
10009 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
10010 assert_eq!(nodes_0_lock.len(), 1);
10011 assert!(nodes_0_lock.contains_key(&channel_id));
10014 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
10016 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
10018 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
10020 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
10021 assert_eq!(nodes_0_lock.len(), 1);
10022 assert!(nodes_0_lock.contains_key(&channel_id));
10024 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
10027 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
10028 // as it has the funding transaction.
10029 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
10030 assert_eq!(nodes_1_lock.len(), 1);
10031 assert!(nodes_1_lock.contains_key(&channel_id));
10033 check_added_monitors!(nodes[1], 1);
10034 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
10035 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
10036 check_added_monitors!(nodes[0], 1);
10037 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
10038 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
10039 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
10040 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
10042 nodes[0].node.close_channel(&channel_id, &nodes[1].node.get_our_node_id()).unwrap();
10043 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()));
10044 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
10045 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &nodes_1_shutdown);
10047 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
10048 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
10050 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
10051 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
10052 // fee for the closing transaction has been negotiated and the parties has the other
10053 // party's signature for the fee negotiated closing transaction.)
10054 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
10055 assert_eq!(nodes_0_lock.len(), 1);
10056 assert!(nodes_0_lock.contains_key(&channel_id));
10060 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
10061 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
10062 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
10063 // kept in the `nodes[1]`'s `id_to_peer` map.
10064 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
10065 assert_eq!(nodes_1_lock.len(), 1);
10066 assert!(nodes_1_lock.contains_key(&channel_id));
10069 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()));
10071 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
10072 // therefore has all it needs to fully close the channel (both signatures for the
10073 // closing transaction).
10074 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
10075 // fully closed by `nodes[0]`.
10076 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
10078 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
10079 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
10080 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
10081 assert_eq!(nodes_1_lock.len(), 1);
10082 assert!(nodes_1_lock.contains_key(&channel_id));
10085 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
10087 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
10089 // Assert that the channel has now been removed from both parties `id_to_peer` map once
10090 // they both have everything required to fully close the channel.
10091 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
10093 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
10095 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
10096 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
10099 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
10100 let expected_message = format!("Not connected to node: {}", expected_public_key);
10101 check_api_error_message(expected_message, res_err)
10104 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
10105 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
10106 check_api_error_message(expected_message, res_err)
10109 fn check_api_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
10111 Err(APIError::APIMisuseError { err }) => {
10112 assert_eq!(err, expected_err_message);
10114 Err(APIError::ChannelUnavailable { err }) => {
10115 assert_eq!(err, expected_err_message);
10117 Ok(_) => panic!("Unexpected Ok"),
10118 Err(_) => panic!("Unexpected Error"),
10123 fn test_api_calls_with_unkown_counterparty_node() {
10124 // Tests that our API functions that expects a `counterparty_node_id` as input, behaves as
10125 // expected if the `counterparty_node_id` is an unkown peer in the
10126 // `ChannelManager::per_peer_state` map.
10127 let chanmon_cfg = create_chanmon_cfgs(2);
10128 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
10129 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
10130 let nodes = create_network(2, &node_cfg, &node_chanmgr);
10133 let channel_id = ChannelId::from_bytes([4; 32]);
10134 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
10135 let intercept_id = InterceptId([0; 32]);
10137 // Test the API functions.
10138 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);
10140 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&channel_id, &unkown_public_key, 42), unkown_public_key);
10142 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
10144 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
10146 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
10148 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
10150 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
10154 fn test_connection_limiting() {
10155 // Test that we limit un-channel'd peers and un-funded channels properly.
10156 let chanmon_cfgs = create_chanmon_cfgs(2);
10157 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10158 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10159 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10161 // Note that create_network connects the nodes together for us
10163 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10164 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10166 let mut funding_tx = None;
10167 for idx in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
10168 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10169 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10172 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
10173 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
10174 funding_tx = Some(tx.clone());
10175 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx).unwrap();
10176 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
10178 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
10179 check_added_monitors!(nodes[1], 1);
10180 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
10182 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
10184 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
10185 check_added_monitors!(nodes[0], 1);
10186 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
10188 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10191 // A MAX_UNFUNDED_CHANS_PER_PEER + 1 channel will be summarily rejected
10192 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10193 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10194 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
10195 open_channel_msg.temporary_channel_id);
10197 // Further, because all of our channels with nodes[0] are inbound, and none of them funded,
10198 // it doesn't count as a "protected" peer, i.e. it counts towards the MAX_NO_CHANNEL_PEERS
10200 let mut peer_pks = Vec::with_capacity(super::MAX_NO_CHANNEL_PEERS);
10201 for _ in 1..super::MAX_NO_CHANNEL_PEERS {
10202 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10203 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10204 peer_pks.push(random_pk);
10205 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
10206 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10209 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10210 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10211 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10212 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10213 }, true).unwrap_err();
10215 // Also importantly, because nodes[0] isn't "protected", we will refuse a reconnection from
10216 // them if we have too many un-channel'd peers.
10217 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10218 let chan_closed_events = nodes[1].node.get_and_clear_pending_events();
10219 assert_eq!(chan_closed_events.len(), super::MAX_UNFUNDED_CHANS_PER_PEER - 1);
10220 for ev in chan_closed_events {
10221 if let Event::ChannelClosed { .. } = ev { } else { panic!(); }
10223 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10224 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10226 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10227 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10228 }, true).unwrap_err();
10230 // but of course if the connection is outbound its allowed...
10231 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10232 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10233 }, false).unwrap();
10234 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
10236 // Now nodes[0] is disconnected but still has a pending, un-funded channel lying around.
10237 // Even though we accept one more connection from new peers, we won't actually let them
10239 assert!(peer_pks.len() > super::MAX_UNFUNDED_CHANNEL_PEERS - 1);
10240 for i in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
10241 nodes[1].node.handle_open_channel(&peer_pks[i], &open_channel_msg);
10242 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, peer_pks[i]);
10243 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10245 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10246 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
10247 open_channel_msg.temporary_channel_id);
10249 // Of course, however, outbound channels are always allowed
10250 nodes[1].node.create_channel(last_random_pk, 100_000, 0, 42, None).unwrap();
10251 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, last_random_pk);
10253 // If we fund the first channel, nodes[0] has a live on-chain channel with us, it is now
10254 // "protected" and can connect again.
10255 mine_transaction(&nodes[1], funding_tx.as_ref().unwrap());
10256 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
10257 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10259 get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
10261 // Further, because the first channel was funded, we can open another channel with
10263 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10264 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
10268 fn test_outbound_chans_unlimited() {
10269 // Test that we never refuse an outbound channel even if a peer is unfuned-channel-limited
10270 let chanmon_cfgs = create_chanmon_cfgs(2);
10271 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10272 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
10273 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10275 // Note that create_network connects the nodes together for us
10277 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10278 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10280 for _ in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
10281 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10282 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10283 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10286 // Once we have MAX_UNFUNDED_CHANS_PER_PEER unfunded channels, new inbound channels will be
10288 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10289 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
10290 open_channel_msg.temporary_channel_id);
10292 // but we can still open an outbound channel.
10293 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10294 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
10296 // but even with such an outbound channel, additional inbound channels will still fail.
10297 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10298 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
10299 open_channel_msg.temporary_channel_id);
10303 fn test_0conf_limiting() {
10304 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
10305 // flag set and (sometimes) accept channels as 0conf.
10306 let chanmon_cfgs = create_chanmon_cfgs(2);
10307 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10308 let mut settings = test_default_channel_config();
10309 settings.manually_accept_inbound_channels = true;
10310 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(settings)]);
10311 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10313 // Note that create_network connects the nodes together for us
10315 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10316 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10318 // First, get us up to MAX_UNFUNDED_CHANNEL_PEERS so we can test at the edge
10319 for _ in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
10320 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10321 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10322 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
10323 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10326 nodes[1].node.handle_open_channel(&random_pk, &open_channel_msg);
10327 let events = nodes[1].node.get_and_clear_pending_events();
10329 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10330 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23).unwrap();
10332 _ => panic!("Unexpected event"),
10334 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, random_pk);
10335 open_channel_msg.temporary_channel_id = ChannelId::temporary_from_entropy_source(&nodes[0].keys_manager);
10338 // If we try to accept a channel from another peer non-0conf it will fail.
10339 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
10340 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
10341 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
10342 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
10344 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10345 let events = nodes[1].node.get_and_clear_pending_events();
10347 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10348 match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23) {
10349 Err(APIError::APIMisuseError { err }) =>
10350 assert_eq!(err, "Too many peers with unfunded channels, refusing to accept new ones"),
10354 _ => panic!("Unexpected event"),
10356 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
10357 open_channel_msg.temporary_channel_id);
10359 // ...however if we accept the same channel 0conf it should work just fine.
10360 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
10361 let events = nodes[1].node.get_and_clear_pending_events();
10363 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10364 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23).unwrap();
10366 _ => panic!("Unexpected event"),
10368 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
10372 fn reject_excessively_underpaying_htlcs() {
10373 let chanmon_cfg = create_chanmon_cfgs(1);
10374 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
10375 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
10376 let node = create_network(1, &node_cfg, &node_chanmgr);
10377 let sender_intended_amt_msat = 100;
10378 let extra_fee_msat = 10;
10379 let hop_data = msgs::InboundOnionPayload::Receive {
10381 outgoing_cltv_value: 42,
10382 payment_metadata: None,
10383 keysend_preimage: None,
10384 payment_data: Some(msgs::FinalOnionHopData {
10385 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
10387 custom_tlvs: Vec::new(),
10389 // Check that if the amount we received + the penultimate hop extra fee is less than the sender
10390 // intended amount, we fail the payment.
10391 if let Err(crate::ln::channelmanager::InboundOnionErr { err_code, .. }) =
10392 node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
10393 sender_intended_amt_msat - extra_fee_msat - 1, 42, None, true, Some(extra_fee_msat))
10395 assert_eq!(err_code, 19);
10396 } else { panic!(); }
10398 // If amt_received + extra_fee is equal to the sender intended amount, we're fine.
10399 let hop_data = msgs::InboundOnionPayload::Receive { // This is the same payload as above, InboundOnionPayload doesn't implement Clone
10401 outgoing_cltv_value: 42,
10402 payment_metadata: None,
10403 keysend_preimage: None,
10404 payment_data: Some(msgs::FinalOnionHopData {
10405 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
10407 custom_tlvs: Vec::new(),
10409 assert!(node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
10410 sender_intended_amt_msat - extra_fee_msat, 42, None, true, Some(extra_fee_msat)).is_ok());
10414 fn test_inbound_anchors_manual_acceptance() {
10415 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
10416 // flag set and (sometimes) accept channels as 0conf.
10417 let mut anchors_cfg = test_default_channel_config();
10418 anchors_cfg.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
10420 let mut anchors_manual_accept_cfg = anchors_cfg.clone();
10421 anchors_manual_accept_cfg.manually_accept_inbound_channels = true;
10423 let chanmon_cfgs = create_chanmon_cfgs(3);
10424 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
10425 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs,
10426 &[Some(anchors_cfg.clone()), Some(anchors_cfg.clone()), Some(anchors_manual_accept_cfg.clone())]);
10427 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
10429 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10430 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10432 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10433 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
10434 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
10435 match &msg_events[0] {
10436 MessageSendEvent::HandleError { node_id, action } => {
10437 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
10439 ErrorAction::SendErrorMessage { msg } =>
10440 assert_eq!(msg.data, "No channels with anchor outputs accepted".to_owned()),
10441 _ => panic!("Unexpected error action"),
10444 _ => panic!("Unexpected event"),
10447 nodes[2].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10448 let events = nodes[2].node.get_and_clear_pending_events();
10450 Event::OpenChannelRequest { temporary_channel_id, .. } =>
10451 nodes[2].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap(),
10452 _ => panic!("Unexpected event"),
10454 get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10458 fn test_anchors_zero_fee_htlc_tx_fallback() {
10459 // Tests that if both nodes support anchors, but the remote node does not want to accept
10460 // anchor channels at the moment, an error it sent to the local node such that it can retry
10461 // the channel without the anchors feature.
10462 let chanmon_cfgs = create_chanmon_cfgs(2);
10463 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10464 let mut anchors_config = test_default_channel_config();
10465 anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
10466 anchors_config.manually_accept_inbound_channels = true;
10467 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config.clone()), Some(anchors_config.clone())]);
10468 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10470 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 0, None).unwrap();
10471 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10472 assert!(open_channel_msg.channel_type.as_ref().unwrap().supports_anchors_zero_fee_htlc_tx());
10474 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10475 let events = nodes[1].node.get_and_clear_pending_events();
10477 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10478 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
10480 _ => panic!("Unexpected event"),
10483 let error_msg = get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id());
10484 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &error_msg);
10486 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10487 assert!(!open_channel_msg.channel_type.unwrap().supports_anchors_zero_fee_htlc_tx());
10489 // Since nodes[1] should not have accepted the channel, it should
10490 // not have generated any events.
10491 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
10495 fn test_update_channel_config() {
10496 let chanmon_cfg = create_chanmon_cfgs(2);
10497 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
10498 let mut user_config = test_default_channel_config();
10499 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
10500 let nodes = create_network(2, &node_cfg, &node_chanmgr);
10501 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
10502 let channel = &nodes[0].node.list_channels()[0];
10504 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
10505 let events = nodes[0].node.get_and_clear_pending_msg_events();
10506 assert_eq!(events.len(), 0);
10508 user_config.channel_config.forwarding_fee_base_msat += 10;
10509 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
10510 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_base_msat, user_config.channel_config.forwarding_fee_base_msat);
10511 let events = nodes[0].node.get_and_clear_pending_msg_events();
10512 assert_eq!(events.len(), 1);
10514 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10515 _ => panic!("expected BroadcastChannelUpdate event"),
10518 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate::default()).unwrap();
10519 let events = nodes[0].node.get_and_clear_pending_msg_events();
10520 assert_eq!(events.len(), 0);
10522 let new_cltv_expiry_delta = user_config.channel_config.cltv_expiry_delta + 6;
10523 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
10524 cltv_expiry_delta: Some(new_cltv_expiry_delta),
10525 ..Default::default()
10527 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
10528 let events = nodes[0].node.get_and_clear_pending_msg_events();
10529 assert_eq!(events.len(), 1);
10531 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10532 _ => panic!("expected BroadcastChannelUpdate event"),
10535 let new_fee = user_config.channel_config.forwarding_fee_proportional_millionths + 100;
10536 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
10537 forwarding_fee_proportional_millionths: Some(new_fee),
10538 ..Default::default()
10540 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
10541 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, new_fee);
10542 let events = nodes[0].node.get_and_clear_pending_msg_events();
10543 assert_eq!(events.len(), 1);
10545 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10546 _ => panic!("expected BroadcastChannelUpdate event"),
10549 // If we provide a channel_id not associated with the peer, we should get an error and no updates
10550 // should be applied to ensure update atomicity as specified in the API docs.
10551 let bad_channel_id = ChannelId::v1_from_funding_txid(&[10; 32], 10);
10552 let current_fee = nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths;
10553 let new_fee = current_fee + 100;
10556 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id, bad_channel_id], &ChannelConfigUpdate {
10557 forwarding_fee_proportional_millionths: Some(new_fee),
10558 ..Default::default()
10560 Err(APIError::ChannelUnavailable { err: _ }),
10563 // Check that the fee hasn't changed for the channel that exists.
10564 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, current_fee);
10565 let events = nodes[0].node.get_and_clear_pending_msg_events();
10566 assert_eq!(events.len(), 0);
10570 fn test_payment_display() {
10571 let payment_id = PaymentId([42; 32]);
10572 assert_eq!(format!("{}", &payment_id), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
10573 let payment_hash = PaymentHash([42; 32]);
10574 assert_eq!(format!("{}", &payment_hash), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
10575 let payment_preimage = PaymentPreimage([42; 32]);
10576 assert_eq!(format!("{}", &payment_preimage), "2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a2a");
10582 use crate::chain::Listen;
10583 use crate::chain::chainmonitor::{ChainMonitor, Persist};
10584 use crate::sign::{KeysManager, InMemorySigner};
10585 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider};
10586 use crate::ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId, RecipientOnionFields, Retry};
10587 use crate::ln::functional_test_utils::*;
10588 use crate::ln::msgs::{ChannelMessageHandler, Init};
10589 use crate::routing::gossip::NetworkGraph;
10590 use crate::routing::router::{PaymentParameters, RouteParameters};
10591 use crate::util::test_utils;
10592 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
10594 use bitcoin::hashes::Hash;
10595 use bitcoin::hashes::sha256::Hash as Sha256;
10596 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
10598 use crate::sync::{Arc, Mutex, RwLock};
10600 use criterion::Criterion;
10602 type Manager<'a, P> = ChannelManager<
10603 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
10604 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
10605 &'a test_utils::TestLogger, &'a P>,
10606 &'a test_utils::TestBroadcaster, &'a KeysManager, &'a KeysManager, &'a KeysManager,
10607 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
10608 &'a test_utils::TestLogger>;
10610 struct ANodeHolder<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> {
10611 node: &'node_cfg Manager<'chan_mon_cfg, P>,
10613 impl<'node_cfg, 'chan_mon_cfg: 'node_cfg, P: Persist<InMemorySigner>> NodeHolder for ANodeHolder<'node_cfg, 'chan_mon_cfg, P> {
10614 type CM = Manager<'chan_mon_cfg, P>;
10616 fn node(&self) -> &Manager<'chan_mon_cfg, P> { self.node }
10618 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { None }
10621 pub fn bench_sends(bench: &mut Criterion) {
10622 bench_two_sends(bench, "bench_sends", test_utils::TestPersister::new(), test_utils::TestPersister::new());
10625 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Criterion, bench_name: &str, persister_a: P, persister_b: P) {
10626 // Do a simple benchmark of sending a payment back and forth between two nodes.
10627 // Note that this is unrealistic as each payment send will require at least two fsync
10629 let network = bitcoin::Network::Testnet;
10630 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
10632 let tx_broadcaster = test_utils::TestBroadcaster::new(network);
10633 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
10634 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
10635 let scorer = RwLock::new(test_utils::TestScorer::new());
10636 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(network, &logger_a)), &scorer);
10638 let mut config: UserConfig = Default::default();
10639 config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
10640 config.channel_handshake_config.minimum_depth = 1;
10642 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
10643 let seed_a = [1u8; 32];
10644 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
10645 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 {
10647 best_block: BestBlock::from_network(network),
10648 }, genesis_block.header.time);
10649 let node_a_holder = ANodeHolder { node: &node_a };
10651 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
10652 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
10653 let seed_b = [2u8; 32];
10654 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
10655 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 {
10657 best_block: BestBlock::from_network(network),
10658 }, genesis_block.header.time);
10659 let node_b_holder = ANodeHolder { node: &node_b };
10661 node_a.peer_connected(&node_b.get_our_node_id(), &Init {
10662 features: node_b.init_features(), networks: None, remote_network_address: None
10664 node_b.peer_connected(&node_a.get_our_node_id(), &Init {
10665 features: node_a.init_features(), networks: None, remote_network_address: None
10666 }, false).unwrap();
10667 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
10668 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()));
10669 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()));
10672 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
10673 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
10674 value: 8_000_000, script_pubkey: output_script,
10676 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
10677 } else { panic!(); }
10679 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()));
10680 let events_b = node_b.get_and_clear_pending_events();
10681 assert_eq!(events_b.len(), 1);
10682 match events_b[0] {
10683 Event::ChannelPending{ ref counterparty_node_id, .. } => {
10684 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
10686 _ => panic!("Unexpected event"),
10689 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()));
10690 let events_a = node_a.get_and_clear_pending_events();
10691 assert_eq!(events_a.len(), 1);
10692 match events_a[0] {
10693 Event::ChannelPending{ ref counterparty_node_id, .. } => {
10694 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
10696 _ => panic!("Unexpected event"),
10699 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
10701 let block = create_dummy_block(BestBlock::from_network(network).block_hash(), 42, vec![tx]);
10702 Listen::block_connected(&node_a, &block, 1);
10703 Listen::block_connected(&node_b, &block, 1);
10705 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()));
10706 let msg_events = node_a.get_and_clear_pending_msg_events();
10707 assert_eq!(msg_events.len(), 2);
10708 match msg_events[0] {
10709 MessageSendEvent::SendChannelReady { ref msg, .. } => {
10710 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
10711 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
10715 match msg_events[1] {
10716 MessageSendEvent::SendChannelUpdate { .. } => {},
10720 let events_a = node_a.get_and_clear_pending_events();
10721 assert_eq!(events_a.len(), 1);
10722 match events_a[0] {
10723 Event::ChannelReady{ ref counterparty_node_id, .. } => {
10724 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
10726 _ => panic!("Unexpected event"),
10729 let events_b = node_b.get_and_clear_pending_events();
10730 assert_eq!(events_b.len(), 1);
10731 match events_b[0] {
10732 Event::ChannelReady{ ref counterparty_node_id, .. } => {
10733 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
10735 _ => panic!("Unexpected event"),
10738 let mut payment_count: u64 = 0;
10739 macro_rules! send_payment {
10740 ($node_a: expr, $node_b: expr) => {
10741 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id(), TEST_FINAL_CLTV)
10742 .with_bolt11_features($node_b.invoice_features()).unwrap();
10743 let mut payment_preimage = PaymentPreimage([0; 32]);
10744 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
10745 payment_count += 1;
10746 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
10747 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
10749 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
10750 PaymentId(payment_hash.0),
10751 RouteParameters::from_payment_params_and_value(payment_params, 10_000),
10752 Retry::Attempts(0)).unwrap();
10753 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
10754 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
10755 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
10756 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_b }, &$node_a.get_our_node_id());
10757 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
10758 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
10759 $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()));
10761 expect_pending_htlcs_forwardable!(ANodeHolder { node: &$node_b });
10762 expect_payment_claimable!(ANodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
10763 $node_b.claim_funds(payment_preimage);
10764 expect_payment_claimed!(ANodeHolder { node: &$node_b }, payment_hash, 10_000);
10766 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
10767 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
10768 assert_eq!(node_id, $node_a.get_our_node_id());
10769 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
10770 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
10772 _ => panic!("Failed to generate claim event"),
10775 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_a }, &$node_b.get_our_node_id());
10776 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
10777 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
10778 $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()));
10780 expect_payment_sent!(ANodeHolder { node: &$node_a }, payment_preimage);
10784 bench.bench_function(bench_name, |b| b.iter(|| {
10785 send_payment!(node_a, node_b);
10786 send_payment!(node_b, node_a);