1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! The top-level channel management and payment tracking stuff lives here.
12 //! The [`ChannelManager`] is the main chunk of logic implementing the lightning protocol and is
13 //! responsible for tracking which channels are open, HTLCs are in flight and reestablishing those
14 //! upon reconnect to the relevant peer(s).
16 //! It does not manage routing logic (see [`Router`] for that) nor does it manage constructing
17 //! on-chain transactions (it only monitors the chain to watch for any force-closes that might
18 //! imply it needs to fail HTLCs/payments/channels it manages).
20 use bitcoin::blockdata::block::BlockHeader;
21 use bitcoin::blockdata::transaction::Transaction;
22 use bitcoin::blockdata::constants::{genesis_block, ChainHash};
23 use bitcoin::network::constants::Network;
25 use bitcoin::hashes::Hash;
26 use bitcoin::hashes::sha256::Hash as Sha256;
27 use bitcoin::hash_types::{BlockHash, Txid};
29 use bitcoin::secp256k1::{SecretKey,PublicKey};
30 use bitcoin::secp256k1::Secp256k1;
31 use bitcoin::{LockTime, secp256k1, Sequence};
34 use crate::chain::{Confirm, ChannelMonitorUpdateStatus, Watch, BestBlock};
35 use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator};
36 use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
37 use crate::chain::transaction::{OutPoint, TransactionData};
39 use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination, PaymentFailureReason};
40 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
41 // construct one themselves.
42 use crate::ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
43 use crate::ln::channel::{Channel, ChannelContext, ChannelError, ChannelUpdateStatus, ShutdownResult, UpdateFulfillCommitFetch, OutboundV1Channel, InboundV1Channel};
44 use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
45 #[cfg(any(feature = "_test_utils", test))]
46 use crate::ln::features::InvoiceFeatures;
47 use crate::routing::gossip::NetworkGraph;
48 use crate::routing::router::{BlindedTail, DefaultRouter, InFlightHtlcs, Path, Payee, PaymentParameters, Route, RouteHop, 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};
57 use crate::ln::wire::Encode;
58 use crate::sign::{EntropySource, KeysManager, NodeSigner, Recipient, SignerProvider, ChannelSigner, WriteableEcdsaChannelSigner};
59 use crate::util::config::{UserConfig, ChannelConfig, ChannelConfigUpdate};
60 use crate::util::wakers::{Future, Notifier};
61 use crate::util::scid_utils::fake_scid;
62 use crate::util::string::UntrustedString;
63 use crate::util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
64 use crate::util::logger::{Level, Logger};
65 use crate::util::errors::APIError;
67 use alloc::collections::BTreeMap;
70 use crate::prelude::*;
72 use core::cell::RefCell;
74 use crate::sync::{Arc, Mutex, RwLock, RwLockReadGuard, FairRwLock, LockTestExt, LockHeldState};
75 use core::sync::atomic::{AtomicUsize, AtomicBool, Ordering};
76 use core::time::Duration;
79 // Re-export this for use in the public API.
80 pub use crate::ln::outbound_payment::{PaymentSendFailure, Retry, RetryableSendFailure, RecipientOnionFields};
81 use crate::ln::script::ShutdownScript;
83 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
85 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
86 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
87 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
89 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
90 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
91 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
92 // before we forward it.
94 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
95 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
96 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
97 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
98 // our payment, which we can use to decode errors or inform the user that the payment was sent.
100 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
101 pub(super) enum PendingHTLCRouting {
103 onion_packet: msgs::OnionPacket,
104 /// The SCID from the onion that we should forward to. This could be a real SCID or a fake one
105 /// generated using `get_fake_scid` from the scid_utils::fake_scid module.
106 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
109 payment_data: msgs::FinalOnionHopData,
110 payment_metadata: Option<Vec<u8>>,
111 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
112 phantom_shared_secret: Option<[u8; 32]>,
115 /// This was added in 0.0.116 and will break deserialization on downgrades.
116 payment_data: Option<msgs::FinalOnionHopData>,
117 payment_preimage: PaymentPreimage,
118 payment_metadata: Option<Vec<u8>>,
119 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
123 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
124 pub(super) struct PendingHTLCInfo {
125 pub(super) routing: PendingHTLCRouting,
126 pub(super) incoming_shared_secret: [u8; 32],
127 payment_hash: PaymentHash,
129 pub(super) incoming_amt_msat: Option<u64>, // Added in 0.0.113
130 /// Sender intended amount to forward or receive (actual amount received
131 /// may overshoot this in either case)
132 pub(super) outgoing_amt_msat: u64,
133 pub(super) outgoing_cltv_value: u32,
134 /// The fee being skimmed off the top of this HTLC. If this is a forward, it'll be the fee we are
135 /// skimming. If we're receiving this HTLC, it's the fee that our counterparty skimmed.
136 pub(super) skimmed_fee_msat: Option<u64>,
139 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
140 pub(super) enum HTLCFailureMsg {
141 Relay(msgs::UpdateFailHTLC),
142 Malformed(msgs::UpdateFailMalformedHTLC),
145 /// Stores whether we can't forward an HTLC or relevant forwarding info
146 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
147 pub(super) enum PendingHTLCStatus {
148 Forward(PendingHTLCInfo),
149 Fail(HTLCFailureMsg),
152 pub(super) struct PendingAddHTLCInfo {
153 pub(super) forward_info: PendingHTLCInfo,
155 // These fields are produced in `forward_htlcs()` and consumed in
156 // `process_pending_htlc_forwards()` for constructing the
157 // `HTLCSource::PreviousHopData` for failed and forwarded
160 // Note that this may be an outbound SCID alias for the associated channel.
161 prev_short_channel_id: u64,
163 prev_funding_outpoint: OutPoint,
164 prev_user_channel_id: u128,
167 pub(super) enum HTLCForwardInfo {
168 AddHTLC(PendingAddHTLCInfo),
171 err_packet: msgs::OnionErrorPacket,
175 /// Tracks the inbound corresponding to an outbound HTLC
176 #[derive(Clone, Hash, PartialEq, Eq)]
177 pub(crate) struct HTLCPreviousHopData {
178 // Note that this may be an outbound SCID alias for the associated channel.
179 short_channel_id: u64,
181 incoming_packet_shared_secret: [u8; 32],
182 phantom_shared_secret: Option<[u8; 32]>,
184 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
185 // channel with a preimage provided by the forward channel.
190 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
192 /// This is only here for backwards-compatibility in serialization, in the future it can be
193 /// removed, breaking clients running 0.0.106 and earlier.
194 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
196 /// Contains the payer-provided preimage.
197 Spontaneous(PaymentPreimage),
200 /// HTLCs that are to us and can be failed/claimed by the user
201 struct ClaimableHTLC {
202 prev_hop: HTLCPreviousHopData,
204 /// The amount (in msats) of this MPP part
206 /// The amount (in msats) that the sender intended to be sent in this MPP
207 /// part (used for validating total MPP amount)
208 sender_intended_value: u64,
209 onion_payload: OnionPayload,
211 /// The total value received for a payment (sum of all MPP parts if the payment is a MPP).
212 /// Gets set to the amount reported when pushing [`Event::PaymentClaimable`].
213 total_value_received: Option<u64>,
214 /// The sender intended sum total of all MPP parts specified in the onion
216 /// The extra fee our counterparty skimmed off the top of this HTLC.
217 counterparty_skimmed_fee_msat: Option<u64>,
220 /// A payment identifier used to uniquely identify a payment to LDK.
222 /// This is not exported to bindings users as we just use [u8; 32] directly
223 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
224 pub struct PaymentId(pub [u8; 32]);
226 impl Writeable for PaymentId {
227 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
232 impl Readable for PaymentId {
233 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
234 let buf: [u8; 32] = Readable::read(r)?;
239 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
241 /// This is not exported to bindings users as we just use [u8; 32] directly
242 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
243 pub struct InterceptId(pub [u8; 32]);
245 impl Writeable for InterceptId {
246 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
251 impl Readable for InterceptId {
252 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
253 let buf: [u8; 32] = Readable::read(r)?;
258 #[derive(Clone, Copy, PartialEq, Eq, Hash)]
259 /// Uniquely describes an HTLC by its source. Just the guaranteed-unique subset of [`HTLCSource`].
260 pub(crate) enum SentHTLCId {
261 PreviousHopData { short_channel_id: u64, htlc_id: u64 },
262 OutboundRoute { session_priv: SecretKey },
265 pub(crate) fn from_source(source: &HTLCSource) -> Self {
267 HTLCSource::PreviousHopData(hop_data) => Self::PreviousHopData {
268 short_channel_id: hop_data.short_channel_id,
269 htlc_id: hop_data.htlc_id,
271 HTLCSource::OutboundRoute { session_priv, .. } =>
272 Self::OutboundRoute { session_priv: *session_priv },
276 impl_writeable_tlv_based_enum!(SentHTLCId,
277 (0, PreviousHopData) => {
278 (0, short_channel_id, required),
279 (2, htlc_id, required),
281 (2, OutboundRoute) => {
282 (0, session_priv, required),
287 /// Tracks the inbound corresponding to an outbound HTLC
288 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
289 #[derive(Clone, PartialEq, Eq)]
290 pub(crate) enum HTLCSource {
291 PreviousHopData(HTLCPreviousHopData),
294 session_priv: SecretKey,
295 /// Technically we can recalculate this from the route, but we cache it here to avoid
296 /// doing a double-pass on route when we get a failure back
297 first_hop_htlc_msat: u64,
298 payment_id: PaymentId,
301 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
302 impl core::hash::Hash for HTLCSource {
303 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
305 HTLCSource::PreviousHopData(prev_hop_data) => {
307 prev_hop_data.hash(hasher);
309 HTLCSource::OutboundRoute { path, session_priv, payment_id, first_hop_htlc_msat } => {
312 session_priv[..].hash(hasher);
313 payment_id.hash(hasher);
314 first_hop_htlc_msat.hash(hasher);
320 #[cfg(all(feature = "_test_vectors", not(feature = "grind_signatures")))]
322 pub fn dummy() -> Self {
323 HTLCSource::OutboundRoute {
324 path: Path { hops: Vec::new(), blinded_tail: None },
325 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
326 first_hop_htlc_msat: 0,
327 payment_id: PaymentId([2; 32]),
331 #[cfg(debug_assertions)]
332 /// Checks whether this HTLCSource could possibly match the given HTLC output in a commitment
333 /// transaction. Useful to ensure different datastructures match up.
334 pub(crate) fn possibly_matches_output(&self, htlc: &super::chan_utils::HTLCOutputInCommitment) -> bool {
335 if let HTLCSource::OutboundRoute { first_hop_htlc_msat, .. } = self {
336 *first_hop_htlc_msat == htlc.amount_msat
338 // There's nothing we can check for forwarded HTLCs
344 struct ReceiveError {
350 /// This enum is used to specify which error data to send to peers when failing back an HTLC
351 /// using [`ChannelManager::fail_htlc_backwards_with_reason`].
353 /// For more info on failure codes, see <https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages>.
354 #[derive(Clone, Copy)]
355 pub enum FailureCode {
356 /// We had a temporary error processing the payment. Useful if no other error codes fit
357 /// and you want to indicate that the payer may want to retry.
358 TemporaryNodeFailure = 0x2000 | 2,
359 /// We have a required feature which was not in this onion. For example, you may require
360 /// some additional metadata that was not provided with this payment.
361 RequiredNodeFeatureMissing = 0x4000 | 0x2000 | 3,
362 /// You may wish to use this when a `payment_preimage` is unknown, or the CLTV expiry of
363 /// the HTLC is too close to the current block height for safe handling.
364 /// Using this failure code in [`ChannelManager::fail_htlc_backwards_with_reason`] is
365 /// equivalent to calling [`ChannelManager::fail_htlc_backwards`].
366 IncorrectOrUnknownPaymentDetails = 0x4000 | 15,
369 /// Error type returned across the peer_state mutex boundary. When an Err is generated for a
370 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
371 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
372 /// peer_state lock. We then return the set of things that need to be done outside the lock in
373 /// this struct and call handle_error!() on it.
375 struct MsgHandleErrInternal {
376 err: msgs::LightningError,
377 chan_id: Option<([u8; 32], u128)>, // If Some a channel of ours has been closed
378 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
380 impl MsgHandleErrInternal {
382 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
384 err: LightningError {
386 action: msgs::ErrorAction::SendErrorMessage {
387 msg: msgs::ErrorMessage {
394 shutdown_finish: None,
398 fn from_no_close(err: msgs::LightningError) -> Self {
399 Self { err, chan_id: None, shutdown_finish: None }
402 fn from_finish_shutdown(err: String, channel_id: [u8; 32], user_channel_id: u128, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
404 err: LightningError {
406 action: msgs::ErrorAction::SendErrorMessage {
407 msg: msgs::ErrorMessage {
413 chan_id: Some((channel_id, user_channel_id)),
414 shutdown_finish: Some((shutdown_res, channel_update)),
418 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
421 ChannelError::Warn(msg) => LightningError {
423 action: msgs::ErrorAction::SendWarningMessage {
424 msg: msgs::WarningMessage {
428 log_level: Level::Warn,
431 ChannelError::Ignore(msg) => LightningError {
433 action: msgs::ErrorAction::IgnoreError,
435 ChannelError::Close(msg) => LightningError {
437 action: msgs::ErrorAction::SendErrorMessage {
438 msg: msgs::ErrorMessage {
446 shutdown_finish: None,
451 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
452 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
453 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
454 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
455 pub(super) const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
457 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
458 /// be sent in the order they appear in the return value, however sometimes the order needs to be
459 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
460 /// they were originally sent). In those cases, this enum is also returned.
461 #[derive(Clone, PartialEq)]
462 pub(super) enum RAACommitmentOrder {
463 /// Send the CommitmentUpdate messages first
465 /// Send the RevokeAndACK message first
469 /// Information about a payment which is currently being claimed.
470 struct ClaimingPayment {
472 payment_purpose: events::PaymentPurpose,
473 receiver_node_id: PublicKey,
475 impl_writeable_tlv_based!(ClaimingPayment, {
476 (0, amount_msat, required),
477 (2, payment_purpose, required),
478 (4, receiver_node_id, required),
481 struct ClaimablePayment {
482 purpose: events::PaymentPurpose,
483 onion_fields: Option<RecipientOnionFields>,
484 htlcs: Vec<ClaimableHTLC>,
487 /// Information about claimable or being-claimed payments
488 struct ClaimablePayments {
489 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
490 /// failed/claimed by the user.
492 /// Note that, no consistency guarantees are made about the channels given here actually
493 /// existing anymore by the time you go to read them!
495 /// When adding to the map, [`Self::pending_claiming_payments`] must also be checked to ensure
496 /// we don't get a duplicate payment.
497 claimable_payments: HashMap<PaymentHash, ClaimablePayment>,
499 /// Map from payment hash to the payment data for HTLCs which we have begun claiming, but which
500 /// are waiting on a [`ChannelMonitorUpdate`] to complete in order to be surfaced to the user
501 /// as an [`events::Event::PaymentClaimed`].
502 pending_claiming_payments: HashMap<PaymentHash, ClaimingPayment>,
505 /// Events which we process internally but cannot be processed immediately at the generation site
506 /// usually because we're running pre-full-init. They are handled immediately once we detect we are
507 /// running normally, and specifically must be processed before any other non-background
508 /// [`ChannelMonitorUpdate`]s are applied.
509 enum BackgroundEvent {
510 /// Handle a ChannelMonitorUpdate which closes the channel or for an already-closed channel.
511 /// This is only separated from [`Self::MonitorUpdateRegeneratedOnStartup`] as the
512 /// maybe-non-closing variant needs a public key to handle channel resumption, whereas if the
513 /// channel has been force-closed we do not need the counterparty node_id.
515 /// Note that any such events are lost on shutdown, so in general they must be updates which
516 /// are regenerated on startup.
517 ClosedMonitorUpdateRegeneratedOnStartup((OutPoint, ChannelMonitorUpdate)),
518 /// Handle a ChannelMonitorUpdate which may or may not close the channel and may unblock the
519 /// channel to continue normal operation.
521 /// In general this should be used rather than
522 /// [`Self::ClosedMonitorUpdateRegeneratedOnStartup`], however in cases where the
523 /// `counterparty_node_id` is not available as the channel has closed from a [`ChannelMonitor`]
524 /// error the other variant is acceptable.
526 /// Note that any such events are lost on shutdown, so in general they must be updates which
527 /// are regenerated on startup.
528 MonitorUpdateRegeneratedOnStartup {
529 counterparty_node_id: PublicKey,
530 funding_txo: OutPoint,
531 update: ChannelMonitorUpdate
536 pub(crate) enum MonitorUpdateCompletionAction {
537 /// Indicates that a payment ultimately destined for us was claimed and we should emit an
538 /// [`events::Event::PaymentClaimed`] to the user if we haven't yet generated such an event for
539 /// this payment. Note that this is only best-effort. On restart it's possible such a duplicate
540 /// event can be generated.
541 PaymentClaimed { payment_hash: PaymentHash },
542 /// Indicates an [`events::Event`] should be surfaced to the user and possibly resume the
543 /// operation of another channel.
545 /// This is usually generated when we've forwarded an HTLC and want to block the outbound edge
546 /// from completing a monitor update which removes the payment preimage until the inbound edge
547 /// completes a monitor update containing the payment preimage. In that case, after the inbound
548 /// edge completes, we will surface an [`Event::PaymentForwarded`] as well as unblock the
550 EmitEventAndFreeOtherChannel {
551 event: events::Event,
552 downstream_counterparty_and_funding_outpoint: Option<(PublicKey, OutPoint, RAAMonitorUpdateBlockingAction)>,
556 impl_writeable_tlv_based_enum_upgradable!(MonitorUpdateCompletionAction,
557 (0, PaymentClaimed) => { (0, payment_hash, required) },
558 (2, EmitEventAndFreeOtherChannel) => {
559 (0, event, upgradable_required),
560 // LDK prior to 0.0.116 did not have this field as the monitor update application order was
561 // required by clients. If we downgrade to something prior to 0.0.116 this may result in
562 // monitor updates which aren't properly blocked or resumed, however that's fine - we don't
563 // support async monitor updates even in LDK 0.0.116 and once we do we'll require no
564 // downgrades to prior versions.
565 (1, downstream_counterparty_and_funding_outpoint, option),
569 #[derive(Clone, Debug, PartialEq, Eq)]
570 pub(crate) enum EventCompletionAction {
571 ReleaseRAAChannelMonitorUpdate {
572 counterparty_node_id: PublicKey,
573 channel_funding_outpoint: OutPoint,
576 impl_writeable_tlv_based_enum!(EventCompletionAction,
577 (0, ReleaseRAAChannelMonitorUpdate) => {
578 (0, channel_funding_outpoint, required),
579 (2, counterparty_node_id, required),
583 #[derive(Clone, PartialEq, Eq, Debug)]
584 /// If something is blocked on the completion of an RAA-generated [`ChannelMonitorUpdate`] we track
585 /// the blocked action here. See enum variants for more info.
586 pub(crate) enum RAAMonitorUpdateBlockingAction {
587 /// A forwarded payment was claimed. We block the downstream channel completing its monitor
588 /// update which removes the HTLC preimage until the upstream channel has gotten the preimage
590 ForwardedPaymentInboundClaim {
591 /// The upstream channel ID (i.e. the inbound edge).
592 channel_id: [u8; 32],
593 /// The HTLC ID on the inbound edge.
598 impl RAAMonitorUpdateBlockingAction {
600 fn from_prev_hop_data(prev_hop: &HTLCPreviousHopData) -> Self {
601 Self::ForwardedPaymentInboundClaim {
602 channel_id: prev_hop.outpoint.to_channel_id(),
603 htlc_id: prev_hop.htlc_id,
608 impl_writeable_tlv_based_enum!(RAAMonitorUpdateBlockingAction,
609 (0, ForwardedPaymentInboundClaim) => { (0, channel_id, required), (2, htlc_id, required) }
613 /// State we hold per-peer.
614 pub(super) struct PeerState<Signer: ChannelSigner> {
615 /// `channel_id` -> `Channel`.
617 /// Holds all funded channels where the peer is the counterparty.
618 pub(super) channel_by_id: HashMap<[u8; 32], Channel<Signer>>,
619 /// `temporary_channel_id` -> `OutboundV1Channel`.
621 /// Holds all outbound V1 channels where the peer is the counterparty. Once an outbound channel has
622 /// been assigned a `channel_id`, the entry in this map is removed and one is created in
624 pub(super) outbound_v1_channel_by_id: HashMap<[u8; 32], OutboundV1Channel<Signer>>,
625 /// `temporary_channel_id` -> `InboundV1Channel`.
627 /// Holds all inbound V1 channels where the peer is the counterparty. Once an inbound channel has
628 /// been assigned a `channel_id`, the entry in this map is removed and one is created in
630 pub(super) inbound_v1_channel_by_id: HashMap<[u8; 32], InboundV1Channel<Signer>>,
631 /// The latest `InitFeatures` we heard from the peer.
632 latest_features: InitFeatures,
633 /// Messages to send to the peer - pushed to in the same lock that they are generated in (except
634 /// for broadcast messages, where ordering isn't as strict).
635 pub(super) pending_msg_events: Vec<MessageSendEvent>,
636 /// Map from Channel IDs to pending [`ChannelMonitorUpdate`]s which have been passed to the
637 /// user but which have not yet completed.
639 /// Note that the channel may no longer exist. For example if the channel was closed but we
640 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
641 /// for a missing channel.
642 in_flight_monitor_updates: BTreeMap<OutPoint, Vec<ChannelMonitorUpdate>>,
643 /// Map from a specific channel to some action(s) that should be taken when all pending
644 /// [`ChannelMonitorUpdate`]s for the channel complete updating.
646 /// Note that because we generally only have one entry here a HashMap is pretty overkill. A
647 /// BTreeMap currently stores more than ten elements per leaf node, so even up to a few
648 /// channels with a peer this will just be one allocation and will amount to a linear list of
649 /// channels to walk, avoiding the whole hashing rigmarole.
651 /// Note that the channel may no longer exist. For example, if a channel was closed but we
652 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
653 /// for a missing channel. While a malicious peer could construct a second channel with the
654 /// same `temporary_channel_id` (or final `channel_id` in the case of 0conf channels or prior
655 /// to funding appearing on-chain), the downstream `ChannelMonitor` set is required to ensure
656 /// duplicates do not occur, so such channels should fail without a monitor update completing.
657 monitor_update_blocked_actions: BTreeMap<[u8; 32], Vec<MonitorUpdateCompletionAction>>,
658 /// If another channel's [`ChannelMonitorUpdate`] needs to complete before a channel we have
659 /// with this peer can complete an RAA [`ChannelMonitorUpdate`] (e.g. because the RAA update
660 /// will remove a preimage that needs to be durably in an upstream channel first), we put an
661 /// entry here to note that the channel with the key's ID is blocked on a set of actions.
662 actions_blocking_raa_monitor_updates: BTreeMap<[u8; 32], Vec<RAAMonitorUpdateBlockingAction>>,
663 /// The peer is currently connected (i.e. we've seen a
664 /// [`ChannelMessageHandler::peer_connected`] and no corresponding
665 /// [`ChannelMessageHandler::peer_disconnected`].
669 impl <Signer: ChannelSigner> PeerState<Signer> {
670 /// Indicates that a peer meets the criteria where we're ok to remove it from our storage.
671 /// If true is passed for `require_disconnected`, the function will return false if we haven't
672 /// disconnected from the node already, ie. `PeerState::is_connected` is set to `true`.
673 fn ok_to_remove(&self, require_disconnected: bool) -> bool {
674 if require_disconnected && self.is_connected {
677 self.channel_by_id.is_empty() && self.monitor_update_blocked_actions.is_empty()
678 && self.in_flight_monitor_updates.is_empty()
681 // Returns a count of all channels we have with this peer, including pending channels.
682 fn total_channel_count(&self) -> usize {
683 self.channel_by_id.len() +
684 self.outbound_v1_channel_by_id.len() +
685 self.inbound_v1_channel_by_id.len()
688 // Returns a bool indicating if the given `channel_id` matches a channel we have with this peer.
689 fn has_channel(&self, channel_id: &[u8; 32]) -> bool {
690 self.channel_by_id.contains_key(channel_id) ||
691 self.outbound_v1_channel_by_id.contains_key(channel_id) ||
692 self.inbound_v1_channel_by_id.contains_key(channel_id)
696 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
697 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
699 /// For users who don't want to bother doing their own payment preimage storage, we also store that
702 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
703 /// and instead encoding it in the payment secret.
704 struct PendingInboundPayment {
705 /// The payment secret that the sender must use for us to accept this payment
706 payment_secret: PaymentSecret,
707 /// Time at which this HTLC expires - blocks with a header time above this value will result in
708 /// this payment being removed.
710 /// Arbitrary identifier the user specifies (or not)
711 user_payment_id: u64,
712 // Other required attributes of the payment, optionally enforced:
713 payment_preimage: Option<PaymentPreimage>,
714 min_value_msat: Option<u64>,
717 /// [`SimpleArcChannelManager`] is useful when you need a [`ChannelManager`] with a static lifetime, e.g.
718 /// when you're using `lightning-net-tokio` (since `tokio::spawn` requires parameters with static
719 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
720 /// [`SimpleRefChannelManager`] is the more appropriate type. Defining these type aliases prevents
721 /// issues such as overly long function definitions. Note that the `ChannelManager` can take any type
722 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
723 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
724 /// of [`KeysManager`] and [`DefaultRouter`].
726 /// This is not exported to bindings users as Arcs don't make sense in bindings
727 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
735 Arc<NetworkGraph<Arc<L>>>,
737 Arc<Mutex<ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>>,
738 ProbabilisticScoringFeeParameters,
739 ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>,
744 /// [`SimpleRefChannelManager`] is a type alias for a ChannelManager reference, and is the reference
745 /// counterpart to the [`SimpleArcChannelManager`] type alias. Use this type by default when you don't
746 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
747 /// usage of lightning-net-tokio (since `tokio::spawn` requires parameters with static lifetimes).
748 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
749 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
750 /// that implements [`NodeSigner`], [`EntropySource`], and [`SignerProvider`] for its keys manager,
751 /// or, respectively, [`Router`] for its router, but this type alias chooses the concrete types
752 /// of [`KeysManager`] and [`DefaultRouter`].
754 /// This is not exported to bindings users as Arcs don't make sense in bindings
755 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> =
764 &'f NetworkGraph<&'g L>,
766 &'h Mutex<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>,
767 ProbabilisticScoringFeeParameters,
768 ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>
773 macro_rules! define_test_pub_trait { ($vis: vis) => {
774 /// A trivial trait which describes any [`ChannelManager`] used in testing.
775 $vis trait AChannelManager {
776 type Watch: chain::Watch<Self::Signer> + ?Sized;
777 type M: Deref<Target = Self::Watch>;
778 type Broadcaster: BroadcasterInterface + ?Sized;
779 type T: Deref<Target = Self::Broadcaster>;
780 type EntropySource: EntropySource + ?Sized;
781 type ES: Deref<Target = Self::EntropySource>;
782 type NodeSigner: NodeSigner + ?Sized;
783 type NS: Deref<Target = Self::NodeSigner>;
784 type Signer: WriteableEcdsaChannelSigner + Sized;
785 type SignerProvider: SignerProvider<Signer = Self::Signer> + ?Sized;
786 type SP: Deref<Target = Self::SignerProvider>;
787 type FeeEstimator: FeeEstimator + ?Sized;
788 type F: Deref<Target = Self::FeeEstimator>;
789 type Router: Router + ?Sized;
790 type R: Deref<Target = Self::Router>;
791 type Logger: Logger + ?Sized;
792 type L: Deref<Target = Self::Logger>;
793 fn get_cm(&self) -> &ChannelManager<Self::M, Self::T, Self::ES, Self::NS, Self::SP, Self::F, Self::R, Self::L>;
796 #[cfg(any(test, feature = "_test_utils"))]
797 define_test_pub_trait!(pub);
798 #[cfg(not(any(test, feature = "_test_utils")))]
799 define_test_pub_trait!(pub(crate));
800 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> AChannelManager
801 for ChannelManager<M, T, ES, NS, SP, F, R, L>
803 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
804 T::Target: BroadcasterInterface,
805 ES::Target: EntropySource,
806 NS::Target: NodeSigner,
807 SP::Target: SignerProvider,
808 F::Target: FeeEstimator,
812 type Watch = M::Target;
814 type Broadcaster = T::Target;
816 type EntropySource = ES::Target;
818 type NodeSigner = NS::Target;
820 type Signer = <SP::Target as SignerProvider>::Signer;
821 type SignerProvider = SP::Target;
823 type FeeEstimator = F::Target;
825 type Router = R::Target;
827 type Logger = L::Target;
829 fn get_cm(&self) -> &ChannelManager<M, T, ES, NS, SP, F, R, L> { self }
832 /// Manager which keeps track of a number of channels and sends messages to the appropriate
833 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
835 /// Implements [`ChannelMessageHandler`], handling the multi-channel parts and passing things through
836 /// to individual Channels.
838 /// Implements [`Writeable`] to write out all channel state to disk. Implies [`peer_disconnected`] for
839 /// all peers during write/read (though does not modify this instance, only the instance being
840 /// serialized). This will result in any channels which have not yet exchanged [`funding_created`] (i.e.,
841 /// called [`funding_transaction_generated`] for outbound channels) being closed.
843 /// Note that you can be a bit lazier about writing out `ChannelManager` than you can be with
844 /// [`ChannelMonitor`]. With [`ChannelMonitor`] you MUST write each monitor update out to disk before
845 /// returning from [`chain::Watch::watch_channel`]/[`update_channel`], with ChannelManagers, writing updates
846 /// happens out-of-band (and will prevent any other `ChannelManager` operations from occurring during
847 /// the serialization process). If the deserialized version is out-of-date compared to the
848 /// [`ChannelMonitor`] passed by reference to [`read`], those channels will be force-closed based on the
849 /// `ChannelMonitor` state and no funds will be lost (mod on-chain transaction fees).
851 /// Note that the deserializer is only implemented for `(`[`BlockHash`]`, `[`ChannelManager`]`)`, which
852 /// tells you the last block hash which was connected. You should get the best block tip before using the manager.
853 /// See [`chain::Listen`] and [`chain::Confirm`] for more details.
855 /// Note that `ChannelManager` is responsible for tracking liveness of its channels and generating
856 /// [`ChannelUpdate`] messages informing peers that the channel is temporarily disabled. To avoid
857 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
858 /// offline for a full minute. In order to track this, you must call
859 /// [`timer_tick_occurred`] roughly once per minute, though it doesn't have to be perfect.
861 /// To avoid trivial DoS issues, `ChannelManager` limits the number of inbound connections and
862 /// inbound channels without confirmed funding transactions. This may result in nodes which we do
863 /// not have a channel with being unable to connect to us or open new channels with us if we have
864 /// many peers with unfunded channels.
866 /// Because it is an indication of trust, inbound channels which we've accepted as 0conf are
867 /// exempted from the count of unfunded channels. Similarly, outbound channels and connections are
868 /// never limited. Please ensure you limit the count of such channels yourself.
870 /// Rather than using a plain `ChannelManager`, it is preferable to use either a [`SimpleArcChannelManager`]
871 /// a [`SimpleRefChannelManager`], for conciseness. See their documentation for more details, but
872 /// essentially you should default to using a [`SimpleRefChannelManager`], and use a
873 /// [`SimpleArcChannelManager`] when you require a `ChannelManager` with a static lifetime, such as when
874 /// you're using lightning-net-tokio.
876 /// [`peer_disconnected`]: msgs::ChannelMessageHandler::peer_disconnected
877 /// [`funding_created`]: msgs::FundingCreated
878 /// [`funding_transaction_generated`]: Self::funding_transaction_generated
879 /// [`BlockHash`]: bitcoin::hash_types::BlockHash
880 /// [`update_channel`]: chain::Watch::update_channel
881 /// [`ChannelUpdate`]: msgs::ChannelUpdate
882 /// [`timer_tick_occurred`]: Self::timer_tick_occurred
883 /// [`read`]: ReadableArgs::read
886 // The tree structure below illustrates the lock order requirements for the different locks of the
887 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
888 // and should then be taken in the order of the lowest to the highest level in the tree.
889 // Note that locks on different branches shall not be taken at the same time, as doing so will
890 // create a new lock order for those specific locks in the order they were taken.
894 // `total_consistency_lock`
896 // |__`forward_htlcs`
898 // | |__`pending_intercepted_htlcs`
900 // |__`per_peer_state`
902 // | |__`pending_inbound_payments`
904 // | |__`claimable_payments`
906 // | |__`pending_outbound_payments` // This field's struct contains a map of pending outbounds
912 // | |__`short_to_chan_info`
914 // | |__`outbound_scid_aliases`
918 // | |__`pending_events`
920 // | |__`pending_background_events`
922 pub struct ChannelManager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
924 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
925 T::Target: BroadcasterInterface,
926 ES::Target: EntropySource,
927 NS::Target: NodeSigner,
928 SP::Target: SignerProvider,
929 F::Target: FeeEstimator,
933 default_configuration: UserConfig,
934 genesis_hash: BlockHash,
935 fee_estimator: LowerBoundedFeeEstimator<F>,
941 /// See `ChannelManager` struct-level documentation for lock order requirements.
943 pub(super) best_block: RwLock<BestBlock>,
945 best_block: RwLock<BestBlock>,
946 secp_ctx: Secp256k1<secp256k1::All>,
948 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
949 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
950 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
951 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
953 /// See `ChannelManager` struct-level documentation for lock order requirements.
954 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
956 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
957 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
958 /// (if the channel has been force-closed), however we track them here to prevent duplicative
959 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
960 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
961 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
962 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
963 /// after reloading from disk while replaying blocks against ChannelMonitors.
965 /// See `PendingOutboundPayment` documentation for more info.
967 /// See `ChannelManager` struct-level documentation for lock order requirements.
968 pending_outbound_payments: OutboundPayments,
970 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
972 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
973 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
974 /// and via the classic SCID.
976 /// Note that no consistency guarantees are made about the existence of a channel with the
977 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
979 /// See `ChannelManager` struct-level documentation for lock order requirements.
981 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
983 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
984 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
985 /// until the user tells us what we should do with them.
987 /// See `ChannelManager` struct-level documentation for lock order requirements.
988 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
990 /// The sets of payments which are claimable or currently being claimed. See
991 /// [`ClaimablePayments`]' individual field docs for more info.
993 /// See `ChannelManager` struct-level documentation for lock order requirements.
994 claimable_payments: Mutex<ClaimablePayments>,
996 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
997 /// and some closed channels which reached a usable state prior to being closed. This is used
998 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
999 /// active channel list on load.
1001 /// See `ChannelManager` struct-level documentation for lock order requirements.
1002 outbound_scid_aliases: Mutex<HashSet<u64>>,
1004 /// `channel_id` -> `counterparty_node_id`.
1006 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
1007 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
1008 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
1010 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
1011 /// the corresponding channel for the event, as we only have access to the `channel_id` during
1012 /// the handling of the events.
1014 /// Note that no consistency guarantees are made about the existence of a peer with the
1015 /// `counterparty_node_id` in our other maps.
1018 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
1019 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
1020 /// would break backwards compatability.
1021 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
1022 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
1023 /// required to access the channel with the `counterparty_node_id`.
1025 /// See `ChannelManager` struct-level documentation for lock order requirements.
1026 id_to_peer: Mutex<HashMap<[u8; 32], PublicKey>>,
1028 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
1030 /// Outbound SCID aliases are added here once the channel is available for normal use, with
1031 /// SCIDs being added once the funding transaction is confirmed at the channel's required
1032 /// confirmation depth.
1034 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
1035 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
1036 /// channel with the `channel_id` in our other maps.
1038 /// See `ChannelManager` struct-level documentation for lock order requirements.
1040 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
1042 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
1044 our_network_pubkey: PublicKey,
1046 inbound_payment_key: inbound_payment::ExpandedKey,
1048 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
1049 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
1050 /// we encrypt the namespace identifier using these bytes.
1052 /// [fake scids]: crate::util::scid_utils::fake_scid
1053 fake_scid_rand_bytes: [u8; 32],
1055 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
1056 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
1057 /// keeping additional state.
1058 probing_cookie_secret: [u8; 32],
1060 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
1061 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
1062 /// very far in the past, and can only ever be up to two hours in the future.
1063 highest_seen_timestamp: AtomicUsize,
1065 /// The bulk of our storage. Currently the `per_peer_state` stores our channels on a per-peer
1066 /// basis, as well as the peer's latest features.
1068 /// If we are connected to a peer we always at least have an entry here, even if no channels
1069 /// are currently open with that peer.
1071 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
1072 /// operate on the inner value freely. This opens up for parallel per-peer operation for
1075 /// Note that the same thread must never acquire two inner `PeerState` locks at the same time.
1077 /// See `ChannelManager` struct-level documentation for lock order requirements.
1078 #[cfg(not(any(test, feature = "_test_utils")))]
1079 per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>>>,
1080 #[cfg(any(test, feature = "_test_utils"))]
1081 pub(super) per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>>>,
1083 /// The set of events which we need to give to the user to handle. In some cases an event may
1084 /// require some further action after the user handles it (currently only blocking a monitor
1085 /// update from being handed to the user to ensure the included changes to the channel state
1086 /// are handled by the user before they're persisted durably to disk). In that case, the second
1087 /// element in the tuple is set to `Some` with further details of the action.
1089 /// Note that events MUST NOT be removed from pending_events after deserialization, as they
1090 /// could be in the middle of being processed without the direct mutex held.
1092 /// See `ChannelManager` struct-level documentation for lock order requirements.
1093 pending_events: Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1094 /// A simple atomic flag to ensure only one task at a time can be processing events asynchronously.
1095 pending_events_processor: AtomicBool,
1097 /// If we are running during init (either directly during the deserialization method or in
1098 /// block connection methods which run after deserialization but before normal operation) we
1099 /// cannot provide the user with [`ChannelMonitorUpdate`]s through the normal update flow -
1100 /// prior to normal operation the user may not have loaded the [`ChannelMonitor`]s into their
1101 /// [`ChainMonitor`] and thus attempting to update it will fail or panic.
1103 /// Thus, we place them here to be handled as soon as possible once we are running normally.
1105 /// See `ChannelManager` struct-level documentation for lock order requirements.
1107 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
1108 pending_background_events: Mutex<Vec<BackgroundEvent>>,
1109 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
1110 /// Essentially just when we're serializing ourselves out.
1111 /// Taken first everywhere where we are making changes before any other locks.
1112 /// When acquiring this lock in read mode, rather than acquiring it directly, call
1113 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
1114 /// Notifier the lock contains sends out a notification when the lock is released.
1115 total_consistency_lock: RwLock<()>,
1117 background_events_processed_since_startup: AtomicBool,
1119 persistence_notifier: Notifier,
1123 signer_provider: SP,
1128 /// Chain-related parameters used to construct a new `ChannelManager`.
1130 /// Typically, the block-specific parameters are derived from the best block hash for the network,
1131 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
1132 /// are not needed when deserializing a previously constructed `ChannelManager`.
1133 #[derive(Clone, Copy, PartialEq)]
1134 pub struct ChainParameters {
1135 /// The network for determining the `chain_hash` in Lightning messages.
1136 pub network: Network,
1138 /// The hash and height of the latest block successfully connected.
1140 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
1141 pub best_block: BestBlock,
1144 #[derive(Copy, Clone, PartialEq)]
1151 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
1152 /// desirable to notify any listeners on `await_persistable_update_timeout`/
1153 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
1154 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
1155 /// sending the aforementioned notification (since the lock being released indicates that the
1156 /// updates are ready for persistence).
1158 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
1159 /// notify or not based on whether relevant changes have been made, providing a closure to
1160 /// `optionally_notify` which returns a `NotifyOption`.
1161 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
1162 persistence_notifier: &'a Notifier,
1164 // We hold onto this result so the lock doesn't get released immediately.
1165 _read_guard: RwLockReadGuard<'a, ()>,
1168 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
1169 fn notify_on_drop<C: AChannelManager>(cm: &'a C) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
1170 let read_guard = cm.get_cm().total_consistency_lock.read().unwrap();
1171 let _ = cm.get_cm().process_background_events(); // We always persist
1173 PersistenceNotifierGuard {
1174 persistence_notifier: &cm.get_cm().persistence_notifier,
1175 should_persist: || -> NotifyOption { NotifyOption::DoPersist },
1176 _read_guard: read_guard,
1181 /// Note that if any [`ChannelMonitorUpdate`]s are possibly generated,
1182 /// [`ChannelManager::process_background_events`] MUST be called first.
1183 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a Notifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
1184 let read_guard = lock.read().unwrap();
1186 PersistenceNotifierGuard {
1187 persistence_notifier: notifier,
1188 should_persist: persist_check,
1189 _read_guard: read_guard,
1194 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
1195 fn drop(&mut self) {
1196 if (self.should_persist)() == NotifyOption::DoPersist {
1197 self.persistence_notifier.notify();
1202 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
1203 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
1205 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
1207 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
1208 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
1209 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
1210 /// the maximum required amount in lnd as of March 2021.
1211 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
1213 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
1214 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
1216 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
1218 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
1219 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
1220 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
1221 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
1222 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
1223 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
1224 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
1225 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
1226 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
1227 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
1228 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
1229 // routing failure for any HTLC sender picking up an LDK node among the first hops.
1230 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
1232 /// Minimum CLTV difference between the current block height and received inbound payments.
1233 /// Invoices generated for payment to us must set their `min_final_cltv_expiry_delta` field to at least
1235 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
1236 // any payments to succeed. Further, we don't want payments to fail if a block was found while
1237 // a payment was being routed, so we add an extra block to be safe.
1238 pub const MIN_FINAL_CLTV_EXPIRY_DELTA: u16 = HTLC_FAIL_BACK_BUFFER as u16 + 3;
1240 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
1241 // ie that if the next-hop peer fails the HTLC within
1242 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
1243 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
1244 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
1245 // LATENCY_GRACE_PERIOD_BLOCKS.
1248 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;
1250 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
1251 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
1254 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
1256 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
1257 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
1259 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until we time-out the
1260 /// idempotency of payments by [`PaymentId`]. See
1261 /// [`OutboundPayments::remove_stale_resolved_payments`].
1262 pub(crate) const IDEMPOTENCY_TIMEOUT_TICKS: u8 = 7;
1264 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is disconnected
1265 /// until we mark the channel disabled and gossip the update.
1266 pub(crate) const DISABLE_GOSSIP_TICKS: u8 = 10;
1268 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] where a peer is connected until
1269 /// we mark the channel enabled and gossip the update.
1270 pub(crate) const ENABLE_GOSSIP_TICKS: u8 = 5;
1272 /// The maximum number of unfunded channels we can have per-peer before we start rejecting new
1273 /// (inbound) ones. The number of peers with unfunded channels is limited separately in
1274 /// [`MAX_UNFUNDED_CHANNEL_PEERS`].
1275 const MAX_UNFUNDED_CHANS_PER_PEER: usize = 4;
1277 /// The maximum number of peers from which we will allow pending unfunded channels. Once we reach
1278 /// this many peers we reject new (inbound) channels from peers with which we don't have a channel.
1279 const MAX_UNFUNDED_CHANNEL_PEERS: usize = 50;
1281 /// The maximum number of peers which we do not have a (funded) channel with. Once we reach this
1282 /// many peers we reject new (inbound) connections.
1283 const MAX_NO_CHANNEL_PEERS: usize = 250;
1285 /// Information needed for constructing an invoice route hint for this channel.
1286 #[derive(Clone, Debug, PartialEq)]
1287 pub struct CounterpartyForwardingInfo {
1288 /// Base routing fee in millisatoshis.
1289 pub fee_base_msat: u32,
1290 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
1291 pub fee_proportional_millionths: u32,
1292 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
1293 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
1294 /// `cltv_expiry_delta` for more details.
1295 pub cltv_expiry_delta: u16,
1298 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
1299 /// to better separate parameters.
1300 #[derive(Clone, Debug, PartialEq)]
1301 pub struct ChannelCounterparty {
1302 /// The node_id of our counterparty
1303 pub node_id: PublicKey,
1304 /// The Features the channel counterparty provided upon last connection.
1305 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
1306 /// many routing-relevant features are present in the init context.
1307 pub features: InitFeatures,
1308 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
1309 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
1310 /// claiming at least this value on chain.
1312 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
1314 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
1315 pub unspendable_punishment_reserve: u64,
1316 /// Information on the fees and requirements that the counterparty requires when forwarding
1317 /// payments to us through this channel.
1318 pub forwarding_info: Option<CounterpartyForwardingInfo>,
1319 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
1320 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
1321 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
1322 pub outbound_htlc_minimum_msat: Option<u64>,
1323 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
1324 pub outbound_htlc_maximum_msat: Option<u64>,
1327 /// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
1328 #[derive(Clone, Debug, PartialEq)]
1329 pub struct ChannelDetails {
1330 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
1331 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
1332 /// Note that this means this value is *not* persistent - it can change once during the
1333 /// lifetime of the channel.
1334 pub channel_id: [u8; 32],
1335 /// Parameters which apply to our counterparty. See individual fields for more information.
1336 pub counterparty: ChannelCounterparty,
1337 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
1338 /// our counterparty already.
1340 /// Note that, if this has been set, `channel_id` will be equivalent to
1341 /// `funding_txo.unwrap().to_channel_id()`.
1342 pub funding_txo: Option<OutPoint>,
1343 /// The features which this channel operates with. See individual features for more info.
1345 /// `None` until negotiation completes and the channel type is finalized.
1346 pub channel_type: Option<ChannelTypeFeatures>,
1347 /// The position of the funding transaction in the chain. None if the funding transaction has
1348 /// not yet been confirmed and the channel fully opened.
1350 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1351 /// payments instead of this. See [`get_inbound_payment_scid`].
1353 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1354 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1356 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1357 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1358 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1359 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1360 /// [`confirmations_required`]: Self::confirmations_required
1361 pub short_channel_id: Option<u64>,
1362 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1363 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1364 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1367 /// This will be `None` as long as the channel is not available for routing outbound payments.
1369 /// [`short_channel_id`]: Self::short_channel_id
1370 /// [`confirmations_required`]: Self::confirmations_required
1371 pub outbound_scid_alias: Option<u64>,
1372 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1373 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1374 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1375 /// when they see a payment to be routed to us.
1377 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1378 /// previous values for inbound payment forwarding.
1380 /// [`short_channel_id`]: Self::short_channel_id
1381 pub inbound_scid_alias: Option<u64>,
1382 /// The value, in satoshis, of this channel as appears in the funding output
1383 pub channel_value_satoshis: u64,
1384 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1385 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1386 /// this value on chain.
1388 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1390 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1392 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1393 pub unspendable_punishment_reserve: Option<u64>,
1394 /// The `user_channel_id` passed in to create_channel, or a random value if the channel was
1395 /// inbound. This may be zero for inbound channels serialized with LDK versions prior to
1397 pub user_channel_id: u128,
1398 /// The currently negotiated fee rate denominated in satoshi per 1000 weight units,
1399 /// which is applied to commitment and HTLC transactions.
1401 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
1402 pub feerate_sat_per_1000_weight: Option<u32>,
1403 /// Our total balance. This is the amount we would get if we close the channel.
1404 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1405 /// amount is not likely to be recoverable on close.
1407 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1408 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1409 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1410 /// This does not consider any on-chain fees.
1412 /// See also [`ChannelDetails::outbound_capacity_msat`]
1413 pub balance_msat: u64,
1414 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1415 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1416 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1417 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1419 /// See also [`ChannelDetails::balance_msat`]
1421 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1422 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1423 /// should be able to spend nearly this amount.
1424 pub outbound_capacity_msat: u64,
1425 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1426 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1427 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1428 /// to use a limit as close as possible to the HTLC limit we can currently send.
1430 /// See also [`ChannelDetails::next_outbound_htlc_minimum_msat`],
1431 /// [`ChannelDetails::balance_msat`], and [`ChannelDetails::outbound_capacity_msat`].
1432 pub next_outbound_htlc_limit_msat: u64,
1433 /// The minimum value for sending a single HTLC to the remote peer. This is the equivalent of
1434 /// [`ChannelDetails::next_outbound_htlc_limit_msat`] but represents a lower-bound, rather than
1435 /// an upper-bound. This is intended for use when routing, allowing us to ensure we pick a
1436 /// route which is valid.
1437 pub next_outbound_htlc_minimum_msat: u64,
1438 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1439 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1440 /// available for inclusion in new inbound HTLCs).
1441 /// Note that there are some corner cases not fully handled here, so the actual available
1442 /// inbound capacity may be slightly higher than this.
1444 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1445 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1446 /// However, our counterparty should be able to spend nearly this amount.
1447 pub inbound_capacity_msat: u64,
1448 /// The number of required confirmations on the funding transaction before the funding will be
1449 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1450 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1451 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1452 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1454 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1456 /// [`is_outbound`]: ChannelDetails::is_outbound
1457 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1458 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1459 pub confirmations_required: Option<u32>,
1460 /// The current number of confirmations on the funding transaction.
1462 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1463 pub confirmations: Option<u32>,
1464 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1465 /// until we can claim our funds after we force-close the channel. During this time our
1466 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1467 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1468 /// time to claim our non-HTLC-encumbered funds.
1470 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1471 pub force_close_spend_delay: Option<u16>,
1472 /// True if the channel was initiated (and thus funded) by us.
1473 pub is_outbound: bool,
1474 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1475 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1476 /// required confirmation count has been reached (and we were connected to the peer at some
1477 /// point after the funding transaction received enough confirmations). The required
1478 /// confirmation count is provided in [`confirmations_required`].
1480 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1481 pub is_channel_ready: bool,
1482 /// The stage of the channel's shutdown.
1483 /// `None` for `ChannelDetails` serialized on LDK versions prior to 0.0.116.
1484 pub channel_shutdown_state: Option<ChannelShutdownState>,
1485 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1486 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1488 /// This is a strict superset of `is_channel_ready`.
1489 pub is_usable: bool,
1490 /// True if this channel is (or will be) publicly-announced.
1491 pub is_public: bool,
1492 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1493 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1494 pub inbound_htlc_minimum_msat: Option<u64>,
1495 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1496 pub inbound_htlc_maximum_msat: Option<u64>,
1497 /// Set of configurable parameters that affect channel operation.
1499 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1500 pub config: Option<ChannelConfig>,
1503 impl ChannelDetails {
1504 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1505 /// This should be used for providing invoice hints or in any other context where our
1506 /// counterparty will forward a payment to us.
1508 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1509 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1510 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1511 self.inbound_scid_alias.or(self.short_channel_id)
1514 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1515 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1516 /// we're sending or forwarding a payment outbound over this channel.
1518 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1519 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1520 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1521 self.short_channel_id.or(self.outbound_scid_alias)
1524 fn from_channel_context<Signer: WriteableEcdsaChannelSigner, F: Deref>(
1525 context: &ChannelContext<Signer>, best_block_height: u32, latest_features: InitFeatures,
1526 fee_estimator: &LowerBoundedFeeEstimator<F>
1528 where F::Target: FeeEstimator
1530 let balance = context.get_available_balances(fee_estimator);
1531 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1532 context.get_holder_counterparty_selected_channel_reserve_satoshis();
1534 channel_id: context.channel_id(),
1535 counterparty: ChannelCounterparty {
1536 node_id: context.get_counterparty_node_id(),
1537 features: latest_features,
1538 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1539 forwarding_info: context.counterparty_forwarding_info(),
1540 // Ensures that we have actually received the `htlc_minimum_msat` value
1541 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1542 // message (as they are always the first message from the counterparty).
1543 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1544 // default `0` value set by `Channel::new_outbound`.
1545 outbound_htlc_minimum_msat: if context.have_received_message() {
1546 Some(context.get_counterparty_htlc_minimum_msat()) } else { None },
1547 outbound_htlc_maximum_msat: context.get_counterparty_htlc_maximum_msat(),
1549 funding_txo: context.get_funding_txo(),
1550 // Note that accept_channel (or open_channel) is always the first message, so
1551 // `have_received_message` indicates that type negotiation has completed.
1552 channel_type: if context.have_received_message() { Some(context.get_channel_type().clone()) } else { None },
1553 short_channel_id: context.get_short_channel_id(),
1554 outbound_scid_alias: if context.is_usable() { Some(context.outbound_scid_alias()) } else { None },
1555 inbound_scid_alias: context.latest_inbound_scid_alias(),
1556 channel_value_satoshis: context.get_value_satoshis(),
1557 feerate_sat_per_1000_weight: Some(context.get_feerate_sat_per_1000_weight()),
1558 unspendable_punishment_reserve: to_self_reserve_satoshis,
1559 balance_msat: balance.balance_msat,
1560 inbound_capacity_msat: balance.inbound_capacity_msat,
1561 outbound_capacity_msat: balance.outbound_capacity_msat,
1562 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1563 next_outbound_htlc_minimum_msat: balance.next_outbound_htlc_minimum_msat,
1564 user_channel_id: context.get_user_id(),
1565 confirmations_required: context.minimum_depth(),
1566 confirmations: Some(context.get_funding_tx_confirmations(best_block_height)),
1567 force_close_spend_delay: context.get_counterparty_selected_contest_delay(),
1568 is_outbound: context.is_outbound(),
1569 is_channel_ready: context.is_usable(),
1570 is_usable: context.is_live(),
1571 is_public: context.should_announce(),
1572 inbound_htlc_minimum_msat: Some(context.get_holder_htlc_minimum_msat()),
1573 inbound_htlc_maximum_msat: context.get_holder_htlc_maximum_msat(),
1574 config: Some(context.config()),
1575 channel_shutdown_state: Some(context.shutdown_state()),
1580 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
1581 /// Further information on the details of the channel shutdown.
1582 /// Upon channels being forced closed (i.e. commitment transaction confirmation detected
1583 /// by `ChainMonitor`), ChannelShutdownState will be set to `ShutdownComplete` or
1584 /// the channel will be removed shortly.
1585 /// Also note, that in normal operation, peers could disconnect at any of these states
1586 /// and require peer re-connection before making progress onto other states
1587 pub enum ChannelShutdownState {
1588 /// Channel has not sent or received a shutdown message.
1590 /// Local node has sent a shutdown message for this channel.
1592 /// Shutdown message exchanges have concluded and the channels are in the midst of
1593 /// resolving all existing open HTLCs before closing can continue.
1595 /// All HTLCs have been resolved, nodes are currently negotiating channel close onchain fee rates.
1596 NegotiatingClosingFee,
1597 /// We've successfully negotiated a closing_signed dance. At this point `ChannelManager` is about
1598 /// to drop the channel.
1602 /// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
1603 /// These include payments that have yet to find a successful path, or have unresolved HTLCs.
1604 #[derive(Debug, PartialEq)]
1605 pub enum RecentPaymentDetails {
1606 /// When a payment is still being sent and awaiting successful delivery.
1608 /// Hash of the payment that is currently being sent but has yet to be fulfilled or
1610 payment_hash: PaymentHash,
1611 /// Total amount (in msat, excluding fees) across all paths for this payment,
1612 /// not just the amount currently inflight.
1615 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
1616 /// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
1617 /// payment is removed from tracking.
1619 /// Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
1620 /// made before LDK version 0.0.104.
1621 payment_hash: Option<PaymentHash>,
1623 /// After a payment's retries are exhausted per the provided [`Retry`], or it is explicitly
1624 /// abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
1625 /// pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
1627 /// Hash of the payment that we have given up trying to send.
1628 payment_hash: PaymentHash,
1632 /// Route hints used in constructing invoices for [phantom node payents].
1634 /// [phantom node payments]: crate::sign::PhantomKeysManager
1636 pub struct PhantomRouteHints {
1637 /// The list of channels to be included in the invoice route hints.
1638 pub channels: Vec<ChannelDetails>,
1639 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1641 pub phantom_scid: u64,
1642 /// The pubkey of the real backing node that would ultimately receive the payment.
1643 pub real_node_pubkey: PublicKey,
1646 macro_rules! handle_error {
1647 ($self: ident, $internal: expr, $counterparty_node_id: expr) => { {
1648 // In testing, ensure there are no deadlocks where the lock is already held upon
1649 // entering the macro.
1650 debug_assert_ne!($self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
1651 debug_assert_ne!($self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
1655 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish }) => {
1656 let mut msg_events = Vec::with_capacity(2);
1658 if let Some((shutdown_res, update_option)) = shutdown_finish {
1659 $self.finish_force_close_channel(shutdown_res);
1660 if let Some(update) = update_option {
1661 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1665 if let Some((channel_id, user_channel_id)) = chan_id {
1666 $self.pending_events.lock().unwrap().push_back((events::Event::ChannelClosed {
1667 channel_id, user_channel_id,
1668 reason: ClosureReason::ProcessingError { err: err.err.clone() }
1673 log_error!($self.logger, "{}", err.err);
1674 if let msgs::ErrorAction::IgnoreError = err.action {
1676 msg_events.push(events::MessageSendEvent::HandleError {
1677 node_id: $counterparty_node_id,
1678 action: err.action.clone()
1682 if !msg_events.is_empty() {
1683 let per_peer_state = $self.per_peer_state.read().unwrap();
1684 if let Some(peer_state_mutex) = per_peer_state.get(&$counterparty_node_id) {
1685 let mut peer_state = peer_state_mutex.lock().unwrap();
1686 peer_state.pending_msg_events.append(&mut msg_events);
1690 // Return error in case higher-API need one
1695 ($self: ident, $internal: expr) => {
1698 Err((chan, msg_handle_err)) => {
1699 let counterparty_node_id = chan.get_counterparty_node_id();
1700 handle_error!($self, Err(msg_handle_err), counterparty_node_id).map_err(|err| (chan, err))
1706 macro_rules! update_maps_on_chan_removal {
1707 ($self: expr, $channel_context: expr) => {{
1708 $self.id_to_peer.lock().unwrap().remove(&$channel_context.channel_id());
1709 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1710 if let Some(short_id) = $channel_context.get_short_channel_id() {
1711 short_to_chan_info.remove(&short_id);
1713 // If the channel was never confirmed on-chain prior to its closure, remove the
1714 // outbound SCID alias we used for it from the collision-prevention set. While we
1715 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1716 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1717 // opening a million channels with us which are closed before we ever reach the funding
1719 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel_context.outbound_scid_alias());
1720 debug_assert!(alias_removed);
1722 short_to_chan_info.remove(&$channel_context.outbound_scid_alias());
1726 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1727 macro_rules! convert_chan_err {
1728 ($self: ident, $err: expr, $channel: expr, $channel_id: expr) => {
1730 ChannelError::Warn(msg) => {
1731 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), $channel_id.clone()))
1733 ChannelError::Ignore(msg) => {
1734 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
1736 ChannelError::Close(msg) => {
1737 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
1738 update_maps_on_chan_removal!($self, &$channel.context);
1739 let shutdown_res = $channel.context.force_shutdown(true);
1740 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.context.get_user_id(),
1741 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
1745 ($self: ident, $err: expr, $channel_context: expr, $channel_id: expr, PREFUNDED) => {
1747 // We should only ever have `ChannelError::Close` when prefunded channels error.
1748 // In any case, just close the channel.
1749 ChannelError::Warn(msg) | ChannelError::Ignore(msg) | ChannelError::Close(msg) => {
1750 log_error!($self.logger, "Closing prefunded channel {} due to an error: {}", log_bytes!($channel_id[..]), msg);
1751 update_maps_on_chan_removal!($self, &$channel_context);
1752 let shutdown_res = $channel_context.force_shutdown(false);
1753 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel_context.get_user_id(),
1754 shutdown_res, None))
1760 macro_rules! break_chan_entry {
1761 ($self: ident, $res: expr, $entry: expr) => {
1765 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1767 $entry.remove_entry();
1775 macro_rules! try_v1_outbound_chan_entry {
1776 ($self: ident, $res: expr, $entry: expr) => {
1780 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut().context, $entry.key(), PREFUNDED);
1782 $entry.remove_entry();
1790 macro_rules! try_chan_entry {
1791 ($self: ident, $res: expr, $entry: expr) => {
1795 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1797 $entry.remove_entry();
1805 macro_rules! remove_channel {
1806 ($self: expr, $entry: expr) => {
1808 let channel = $entry.remove_entry().1;
1809 update_maps_on_chan_removal!($self, &channel.context);
1815 macro_rules! send_channel_ready {
1816 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
1817 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1818 node_id: $channel.context.get_counterparty_node_id(),
1819 msg: $channel_ready_msg,
1821 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1822 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1823 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1824 let outbound_alias_insert = short_to_chan_info.insert($channel.context.outbound_scid_alias(), ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
1825 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
1826 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1827 if let Some(real_scid) = $channel.context.get_short_channel_id() {
1828 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()));
1829 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.context.get_counterparty_node_id(), $channel.context.channel_id()),
1830 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1835 macro_rules! emit_channel_pending_event {
1836 ($locked_events: expr, $channel: expr) => {
1837 if $channel.context.should_emit_channel_pending_event() {
1838 $locked_events.push_back((events::Event::ChannelPending {
1839 channel_id: $channel.context.channel_id(),
1840 former_temporary_channel_id: $channel.context.temporary_channel_id(),
1841 counterparty_node_id: $channel.context.get_counterparty_node_id(),
1842 user_channel_id: $channel.context.get_user_id(),
1843 funding_txo: $channel.context.get_funding_txo().unwrap().into_bitcoin_outpoint(),
1845 $channel.context.set_channel_pending_event_emitted();
1850 macro_rules! emit_channel_ready_event {
1851 ($locked_events: expr, $channel: expr) => {
1852 if $channel.context.should_emit_channel_ready_event() {
1853 debug_assert!($channel.context.channel_pending_event_emitted());
1854 $locked_events.push_back((events::Event::ChannelReady {
1855 channel_id: $channel.context.channel_id(),
1856 user_channel_id: $channel.context.get_user_id(),
1857 counterparty_node_id: $channel.context.get_counterparty_node_id(),
1858 channel_type: $channel.context.get_channel_type().clone(),
1860 $channel.context.set_channel_ready_event_emitted();
1865 macro_rules! handle_monitor_update_completion {
1866 ($self: ident, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
1867 let mut updates = $chan.monitor_updating_restored(&$self.logger,
1868 &$self.node_signer, $self.genesis_hash, &$self.default_configuration,
1869 $self.best_block.read().unwrap().height());
1870 let counterparty_node_id = $chan.context.get_counterparty_node_id();
1871 let channel_update = if updates.channel_ready.is_some() && $chan.context.is_usable() {
1872 // We only send a channel_update in the case where we are just now sending a
1873 // channel_ready and the channel is in a usable state. We may re-send a
1874 // channel_update later through the announcement_signatures process for public
1875 // channels, but there's no reason not to just inform our counterparty of our fees
1877 if let Ok(msg) = $self.get_channel_update_for_unicast($chan) {
1878 Some(events::MessageSendEvent::SendChannelUpdate {
1879 node_id: counterparty_node_id,
1885 let update_actions = $peer_state.monitor_update_blocked_actions
1886 .remove(&$chan.context.channel_id()).unwrap_or(Vec::new());
1888 let htlc_forwards = $self.handle_channel_resumption(
1889 &mut $peer_state.pending_msg_events, $chan, updates.raa,
1890 updates.commitment_update, updates.order, updates.accepted_htlcs,
1891 updates.funding_broadcastable, updates.channel_ready,
1892 updates.announcement_sigs);
1893 if let Some(upd) = channel_update {
1894 $peer_state.pending_msg_events.push(upd);
1897 let channel_id = $chan.context.channel_id();
1898 core::mem::drop($peer_state_lock);
1899 core::mem::drop($per_peer_state_lock);
1901 $self.handle_monitor_update_completion_actions(update_actions);
1903 if let Some(forwards) = htlc_forwards {
1904 $self.forward_htlcs(&mut [forwards][..]);
1906 $self.finalize_claims(updates.finalized_claimed_htlcs);
1907 for failure in updates.failed_htlcs.drain(..) {
1908 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
1909 $self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
1914 macro_rules! handle_new_monitor_update {
1915 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr, _internal, $remove: expr, $completed: expr) => { {
1916 // update_maps_on_chan_removal needs to be able to take id_to_peer, so make sure we can in
1917 // any case so that it won't deadlock.
1918 debug_assert_ne!($self.id_to_peer.held_by_thread(), LockHeldState::HeldByThread);
1919 debug_assert!($self.background_events_processed_since_startup.load(Ordering::Acquire));
1921 ChannelMonitorUpdateStatus::InProgress => {
1922 log_debug!($self.logger, "ChannelMonitor update for {} in flight, holding messages until the update completes.",
1923 log_bytes!($chan.context.channel_id()[..]));
1926 ChannelMonitorUpdateStatus::PermanentFailure => {
1927 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateStatus::PermanentFailure",
1928 log_bytes!($chan.context.channel_id()[..]));
1929 update_maps_on_chan_removal!($self, &$chan.context);
1930 let res = Err(MsgHandleErrInternal::from_finish_shutdown(
1931 "ChannelMonitor storage failure".to_owned(), $chan.context.channel_id(),
1932 $chan.context.get_user_id(), $chan.context.force_shutdown(false),
1933 $self.get_channel_update_for_broadcast(&$chan).ok()));
1937 ChannelMonitorUpdateStatus::Completed => {
1943 ($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) => {
1944 handle_new_monitor_update!($self, $update_res, $peer_state_lock, $peer_state,
1945 $per_peer_state_lock, $chan, _internal, $remove,
1946 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan))
1948 ($self: ident, $update_res: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan_entry: expr, INITIAL_MONITOR) => {
1949 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())
1951 ($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) => { {
1952 let in_flight_updates = $peer_state.in_flight_monitor_updates.entry($funding_txo)
1953 .or_insert_with(Vec::new);
1954 // During startup, we push monitor updates as background events through to here in
1955 // order to replay updates that were in-flight when we shut down. Thus, we have to
1956 // filter for uniqueness here.
1957 let idx = in_flight_updates.iter().position(|upd| upd == &$update)
1958 .unwrap_or_else(|| {
1959 in_flight_updates.push($update);
1960 in_flight_updates.len() - 1
1962 let update_res = $self.chain_monitor.update_channel($funding_txo, &in_flight_updates[idx]);
1963 handle_new_monitor_update!($self, update_res, $peer_state_lock, $peer_state,
1964 $per_peer_state_lock, $chan, _internal, $remove,
1966 let _ = in_flight_updates.remove(idx);
1967 if in_flight_updates.is_empty() && $chan.blocked_monitor_updates_pending() == 0 {
1968 handle_monitor_update_completion!($self, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan);
1972 ($self: ident, $funding_txo: expr, $update: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan_entry: expr) => {
1973 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())
1977 macro_rules! process_events_body {
1978 ($self: expr, $event_to_handle: expr, $handle_event: expr) => {
1979 let mut processed_all_events = false;
1980 while !processed_all_events {
1981 if $self.pending_events_processor.compare_exchange(false, true, Ordering::Acquire, Ordering::Relaxed).is_err() {
1985 let mut result = NotifyOption::SkipPersist;
1988 // We'll acquire our total consistency lock so that we can be sure no other
1989 // persists happen while processing monitor events.
1990 let _read_guard = $self.total_consistency_lock.read().unwrap();
1992 // Because `handle_post_event_actions` may send `ChannelMonitorUpdate`s to the user we must
1993 // ensure any startup-generated background events are handled first.
1994 if $self.process_background_events() == NotifyOption::DoPersist { result = NotifyOption::DoPersist; }
1996 // TODO: This behavior should be documented. It's unintuitive that we query
1997 // ChannelMonitors when clearing other events.
1998 if $self.process_pending_monitor_events() {
1999 result = NotifyOption::DoPersist;
2003 let pending_events = $self.pending_events.lock().unwrap().clone();
2004 let num_events = pending_events.len();
2005 if !pending_events.is_empty() {
2006 result = NotifyOption::DoPersist;
2009 let mut post_event_actions = Vec::new();
2011 for (event, action_opt) in pending_events {
2012 $event_to_handle = event;
2014 if let Some(action) = action_opt {
2015 post_event_actions.push(action);
2020 let mut pending_events = $self.pending_events.lock().unwrap();
2021 pending_events.drain(..num_events);
2022 processed_all_events = pending_events.is_empty();
2023 $self.pending_events_processor.store(false, Ordering::Release);
2026 if !post_event_actions.is_empty() {
2027 $self.handle_post_event_actions(post_event_actions);
2028 // If we had some actions, go around again as we may have more events now
2029 processed_all_events = false;
2032 if result == NotifyOption::DoPersist {
2033 $self.persistence_notifier.notify();
2039 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>
2041 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
2042 T::Target: BroadcasterInterface,
2043 ES::Target: EntropySource,
2044 NS::Target: NodeSigner,
2045 SP::Target: SignerProvider,
2046 F::Target: FeeEstimator,
2050 /// Constructs a new `ChannelManager` to hold several channels and route between them.
2052 /// The current time or latest block header time can be provided as the `current_timestamp`.
2054 /// This is the main "logic hub" for all channel-related actions, and implements
2055 /// [`ChannelMessageHandler`].
2057 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
2059 /// Users need to notify the new `ChannelManager` when a new block is connected or
2060 /// disconnected using its [`block_connected`] and [`block_disconnected`] methods, starting
2061 /// from after [`params.best_block.block_hash`]. See [`chain::Listen`] and [`chain::Confirm`] for
2064 /// [`block_connected`]: chain::Listen::block_connected
2065 /// [`block_disconnected`]: chain::Listen::block_disconnected
2066 /// [`params.best_block.block_hash`]: chain::BestBlock::block_hash
2068 fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, entropy_source: ES,
2069 node_signer: NS, signer_provider: SP, config: UserConfig, params: ChainParameters,
2070 current_timestamp: u32,
2072 let mut secp_ctx = Secp256k1::new();
2073 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
2074 let inbound_pmt_key_material = node_signer.get_inbound_payment_key_material();
2075 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
2077 default_configuration: config.clone(),
2078 genesis_hash: genesis_block(params.network).header.block_hash(),
2079 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
2084 best_block: RwLock::new(params.best_block),
2086 outbound_scid_aliases: Mutex::new(HashSet::new()),
2087 pending_inbound_payments: Mutex::new(HashMap::new()),
2088 pending_outbound_payments: OutboundPayments::new(),
2089 forward_htlcs: Mutex::new(HashMap::new()),
2090 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments: HashMap::new(), pending_claiming_payments: HashMap::new() }),
2091 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
2092 id_to_peer: Mutex::new(HashMap::new()),
2093 short_to_chan_info: FairRwLock::new(HashMap::new()),
2095 our_network_pubkey: node_signer.get_node_id(Recipient::Node).unwrap(),
2098 inbound_payment_key: expanded_inbound_key,
2099 fake_scid_rand_bytes: entropy_source.get_secure_random_bytes(),
2101 probing_cookie_secret: entropy_source.get_secure_random_bytes(),
2103 highest_seen_timestamp: AtomicUsize::new(current_timestamp as usize),
2105 per_peer_state: FairRwLock::new(HashMap::new()),
2107 pending_events: Mutex::new(VecDeque::new()),
2108 pending_events_processor: AtomicBool::new(false),
2109 pending_background_events: Mutex::new(Vec::new()),
2110 total_consistency_lock: RwLock::new(()),
2111 background_events_processed_since_startup: AtomicBool::new(false),
2112 persistence_notifier: Notifier::new(),
2122 /// Gets the current configuration applied to all new channels.
2123 pub fn get_current_default_configuration(&self) -> &UserConfig {
2124 &self.default_configuration
2127 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
2128 let height = self.best_block.read().unwrap().height();
2129 let mut outbound_scid_alias = 0;
2132 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
2133 outbound_scid_alias += 1;
2135 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
2137 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
2141 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"); }
2146 /// Creates a new outbound channel to the given remote node and with the given value.
2148 /// `user_channel_id` will be provided back as in
2149 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
2150 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
2151 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
2152 /// is simply copied to events and otherwise ignored.
2154 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
2155 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
2157 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be opened due to failing to
2158 /// generate a shutdown scriptpubkey or destination script set by
2159 /// [`SignerProvider::get_shutdown_scriptpubkey`] or [`SignerProvider::get_destination_script`].
2161 /// Note that we do not check if you are currently connected to the given peer. If no
2162 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
2163 /// the channel eventually being silently forgotten (dropped on reload).
2165 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
2166 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
2167 /// [`ChannelDetails::channel_id`] until after
2168 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
2169 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
2170 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
2172 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
2173 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
2174 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
2175 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_channel_id: u128, override_config: Option<UserConfig>) -> Result<[u8; 32], APIError> {
2176 if channel_value_satoshis < 1000 {
2177 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
2180 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2181 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
2182 debug_assert!(&self.total_consistency_lock.try_write().is_err());
2184 let per_peer_state = self.per_peer_state.read().unwrap();
2186 let peer_state_mutex = per_peer_state.get(&their_network_key)
2187 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Not connected to node: {}", their_network_key) })?;
2189 let mut peer_state = peer_state_mutex.lock().unwrap();
2191 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
2192 let their_features = &peer_state.latest_features;
2193 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
2194 match OutboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider, their_network_key,
2195 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
2196 self.best_block.read().unwrap().height(), outbound_scid_alias)
2200 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
2205 let res = channel.get_open_channel(self.genesis_hash.clone());
2207 let temporary_channel_id = channel.context.channel_id();
2208 match peer_state.outbound_v1_channel_by_id.entry(temporary_channel_id) {
2209 hash_map::Entry::Occupied(_) => {
2211 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
2213 panic!("RNG is bad???");
2216 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
2219 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
2220 node_id: their_network_key,
2223 Ok(temporary_channel_id)
2226 fn list_funded_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<<SP::Target as SignerProvider>::Signer>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
2227 // Allocate our best estimate of the number of channels we have in the `res`
2228 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2229 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2230 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2231 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2232 // the same channel.
2233 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2235 let best_block_height = self.best_block.read().unwrap().height();
2236 let per_peer_state = self.per_peer_state.read().unwrap();
2237 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2238 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2239 let peer_state = &mut *peer_state_lock;
2240 for (_channel_id, channel) in peer_state.channel_by_id.iter().filter(f) {
2241 let details = ChannelDetails::from_channel_context(&channel.context, best_block_height,
2242 peer_state.latest_features.clone(), &self.fee_estimator);
2250 /// Gets the list of open channels, in random order. See [`ChannelDetails`] field documentation for
2251 /// more information.
2252 pub fn list_channels(&self) -> Vec<ChannelDetails> {
2253 // Allocate our best estimate of the number of channels we have in the `res`
2254 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
2255 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
2256 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
2257 // unlikely as the `short_to_chan_info` map often contains 2 entries for
2258 // the same channel.
2259 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
2261 let best_block_height = self.best_block.read().unwrap().height();
2262 let per_peer_state = self.per_peer_state.read().unwrap();
2263 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
2264 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2265 let peer_state = &mut *peer_state_lock;
2266 for (_channel_id, channel) in peer_state.channel_by_id.iter() {
2267 let details = ChannelDetails::from_channel_context(&channel.context, best_block_height,
2268 peer_state.latest_features.clone(), &self.fee_estimator);
2271 for (_channel_id, channel) in peer_state.inbound_v1_channel_by_id.iter() {
2272 let details = ChannelDetails::from_channel_context(&channel.context, best_block_height,
2273 peer_state.latest_features.clone(), &self.fee_estimator);
2276 for (_channel_id, channel) in peer_state.outbound_v1_channel_by_id.iter() {
2277 let details = ChannelDetails::from_channel_context(&channel.context, best_block_height,
2278 peer_state.latest_features.clone(), &self.fee_estimator);
2286 /// Gets the list of usable channels, in random order. Useful as an argument to
2287 /// [`Router::find_route`] to ensure non-announced channels are used.
2289 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
2290 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
2292 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
2293 // Note we use is_live here instead of usable which leads to somewhat confused
2294 // internal/external nomenclature, but that's ok cause that's probably what the user
2295 // really wanted anyway.
2296 self.list_funded_channels_with_filter(|&(_, ref channel)| channel.context.is_live())
2299 /// Gets the list of channels we have with a given counterparty, in random order.
2300 pub fn list_channels_with_counterparty(&self, counterparty_node_id: &PublicKey) -> Vec<ChannelDetails> {
2301 let best_block_height = self.best_block.read().unwrap().height();
2302 let per_peer_state = self.per_peer_state.read().unwrap();
2304 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
2305 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2306 let peer_state = &mut *peer_state_lock;
2307 let features = &peer_state.latest_features;
2308 return peer_state.channel_by_id
2311 ChannelDetails::from_channel_context(&channel.context, best_block_height,
2312 features.clone(), &self.fee_estimator))
2318 /// Returns in an undefined order recent payments that -- if not fulfilled -- have yet to find a
2319 /// successful path, or have unresolved HTLCs.
2321 /// This can be useful for payments that may have been prepared, but ultimately not sent, as a
2322 /// result of a crash. If such a payment exists, is not listed here, and an
2323 /// [`Event::PaymentSent`] has not been received, you may consider resending the payment.
2325 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2326 pub fn list_recent_payments(&self) -> Vec<RecentPaymentDetails> {
2327 self.pending_outbound_payments.pending_outbound_payments.lock().unwrap().iter()
2328 .filter_map(|(_, pending_outbound_payment)| match pending_outbound_payment {
2329 PendingOutboundPayment::Retryable { payment_hash, total_msat, .. } => {
2330 Some(RecentPaymentDetails::Pending {
2331 payment_hash: *payment_hash,
2332 total_msat: *total_msat,
2335 PendingOutboundPayment::Abandoned { payment_hash, .. } => {
2336 Some(RecentPaymentDetails::Abandoned { payment_hash: *payment_hash })
2338 PendingOutboundPayment::Fulfilled { payment_hash, .. } => {
2339 Some(RecentPaymentDetails::Fulfilled { payment_hash: *payment_hash })
2341 PendingOutboundPayment::Legacy { .. } => None
2346 /// Helper function that issues the channel close events
2347 fn issue_channel_close_events(&self, context: &ChannelContext<<SP::Target as SignerProvider>::Signer>, closure_reason: ClosureReason) {
2348 let mut pending_events_lock = self.pending_events.lock().unwrap();
2349 match context.unbroadcasted_funding() {
2350 Some(transaction) => {
2351 pending_events_lock.push_back((events::Event::DiscardFunding {
2352 channel_id: context.channel_id(), transaction
2357 pending_events_lock.push_back((events::Event::ChannelClosed {
2358 channel_id: context.channel_id(),
2359 user_channel_id: context.get_user_id(),
2360 reason: closure_reason
2364 fn close_channel_internal(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>, override_shutdown_script: Option<ShutdownScript>) -> Result<(), APIError> {
2365 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2367 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
2368 let result: Result<(), _> = loop {
2369 let per_peer_state = self.per_peer_state.read().unwrap();
2371 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2372 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2374 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2375 let peer_state = &mut *peer_state_lock;
2376 match peer_state.channel_by_id.entry(channel_id.clone()) {
2377 hash_map::Entry::Occupied(mut chan_entry) => {
2378 let funding_txo_opt = chan_entry.get().context.get_funding_txo();
2379 let their_features = &peer_state.latest_features;
2380 let (shutdown_msg, mut monitor_update_opt, htlcs) = chan_entry.get_mut()
2381 .get_shutdown(&self.signer_provider, their_features, target_feerate_sats_per_1000_weight, override_shutdown_script)?;
2382 failed_htlcs = htlcs;
2384 // We can send the `shutdown` message before updating the `ChannelMonitor`
2385 // here as we don't need the monitor update to complete until we send a
2386 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
2387 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2388 node_id: *counterparty_node_id,
2392 // Update the monitor with the shutdown script if necessary.
2393 if let Some(monitor_update) = monitor_update_opt.take() {
2394 break handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
2395 peer_state_lock, peer_state, per_peer_state, chan_entry).map(|_| ());
2398 if chan_entry.get().is_shutdown() {
2399 let channel = remove_channel!(self, chan_entry);
2400 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
2401 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2405 self.issue_channel_close_events(&channel.context, ClosureReason::HolderForceClosed);
2409 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*channel_id), counterparty_node_id) })
2413 for htlc_source in failed_htlcs.drain(..) {
2414 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2415 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
2416 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
2419 let _ = handle_error!(self, result, *counterparty_node_id);
2423 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2424 /// will be accepted on the given channel, and after additional timeout/the closing of all
2425 /// pending HTLCs, the channel will be closed on chain.
2427 /// * If we are the channel initiator, we will pay between our [`Background`] and
2428 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
2430 /// * If our counterparty is the channel initiator, we will require a channel closing
2431 /// transaction feerate of at least our [`Background`] feerate or the feerate which
2432 /// would appear on a force-closure transaction, whichever is lower. We will allow our
2433 /// counterparty to pay as much fee as they'd like, however.
2435 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2437 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2438 /// generate a shutdown scriptpubkey or destination script set by
2439 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2442 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2443 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
2444 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
2445 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2446 pub fn close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
2447 self.close_channel_internal(channel_id, counterparty_node_id, None, None)
2450 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2451 /// will be accepted on the given channel, and after additional timeout/the closing of all
2452 /// pending HTLCs, the channel will be closed on chain.
2454 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
2455 /// the channel being closed or not:
2456 /// * If we are the channel initiator, we will pay at least this feerate on the closing
2457 /// transaction. The upper-bound is set by
2458 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
2459 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
2460 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
2461 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
2462 /// will appear on a force-closure transaction, whichever is lower).
2464 /// The `shutdown_script` provided will be used as the `scriptPubKey` for the closing transaction.
2465 /// Will fail if a shutdown script has already been set for this channel by
2466 /// ['ChannelHandshakeConfig::commit_upfront_shutdown_pubkey`]. The given shutdown script must
2467 /// also be compatible with our and the counterparty's features.
2469 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2471 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2472 /// generate a shutdown scriptpubkey or destination script set by
2473 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2476 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2477 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
2478 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
2479 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2480 pub fn close_channel_with_feerate_and_script(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>, shutdown_script: Option<ShutdownScript>) -> Result<(), APIError> {
2481 self.close_channel_internal(channel_id, counterparty_node_id, target_feerate_sats_per_1000_weight, shutdown_script)
2485 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
2486 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
2487 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
2488 for htlc_source in failed_htlcs.drain(..) {
2489 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
2490 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
2491 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2492 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
2494 if let Some((_, funding_txo, monitor_update)) = monitor_update_option {
2495 // There isn't anything we can do if we get an update failure - we're already
2496 // force-closing. The monitor update on the required in-memory copy should broadcast
2497 // the latest local state, which is the best we can do anyway. Thus, it is safe to
2498 // ignore the result here.
2499 let _ = self.chain_monitor.update_channel(funding_txo, &monitor_update);
2503 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
2504 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
2505 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
2506 -> Result<PublicKey, APIError> {
2507 let per_peer_state = self.per_peer_state.read().unwrap();
2508 let peer_state_mutex = per_peer_state.get(peer_node_id)
2509 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", peer_node_id) })?;
2510 let (update_opt, counterparty_node_id) = {
2511 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2512 let peer_state = &mut *peer_state_lock;
2513 let closure_reason = if let Some(peer_msg) = peer_msg {
2514 ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(peer_msg.to_string()) }
2516 ClosureReason::HolderForceClosed
2518 if let hash_map::Entry::Occupied(chan) = peer_state.channel_by_id.entry(channel_id.clone()) {
2519 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
2520 self.issue_channel_close_events(&chan.get().context, closure_reason);
2521 let mut chan = remove_channel!(self, chan);
2522 self.finish_force_close_channel(chan.context.force_shutdown(broadcast));
2523 (self.get_channel_update_for_broadcast(&chan).ok(), chan.context.get_counterparty_node_id())
2524 } else if let hash_map::Entry::Occupied(chan) = peer_state.outbound_v1_channel_by_id.entry(channel_id.clone()) {
2525 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
2526 self.issue_channel_close_events(&chan.get().context, closure_reason);
2527 let mut chan = remove_channel!(self, chan);
2528 self.finish_force_close_channel(chan.context.force_shutdown(false));
2529 // Prefunded channel has no update
2530 (None, chan.context.get_counterparty_node_id())
2531 } else if let hash_map::Entry::Occupied(chan) = peer_state.inbound_v1_channel_by_id.entry(channel_id.clone()) {
2532 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
2533 self.issue_channel_close_events(&chan.get().context, closure_reason);
2534 let mut chan = remove_channel!(self, chan);
2535 self.finish_force_close_channel(chan.context.force_shutdown(false));
2536 // Prefunded channel has no update
2537 (None, chan.context.get_counterparty_node_id())
2539 return Err(APIError::ChannelUnavailable{ err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*channel_id), peer_node_id) });
2542 if let Some(update) = update_opt {
2543 let mut peer_state = peer_state_mutex.lock().unwrap();
2544 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2549 Ok(counterparty_node_id)
2552 fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
2553 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
2554 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
2555 Ok(counterparty_node_id) => {
2556 let per_peer_state = self.per_peer_state.read().unwrap();
2557 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2558 let mut peer_state = peer_state_mutex.lock().unwrap();
2559 peer_state.pending_msg_events.push(
2560 events::MessageSendEvent::HandleError {
2561 node_id: counterparty_node_id,
2562 action: msgs::ErrorAction::SendErrorMessage {
2563 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
2574 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
2575 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
2576 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
2578 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
2579 -> Result<(), APIError> {
2580 self.force_close_sending_error(channel_id, counterparty_node_id, true)
2583 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
2584 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
2585 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
2587 /// You can always get the latest local transaction(s) to broadcast from
2588 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
2589 pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
2590 -> Result<(), APIError> {
2591 self.force_close_sending_error(channel_id, counterparty_node_id, false)
2594 /// Force close all channels, immediately broadcasting the latest local commitment transaction
2595 /// for each to the chain and rejecting new HTLCs on each.
2596 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
2597 for chan in self.list_channels() {
2598 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
2602 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
2603 /// local transaction(s).
2604 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
2605 for chan in self.list_channels() {
2606 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
2610 fn construct_recv_pending_htlc_info(
2611 &self, hop_data: msgs::OnionHopData, shared_secret: [u8; 32], payment_hash: PaymentHash,
2612 amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>, allow_underpay: bool,
2613 counterparty_skimmed_fee_msat: Option<u64>,
2614 ) -> Result<PendingHTLCInfo, ReceiveError> {
2615 // final_incorrect_cltv_expiry
2616 if hop_data.outgoing_cltv_value > cltv_expiry {
2617 return Err(ReceiveError {
2618 msg: "Upstream node set CLTV to less than the CLTV set by the sender",
2620 err_data: cltv_expiry.to_be_bytes().to_vec()
2623 // final_expiry_too_soon
2624 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
2625 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
2627 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
2628 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
2629 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
2630 let current_height: u32 = self.best_block.read().unwrap().height();
2631 if (hop_data.outgoing_cltv_value as u64) <= current_height as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
2632 let mut err_data = Vec::with_capacity(12);
2633 err_data.extend_from_slice(&amt_msat.to_be_bytes());
2634 err_data.extend_from_slice(¤t_height.to_be_bytes());
2635 return Err(ReceiveError {
2636 err_code: 0x4000 | 15, err_data,
2637 msg: "The final CLTV expiry is too soon to handle",
2640 if (!allow_underpay && hop_data.amt_to_forward > amt_msat) ||
2641 (allow_underpay && hop_data.amt_to_forward >
2642 amt_msat.saturating_add(counterparty_skimmed_fee_msat.unwrap_or(0)))
2644 return Err(ReceiveError {
2646 err_data: amt_msat.to_be_bytes().to_vec(),
2647 msg: "Upstream node sent less than we were supposed to receive in payment",
2651 let routing = match hop_data.format {
2652 msgs::OnionHopDataFormat::NonFinalNode { .. } => {
2653 return Err(ReceiveError {
2654 err_code: 0x4000|22,
2655 err_data: Vec::new(),
2656 msg: "Got non final data with an HMAC of 0",
2659 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage, payment_metadata } => {
2660 if let Some(payment_preimage) = keysend_preimage {
2661 // We need to check that the sender knows the keysend preimage before processing this
2662 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
2663 // could discover the final destination of X, by probing the adjacent nodes on the route
2664 // with a keysend payment of identical payment hash to X and observing the processing
2665 // time discrepancies due to a hash collision with X.
2666 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2667 if hashed_preimage != payment_hash {
2668 return Err(ReceiveError {
2669 err_code: 0x4000|22,
2670 err_data: Vec::new(),
2671 msg: "Payment preimage didn't match payment hash",
2674 if !self.default_configuration.accept_mpp_keysend && payment_data.is_some() {
2675 return Err(ReceiveError {
2676 err_code: 0x4000|22,
2677 err_data: Vec::new(),
2678 msg: "We don't support MPP keysend payments",
2681 PendingHTLCRouting::ReceiveKeysend {
2685 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2687 } else if let Some(data) = payment_data {
2688 PendingHTLCRouting::Receive {
2691 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2692 phantom_shared_secret,
2695 return Err(ReceiveError {
2696 err_code: 0x4000|0x2000|3,
2697 err_data: Vec::new(),
2698 msg: "We require payment_secrets",
2703 Ok(PendingHTLCInfo {
2706 incoming_shared_secret: shared_secret,
2707 incoming_amt_msat: Some(amt_msat),
2708 outgoing_amt_msat: hop_data.amt_to_forward,
2709 outgoing_cltv_value: hop_data.outgoing_cltv_value,
2710 skimmed_fee_msat: counterparty_skimmed_fee_msat,
2714 fn decode_update_add_htlc_onion(
2715 &self, msg: &msgs::UpdateAddHTLC
2716 ) -> Result<(onion_utils::Hop, [u8; 32], Option<Result<PublicKey, secp256k1::Error>>), HTLCFailureMsg> {
2717 macro_rules! return_malformed_err {
2718 ($msg: expr, $err_code: expr) => {
2720 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2721 return Err(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
2722 channel_id: msg.channel_id,
2723 htlc_id: msg.htlc_id,
2724 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
2725 failure_code: $err_code,
2731 if let Err(_) = msg.onion_routing_packet.public_key {
2732 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2735 let shared_secret = self.node_signer.ecdh(
2736 Recipient::Node, &msg.onion_routing_packet.public_key.unwrap(), None
2737 ).unwrap().secret_bytes();
2739 if msg.onion_routing_packet.version != 0 {
2740 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2741 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2742 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2743 //receiving node would have to brute force to figure out which version was put in the
2744 //packet by the node that send us the message, in the case of hashing the hop_data, the
2745 //node knows the HMAC matched, so they already know what is there...
2746 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2748 macro_rules! return_err {
2749 ($msg: expr, $err_code: expr, $data: expr) => {
2751 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2752 return Err(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2753 channel_id: msg.channel_id,
2754 htlc_id: msg.htlc_id,
2755 reason: HTLCFailReason::reason($err_code, $data.to_vec())
2756 .get_encrypted_failure_packet(&shared_secret, &None),
2762 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) {
2764 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2765 return_malformed_err!(err_msg, err_code);
2767 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2768 return_err!(err_msg, err_code, &[0; 0]);
2771 let (outgoing_scid, outgoing_amt_msat, outgoing_cltv_value, next_packet_pk_opt) = match next_hop {
2772 onion_utils::Hop::Forward {
2773 next_hop_data: msgs::OnionHopData {
2774 format: msgs::OnionHopDataFormat::NonFinalNode { short_channel_id }, amt_to_forward,
2775 outgoing_cltv_value,
2778 let next_pk = onion_utils::next_hop_packet_pubkey(&self.secp_ctx,
2779 msg.onion_routing_packet.public_key.unwrap(), &shared_secret);
2780 (short_channel_id, amt_to_forward, outgoing_cltv_value, Some(next_pk))
2782 // We'll do receive checks in [`Self::construct_pending_htlc_info`] so we have access to the
2783 // inbound channel's state.
2784 onion_utils::Hop::Receive { .. } => return Ok((next_hop, shared_secret, None)),
2785 onion_utils::Hop::Forward {
2786 next_hop_data: msgs::OnionHopData { format: msgs::OnionHopDataFormat::FinalNode { .. }, .. }, ..
2788 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0; 0]);
2792 // Perform outbound checks here instead of in [`Self::construct_pending_htlc_info`] because we
2793 // can't hold the outbound peer state lock at the same time as the inbound peer state lock.
2794 if let Some((err, mut code, chan_update)) = loop {
2795 let id_option = self.short_to_chan_info.read().unwrap().get(&outgoing_scid).cloned();
2796 let forwarding_chan_info_opt = match id_option {
2797 None => { // unknown_next_peer
2798 // Note that this is likely a timing oracle for detecting whether an scid is a
2799 // phantom or an intercept.
2800 if (self.default_configuration.accept_intercept_htlcs &&
2801 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, outgoing_scid, &self.genesis_hash)) ||
2802 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, outgoing_scid, &self.genesis_hash)
2806 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2809 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
2811 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
2812 let per_peer_state = self.per_peer_state.read().unwrap();
2813 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
2814 if peer_state_mutex_opt.is_none() {
2815 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2817 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
2818 let peer_state = &mut *peer_state_lock;
2819 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id) {
2821 // Channel was removed. The short_to_chan_info and channel_by_id maps
2822 // have no consistency guarantees.
2823 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2827 if !chan.context.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
2828 // Note that the behavior here should be identical to the above block - we
2829 // should NOT reveal the existence or non-existence of a private channel if
2830 // we don't allow forwards outbound over them.
2831 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
2833 if chan.context.get_channel_type().supports_scid_privacy() && outgoing_scid != chan.context.outbound_scid_alias() {
2834 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
2835 // "refuse to forward unless the SCID alias was used", so we pretend
2836 // we don't have the channel here.
2837 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
2839 let chan_update_opt = self.get_channel_update_for_onion(outgoing_scid, chan).ok();
2841 // Note that we could technically not return an error yet here and just hope
2842 // that the connection is reestablished or monitor updated by the time we get
2843 // around to doing the actual forward, but better to fail early if we can and
2844 // hopefully an attacker trying to path-trace payments cannot make this occur
2845 // on a small/per-node/per-channel scale.
2846 if !chan.context.is_live() { // channel_disabled
2847 // If the channel_update we're going to return is disabled (i.e. the
2848 // peer has been disabled for some time), return `channel_disabled`,
2849 // otherwise return `temporary_channel_failure`.
2850 if chan_update_opt.as_ref().map(|u| u.contents.flags & 2 == 2).unwrap_or(false) {
2851 break Some(("Forwarding channel has been disconnected for some time.", 0x1000 | 20, chan_update_opt));
2853 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 7, chan_update_opt));
2856 if outgoing_amt_msat < chan.context.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
2857 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
2859 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, outgoing_amt_msat, outgoing_cltv_value) {
2860 break Some((err, code, chan_update_opt));
2864 if (msg.cltv_expiry as u64) < (outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 {
2865 // We really should set `incorrect_cltv_expiry` here but as we're not
2866 // forwarding over a real channel we can't generate a channel_update
2867 // for it. Instead we just return a generic temporary_node_failure.
2869 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
2876 let cur_height = self.best_block.read().unwrap().height() + 1;
2877 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
2878 // but we want to be robust wrt to counterparty packet sanitization (see
2879 // HTLC_FAIL_BACK_BUFFER rationale).
2880 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
2881 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
2883 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
2884 break Some(("CLTV expiry is too far in the future", 21, None));
2886 // If the HTLC expires ~now, don't bother trying to forward it to our
2887 // counterparty. They should fail it anyway, but we don't want to bother with
2888 // the round-trips or risk them deciding they definitely want the HTLC and
2889 // force-closing to ensure they get it if we're offline.
2890 // We previously had a much more aggressive check here which tried to ensure
2891 // our counterparty receives an HTLC which has *our* risk threshold met on it,
2892 // but there is no need to do that, and since we're a bit conservative with our
2893 // risk threshold it just results in failing to forward payments.
2894 if (outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
2895 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
2901 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
2902 if let Some(chan_update) = chan_update {
2903 if code == 0x1000 | 11 || code == 0x1000 | 12 {
2904 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
2906 else if code == 0x1000 | 13 {
2907 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
2909 else if code == 0x1000 | 20 {
2910 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
2911 0u16.write(&mut res).expect("Writes cannot fail");
2913 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
2914 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
2915 chan_update.write(&mut res).expect("Writes cannot fail");
2916 } else if code & 0x1000 == 0x1000 {
2917 // If we're trying to return an error that requires a `channel_update` but
2918 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
2919 // generate an update), just use the generic "temporary_node_failure"
2923 return_err!(err, code, &res.0[..]);
2925 Ok((next_hop, shared_secret, next_packet_pk_opt))
2928 fn construct_pending_htlc_status<'a>(
2929 &self, msg: &msgs::UpdateAddHTLC, shared_secret: [u8; 32], decoded_hop: onion_utils::Hop,
2930 allow_underpay: bool, next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
2931 ) -> PendingHTLCStatus {
2932 macro_rules! return_err {
2933 ($msg: expr, $err_code: expr, $data: expr) => {
2935 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2936 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2937 channel_id: msg.channel_id,
2938 htlc_id: msg.htlc_id,
2939 reason: HTLCFailReason::reason($err_code, $data.to_vec())
2940 .get_encrypted_failure_packet(&shared_secret, &None),
2946 onion_utils::Hop::Receive(next_hop_data) => {
2948 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash,
2949 msg.amount_msat, msg.cltv_expiry, None, allow_underpay, msg.skimmed_fee_msat)
2952 // Note that we could obviously respond immediately with an update_fulfill_htlc
2953 // message, however that would leak that we are the recipient of this payment, so
2954 // instead we stay symmetric with the forwarding case, only responding (after a
2955 // delay) once they've send us a commitment_signed!
2956 PendingHTLCStatus::Forward(info)
2958 Err(ReceiveError { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
2961 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
2962 debug_assert!(next_packet_pubkey_opt.is_some());
2963 let outgoing_packet = msgs::OnionPacket {
2965 public_key: next_packet_pubkey_opt.unwrap_or(Err(secp256k1::Error::InvalidPublicKey)),
2966 hop_data: new_packet_bytes,
2967 hmac: next_hop_hmac.clone(),
2970 let short_channel_id = match next_hop_data.format {
2971 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
2972 msgs::OnionHopDataFormat::FinalNode { .. } => {
2973 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
2977 PendingHTLCStatus::Forward(PendingHTLCInfo {
2978 routing: PendingHTLCRouting::Forward {
2979 onion_packet: outgoing_packet,
2982 payment_hash: msg.payment_hash.clone(),
2983 incoming_shared_secret: shared_secret,
2984 incoming_amt_msat: Some(msg.amount_msat),
2985 outgoing_amt_msat: next_hop_data.amt_to_forward,
2986 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
2987 skimmed_fee_msat: None,
2993 /// Gets the current [`channel_update`] for the given channel. This first checks if the channel is
2994 /// public, and thus should be called whenever the result is going to be passed out in a
2995 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
2997 /// Note that in [`internal_closing_signed`], this function is called without the `peer_state`
2998 /// corresponding to the channel's counterparty locked, as the channel been removed from the
2999 /// storage and the `peer_state` lock has been dropped.
3001 /// [`channel_update`]: msgs::ChannelUpdate
3002 /// [`internal_closing_signed`]: Self::internal_closing_signed
3003 fn get_channel_update_for_broadcast(&self, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
3004 if !chan.context.should_announce() {
3005 return Err(LightningError {
3006 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
3007 action: msgs::ErrorAction::IgnoreError
3010 if chan.context.get_short_channel_id().is_none() {
3011 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
3013 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.context.channel_id()));
3014 self.get_channel_update_for_unicast(chan)
3017 /// Gets the current [`channel_update`] for the given channel. This does not check if the channel
3018 /// is public (only returning an `Err` if the channel does not yet have an assigned SCID),
3019 /// and thus MUST NOT be called unless the recipient of the resulting message has already
3020 /// provided evidence that they know about the existence of the channel.
3022 /// Note that through [`internal_closing_signed`], this function is called without the
3023 /// `peer_state` corresponding to the channel's counterparty locked, as the channel been
3024 /// removed from the storage and the `peer_state` lock has been dropped.
3026 /// [`channel_update`]: msgs::ChannelUpdate
3027 /// [`internal_closing_signed`]: Self::internal_closing_signed
3028 fn get_channel_update_for_unicast(&self, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
3029 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.context.channel_id()));
3030 let short_channel_id = match chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias()) {
3031 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
3035 self.get_channel_update_for_onion(short_channel_id, chan)
3038 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
3039 log_trace!(self.logger, "Generating channel update for channel {}", log_bytes!(chan.context.channel_id()));
3040 let were_node_one = self.our_network_pubkey.serialize()[..] < chan.context.get_counterparty_node_id().serialize()[..];
3042 let enabled = chan.context.is_usable() && match chan.channel_update_status() {
3043 ChannelUpdateStatus::Enabled => true,
3044 ChannelUpdateStatus::DisabledStaged(_) => true,
3045 ChannelUpdateStatus::Disabled => false,
3046 ChannelUpdateStatus::EnabledStaged(_) => false,
3049 let unsigned = msgs::UnsignedChannelUpdate {
3050 chain_hash: self.genesis_hash,
3052 timestamp: chan.context.get_update_time_counter(),
3053 flags: (!were_node_one) as u8 | ((!enabled as u8) << 1),
3054 cltv_expiry_delta: chan.context.get_cltv_expiry_delta(),
3055 htlc_minimum_msat: chan.context.get_counterparty_htlc_minimum_msat(),
3056 htlc_maximum_msat: chan.context.get_announced_htlc_max_msat(),
3057 fee_base_msat: chan.context.get_outbound_forwarding_fee_base_msat(),
3058 fee_proportional_millionths: chan.context.get_fee_proportional_millionths(),
3059 excess_data: Vec::new(),
3061 // Panic on failure to signal LDK should be restarted to retry signing the `ChannelUpdate`.
3062 // If we returned an error and the `node_signer` cannot provide a signature for whatever
3063 // reason`, we wouldn't be able to receive inbound payments through the corresponding
3065 let sig = self.node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelUpdate(&unsigned)).unwrap();
3067 Ok(msgs::ChannelUpdate {
3074 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> {
3075 let _lck = self.total_consistency_lock.read().unwrap();
3076 self.send_payment_along_path(path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv_bytes)
3079 fn 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> {
3080 // The top-level caller should hold the total_consistency_lock read lock.
3081 debug_assert!(self.total_consistency_lock.try_write().is_err());
3083 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.hops.first().unwrap().short_channel_id);
3084 let prng_seed = self.entropy_source.get_secure_random_bytes();
3085 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
3087 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
3088 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected".to_owned()})?;
3089 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, recipient_onion, cur_height, keysend_preimage)?;
3091 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash)
3092 .map_err(|_| APIError::InvalidRoute { err: "Route size too large considering onion data".to_owned()})?;
3094 let err: Result<(), _> = loop {
3095 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.hops.first().unwrap().short_channel_id) {
3096 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
3097 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3100 let per_peer_state = self.per_peer_state.read().unwrap();
3101 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
3102 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
3103 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3104 let peer_state = &mut *peer_state_lock;
3105 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(id) {
3106 if !chan.get().context.is_live() {
3107 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected".to_owned()});
3109 let funding_txo = chan.get().context.get_funding_txo().unwrap();
3110 let send_res = chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(),
3111 htlc_cltv, HTLCSource::OutboundRoute {
3113 session_priv: session_priv.clone(),
3114 first_hop_htlc_msat: htlc_msat,
3116 }, onion_packet, None, &self.fee_estimator, &self.logger);
3117 match break_chan_entry!(self, send_res, chan) {
3118 Some(monitor_update) => {
3119 match handle_new_monitor_update!(self, funding_txo, monitor_update, peer_state_lock, peer_state, per_peer_state, chan) {
3120 Err(e) => break Err(e),
3122 // Note that MonitorUpdateInProgress here indicates (per function
3123 // docs) that we will resend the commitment update once monitor
3124 // updating completes. Therefore, we must return an error
3125 // indicating that it is unsafe to retry the payment wholesale,
3126 // which we do in the send_payment check for
3127 // MonitorUpdateInProgress, below.
3128 return Err(APIError::MonitorUpdateInProgress);
3136 // The channel was likely removed after we fetched the id from the
3137 // `short_to_chan_info` map, but before we successfully locked the
3138 // `channel_by_id` map.
3139 // This can occur as no consistency guarantees exists between the two maps.
3140 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
3145 match handle_error!(self, err, path.hops.first().unwrap().pubkey) {
3146 Ok(_) => unreachable!(),
3148 Err(APIError::ChannelUnavailable { err: e.err })
3153 /// Sends a payment along a given route.
3155 /// Value parameters are provided via the last hop in route, see documentation for [`RouteHop`]
3156 /// fields for more info.
3158 /// May generate [`UpdateHTLCs`] message(s) event on success, which should be relayed (e.g. via
3159 /// [`PeerManager::process_events`]).
3161 /// # Avoiding Duplicate Payments
3163 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
3164 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
3165 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
3166 /// [`Event::PaymentSent`] or [`Event::PaymentFailed`]) LDK will not stop you from sending a
3167 /// second payment with the same [`PaymentId`].
3169 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
3170 /// tracking of payments, including state to indicate once a payment has completed. Because you
3171 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
3172 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
3173 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
3175 /// Additionally, in the scenario where we begin the process of sending a payment, but crash
3176 /// before `send_payment` returns (or prior to [`ChannelMonitorUpdate`] persistence if you're
3177 /// using [`ChannelMonitorUpdateStatus::InProgress`]), the payment may be lost on restart. See
3178 /// [`ChannelManager::list_recent_payments`] for more information.
3180 /// # Possible Error States on [`PaymentSendFailure`]
3182 /// Each path may have a different return value, and [`PaymentSendFailure`] may return a `Vec` with
3183 /// each entry matching the corresponding-index entry in the route paths, see
3184 /// [`PaymentSendFailure`] for more info.
3186 /// In general, a path may raise:
3187 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
3188 /// node public key) is specified.
3189 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
3190 /// (including due to previous monitor update failure or new permanent monitor update
3192 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
3193 /// relevant updates.
3195 /// Note that depending on the type of the [`PaymentSendFailure`] the HTLC may have been
3196 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
3197 /// different route unless you intend to pay twice!
3199 /// [`Event::PaymentSent`]: events::Event::PaymentSent
3200 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
3201 /// [`UpdateHTLCs`]: events::MessageSendEvent::UpdateHTLCs
3202 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
3203 /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
3204 pub fn send_payment_with_route(&self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
3205 let best_block_height = self.best_block.read().unwrap().height();
3206 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3207 self.pending_outbound_payments
3208 .send_payment_with_route(route, payment_hash, recipient_onion, payment_id, &self.entropy_source, &self.node_signer, best_block_height,
3209 |path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv|
3210 self.send_payment_along_path(path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv))
3213 /// Similar to [`ChannelManager::send_payment_with_route`], but will automatically find a route based on
3214 /// `route_params` and retry failed payment paths based on `retry_strategy`.
3215 pub fn send_payment(&self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<(), RetryableSendFailure> {
3216 let best_block_height = self.best_block.read().unwrap().height();
3217 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3218 self.pending_outbound_payments
3219 .send_payment(payment_hash, recipient_onion, payment_id, retry_strategy, route_params,
3220 &self.router, self.list_usable_channels(), || self.compute_inflight_htlcs(),
3221 &self.entropy_source, &self.node_signer, best_block_height, &self.logger,
3222 &self.pending_events,
3223 |path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv|
3224 self.send_payment_along_path(path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv))
3228 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> {
3229 let best_block_height = self.best_block.read().unwrap().height();
3230 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3231 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, recipient_onion, keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.node_signer, best_block_height,
3232 |path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv|
3233 self.send_payment_along_path(path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv))
3237 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> {
3238 let best_block_height = self.best_block.read().unwrap().height();
3239 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, recipient_onion, payment_id, route, None, &self.entropy_source, best_block_height)
3243 pub(crate) fn test_set_payment_metadata(&self, payment_id: PaymentId, new_payment_metadata: Option<Vec<u8>>) {
3244 self.pending_outbound_payments.test_set_payment_metadata(payment_id, new_payment_metadata);
3248 /// Signals that no further retries for the given payment should occur. Useful if you have a
3249 /// pending outbound payment with retries remaining, but wish to stop retrying the payment before
3250 /// retries are exhausted.
3252 /// If no [`Event::PaymentFailed`] event had been generated before, one will be generated as soon
3253 /// as there are no remaining pending HTLCs for this payment.
3255 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
3256 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
3257 /// determine the ultimate status of a payment.
3259 /// If an [`Event::PaymentFailed`] event is generated and we restart without this
3260 /// [`ChannelManager`] having been persisted, another [`Event::PaymentFailed`] may be generated.
3262 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
3263 /// [`Event::PaymentSent`]: events::Event::PaymentSent
3264 pub fn abandon_payment(&self, payment_id: PaymentId) {
3265 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3266 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
3269 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
3270 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
3271 /// the preimage, it must be a cryptographically secure random value that no intermediate node
3272 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
3273 /// never reach the recipient.
3275 /// See [`send_payment`] documentation for more details on the return value of this function
3276 /// and idempotency guarantees provided by the [`PaymentId`] key.
3278 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
3279 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
3281 /// [`send_payment`]: Self::send_payment
3282 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, recipient_onion: RecipientOnionFields, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
3283 let best_block_height = self.best_block.read().unwrap().height();
3284 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3285 self.pending_outbound_payments.send_spontaneous_payment_with_route(
3286 route, payment_preimage, recipient_onion, payment_id, &self.entropy_source,
3287 &self.node_signer, best_block_height,
3288 |path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv|
3289 self.send_payment_along_path(path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv))
3292 /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
3293 /// based on `route_params` and retry failed payment paths based on `retry_strategy`.
3295 /// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous
3298 /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
3299 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> {
3300 let best_block_height = self.best_block.read().unwrap().height();
3301 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3302 self.pending_outbound_payments.send_spontaneous_payment(payment_preimage, recipient_onion,
3303 payment_id, retry_strategy, route_params, &self.router, self.list_usable_channels(),
3304 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
3305 &self.logger, &self.pending_events,
3306 |path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv|
3307 self.send_payment_along_path(path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv))
3310 /// Send a payment that is probing the given route for liquidity. We calculate the
3311 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
3312 /// us to easily discern them from real payments.
3313 pub fn send_probe(&self, path: Path) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
3314 let best_block_height = self.best_block.read().unwrap().height();
3315 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3316 self.pending_outbound_payments.send_probe(path, self.probing_cookie_secret, &self.entropy_source, &self.node_signer, best_block_height,
3317 |path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv|
3318 self.send_payment_along_path(path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv))
3321 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
3324 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
3325 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
3328 /// Handles the generation of a funding transaction, optionally (for tests) with a function
3329 /// which checks the correctness of the funding transaction given the associated channel.
3330 fn funding_transaction_generated_intern<FundingOutput: Fn(&OutboundV1Channel<<SP::Target as SignerProvider>::Signer>, &Transaction) -> Result<OutPoint, APIError>>(
3331 &self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
3332 ) -> Result<(), APIError> {
3333 let per_peer_state = self.per_peer_state.read().unwrap();
3334 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3335 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3337 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3338 let peer_state = &mut *peer_state_lock;
3339 let (chan, msg) = match peer_state.outbound_v1_channel_by_id.remove(temporary_channel_id) {
3341 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
3343 let funding_res = chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
3344 .map_err(|(mut chan, e)| if let ChannelError::Close(msg) = e {
3345 let channel_id = chan.context.channel_id();
3346 let user_id = chan.context.get_user_id();
3347 let shutdown_res = chan.context.force_shutdown(false);
3348 (chan, MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, user_id, shutdown_res, None))
3349 } else { unreachable!(); });
3351 Ok((chan, funding_msg)) => (chan, funding_msg),
3352 Err((chan, err)) => {
3353 mem::drop(peer_state_lock);
3354 mem::drop(per_peer_state);
3356 let _: Result<(), _> = handle_error!(self, Err(err), chan.context.get_counterparty_node_id());
3357 return Err(APIError::ChannelUnavailable {
3358 err: "Signer refused to sign the initial commitment transaction".to_owned()
3364 return Err(APIError::ChannelUnavailable {
3366 "Channel with id {} not found for the passed counterparty node_id {}",
3367 log_bytes!(*temporary_channel_id), counterparty_node_id),
3372 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
3373 node_id: chan.context.get_counterparty_node_id(),
3376 match peer_state.channel_by_id.entry(chan.context.channel_id()) {
3377 hash_map::Entry::Occupied(_) => {
3378 panic!("Generated duplicate funding txid?");
3380 hash_map::Entry::Vacant(e) => {
3381 let mut id_to_peer = self.id_to_peer.lock().unwrap();
3382 if id_to_peer.insert(chan.context.channel_id(), chan.context.get_counterparty_node_id()).is_some() {
3383 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
3392 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
3393 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
3394 Ok(OutPoint { txid: tx.txid(), index: output_index })
3398 /// Call this upon creation of a funding transaction for the given channel.
3400 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
3401 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
3403 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
3404 /// across the p2p network.
3406 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
3407 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
3409 /// May panic if the output found in the funding transaction is duplicative with some other
3410 /// channel (note that this should be trivially prevented by using unique funding transaction
3411 /// keys per-channel).
3413 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
3414 /// counterparty's signature the funding transaction will automatically be broadcast via the
3415 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
3417 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
3418 /// not currently support replacing a funding transaction on an existing channel. Instead,
3419 /// create a new channel with a conflicting funding transaction.
3421 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
3422 /// the wallet software generating the funding transaction to apply anti-fee sniping as
3423 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
3424 /// for more details.
3426 /// [`Event::FundingGenerationReady`]: crate::events::Event::FundingGenerationReady
3427 /// [`Event::ChannelClosed`]: crate::events::Event::ChannelClosed
3428 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
3429 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3431 for inp in funding_transaction.input.iter() {
3432 if inp.witness.is_empty() {
3433 return Err(APIError::APIMisuseError {
3434 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
3439 let height = self.best_block.read().unwrap().height();
3440 // Transactions are evaluated as final by network mempools if their locktime is strictly
3441 // lower than the next block height. However, the modules constituting our Lightning
3442 // node might not have perfect sync about their blockchain views. Thus, if the wallet
3443 // module is ahead of LDK, only allow one more block of headroom.
3444 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 {
3445 return Err(APIError::APIMisuseError {
3446 err: "Funding transaction absolute timelock is non-final".to_owned()
3450 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
3451 if tx.output.len() > u16::max_value() as usize {
3452 return Err(APIError::APIMisuseError {
3453 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
3457 let mut output_index = None;
3458 let expected_spk = chan.context.get_funding_redeemscript().to_v0_p2wsh();
3459 for (idx, outp) in tx.output.iter().enumerate() {
3460 if outp.script_pubkey == expected_spk && outp.value == chan.context.get_value_satoshis() {
3461 if output_index.is_some() {
3462 return Err(APIError::APIMisuseError {
3463 err: "Multiple outputs matched the expected script and value".to_owned()
3466 output_index = Some(idx as u16);
3469 if output_index.is_none() {
3470 return Err(APIError::APIMisuseError {
3471 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
3474 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
3478 /// Atomically applies partial updates to the [`ChannelConfig`] of the given channels.
3480 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3481 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3482 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3483 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3485 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3486 /// `counterparty_node_id` is provided.
3488 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3489 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3491 /// If an error is returned, none of the updates should be considered applied.
3493 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3494 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3495 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3496 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3497 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3498 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3499 /// [`APIMisuseError`]: APIError::APIMisuseError
3500 pub fn update_partial_channel_config(
3501 &self, counterparty_node_id: &PublicKey, channel_ids: &[[u8; 32]], config_update: &ChannelConfigUpdate,
3502 ) -> Result<(), APIError> {
3503 if config_update.cltv_expiry_delta.map(|delta| delta < MIN_CLTV_EXPIRY_DELTA).unwrap_or(false) {
3504 return Err(APIError::APIMisuseError {
3505 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
3509 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3510 let per_peer_state = self.per_peer_state.read().unwrap();
3511 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
3512 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
3513 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3514 let peer_state = &mut *peer_state_lock;
3515 for channel_id in channel_ids {
3516 if !peer_state.channel_by_id.contains_key(channel_id) {
3517 return Err(APIError::ChannelUnavailable {
3518 err: format!("Channel with ID {} was not found for the passed counterparty_node_id {}", log_bytes!(*channel_id), counterparty_node_id),
3522 for channel_id in channel_ids {
3523 let channel = peer_state.channel_by_id.get_mut(channel_id).unwrap();
3524 let mut config = channel.context.config();
3525 config.apply(config_update);
3526 if !channel.context.update_config(&config) {
3529 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
3530 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
3531 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
3532 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
3533 node_id: channel.context.get_counterparty_node_id(),
3541 /// Atomically updates the [`ChannelConfig`] for the given channels.
3543 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3544 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3545 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3546 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3548 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3549 /// `counterparty_node_id` is provided.
3551 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3552 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3554 /// If an error is returned, none of the updates should be considered applied.
3556 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3557 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3558 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3559 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3560 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3561 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3562 /// [`APIMisuseError`]: APIError::APIMisuseError
3563 pub fn update_channel_config(
3564 &self, counterparty_node_id: &PublicKey, channel_ids: &[[u8; 32]], config: &ChannelConfig,
3565 ) -> Result<(), APIError> {
3566 return self.update_partial_channel_config(counterparty_node_id, channel_ids, &(*config).into());
3569 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
3570 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
3572 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
3573 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
3575 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
3576 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
3577 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
3578 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
3579 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
3581 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
3582 /// you from forwarding more than you received. See
3583 /// [`HTLCIntercepted::expected_outbound_amount_msat`] for more on forwarding a different amount
3586 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
3589 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
3590 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
3591 /// [`HTLCIntercepted::expected_outbound_amount_msat`]: events::Event::HTLCIntercepted::expected_outbound_amount_msat
3592 // TODO: when we move to deciding the best outbound channel at forward time, only take
3593 // `next_node_id` and not `next_hop_channel_id`
3594 pub fn forward_intercepted_htlc(&self, intercept_id: InterceptId, next_hop_channel_id: &[u8; 32], next_node_id: PublicKey, amt_to_forward_msat: u64) -> Result<(), APIError> {
3595 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3597 let next_hop_scid = {
3598 let peer_state_lock = self.per_peer_state.read().unwrap();
3599 let peer_state_mutex = peer_state_lock.get(&next_node_id)
3600 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) })?;
3601 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3602 let peer_state = &mut *peer_state_lock;
3603 match peer_state.channel_by_id.get(next_hop_channel_id) {
3605 if !chan.context.is_usable() {
3606 return Err(APIError::ChannelUnavailable {
3607 err: format!("Channel with id {} not fully established", log_bytes!(*next_hop_channel_id))
3610 chan.context.get_short_channel_id().unwrap_or(chan.context.outbound_scid_alias())
3612 None => return Err(APIError::ChannelUnavailable {
3613 err: format!("Funded channel with id {} not found for the passed counterparty node_id {}. Channel may still be opening.",
3614 log_bytes!(*next_hop_channel_id), next_node_id)
3619 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
3620 .ok_or_else(|| APIError::APIMisuseError {
3621 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
3624 let routing = match payment.forward_info.routing {
3625 PendingHTLCRouting::Forward { onion_packet, .. } => {
3626 PendingHTLCRouting::Forward { onion_packet, short_channel_id: next_hop_scid }
3628 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
3630 let skimmed_fee_msat =
3631 payment.forward_info.outgoing_amt_msat.saturating_sub(amt_to_forward_msat);
3632 let pending_htlc_info = PendingHTLCInfo {
3633 skimmed_fee_msat: if skimmed_fee_msat == 0 { None } else { Some(skimmed_fee_msat) },
3634 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
3637 let mut per_source_pending_forward = [(
3638 payment.prev_short_channel_id,
3639 payment.prev_funding_outpoint,
3640 payment.prev_user_channel_id,
3641 vec![(pending_htlc_info, payment.prev_htlc_id)]
3643 self.forward_htlcs(&mut per_source_pending_forward);
3647 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
3648 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
3650 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
3653 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
3654 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
3655 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3657 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
3658 .ok_or_else(|| APIError::APIMisuseError {
3659 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
3662 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
3663 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3664 short_channel_id: payment.prev_short_channel_id,
3665 outpoint: payment.prev_funding_outpoint,
3666 htlc_id: payment.prev_htlc_id,
3667 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
3668 phantom_shared_secret: None,
3671 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
3672 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
3673 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
3674 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
3679 /// Processes HTLCs which are pending waiting on random forward delay.
3681 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
3682 /// Will likely generate further events.
3683 pub fn process_pending_htlc_forwards(&self) {
3684 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
3686 let mut new_events = VecDeque::new();
3687 let mut failed_forwards = Vec::new();
3688 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
3690 let mut forward_htlcs = HashMap::new();
3691 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
3693 for (short_chan_id, mut pending_forwards) in forward_htlcs {
3694 if short_chan_id != 0 {
3695 macro_rules! forwarding_channel_not_found {
3697 for forward_info in pending_forwards.drain(..) {
3698 match forward_info {
3699 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3700 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3701 forward_info: PendingHTLCInfo {
3702 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
3703 outgoing_cltv_value, ..
3706 macro_rules! failure_handler {
3707 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
3708 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3710 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3711 short_channel_id: prev_short_channel_id,
3712 outpoint: prev_funding_outpoint,
3713 htlc_id: prev_htlc_id,
3714 incoming_packet_shared_secret: incoming_shared_secret,
3715 phantom_shared_secret: $phantom_ss,
3718 let reason = if $next_hop_unknown {
3719 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
3721 HTLCDestination::FailedPayment{ payment_hash }
3724 failed_forwards.push((htlc_source, payment_hash,
3725 HTLCFailReason::reason($err_code, $err_data),
3731 macro_rules! fail_forward {
3732 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3734 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
3738 macro_rules! failed_payment {
3739 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3741 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
3745 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
3746 let phantom_pubkey_res = self.node_signer.get_node_id(Recipient::PhantomNode);
3747 if phantom_pubkey_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.genesis_hash) {
3748 let phantom_shared_secret = self.node_signer.ecdh(Recipient::PhantomNode, &onion_packet.public_key.unwrap(), None).unwrap().secret_bytes();
3749 let next_hop = match onion_utils::decode_next_payment_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
3751 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
3752 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
3753 // In this scenario, the phantom would have sent us an
3754 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
3755 // if it came from us (the second-to-last hop) but contains the sha256
3757 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
3759 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3760 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
3764 onion_utils::Hop::Receive(hop_data) => {
3765 match self.construct_recv_pending_htlc_info(hop_data,
3766 incoming_shared_secret, payment_hash, outgoing_amt_msat,
3767 outgoing_cltv_value, Some(phantom_shared_secret), false, None)
3769 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
3770 Err(ReceiveError { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
3776 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3779 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3782 HTLCForwardInfo::FailHTLC { .. } => {
3783 // Channel went away before we could fail it. This implies
3784 // the channel is now on chain and our counterparty is
3785 // trying to broadcast the HTLC-Timeout, but that's their
3786 // problem, not ours.
3792 let (counterparty_node_id, forward_chan_id) = match self.short_to_chan_info.read().unwrap().get(&short_chan_id) {
3793 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3795 forwarding_channel_not_found!();
3799 let per_peer_state = self.per_peer_state.read().unwrap();
3800 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3801 if peer_state_mutex_opt.is_none() {
3802 forwarding_channel_not_found!();
3805 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
3806 let peer_state = &mut *peer_state_lock;
3807 match peer_state.channel_by_id.entry(forward_chan_id) {
3808 hash_map::Entry::Vacant(_) => {
3809 forwarding_channel_not_found!();
3812 hash_map::Entry::Occupied(mut chan) => {
3813 for forward_info in pending_forwards.drain(..) {
3814 match forward_info {
3815 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3816 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id: _,
3817 forward_info: PendingHTLCInfo {
3818 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
3819 routing: PendingHTLCRouting::Forward { onion_packet, .. }, skimmed_fee_msat, ..
3822 log_trace!(self.logger, "Adding HTLC from short id {} with payment_hash {} to channel with short id {} after delay", prev_short_channel_id, log_bytes!(payment_hash.0), short_chan_id);
3823 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3824 short_channel_id: prev_short_channel_id,
3825 outpoint: prev_funding_outpoint,
3826 htlc_id: prev_htlc_id,
3827 incoming_packet_shared_secret: incoming_shared_secret,
3828 // Phantom payments are only PendingHTLCRouting::Receive.
3829 phantom_shared_secret: None,
3831 if let Err(e) = chan.get_mut().queue_add_htlc(outgoing_amt_msat,
3832 payment_hash, outgoing_cltv_value, htlc_source.clone(),
3833 onion_packet, skimmed_fee_msat, &self.fee_estimator,
3836 if let ChannelError::Ignore(msg) = e {
3837 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
3839 panic!("Stated return value requirements in send_htlc() were not met");
3841 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan.get());
3842 failed_forwards.push((htlc_source, payment_hash,
3843 HTLCFailReason::reason(failure_code, data),
3844 HTLCDestination::NextHopChannel { node_id: Some(chan.get().context.get_counterparty_node_id()), channel_id: forward_chan_id }
3849 HTLCForwardInfo::AddHTLC { .. } => {
3850 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
3852 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
3853 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
3854 if let Err(e) = chan.get_mut().queue_fail_htlc(
3855 htlc_id, err_packet, &self.logger
3857 if let ChannelError::Ignore(msg) = e {
3858 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
3860 panic!("Stated return value requirements in queue_fail_htlc() were not met");
3862 // fail-backs are best-effort, we probably already have one
3863 // pending, and if not that's OK, if not, the channel is on
3864 // the chain and sending the HTLC-Timeout is their problem.
3873 'next_forwardable_htlc: for forward_info in pending_forwards.drain(..) {
3874 match forward_info {
3875 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3876 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3877 forward_info: PendingHTLCInfo {
3878 routing, incoming_shared_secret, payment_hash, incoming_amt_msat, outgoing_amt_msat,
3879 skimmed_fee_msat, ..
3882 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret, mut onion_fields) = match routing {
3883 PendingHTLCRouting::Receive { payment_data, payment_metadata, incoming_cltv_expiry, phantom_shared_secret } => {
3884 let _legacy_hop_data = Some(payment_data.clone());
3886 RecipientOnionFields { payment_secret: Some(payment_data.payment_secret), payment_metadata };
3887 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data },
3888 Some(payment_data), phantom_shared_secret, onion_fields)
3890 PendingHTLCRouting::ReceiveKeysend { payment_data, payment_preimage, payment_metadata, incoming_cltv_expiry } => {
3891 let onion_fields = RecipientOnionFields {
3892 payment_secret: payment_data.as_ref().map(|data| data.payment_secret),
3895 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage),
3896 payment_data, None, onion_fields)
3899 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
3902 let claimable_htlc = ClaimableHTLC {
3903 prev_hop: HTLCPreviousHopData {
3904 short_channel_id: prev_short_channel_id,
3905 outpoint: prev_funding_outpoint,
3906 htlc_id: prev_htlc_id,
3907 incoming_packet_shared_secret: incoming_shared_secret,
3908 phantom_shared_secret,
3910 // We differentiate the received value from the sender intended value
3911 // if possible so that we don't prematurely mark MPP payments complete
3912 // if routing nodes overpay
3913 value: incoming_amt_msat.unwrap_or(outgoing_amt_msat),
3914 sender_intended_value: outgoing_amt_msat,
3916 total_value_received: None,
3917 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
3920 counterparty_skimmed_fee_msat: skimmed_fee_msat,
3923 let mut committed_to_claimable = false;
3925 macro_rules! fail_htlc {
3926 ($htlc: expr, $payment_hash: expr) => {
3927 debug_assert!(!committed_to_claimable);
3928 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
3929 htlc_msat_height_data.extend_from_slice(
3930 &self.best_block.read().unwrap().height().to_be_bytes(),
3932 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
3933 short_channel_id: $htlc.prev_hop.short_channel_id,
3934 outpoint: prev_funding_outpoint,
3935 htlc_id: $htlc.prev_hop.htlc_id,
3936 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
3937 phantom_shared_secret,
3939 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
3940 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
3942 continue 'next_forwardable_htlc;
3945 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
3946 let mut receiver_node_id = self.our_network_pubkey;
3947 if phantom_shared_secret.is_some() {
3948 receiver_node_id = self.node_signer.get_node_id(Recipient::PhantomNode)
3949 .expect("Failed to get node_id for phantom node recipient");
3952 macro_rules! check_total_value {
3953 ($purpose: expr) => {{
3954 let mut payment_claimable_generated = false;
3955 let is_keysend = match $purpose {
3956 events::PaymentPurpose::SpontaneousPayment(_) => true,
3957 events::PaymentPurpose::InvoicePayment { .. } => false,
3959 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3960 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
3961 fail_htlc!(claimable_htlc, payment_hash);
3963 let ref mut claimable_payment = claimable_payments.claimable_payments
3964 .entry(payment_hash)
3965 // Note that if we insert here we MUST NOT fail_htlc!()
3966 .or_insert_with(|| {
3967 committed_to_claimable = true;
3969 purpose: $purpose.clone(), htlcs: Vec::new(), onion_fields: None,
3972 if $purpose != claimable_payment.purpose {
3973 let log_keysend = |keysend| if keysend { "keysend" } else { "non-keysend" };
3974 log_trace!(self.logger, "Failing new {} HTLC with payment_hash {} as we already had an existing {} HTLC with the same payment hash", log_keysend(is_keysend), log_bytes!(payment_hash.0), log_keysend(!is_keysend));
3975 fail_htlc!(claimable_htlc, payment_hash);
3977 if !self.default_configuration.accept_mpp_keysend && is_keysend && !claimable_payment.htlcs.is_empty() {
3978 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} as we already had an existing keysend HTLC with the same payment hash and our config states we don't accept MPP keysend", log_bytes!(payment_hash.0));
3979 fail_htlc!(claimable_htlc, payment_hash);
3981 if let Some(earlier_fields) = &mut claimable_payment.onion_fields {
3982 if earlier_fields.check_merge(&mut onion_fields).is_err() {
3983 fail_htlc!(claimable_htlc, payment_hash);
3986 claimable_payment.onion_fields = Some(onion_fields);
3988 let ref mut htlcs = &mut claimable_payment.htlcs;
3989 let mut total_value = claimable_htlc.sender_intended_value;
3990 let mut earliest_expiry = claimable_htlc.cltv_expiry;
3991 for htlc in htlcs.iter() {
3992 total_value += htlc.sender_intended_value;
3993 earliest_expiry = cmp::min(earliest_expiry, htlc.cltv_expiry);
3994 if htlc.total_msat != claimable_htlc.total_msat {
3995 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
3996 log_bytes!(payment_hash.0), claimable_htlc.total_msat, htlc.total_msat);
3997 total_value = msgs::MAX_VALUE_MSAT;
3999 if total_value >= msgs::MAX_VALUE_MSAT { break; }
4001 // The condition determining whether an MPP is complete must
4002 // match exactly the condition used in `timer_tick_occurred`
4003 if total_value >= msgs::MAX_VALUE_MSAT {
4004 fail_htlc!(claimable_htlc, payment_hash);
4005 } else if total_value - claimable_htlc.sender_intended_value >= claimable_htlc.total_msat {
4006 log_trace!(self.logger, "Failing HTLC with payment_hash {} as payment is already claimable",
4007 log_bytes!(payment_hash.0));
4008 fail_htlc!(claimable_htlc, payment_hash);
4009 } else if total_value >= claimable_htlc.total_msat {
4010 #[allow(unused_assignments)] {
4011 committed_to_claimable = true;
4013 let prev_channel_id = prev_funding_outpoint.to_channel_id();
4014 htlcs.push(claimable_htlc);
4015 let amount_msat = htlcs.iter().map(|htlc| htlc.value).sum();
4016 htlcs.iter_mut().for_each(|htlc| htlc.total_value_received = Some(amount_msat));
4017 let counterparty_skimmed_fee_msat = htlcs.iter()
4018 .map(|htlc| htlc.counterparty_skimmed_fee_msat.unwrap_or(0)).sum();
4019 debug_assert!(total_value.saturating_sub(amount_msat) <=
4020 counterparty_skimmed_fee_msat);
4021 new_events.push_back((events::Event::PaymentClaimable {
4022 receiver_node_id: Some(receiver_node_id),
4026 counterparty_skimmed_fee_msat,
4027 via_channel_id: Some(prev_channel_id),
4028 via_user_channel_id: Some(prev_user_channel_id),
4029 claim_deadline: Some(earliest_expiry - HTLC_FAIL_BACK_BUFFER),
4030 onion_fields: claimable_payment.onion_fields.clone(),
4032 payment_claimable_generated = true;
4034 // Nothing to do - we haven't reached the total
4035 // payment value yet, wait until we receive more
4037 htlcs.push(claimable_htlc);
4038 #[allow(unused_assignments)] {
4039 committed_to_claimable = true;
4042 payment_claimable_generated
4046 // Check that the payment hash and secret are known. Note that we
4047 // MUST take care to handle the "unknown payment hash" and
4048 // "incorrect payment secret" cases here identically or we'd expose
4049 // that we are the ultimate recipient of the given payment hash.
4050 // Further, we must not expose whether we have any other HTLCs
4051 // associated with the same payment_hash pending or not.
4052 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4053 match payment_secrets.entry(payment_hash) {
4054 hash_map::Entry::Vacant(_) => {
4055 match claimable_htlc.onion_payload {
4056 OnionPayload::Invoice { .. } => {
4057 let payment_data = payment_data.unwrap();
4058 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) {
4059 Ok(result) => result,
4061 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as payment verification failed", log_bytes!(payment_hash.0));
4062 fail_htlc!(claimable_htlc, payment_hash);
4065 if let Some(min_final_cltv_expiry_delta) = min_final_cltv_expiry_delta {
4066 let expected_min_expiry_height = (self.current_best_block().height() + min_final_cltv_expiry_delta as u32) as u64;
4067 if (cltv_expiry as u64) < expected_min_expiry_height {
4068 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as its CLTV expiry was too soon (had {}, earliest expected {})",
4069 log_bytes!(payment_hash.0), cltv_expiry, expected_min_expiry_height);
4070 fail_htlc!(claimable_htlc, payment_hash);
4073 let purpose = events::PaymentPurpose::InvoicePayment {
4074 payment_preimage: payment_preimage.clone(),
4075 payment_secret: payment_data.payment_secret,
4077 check_total_value!(purpose);
4079 OnionPayload::Spontaneous(preimage) => {
4080 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
4081 check_total_value!(purpose);
4085 hash_map::Entry::Occupied(inbound_payment) => {
4086 if let OnionPayload::Spontaneous(_) = claimable_htlc.onion_payload {
4087 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} because we already have an inbound payment with the same payment hash", log_bytes!(payment_hash.0));
4088 fail_htlc!(claimable_htlc, payment_hash);
4090 let payment_data = payment_data.unwrap();
4091 if inbound_payment.get().payment_secret != payment_data.payment_secret {
4092 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
4093 fail_htlc!(claimable_htlc, payment_hash);
4094 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
4095 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
4096 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
4097 fail_htlc!(claimable_htlc, payment_hash);
4099 let purpose = events::PaymentPurpose::InvoicePayment {
4100 payment_preimage: inbound_payment.get().payment_preimage,
4101 payment_secret: payment_data.payment_secret,
4103 let payment_claimable_generated = check_total_value!(purpose);
4104 if payment_claimable_generated {
4105 inbound_payment.remove_entry();
4111 HTLCForwardInfo::FailHTLC { .. } => {
4112 panic!("Got pending fail of our own HTLC");
4120 let best_block_height = self.best_block.read().unwrap().height();
4121 self.pending_outbound_payments.check_retry_payments(&self.router, || self.list_usable_channels(),
4122 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
4123 &self.pending_events, &self.logger,
4124 |path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv|
4125 self.send_payment_along_path(path, payment_hash, recipient_onion, total_value, cur_height, payment_id, keysend_preimage, session_priv));
4127 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
4128 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4130 self.forward_htlcs(&mut phantom_receives);
4132 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
4133 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
4134 // nice to do the work now if we can rather than while we're trying to get messages in the
4136 self.check_free_holding_cells();
4138 if new_events.is_empty() { return }
4139 let mut events = self.pending_events.lock().unwrap();
4140 events.append(&mut new_events);
4143 /// Free the background events, generally called from [`PersistenceNotifierGuard`] constructors.
4145 /// Expects the caller to have a total_consistency_lock read lock.
4146 fn process_background_events(&self) -> NotifyOption {
4147 debug_assert_ne!(self.total_consistency_lock.held_by_thread(), LockHeldState::NotHeldByThread);
4149 self.background_events_processed_since_startup.store(true, Ordering::Release);
4151 let mut background_events = Vec::new();
4152 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
4153 if background_events.is_empty() {
4154 return NotifyOption::SkipPersist;
4157 for event in background_events.drain(..) {
4159 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((funding_txo, update)) => {
4160 // The channel has already been closed, so no use bothering to care about the
4161 // monitor updating completing.
4162 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4164 BackgroundEvent::MonitorUpdateRegeneratedOnStartup { counterparty_node_id, funding_txo, update } => {
4165 let mut updated_chan = false;
4167 let per_peer_state = self.per_peer_state.read().unwrap();
4168 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4169 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4170 let peer_state = &mut *peer_state_lock;
4171 match peer_state.channel_by_id.entry(funding_txo.to_channel_id()) {
4172 hash_map::Entry::Occupied(mut chan) => {
4173 updated_chan = true;
4174 handle_new_monitor_update!(self, funding_txo, update.clone(),
4175 peer_state_lock, peer_state, per_peer_state, chan).map(|_| ())
4177 hash_map::Entry::Vacant(_) => Ok(()),
4182 // TODO: Track this as in-flight even though the channel is closed.
4183 let _ = self.chain_monitor.update_channel(funding_txo, &update);
4185 // TODO: If this channel has since closed, we're likely providing a payment
4186 // preimage update, which we must ensure is durable! We currently don't,
4187 // however, ensure that.
4189 log_error!(self.logger,
4190 "Failed to provide ChannelMonitorUpdate to closed channel! This likely lost us a payment preimage!");
4192 let _ = handle_error!(self, res, counterparty_node_id);
4196 NotifyOption::DoPersist
4199 #[cfg(any(test, feature = "_test_utils"))]
4200 /// Process background events, for functional testing
4201 pub fn test_process_background_events(&self) {
4202 let _lck = self.total_consistency_lock.read().unwrap();
4203 let _ = self.process_background_events();
4206 fn update_channel_fee(&self, chan_id: &[u8; 32], chan: &mut Channel<<SP::Target as SignerProvider>::Signer>, new_feerate: u32) -> NotifyOption {
4207 if !chan.context.is_outbound() { return NotifyOption::SkipPersist; }
4208 // If the feerate has decreased by less than half, don't bother
4209 if new_feerate <= chan.context.get_feerate_sat_per_1000_weight() && new_feerate * 2 > chan.context.get_feerate_sat_per_1000_weight() {
4210 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
4211 log_bytes!(chan_id[..]), chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4212 return NotifyOption::SkipPersist;
4214 if !chan.context.is_live() {
4215 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).",
4216 log_bytes!(chan_id[..]), chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4217 return NotifyOption::SkipPersist;
4219 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
4220 log_bytes!(chan_id[..]), chan.context.get_feerate_sat_per_1000_weight(), new_feerate);
4222 chan.queue_update_fee(new_feerate, &self.fee_estimator, &self.logger);
4223 NotifyOption::DoPersist
4227 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
4228 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
4229 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
4230 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
4231 pub fn maybe_update_chan_fees(&self) {
4232 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4233 let mut should_persist = self.process_background_events();
4235 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4237 let per_peer_state = self.per_peer_state.read().unwrap();
4238 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
4239 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4240 let peer_state = &mut *peer_state_lock;
4241 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
4242 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4243 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4251 /// Performs actions which should happen on startup and roughly once per minute thereafter.
4253 /// This currently includes:
4254 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
4255 /// * Broadcasting [`ChannelUpdate`] messages if we've been disconnected from our peer for more
4256 /// than a minute, informing the network that they should no longer attempt to route over
4258 /// * Expiring a channel's previous [`ChannelConfig`] if necessary to only allow forwarding HTLCs
4259 /// with the current [`ChannelConfig`].
4260 /// * Removing peers which have disconnected but and no longer have any channels.
4262 /// Note that this may cause reentrancy through [`chain::Watch::update_channel`] calls or feerate
4263 /// estimate fetches.
4265 /// [`ChannelUpdate`]: msgs::ChannelUpdate
4266 /// [`ChannelConfig`]: crate::util::config::ChannelConfig
4267 pub fn timer_tick_occurred(&self) {
4268 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4269 let mut should_persist = self.process_background_events();
4271 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4273 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
4274 let mut timed_out_mpp_htlcs = Vec::new();
4275 let mut pending_peers_awaiting_removal = Vec::new();
4277 let per_peer_state = self.per_peer_state.read().unwrap();
4278 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
4279 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4280 let peer_state = &mut *peer_state_lock;
4281 let pending_msg_events = &mut peer_state.pending_msg_events;
4282 let counterparty_node_id = *counterparty_node_id;
4283 peer_state.channel_by_id.retain(|chan_id, chan| {
4284 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
4285 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
4287 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
4288 let (needs_close, err) = convert_chan_err!(self, e, chan, chan_id);
4289 handle_errors.push((Err(err), counterparty_node_id));
4290 if needs_close { return false; }
4293 match chan.channel_update_status() {
4294 ChannelUpdateStatus::Enabled if !chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(0)),
4295 ChannelUpdateStatus::Disabled if chan.context.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(0)),
4296 ChannelUpdateStatus::DisabledStaged(_) if chan.context.is_live()
4297 => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
4298 ChannelUpdateStatus::EnabledStaged(_) if !chan.context.is_live()
4299 => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
4300 ChannelUpdateStatus::DisabledStaged(mut n) if !chan.context.is_live() => {
4302 if n >= DISABLE_GOSSIP_TICKS {
4303 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
4304 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4305 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4309 should_persist = NotifyOption::DoPersist;
4311 chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged(n));
4314 ChannelUpdateStatus::EnabledStaged(mut n) if chan.context.is_live() => {
4316 if n >= ENABLE_GOSSIP_TICKS {
4317 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
4318 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4319 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4323 should_persist = NotifyOption::DoPersist;
4325 chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged(n));
4331 chan.context.maybe_expire_prev_config();
4333 if chan.should_disconnect_peer_awaiting_response() {
4334 log_debug!(self.logger, "Disconnecting peer {} due to not making any progress on channel {}",
4335 counterparty_node_id, log_bytes!(*chan_id));
4336 pending_msg_events.push(MessageSendEvent::HandleError {
4337 node_id: counterparty_node_id,
4338 action: msgs::ErrorAction::DisconnectPeerWithWarning {
4339 msg: msgs::WarningMessage {
4340 channel_id: *chan_id,
4341 data: "Disconnecting due to timeout awaiting response".to_owned(),
4349 if peer_state.ok_to_remove(true) {
4350 pending_peers_awaiting_removal.push(counterparty_node_id);
4355 // When a peer disconnects but still has channels, the peer's `peer_state` entry in the
4356 // `per_peer_state` is not removed by the `peer_disconnected` function. If the channels
4357 // of to that peer is later closed while still being disconnected (i.e. force closed),
4358 // we therefore need to remove the peer from `peer_state` separately.
4359 // To avoid having to take the `per_peer_state` `write` lock once the channels are
4360 // closed, we instead remove such peers awaiting removal here on a timer, to limit the
4361 // negative effects on parallelism as much as possible.
4362 if pending_peers_awaiting_removal.len() > 0 {
4363 let mut per_peer_state = self.per_peer_state.write().unwrap();
4364 for counterparty_node_id in pending_peers_awaiting_removal {
4365 match per_peer_state.entry(counterparty_node_id) {
4366 hash_map::Entry::Occupied(entry) => {
4367 // Remove the entry if the peer is still disconnected and we still
4368 // have no channels to the peer.
4369 let remove_entry = {
4370 let peer_state = entry.get().lock().unwrap();
4371 peer_state.ok_to_remove(true)
4374 entry.remove_entry();
4377 hash_map::Entry::Vacant(_) => { /* The PeerState has already been removed */ }
4382 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
4383 if payment.htlcs.is_empty() {
4384 // This should be unreachable
4385 debug_assert!(false);
4388 if let OnionPayload::Invoice { .. } = payment.htlcs[0].onion_payload {
4389 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
4390 // In this case we're not going to handle any timeouts of the parts here.
4391 // This condition determining whether the MPP is complete here must match
4392 // exactly the condition used in `process_pending_htlc_forwards`.
4393 if payment.htlcs[0].total_msat <= payment.htlcs.iter()
4394 .fold(0, |total, htlc| total + htlc.sender_intended_value)
4397 } else if payment.htlcs.iter_mut().any(|htlc| {
4398 htlc.timer_ticks += 1;
4399 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
4401 timed_out_mpp_htlcs.extend(payment.htlcs.drain(..)
4402 .map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
4409 for htlc_source in timed_out_mpp_htlcs.drain(..) {
4410 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
4411 let reason = HTLCFailReason::from_failure_code(23);
4412 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
4413 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
4416 for (err, counterparty_node_id) in handle_errors.drain(..) {
4417 let _ = handle_error!(self, err, counterparty_node_id);
4420 self.pending_outbound_payments.remove_stale_resolved_payments(&self.pending_events);
4422 // Technically we don't need to do this here, but if we have holding cell entries in a
4423 // channel that need freeing, it's better to do that here and block a background task
4424 // than block the message queueing pipeline.
4425 if self.check_free_holding_cells() {
4426 should_persist = NotifyOption::DoPersist;
4433 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
4434 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
4435 /// along the path (including in our own channel on which we received it).
4437 /// Note that in some cases around unclean shutdown, it is possible the payment may have
4438 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
4439 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
4440 /// may have already been failed automatically by LDK if it was nearing its expiration time.
4442 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
4443 /// [`ChannelManager::claim_funds`]), you should still monitor for
4444 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
4445 /// startup during which time claims that were in-progress at shutdown may be replayed.
4446 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
4447 self.fail_htlc_backwards_with_reason(payment_hash, FailureCode::IncorrectOrUnknownPaymentDetails);
4450 /// This is a variant of [`ChannelManager::fail_htlc_backwards`] that allows you to specify the
4451 /// reason for the failure.
4453 /// See [`FailureCode`] for valid failure codes.
4454 pub fn fail_htlc_backwards_with_reason(&self, payment_hash: &PaymentHash, failure_code: FailureCode) {
4455 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4457 let removed_source = self.claimable_payments.lock().unwrap().claimable_payments.remove(payment_hash);
4458 if let Some(payment) = removed_source {
4459 for htlc in payment.htlcs {
4460 let reason = self.get_htlc_fail_reason_from_failure_code(failure_code, &htlc);
4461 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
4462 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
4463 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
4468 /// Gets error data to form an [`HTLCFailReason`] given a [`FailureCode`] and [`ClaimableHTLC`].
4469 fn get_htlc_fail_reason_from_failure_code(&self, failure_code: FailureCode, htlc: &ClaimableHTLC) -> HTLCFailReason {
4470 match failure_code {
4471 FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(failure_code as u16),
4472 FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(failure_code as u16),
4473 FailureCode::IncorrectOrUnknownPaymentDetails => {
4474 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
4475 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
4476 HTLCFailReason::reason(failure_code as u16, htlc_msat_height_data)
4481 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
4482 /// that we want to return and a channel.
4484 /// This is for failures on the channel on which the HTLC was *received*, not failures
4486 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> (u16, Vec<u8>) {
4487 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
4488 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
4489 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
4490 // an inbound SCID alias before the real SCID.
4491 let scid_pref = if chan.context.should_announce() {
4492 chan.context.get_short_channel_id().or(chan.context.latest_inbound_scid_alias())
4494 chan.context.latest_inbound_scid_alias().or(chan.context.get_short_channel_id())
4496 if let Some(scid) = scid_pref {
4497 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
4499 (0x4000|10, Vec::new())
4504 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
4505 /// that we want to return and a channel.
4506 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> (u16, Vec<u8>) {
4507 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
4508 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
4509 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
4510 if desired_err_code == 0x1000 | 20 {
4511 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
4512 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
4513 0u16.write(&mut enc).expect("Writes cannot fail");
4515 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
4516 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
4517 upd.write(&mut enc).expect("Writes cannot fail");
4518 (desired_err_code, enc.0)
4520 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
4521 // which means we really shouldn't have gotten a payment to be forwarded over this
4522 // channel yet, or if we did it's from a route hint. Either way, returning an error of
4523 // PERM|no_such_channel should be fine.
4524 (0x4000|10, Vec::new())
4528 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
4529 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
4530 // be surfaced to the user.
4531 fn fail_holding_cell_htlcs(
4532 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32],
4533 counterparty_node_id: &PublicKey
4535 let (failure_code, onion_failure_data) = {
4536 let per_peer_state = self.per_peer_state.read().unwrap();
4537 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4538 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4539 let peer_state = &mut *peer_state_lock;
4540 match peer_state.channel_by_id.entry(channel_id) {
4541 hash_map::Entry::Occupied(chan_entry) => {
4542 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan_entry.get())
4544 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
4546 } else { (0x4000|10, Vec::new()) }
4549 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
4550 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
4551 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
4552 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
4556 /// Fails an HTLC backwards to the sender of it to us.
4557 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
4558 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
4559 // Ensure that no peer state channel storage lock is held when calling this function.
4560 // This ensures that future code doesn't introduce a lock-order requirement for
4561 // `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
4562 // this function with any `per_peer_state` peer lock acquired would.
4563 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
4564 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
4567 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
4568 //identify whether we sent it or not based on the (I presume) very different runtime
4569 //between the branches here. We should make this async and move it into the forward HTLCs
4572 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4573 // from block_connected which may run during initialization prior to the chain_monitor
4574 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
4576 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, .. } => {
4577 if self.pending_outbound_payments.fail_htlc(source, payment_hash, onion_error, path,
4578 session_priv, payment_id, self.probing_cookie_secret, &self.secp_ctx,
4579 &self.pending_events, &self.logger)
4580 { self.push_pending_forwards_ev(); }
4582 HTLCSource::PreviousHopData(HTLCPreviousHopData { ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret, ref phantom_shared_secret, ref outpoint }) => {
4583 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with {:?}", log_bytes!(payment_hash.0), onion_error);
4584 let err_packet = onion_error.get_encrypted_failure_packet(incoming_packet_shared_secret, phantom_shared_secret);
4586 let mut push_forward_ev = false;
4587 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
4588 if forward_htlcs.is_empty() {
4589 push_forward_ev = true;
4591 match forward_htlcs.entry(*short_channel_id) {
4592 hash_map::Entry::Occupied(mut entry) => {
4593 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet });
4595 hash_map::Entry::Vacant(entry) => {
4596 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }));
4599 mem::drop(forward_htlcs);
4600 if push_forward_ev { self.push_pending_forwards_ev(); }
4601 let mut pending_events = self.pending_events.lock().unwrap();
4602 pending_events.push_back((events::Event::HTLCHandlingFailed {
4603 prev_channel_id: outpoint.to_channel_id(),
4604 failed_next_destination: destination,
4610 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
4611 /// [`MessageSendEvent`]s needed to claim the payment.
4613 /// This method is guaranteed to ensure the payment has been claimed but only if the current
4614 /// height is strictly below [`Event::PaymentClaimable::claim_deadline`]. To avoid race
4615 /// conditions, you should wait for an [`Event::PaymentClaimed`] before considering the payment
4616 /// successful. It will generally be available in the next [`process_pending_events`] call.
4618 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
4619 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
4620 /// event matches your expectation. If you fail to do so and call this method, you may provide
4621 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
4623 /// [`Event::PaymentClaimable`]: crate::events::Event::PaymentClaimable
4624 /// [`Event::PaymentClaimable::claim_deadline`]: crate::events::Event::PaymentClaimable::claim_deadline
4625 /// [`Event::PaymentClaimed`]: crate::events::Event::PaymentClaimed
4626 /// [`process_pending_events`]: EventsProvider::process_pending_events
4627 /// [`create_inbound_payment`]: Self::create_inbound_payment
4628 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
4629 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
4630 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4632 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
4635 let mut claimable_payments = self.claimable_payments.lock().unwrap();
4636 if let Some(payment) = claimable_payments.claimable_payments.remove(&payment_hash) {
4637 let mut receiver_node_id = self.our_network_pubkey;
4638 for htlc in payment.htlcs.iter() {
4639 if htlc.prev_hop.phantom_shared_secret.is_some() {
4640 let phantom_pubkey = self.node_signer.get_node_id(Recipient::PhantomNode)
4641 .expect("Failed to get node_id for phantom node recipient");
4642 receiver_node_id = phantom_pubkey;
4647 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
4648 ClaimingPayment { amount_msat: payment.htlcs.iter().map(|source| source.value).sum(),
4649 payment_purpose: payment.purpose, receiver_node_id,
4651 if dup_purpose.is_some() {
4652 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
4653 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
4654 log_bytes!(payment_hash.0));
4659 debug_assert!(!sources.is_empty());
4661 // Just in case one HTLC has been failed between when we generated the `PaymentClaimable`
4662 // and when we got here we need to check that the amount we're about to claim matches the
4663 // amount we told the user in the last `PaymentClaimable`. We also do a sanity-check that
4664 // the MPP parts all have the same `total_msat`.
4665 let mut claimable_amt_msat = 0;
4666 let mut prev_total_msat = None;
4667 let mut expected_amt_msat = None;
4668 let mut valid_mpp = true;
4669 let mut errs = Vec::new();
4670 let per_peer_state = self.per_peer_state.read().unwrap();
4671 for htlc in sources.iter() {
4672 if prev_total_msat.is_some() && prev_total_msat != Some(htlc.total_msat) {
4673 log_error!(self.logger, "Somehow ended up with an MPP payment with different expected total amounts - this should not be reachable!");
4674 debug_assert!(false);
4678 prev_total_msat = Some(htlc.total_msat);
4680 if expected_amt_msat.is_some() && expected_amt_msat != htlc.total_value_received {
4681 log_error!(self.logger, "Somehow ended up with an MPP payment with different received total amounts - this should not be reachable!");
4682 debug_assert!(false);
4686 expected_amt_msat = htlc.total_value_received;
4687 claimable_amt_msat += htlc.value;
4689 mem::drop(per_peer_state);
4690 if sources.is_empty() || expected_amt_msat.is_none() {
4691 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4692 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
4695 if claimable_amt_msat != expected_amt_msat.unwrap() {
4696 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4697 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
4698 expected_amt_msat.unwrap(), claimable_amt_msat);
4702 for htlc in sources.drain(..) {
4703 if let Err((pk, err)) = self.claim_funds_from_hop(
4704 htlc.prev_hop, payment_preimage,
4705 |_| Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash }))
4707 if let msgs::ErrorAction::IgnoreError = err.err.action {
4708 // We got a temporary failure updating monitor, but will claim the
4709 // HTLC when the monitor updating is restored (or on chain).
4710 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
4711 } else { errs.push((pk, err)); }
4716 for htlc in sources.drain(..) {
4717 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
4718 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
4719 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
4720 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
4721 let receiver = HTLCDestination::FailedPayment { payment_hash };
4722 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
4724 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4727 // Now we can handle any errors which were generated.
4728 for (counterparty_node_id, err) in errs.drain(..) {
4729 let res: Result<(), _> = Err(err);
4730 let _ = handle_error!(self, res, counterparty_node_id);
4734 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>) -> Option<MonitorUpdateCompletionAction>>(&self,
4735 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
4736 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
4737 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
4739 // If we haven't yet run background events assume we're still deserializing and shouldn't
4740 // actually pass `ChannelMonitorUpdate`s to users yet. Instead, queue them up as
4741 // `BackgroundEvent`s.
4742 let during_init = !self.background_events_processed_since_startup.load(Ordering::Acquire);
4745 let per_peer_state = self.per_peer_state.read().unwrap();
4746 let chan_id = prev_hop.outpoint.to_channel_id();
4747 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
4748 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
4752 let peer_state_opt = counterparty_node_id_opt.as_ref().map(
4753 |counterparty_node_id| per_peer_state.get(counterparty_node_id)
4754 .map(|peer_mutex| peer_mutex.lock().unwrap())
4757 if peer_state_opt.is_some() {
4758 let mut peer_state_lock = peer_state_opt.unwrap();
4759 let peer_state = &mut *peer_state_lock;
4760 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(chan_id) {
4761 let counterparty_node_id = chan.get().context.get_counterparty_node_id();
4762 let fulfill_res = chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger);
4764 if let UpdateFulfillCommitFetch::NewClaim { htlc_value_msat, monitor_update } = fulfill_res {
4765 if let Some(action) = completion_action(Some(htlc_value_msat)) {
4766 log_trace!(self.logger, "Tracking monitor update completion action for channel {}: {:?}",
4767 log_bytes!(chan_id), action);
4768 peer_state.monitor_update_blocked_actions.entry(chan_id).or_insert(Vec::new()).push(action);
4771 let res = handle_new_monitor_update!(self, prev_hop.outpoint, monitor_update, peer_state_lock,
4772 peer_state, per_peer_state, chan);
4773 if let Err(e) = res {
4774 // TODO: This is a *critical* error - we probably updated the outbound edge
4775 // of the HTLC's monitor with a preimage. We should retry this monitor
4776 // update over and over again until morale improves.
4777 log_error!(self.logger, "Failed to update channel monitor with preimage {:?}", payment_preimage);
4778 return Err((counterparty_node_id, e));
4781 // If we're running during init we cannot update a monitor directly -
4782 // they probably haven't actually been loaded yet. Instead, push the
4783 // monitor update as a background event.
4784 self.pending_background_events.lock().unwrap().push(
4785 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
4786 counterparty_node_id,
4787 funding_txo: prev_hop.outpoint,
4788 update: monitor_update.clone(),
4796 let preimage_update = ChannelMonitorUpdate {
4797 update_id: CLOSED_CHANNEL_UPDATE_ID,
4798 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
4804 // We update the ChannelMonitor on the backward link, after
4805 // receiving an `update_fulfill_htlc` from the forward link.
4806 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, &preimage_update);
4807 if update_res != ChannelMonitorUpdateStatus::Completed {
4808 // TODO: This needs to be handled somehow - if we receive a monitor update
4809 // with a preimage we *must* somehow manage to propagate it to the upstream
4810 // channel, or we must have an ability to receive the same event and try
4811 // again on restart.
4812 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
4813 payment_preimage, update_res);
4816 // If we're running during init we cannot update a monitor directly - they probably
4817 // haven't actually been loaded yet. Instead, push the monitor update as a background
4819 // Note that while it's safe to use `ClosedMonitorUpdateRegeneratedOnStartup` here (the
4820 // channel is already closed) we need to ultimately handle the monitor update
4821 // completion action only after we've completed the monitor update. This is the only
4822 // way to guarantee this update *will* be regenerated on startup (otherwise if this was
4823 // from a forwarded HTLC the downstream preimage may be deleted before we claim
4824 // upstream). Thus, we need to transition to some new `BackgroundEvent` type which will
4825 // complete the monitor update completion action from `completion_action`.
4826 self.pending_background_events.lock().unwrap().push(
4827 BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((
4828 prev_hop.outpoint, preimage_update,
4831 // Note that we do process the completion action here. This totally could be a
4832 // duplicate claim, but we have no way of knowing without interrogating the
4833 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
4834 // generally always allowed to be duplicative (and it's specifically noted in
4835 // `PaymentForwarded`).
4836 self.handle_monitor_update_completion_actions(completion_action(None));
4840 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
4841 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
4844 fn claim_funds_internal(&self, source: HTLCSource, payment_preimage: PaymentPreimage, forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, next_channel_id: [u8; 32]) {
4846 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
4847 debug_assert!(self.background_events_processed_since_startup.load(Ordering::Acquire),
4848 "We don't support claim_htlc claims during startup - monitors may not be available yet");
4849 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage, session_priv, path, from_onchain, &self.pending_events, &self.logger);
4851 HTLCSource::PreviousHopData(hop_data) => {
4852 let prev_outpoint = hop_data.outpoint;
4853 let res = self.claim_funds_from_hop(hop_data, payment_preimage,
4854 |htlc_claim_value_msat| {
4855 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
4856 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
4857 Some(claimed_htlc_value - forwarded_htlc_value)
4860 Some(MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
4861 event: events::Event::PaymentForwarded {
4863 claim_from_onchain_tx: from_onchain,
4864 prev_channel_id: Some(prev_outpoint.to_channel_id()),
4865 next_channel_id: Some(next_channel_id),
4866 outbound_amount_forwarded_msat: forwarded_htlc_value_msat,
4868 downstream_counterparty_and_funding_outpoint: None,
4872 if let Err((pk, err)) = res {
4873 let result: Result<(), _> = Err(err);
4874 let _ = handle_error!(self, result, pk);
4880 /// Gets the node_id held by this ChannelManager
4881 pub fn get_our_node_id(&self) -> PublicKey {
4882 self.our_network_pubkey.clone()
4885 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
4886 for action in actions.into_iter() {
4888 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
4889 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4890 if let Some(ClaimingPayment { amount_msat, payment_purpose: purpose, receiver_node_id }) = payment {
4891 self.pending_events.lock().unwrap().push_back((events::Event::PaymentClaimed {
4892 payment_hash, purpose, amount_msat, receiver_node_id: Some(receiver_node_id),
4896 MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
4897 event, downstream_counterparty_and_funding_outpoint
4899 self.pending_events.lock().unwrap().push_back((event, None));
4900 if let Some((node_id, funding_outpoint, blocker)) = downstream_counterparty_and_funding_outpoint {
4901 self.handle_monitor_update_release(node_id, funding_outpoint, Some(blocker));
4908 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
4909 /// update completion.
4910 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
4911 channel: &mut Channel<<SP::Target as SignerProvider>::Signer>, raa: Option<msgs::RevokeAndACK>,
4912 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
4913 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
4914 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
4915 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
4916 log_trace!(self.logger, "Handling channel resumption for channel {} with {} RAA, {} commitment update, {} pending forwards, {}broadcasting funding, {} channel ready, {} announcement",
4917 log_bytes!(channel.context.channel_id()),
4918 if raa.is_some() { "an" } else { "no" },
4919 if commitment_update.is_some() { "a" } else { "no" }, pending_forwards.len(),
4920 if funding_broadcastable.is_some() { "" } else { "not " },
4921 if channel_ready.is_some() { "sending" } else { "without" },
4922 if announcement_sigs.is_some() { "sending" } else { "without" });
4924 let mut htlc_forwards = None;
4926 let counterparty_node_id = channel.context.get_counterparty_node_id();
4927 if !pending_forwards.is_empty() {
4928 htlc_forwards = Some((channel.context.get_short_channel_id().unwrap_or(channel.context.outbound_scid_alias()),
4929 channel.context.get_funding_txo().unwrap(), channel.context.get_user_id(), pending_forwards));
4932 if let Some(msg) = channel_ready {
4933 send_channel_ready!(self, pending_msg_events, channel, msg);
4935 if let Some(msg) = announcement_sigs {
4936 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4937 node_id: counterparty_node_id,
4942 macro_rules! handle_cs { () => {
4943 if let Some(update) = commitment_update {
4944 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4945 node_id: counterparty_node_id,
4950 macro_rules! handle_raa { () => {
4951 if let Some(revoke_and_ack) = raa {
4952 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
4953 node_id: counterparty_node_id,
4954 msg: revoke_and_ack,
4959 RAACommitmentOrder::CommitmentFirst => {
4963 RAACommitmentOrder::RevokeAndACKFirst => {
4969 if let Some(tx) = funding_broadcastable {
4970 log_info!(self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
4971 self.tx_broadcaster.broadcast_transactions(&[&tx]);
4975 let mut pending_events = self.pending_events.lock().unwrap();
4976 emit_channel_pending_event!(pending_events, channel);
4977 emit_channel_ready_event!(pending_events, channel);
4983 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
4984 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
4986 let counterparty_node_id = match counterparty_node_id {
4987 Some(cp_id) => cp_id.clone(),
4989 // TODO: Once we can rely on the counterparty_node_id from the
4990 // monitor event, this and the id_to_peer map should be removed.
4991 let id_to_peer = self.id_to_peer.lock().unwrap();
4992 match id_to_peer.get(&funding_txo.to_channel_id()) {
4993 Some(cp_id) => cp_id.clone(),
4998 let per_peer_state = self.per_peer_state.read().unwrap();
4999 let mut peer_state_lock;
5000 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
5001 if peer_state_mutex_opt.is_none() { return }
5002 peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5003 let peer_state = &mut *peer_state_lock;
5005 match peer_state.channel_by_id.entry(funding_txo.to_channel_id()){
5006 hash_map::Entry::Occupied(chan) => chan,
5007 hash_map::Entry::Vacant(_) => return,
5010 let remaining_in_flight =
5011 if let Some(pending) = peer_state.in_flight_monitor_updates.get_mut(funding_txo) {
5012 pending.retain(|upd| upd.update_id > highest_applied_update_id);
5015 log_trace!(self.logger, "ChannelMonitor updated to {}. Current highest is {}. {} pending in-flight updates.",
5016 highest_applied_update_id, channel.get().context.get_latest_monitor_update_id(),
5017 remaining_in_flight);
5018 if !channel.get().is_awaiting_monitor_update() || channel.get().context.get_latest_monitor_update_id() != highest_applied_update_id {
5021 handle_monitor_update_completion!(self, peer_state_lock, peer_state, per_peer_state, channel.get_mut());
5024 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
5026 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
5027 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
5030 /// The `user_channel_id` parameter will be provided back in
5031 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5032 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5034 /// Note that this method will return an error and reject the channel, if it requires support
5035 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
5036 /// used to accept such channels.
5038 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5039 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5040 pub fn accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5041 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
5044 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
5045 /// it as confirmed immediately.
5047 /// The `user_channel_id` parameter will be provided back in
5048 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
5049 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
5051 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
5052 /// and (if the counterparty agrees), enables forwarding of payments immediately.
5054 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
5055 /// transaction and blindly assumes that it will eventually confirm.
5057 /// If it does not confirm before we decide to close the channel, or if the funding transaction
5058 /// does not pay to the correct script the correct amount, *you will lose funds*.
5060 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
5061 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
5062 pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
5063 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
5066 fn do_accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
5067 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
5069 let peers_without_funded_channels =
5070 self.peers_without_funded_channels(|peer| { peer.total_channel_count() > 0 });
5071 let per_peer_state = self.per_peer_state.read().unwrap();
5072 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5073 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
5074 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5075 let peer_state = &mut *peer_state_lock;
5076 let is_only_peer_channel = peer_state.total_channel_count() == 1;
5077 match peer_state.inbound_v1_channel_by_id.entry(temporary_channel_id.clone()) {
5078 hash_map::Entry::Occupied(mut channel) => {
5079 if !channel.get().is_awaiting_accept() {
5080 return Err(APIError::APIMisuseError { err: "The channel isn't currently awaiting to be accepted.".to_owned() });
5083 channel.get_mut().set_0conf();
5084 } else if channel.get().context.get_channel_type().requires_zero_conf() {
5085 let send_msg_err_event = events::MessageSendEvent::HandleError {
5086 node_id: channel.get().context.get_counterparty_node_id(),
5087 action: msgs::ErrorAction::SendErrorMessage{
5088 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
5091 peer_state.pending_msg_events.push(send_msg_err_event);
5092 let _ = remove_channel!(self, channel);
5093 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
5095 // If this peer already has some channels, a new channel won't increase our number of peers
5096 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
5097 // channels per-peer we can accept channels from a peer with existing ones.
5098 if is_only_peer_channel && peers_without_funded_channels >= MAX_UNFUNDED_CHANNEL_PEERS {
5099 let send_msg_err_event = events::MessageSendEvent::HandleError {
5100 node_id: channel.get().context.get_counterparty_node_id(),
5101 action: msgs::ErrorAction::SendErrorMessage{
5102 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "Have too many peers with unfunded channels, not accepting new ones".to_owned(), }
5105 peer_state.pending_msg_events.push(send_msg_err_event);
5106 let _ = remove_channel!(self, channel);
5107 return Err(APIError::APIMisuseError { err: "Too many peers with unfunded channels, refusing to accept new ones".to_owned() });
5111 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
5112 node_id: channel.get().context.get_counterparty_node_id(),
5113 msg: channel.get_mut().accept_inbound_channel(user_channel_id),
5116 hash_map::Entry::Vacant(_) => {
5117 return Err(APIError::ChannelUnavailable { err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*temporary_channel_id), counterparty_node_id) });
5123 /// Gets the number of peers which match the given filter and do not have any funded, outbound,
5124 /// or 0-conf channels.
5126 /// The filter is called for each peer and provided with the number of unfunded, inbound, and
5127 /// non-0-conf channels we have with the peer.
5128 fn peers_without_funded_channels<Filter>(&self, maybe_count_peer: Filter) -> usize
5129 where Filter: Fn(&PeerState<<SP::Target as SignerProvider>::Signer>) -> bool {
5130 let mut peers_without_funded_channels = 0;
5131 let best_block_height = self.best_block.read().unwrap().height();
5133 let peer_state_lock = self.per_peer_state.read().unwrap();
5134 for (_, peer_mtx) in peer_state_lock.iter() {
5135 let peer = peer_mtx.lock().unwrap();
5136 if !maybe_count_peer(&*peer) { continue; }
5137 let num_unfunded_channels = Self::unfunded_channel_count(&peer, best_block_height);
5138 if num_unfunded_channels == peer.total_channel_count() {
5139 peers_without_funded_channels += 1;
5143 return peers_without_funded_channels;
5146 fn unfunded_channel_count(
5147 peer: &PeerState<<SP::Target as SignerProvider>::Signer>, best_block_height: u32
5149 let mut num_unfunded_channels = 0;
5150 for (_, chan) in peer.channel_by_id.iter() {
5151 // This covers non-zero-conf inbound `Channel`s that we are currently monitoring, but those
5152 // which have not yet had any confirmations on-chain.
5153 if !chan.context.is_outbound() && chan.context.minimum_depth().unwrap_or(1) != 0 &&
5154 chan.context.get_funding_tx_confirmations(best_block_height) == 0
5156 num_unfunded_channels += 1;
5159 for (_, chan) in peer.inbound_v1_channel_by_id.iter() {
5160 if chan.context.minimum_depth().unwrap_or(1) != 0 {
5161 num_unfunded_channels += 1;
5164 num_unfunded_channels
5167 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
5168 if msg.chain_hash != self.genesis_hash {
5169 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
5172 if !self.default_configuration.accept_inbound_channels {
5173 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
5176 let mut random_bytes = [0u8; 16];
5177 random_bytes.copy_from_slice(&self.entropy_source.get_secure_random_bytes()[..16]);
5178 let user_channel_id = u128::from_be_bytes(random_bytes);
5179 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
5181 // Get the number of peers with channels, but without funded ones. We don't care too much
5182 // about peers that never open a channel, so we filter by peers that have at least one
5183 // channel, and then limit the number of those with unfunded channels.
5184 let channeled_peers_without_funding =
5185 self.peers_without_funded_channels(|node| node.total_channel_count() > 0);
5187 let per_peer_state = self.per_peer_state.read().unwrap();
5188 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5190 debug_assert!(false);
5191 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())
5193 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5194 let peer_state = &mut *peer_state_lock;
5196 // If this peer already has some channels, a new channel won't increase our number of peers
5197 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
5198 // channels per-peer we can accept channels from a peer with existing ones.
5199 if peer_state.total_channel_count() == 0 &&
5200 channeled_peers_without_funding >= MAX_UNFUNDED_CHANNEL_PEERS &&
5201 !self.default_configuration.manually_accept_inbound_channels
5203 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5204 "Have too many peers with unfunded channels, not accepting new ones".to_owned(),
5205 msg.temporary_channel_id.clone()));
5208 let best_block_height = self.best_block.read().unwrap().height();
5209 if Self::unfunded_channel_count(peer_state, best_block_height) >= MAX_UNFUNDED_CHANS_PER_PEER {
5210 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5211 format!("Refusing more than {} unfunded channels.", MAX_UNFUNDED_CHANS_PER_PEER),
5212 msg.temporary_channel_id.clone()));
5215 let mut channel = match InboundV1Channel::new(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
5216 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id,
5217 &self.default_configuration, best_block_height, &self.logger, outbound_scid_alias)
5220 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
5221 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
5225 let channel_id = channel.context.channel_id();
5226 let channel_exists = peer_state.has_channel(&channel_id);
5228 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
5229 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision for the same peer!".to_owned(), msg.temporary_channel_id.clone()))
5231 if !self.default_configuration.manually_accept_inbound_channels {
5232 let channel_type = channel.context.get_channel_type();
5233 if channel_type.requires_zero_conf() {
5234 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
5236 if channel_type.requires_anchors_zero_fee_htlc_tx() {
5237 return Err(MsgHandleErrInternal::send_err_msg_no_close("No channels with anchor outputs accepted".to_owned(), msg.temporary_channel_id.clone()));
5239 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
5240 node_id: counterparty_node_id.clone(),
5241 msg: channel.accept_inbound_channel(user_channel_id),
5244 let mut pending_events = self.pending_events.lock().unwrap();
5245 pending_events.push_back((events::Event::OpenChannelRequest {
5246 temporary_channel_id: msg.temporary_channel_id.clone(),
5247 counterparty_node_id: counterparty_node_id.clone(),
5248 funding_satoshis: msg.funding_satoshis,
5249 push_msat: msg.push_msat,
5250 channel_type: channel.context.get_channel_type().clone(),
5253 peer_state.inbound_v1_channel_by_id.insert(channel_id, channel);
5258 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
5259 let (value, output_script, user_id) = {
5260 let per_peer_state = self.per_peer_state.read().unwrap();
5261 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5263 debug_assert!(false);
5264 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)
5266 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5267 let peer_state = &mut *peer_state_lock;
5268 match peer_state.outbound_v1_channel_by_id.entry(msg.temporary_channel_id) {
5269 hash_map::Entry::Occupied(mut chan) => {
5270 try_v1_outbound_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &peer_state.latest_features), chan);
5271 (chan.get().context.get_value_satoshis(), chan.get().context.get_funding_redeemscript().to_v0_p2wsh(), chan.get().context.get_user_id())
5273 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))
5276 let mut pending_events = self.pending_events.lock().unwrap();
5277 pending_events.push_back((events::Event::FundingGenerationReady {
5278 temporary_channel_id: msg.temporary_channel_id,
5279 counterparty_node_id: *counterparty_node_id,
5280 channel_value_satoshis: value,
5282 user_channel_id: user_id,
5287 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
5288 let best_block = *self.best_block.read().unwrap();
5290 let per_peer_state = self.per_peer_state.read().unwrap();
5291 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5293 debug_assert!(false);
5294 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)
5297 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5298 let peer_state = &mut *peer_state_lock;
5299 let (chan, funding_msg, monitor) =
5300 match peer_state.inbound_v1_channel_by_id.remove(&msg.temporary_channel_id) {
5301 Some(inbound_chan) => {
5302 match inbound_chan.funding_created(msg, best_block, &self.signer_provider, &self.logger) {
5304 Err((mut inbound_chan, err)) => {
5305 // We've already removed this inbound channel from the map in `PeerState`
5306 // above so at this point we just need to clean up any lingering entries
5307 // concerning this channel as it is safe to do so.
5308 update_maps_on_chan_removal!(self, &inbound_chan.context);
5309 let user_id = inbound_chan.context.get_user_id();
5310 let shutdown_res = inbound_chan.context.force_shutdown(false);
5311 return Err(MsgHandleErrInternal::from_finish_shutdown(format!("{}", err),
5312 msg.temporary_channel_id, user_id, shutdown_res, None));
5316 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))
5319 match peer_state.channel_by_id.entry(funding_msg.channel_id) {
5320 hash_map::Entry::Occupied(_) => {
5321 Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
5323 hash_map::Entry::Vacant(e) => {
5324 match self.id_to_peer.lock().unwrap().entry(chan.context.channel_id()) {
5325 hash_map::Entry::Occupied(_) => {
5326 return Err(MsgHandleErrInternal::send_err_msg_no_close(
5327 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
5328 funding_msg.channel_id))
5330 hash_map::Entry::Vacant(i_e) => {
5331 i_e.insert(chan.context.get_counterparty_node_id());
5335 // There's no problem signing a counterparty's funding transaction if our monitor
5336 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
5337 // accepted payment from yet. We do, however, need to wait to send our channel_ready
5338 // until we have persisted our monitor.
5339 let new_channel_id = funding_msg.channel_id;
5340 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
5341 node_id: counterparty_node_id.clone(),
5345 let monitor_res = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
5347 let chan = e.insert(chan);
5348 let mut res = handle_new_monitor_update!(self, monitor_res, peer_state_lock, peer_state,
5349 per_peer_state, chan, MANUALLY_REMOVING_INITIAL_MONITOR,
5350 { peer_state.channel_by_id.remove(&new_channel_id) });
5352 // Note that we reply with the new channel_id in error messages if we gave up on the
5353 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
5354 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
5355 // any messages referencing a previously-closed channel anyway.
5356 // We do not propagate the monitor update to the user as it would be for a monitor
5357 // that we didn't manage to store (and that we don't care about - we don't respond
5358 // with the funding_signed so the channel can never go on chain).
5359 if let Err(MsgHandleErrInternal { shutdown_finish: Some((res, _)), .. }) = &mut res {
5367 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
5368 let best_block = *self.best_block.read().unwrap();
5369 let per_peer_state = self.per_peer_state.read().unwrap();
5370 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5372 debug_assert!(false);
5373 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5376 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5377 let peer_state = &mut *peer_state_lock;
5378 match peer_state.channel_by_id.entry(msg.channel_id) {
5379 hash_map::Entry::Occupied(mut chan) => {
5380 let monitor = try_chan_entry!(self,
5381 chan.get_mut().funding_signed(&msg, best_block, &self.signer_provider, &self.logger), chan);
5382 let update_res = self.chain_monitor.watch_channel(chan.get().context.get_funding_txo().unwrap(), monitor);
5383 let mut res = handle_new_monitor_update!(self, update_res, peer_state_lock, peer_state, per_peer_state, chan, INITIAL_MONITOR);
5384 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
5385 // We weren't able to watch the channel to begin with, so no updates should be made on
5386 // it. Previously, full_stack_target found an (unreachable) panic when the
5387 // monitor update contained within `shutdown_finish` was applied.
5388 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
5389 shutdown_finish.0.take();
5394 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5398 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
5399 let per_peer_state = self.per_peer_state.read().unwrap();
5400 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5402 debug_assert!(false);
5403 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5405 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5406 let peer_state = &mut *peer_state_lock;
5407 match peer_state.channel_by_id.entry(msg.channel_id) {
5408 hash_map::Entry::Occupied(mut chan) => {
5409 let announcement_sigs_opt = try_chan_entry!(self, chan.get_mut().channel_ready(&msg, &self.node_signer,
5410 self.genesis_hash.clone(), &self.default_configuration, &self.best_block.read().unwrap(), &self.logger), chan);
5411 if let Some(announcement_sigs) = announcement_sigs_opt {
5412 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(chan.get().context.channel_id()));
5413 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5414 node_id: counterparty_node_id.clone(),
5415 msg: announcement_sigs,
5417 } else if chan.get().context.is_usable() {
5418 // If we're sending an announcement_signatures, we'll send the (public)
5419 // channel_update after sending a channel_announcement when we receive our
5420 // counterparty's announcement_signatures. Thus, we only bother to send a
5421 // channel_update here if the channel is not public, i.e. we're not sending an
5422 // announcement_signatures.
5423 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", log_bytes!(chan.get().context.channel_id()));
5424 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
5425 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
5426 node_id: counterparty_node_id.clone(),
5433 let mut pending_events = self.pending_events.lock().unwrap();
5434 emit_channel_ready_event!(pending_events, chan.get_mut());
5439 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))
5443 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
5444 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
5445 let result: Result<(), _> = loop {
5446 let per_peer_state = self.per_peer_state.read().unwrap();
5447 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5449 debug_assert!(false);
5450 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5452 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5453 let peer_state = &mut *peer_state_lock;
5454 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
5455 hash_map::Entry::Occupied(mut chan_entry) => {
5457 if !chan_entry.get().received_shutdown() {
5458 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
5459 log_bytes!(msg.channel_id),
5460 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
5463 let funding_txo_opt = chan_entry.get().context.get_funding_txo();
5464 let (shutdown, monitor_update_opt, htlcs) = try_chan_entry!(self,
5465 chan_entry.get_mut().shutdown(&self.signer_provider, &peer_state.latest_features, &msg), chan_entry);
5466 dropped_htlcs = htlcs;
5468 if let Some(msg) = shutdown {
5469 // We can send the `shutdown` message before updating the `ChannelMonitor`
5470 // here as we don't need the monitor update to complete until we send a
5471 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
5472 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5473 node_id: *counterparty_node_id,
5478 // Update the monitor with the shutdown script if necessary.
5479 if let Some(monitor_update) = monitor_update_opt {
5480 break handle_new_monitor_update!(self, funding_txo_opt.unwrap(), monitor_update,
5481 peer_state_lock, peer_state, per_peer_state, chan_entry).map(|_| ());
5485 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))
5488 for htlc_source in dropped_htlcs.drain(..) {
5489 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
5490 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
5491 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
5497 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
5498 let per_peer_state = self.per_peer_state.read().unwrap();
5499 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5501 debug_assert!(false);
5502 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5504 let (tx, chan_option) = {
5505 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5506 let peer_state = &mut *peer_state_lock;
5507 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
5508 hash_map::Entry::Occupied(mut chan_entry) => {
5509 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), chan_entry);
5510 if let Some(msg) = closing_signed {
5511 peer_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5512 node_id: counterparty_node_id.clone(),
5517 // We're done with this channel, we've got a signed closing transaction and
5518 // will send the closing_signed back to the remote peer upon return. This
5519 // also implies there are no pending HTLCs left on the channel, so we can
5520 // fully delete it from tracking (the channel monitor is still around to
5521 // watch for old state broadcasts)!
5522 (tx, Some(remove_channel!(self, chan_entry)))
5523 } else { (tx, None) }
5525 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))
5528 if let Some(broadcast_tx) = tx {
5529 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
5530 self.tx_broadcaster.broadcast_transactions(&[&broadcast_tx]);
5532 if let Some(chan) = chan_option {
5533 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5534 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5535 let peer_state = &mut *peer_state_lock;
5536 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5540 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
5545 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
5546 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
5547 //determine the state of the payment based on our response/if we forward anything/the time
5548 //we take to respond. We should take care to avoid allowing such an attack.
5550 //TODO: There exists a further attack where a node may garble the onion data, forward it to
5551 //us repeatedly garbled in different ways, and compare our error messages, which are
5552 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
5553 //but we should prevent it anyway.
5555 let decoded_hop_res = self.decode_update_add_htlc_onion(msg);
5556 let per_peer_state = self.per_peer_state.read().unwrap();
5557 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5559 debug_assert!(false);
5560 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5562 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5563 let peer_state = &mut *peer_state_lock;
5564 match peer_state.channel_by_id.entry(msg.channel_id) {
5565 hash_map::Entry::Occupied(mut chan) => {
5567 let pending_forward_info = match decoded_hop_res {
5568 Ok((next_hop, shared_secret, next_packet_pk_opt)) =>
5569 self.construct_pending_htlc_status(msg, shared_secret, next_hop,
5570 chan.get().context.config().accept_underpaying_htlcs, next_packet_pk_opt),
5571 Err(e) => PendingHTLCStatus::Fail(e)
5573 let create_pending_htlc_status = |chan: &Channel<<SP::Target as SignerProvider>::Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
5574 // If the update_add is completely bogus, the call will Err and we will close,
5575 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
5576 // want to reject the new HTLC and fail it backwards instead of forwarding.
5577 match pending_forward_info {
5578 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
5579 let reason = if (error_code & 0x1000) != 0 {
5580 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
5581 HTLCFailReason::reason(real_code, error_data)
5583 HTLCFailReason::from_failure_code(error_code)
5584 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
5585 let msg = msgs::UpdateFailHTLC {
5586 channel_id: msg.channel_id,
5587 htlc_id: msg.htlc_id,
5590 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
5592 _ => pending_forward_info
5595 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.fee_estimator, &self.logger), chan);
5597 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))
5602 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
5603 let (htlc_source, forwarded_htlc_value) = {
5604 let per_peer_state = self.per_peer_state.read().unwrap();
5605 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5607 debug_assert!(false);
5608 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5610 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5611 let peer_state = &mut *peer_state_lock;
5612 match peer_state.channel_by_id.entry(msg.channel_id) {
5613 hash_map::Entry::Occupied(mut chan) => {
5614 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), chan)
5616 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))
5619 self.claim_funds_internal(htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, msg.channel_id);
5623 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
5624 let per_peer_state = self.per_peer_state.read().unwrap();
5625 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5627 debug_assert!(false);
5628 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5630 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5631 let peer_state = &mut *peer_state_lock;
5632 match peer_state.channel_by_id.entry(msg.channel_id) {
5633 hash_map::Entry::Occupied(mut chan) => {
5634 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan);
5636 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))
5641 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
5642 let per_peer_state = self.per_peer_state.read().unwrap();
5643 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5645 debug_assert!(false);
5646 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5648 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5649 let peer_state = &mut *peer_state_lock;
5650 match peer_state.channel_by_id.entry(msg.channel_id) {
5651 hash_map::Entry::Occupied(mut chan) => {
5652 if (msg.failure_code & 0x8000) == 0 {
5653 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
5654 try_chan_entry!(self, Err(chan_err), chan);
5656 try_chan_entry!(self, chan.get_mut().update_fail_malformed_htlc(&msg, HTLCFailReason::reason(msg.failure_code, msg.sha256_of_onion.to_vec())), chan);
5659 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))
5663 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
5664 let per_peer_state = self.per_peer_state.read().unwrap();
5665 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5667 debug_assert!(false);
5668 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5670 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5671 let peer_state = &mut *peer_state_lock;
5672 match peer_state.channel_by_id.entry(msg.channel_id) {
5673 hash_map::Entry::Occupied(mut chan) => {
5674 let funding_txo = chan.get().context.get_funding_txo();
5675 let monitor_update_opt = try_chan_entry!(self, chan.get_mut().commitment_signed(&msg, &self.logger), chan);
5676 if let Some(monitor_update) = monitor_update_opt {
5677 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update, peer_state_lock,
5678 peer_state, per_peer_state, chan).map(|_| ())
5681 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))
5686 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
5687 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
5688 let mut push_forward_event = false;
5689 let mut new_intercept_events = VecDeque::new();
5690 let mut failed_intercept_forwards = Vec::new();
5691 if !pending_forwards.is_empty() {
5692 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
5693 let scid = match forward_info.routing {
5694 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
5695 PendingHTLCRouting::Receive { .. } => 0,
5696 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
5698 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
5699 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
5701 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
5702 let forward_htlcs_empty = forward_htlcs.is_empty();
5703 match forward_htlcs.entry(scid) {
5704 hash_map::Entry::Occupied(mut entry) => {
5705 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
5706 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
5708 hash_map::Entry::Vacant(entry) => {
5709 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
5710 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.genesis_hash)
5712 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).into_inner());
5713 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
5714 match pending_intercepts.entry(intercept_id) {
5715 hash_map::Entry::Vacant(entry) => {
5716 new_intercept_events.push_back((events::Event::HTLCIntercepted {
5717 requested_next_hop_scid: scid,
5718 payment_hash: forward_info.payment_hash,
5719 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
5720 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
5723 entry.insert(PendingAddHTLCInfo {
5724 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
5726 hash_map::Entry::Occupied(_) => {
5727 log_info!(self.logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
5728 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
5729 short_channel_id: prev_short_channel_id,
5730 outpoint: prev_funding_outpoint,
5731 htlc_id: prev_htlc_id,
5732 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
5733 phantom_shared_secret: None,
5736 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
5737 HTLCFailReason::from_failure_code(0x4000 | 10),
5738 HTLCDestination::InvalidForward { requested_forward_scid: scid },
5743 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
5744 // payments are being processed.
5745 if forward_htlcs_empty {
5746 push_forward_event = true;
5748 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
5749 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
5756 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
5757 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
5760 if !new_intercept_events.is_empty() {
5761 let mut events = self.pending_events.lock().unwrap();
5762 events.append(&mut new_intercept_events);
5764 if push_forward_event { self.push_pending_forwards_ev() }
5768 // We only want to push a PendingHTLCsForwardable event if no others are queued.
5769 fn push_pending_forwards_ev(&self) {
5770 let mut pending_events = self.pending_events.lock().unwrap();
5771 let forward_ev_exists = pending_events.iter()
5772 .find(|(ev, _)| if let events::Event::PendingHTLCsForwardable { .. } = ev { true } else { false })
5774 if !forward_ev_exists {
5775 pending_events.push_back((events::Event::PendingHTLCsForwardable {
5777 Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
5782 /// Checks whether [`ChannelMonitorUpdate`]s generated by the receipt of a remote
5783 /// [`msgs::RevokeAndACK`] should be held for the given channel until some other action
5784 /// completes. Note that this needs to happen in the same [`PeerState`] mutex as any release of
5785 /// the [`ChannelMonitorUpdate`] in question.
5786 fn raa_monitor_updates_held(&self,
5787 actions_blocking_raa_monitor_updates: &BTreeMap<[u8; 32], Vec<RAAMonitorUpdateBlockingAction>>,
5788 channel_funding_outpoint: OutPoint, counterparty_node_id: PublicKey
5790 actions_blocking_raa_monitor_updates
5791 .get(&channel_funding_outpoint.to_channel_id()).map(|v| !v.is_empty()).unwrap_or(false)
5792 || self.pending_events.lock().unwrap().iter().any(|(_, action)| {
5793 action == &Some(EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
5794 channel_funding_outpoint,
5795 counterparty_node_id,
5800 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
5801 let (htlcs_to_fail, res) = {
5802 let per_peer_state = self.per_peer_state.read().unwrap();
5803 let mut peer_state_lock = per_peer_state.get(counterparty_node_id)
5805 debug_assert!(false);
5806 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5807 }).map(|mtx| mtx.lock().unwrap())?;
5808 let peer_state = &mut *peer_state_lock;
5809 match peer_state.channel_by_id.entry(msg.channel_id) {
5810 hash_map::Entry::Occupied(mut chan) => {
5811 let funding_txo = chan.get().context.get_funding_txo();
5812 let (htlcs_to_fail, monitor_update_opt) = try_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &self.fee_estimator, &self.logger), chan);
5813 let res = if let Some(monitor_update) = monitor_update_opt {
5814 handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update,
5815 peer_state_lock, peer_state, per_peer_state, chan).map(|_| ())
5817 (htlcs_to_fail, res)
5819 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))
5822 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
5826 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
5827 let per_peer_state = self.per_peer_state.read().unwrap();
5828 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5830 debug_assert!(false);
5831 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5833 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5834 let peer_state = &mut *peer_state_lock;
5835 match peer_state.channel_by_id.entry(msg.channel_id) {
5836 hash_map::Entry::Occupied(mut chan) => {
5837 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg, &self.logger), chan);
5839 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))
5844 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
5845 let per_peer_state = self.per_peer_state.read().unwrap();
5846 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5848 debug_assert!(false);
5849 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5851 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5852 let peer_state = &mut *peer_state_lock;
5853 match peer_state.channel_by_id.entry(msg.channel_id) {
5854 hash_map::Entry::Occupied(mut chan) => {
5855 if !chan.get().context.is_usable() {
5856 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
5859 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5860 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(
5861 &self.node_signer, self.genesis_hash.clone(), self.best_block.read().unwrap().height(),
5862 msg, &self.default_configuration
5864 // Note that announcement_signatures fails if the channel cannot be announced,
5865 // so get_channel_update_for_broadcast will never fail by the time we get here.
5866 update_msg: Some(self.get_channel_update_for_broadcast(chan.get()).unwrap()),
5869 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))
5874 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
5875 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
5876 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
5877 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
5879 // It's not a local channel
5880 return Ok(NotifyOption::SkipPersist)
5883 let per_peer_state = self.per_peer_state.read().unwrap();
5884 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
5885 if peer_state_mutex_opt.is_none() {
5886 return Ok(NotifyOption::SkipPersist)
5888 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5889 let peer_state = &mut *peer_state_lock;
5890 match peer_state.channel_by_id.entry(chan_id) {
5891 hash_map::Entry::Occupied(mut chan) => {
5892 if chan.get().context.get_counterparty_node_id() != *counterparty_node_id {
5893 if chan.get().context.should_announce() {
5894 // If the announcement is about a channel of ours which is public, some
5895 // other peer may simply be forwarding all its gossip to us. Don't provide
5896 // a scary-looking error message and return Ok instead.
5897 return Ok(NotifyOption::SkipPersist);
5899 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));
5901 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().context.get_counterparty_node_id().serialize()[..];
5902 let msg_from_node_one = msg.contents.flags & 1 == 0;
5903 if were_node_one == msg_from_node_one {
5904 return Ok(NotifyOption::SkipPersist);
5906 log_debug!(self.logger, "Received channel_update for channel {}.", log_bytes!(chan_id));
5907 try_chan_entry!(self, chan.get_mut().channel_update(&msg), chan);
5910 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersist)
5912 Ok(NotifyOption::DoPersist)
5915 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
5917 let need_lnd_workaround = {
5918 let per_peer_state = self.per_peer_state.read().unwrap();
5920 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5922 debug_assert!(false);
5923 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5925 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5926 let peer_state = &mut *peer_state_lock;
5927 match peer_state.channel_by_id.entry(msg.channel_id) {
5928 hash_map::Entry::Occupied(mut chan) => {
5929 // Currently, we expect all holding cell update_adds to be dropped on peer
5930 // disconnect, so Channel's reestablish will never hand us any holding cell
5931 // freed HTLCs to fail backwards. If in the future we no longer drop pending
5932 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
5933 let responses = try_chan_entry!(self, chan.get_mut().channel_reestablish(
5934 msg, &self.logger, &self.node_signer, self.genesis_hash,
5935 &self.default_configuration, &*self.best_block.read().unwrap()), chan);
5936 let mut channel_update = None;
5937 if let Some(msg) = responses.shutdown_msg {
5938 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5939 node_id: counterparty_node_id.clone(),
5942 } else if chan.get().context.is_usable() {
5943 // If the channel is in a usable state (ie the channel is not being shut
5944 // down), send a unicast channel_update to our counterparty to make sure
5945 // they have the latest channel parameters.
5946 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
5947 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
5948 node_id: chan.get().context.get_counterparty_node_id(),
5953 let need_lnd_workaround = chan.get_mut().context.workaround_lnd_bug_4006.take();
5954 htlc_forwards = self.handle_channel_resumption(
5955 &mut peer_state.pending_msg_events, chan.get_mut(), responses.raa, responses.commitment_update, responses.order,
5956 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
5957 if let Some(upd) = channel_update {
5958 peer_state.pending_msg_events.push(upd);
5962 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))
5966 if let Some(forwards) = htlc_forwards {
5967 self.forward_htlcs(&mut [forwards][..]);
5970 if let Some(channel_ready_msg) = need_lnd_workaround {
5971 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
5976 /// Process pending events from the [`chain::Watch`], returning whether any events were processed.
5977 fn process_pending_monitor_events(&self) -> bool {
5978 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
5980 let mut failed_channels = Vec::new();
5981 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
5982 let has_pending_monitor_events = !pending_monitor_events.is_empty();
5983 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
5984 for monitor_event in monitor_events.drain(..) {
5985 match monitor_event {
5986 MonitorEvent::HTLCEvent(htlc_update) => {
5987 if let Some(preimage) = htlc_update.payment_preimage {
5988 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
5989 self.claim_funds_internal(htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, funding_outpoint.to_channel_id());
5991 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
5992 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
5993 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
5994 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
5997 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
5998 MonitorEvent::UpdateFailed(funding_outpoint) => {
5999 let counterparty_node_id_opt = match counterparty_node_id {
6000 Some(cp_id) => Some(cp_id),
6002 // TODO: Once we can rely on the counterparty_node_id from the
6003 // monitor event, this and the id_to_peer map should be removed.
6004 let id_to_peer = self.id_to_peer.lock().unwrap();
6005 id_to_peer.get(&funding_outpoint.to_channel_id()).cloned()
6008 if let Some(counterparty_node_id) = counterparty_node_id_opt {
6009 let per_peer_state = self.per_peer_state.read().unwrap();
6010 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
6011 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6012 let peer_state = &mut *peer_state_lock;
6013 let pending_msg_events = &mut peer_state.pending_msg_events;
6014 if let hash_map::Entry::Occupied(chan_entry) = peer_state.channel_by_id.entry(funding_outpoint.to_channel_id()) {
6015 let mut chan = remove_channel!(self, chan_entry);
6016 failed_channels.push(chan.context.force_shutdown(false));
6017 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6018 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6022 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
6023 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
6025 ClosureReason::CommitmentTxConfirmed
6027 self.issue_channel_close_events(&chan.context, reason);
6028 pending_msg_events.push(events::MessageSendEvent::HandleError {
6029 node_id: chan.context.get_counterparty_node_id(),
6030 action: msgs::ErrorAction::SendErrorMessage {
6031 msg: msgs::ErrorMessage { channel_id: chan.context.channel_id(), data: "Channel force-closed".to_owned() }
6038 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
6039 self.channel_monitor_updated(&funding_txo, monitor_update_id, counterparty_node_id.as_ref());
6045 for failure in failed_channels.drain(..) {
6046 self.finish_force_close_channel(failure);
6049 has_pending_monitor_events
6052 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
6053 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
6054 /// update events as a separate process method here.
6056 pub fn process_monitor_events(&self) {
6057 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6058 self.process_pending_monitor_events();
6061 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
6062 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
6063 /// update was applied.
6064 fn check_free_holding_cells(&self) -> bool {
6065 let mut has_monitor_update = false;
6066 let mut failed_htlcs = Vec::new();
6067 let mut handle_errors = Vec::new();
6069 // Walk our list of channels and find any that need to update. Note that when we do find an
6070 // update, if it includes actions that must be taken afterwards, we have to drop the
6071 // per-peer state lock as well as the top level per_peer_state lock. Thus, we loop until we
6072 // manage to go through all our peers without finding a single channel to update.
6074 let per_peer_state = self.per_peer_state.read().unwrap();
6075 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6077 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6078 let peer_state: &mut PeerState<_> = &mut *peer_state_lock;
6079 for (channel_id, chan) in peer_state.channel_by_id.iter_mut() {
6080 let counterparty_node_id = chan.context.get_counterparty_node_id();
6081 let funding_txo = chan.context.get_funding_txo();
6082 let (monitor_opt, holding_cell_failed_htlcs) =
6083 chan.maybe_free_holding_cell_htlcs(&self.fee_estimator, &self.logger);
6084 if !holding_cell_failed_htlcs.is_empty() {
6085 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id, counterparty_node_id));
6087 if let Some(monitor_update) = monitor_opt {
6088 has_monitor_update = true;
6090 let channel_id: [u8; 32] = *channel_id;
6091 let res = handle_new_monitor_update!(self, funding_txo.unwrap(), monitor_update,
6092 peer_state_lock, peer_state, per_peer_state, chan, MANUALLY_REMOVING,
6093 peer_state.channel_by_id.remove(&channel_id));
6095 handle_errors.push((counterparty_node_id, res));
6097 continue 'peer_loop;
6106 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
6107 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
6108 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
6111 for (counterparty_node_id, err) in handle_errors.drain(..) {
6112 let _ = handle_error!(self, err, counterparty_node_id);
6118 /// Check whether any channels have finished removing all pending updates after a shutdown
6119 /// exchange and can now send a closing_signed.
6120 /// Returns whether any closing_signed messages were generated.
6121 fn maybe_generate_initial_closing_signed(&self) -> bool {
6122 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
6123 let mut has_update = false;
6125 let per_peer_state = self.per_peer_state.read().unwrap();
6127 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6128 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6129 let peer_state = &mut *peer_state_lock;
6130 let pending_msg_events = &mut peer_state.pending_msg_events;
6131 peer_state.channel_by_id.retain(|channel_id, chan| {
6132 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
6133 Ok((msg_opt, tx_opt)) => {
6134 if let Some(msg) = msg_opt {
6136 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
6137 node_id: chan.context.get_counterparty_node_id(), msg,
6140 if let Some(tx) = tx_opt {
6141 // We're done with this channel. We got a closing_signed and sent back
6142 // a closing_signed with a closing transaction to broadcast.
6143 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
6144 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6149 self.issue_channel_close_events(&chan.context, ClosureReason::CooperativeClosure);
6151 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
6152 self.tx_broadcaster.broadcast_transactions(&[&tx]);
6153 update_maps_on_chan_removal!(self, &chan.context);
6159 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
6160 handle_errors.push((chan.context.get_counterparty_node_id(), Err(res)));
6168 for (counterparty_node_id, err) in handle_errors.drain(..) {
6169 let _ = handle_error!(self, err, counterparty_node_id);
6175 /// Handle a list of channel failures during a block_connected or block_disconnected call,
6176 /// pushing the channel monitor update (if any) to the background events queue and removing the
6178 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
6179 for mut failure in failed_channels.drain(..) {
6180 // Either a commitment transactions has been confirmed on-chain or
6181 // Channel::block_disconnected detected that the funding transaction has been
6182 // reorganized out of the main chain.
6183 // We cannot broadcast our latest local state via monitor update (as
6184 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
6185 // so we track the update internally and handle it when the user next calls
6186 // timer_tick_occurred, guaranteeing we're running normally.
6187 if let Some((counterparty_node_id, funding_txo, update)) = failure.0.take() {
6188 assert_eq!(update.updates.len(), 1);
6189 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
6190 assert!(should_broadcast);
6191 } else { unreachable!(); }
6192 self.pending_background_events.lock().unwrap().push(
6193 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
6194 counterparty_node_id, funding_txo, update
6197 self.finish_force_close_channel(failure);
6201 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
6204 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
6205 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
6207 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
6208 /// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
6209 /// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
6210 /// passed directly to [`claim_funds`].
6212 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
6214 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
6215 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
6219 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
6220 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
6222 /// Errors if `min_value_msat` is greater than total bitcoin supply.
6224 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
6225 /// on versions of LDK prior to 0.0.114.
6227 /// [`claim_funds`]: Self::claim_funds
6228 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
6229 /// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
6230 /// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
6231 /// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
6232 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
6233 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
6234 min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
6235 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs,
6236 &self.entropy_source, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
6237 min_final_cltv_expiry_delta)
6240 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
6241 /// stored external to LDK.
6243 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
6244 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
6245 /// the `min_value_msat` provided here, if one is provided.
6247 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
6248 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
6251 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
6252 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
6253 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
6254 /// sender "proof-of-payment" unless they have paid the required amount.
6256 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
6257 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
6258 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
6259 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
6260 /// invoices when no timeout is set.
6262 /// Note that we use block header time to time-out pending inbound payments (with some margin
6263 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
6264 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
6265 /// If you need exact expiry semantics, you should enforce them upon receipt of
6266 /// [`PaymentClaimable`].
6268 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
6269 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
6271 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
6272 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
6276 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
6277 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
6279 /// Errors if `min_value_msat` is greater than total bitcoin supply.
6281 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
6282 /// on versions of LDK prior to 0.0.114.
6284 /// [`create_inbound_payment`]: Self::create_inbound_payment
6285 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
6286 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>,
6287 invoice_expiry_delta_secs: u32, min_final_cltv_expiry: Option<u16>) -> Result<PaymentSecret, ()> {
6288 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash,
6289 invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
6290 min_final_cltv_expiry)
6293 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
6294 /// previously returned from [`create_inbound_payment`].
6296 /// [`create_inbound_payment`]: Self::create_inbound_payment
6297 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
6298 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
6301 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
6302 /// are used when constructing the phantom invoice's route hints.
6304 /// [phantom node payments]: crate::sign::PhantomKeysManager
6305 pub fn get_phantom_scid(&self) -> u64 {
6306 let best_block_height = self.best_block.read().unwrap().height();
6307 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
6309 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
6310 // Ensure the generated scid doesn't conflict with a real channel.
6311 match short_to_chan_info.get(&scid_candidate) {
6312 Some(_) => continue,
6313 None => return scid_candidate
6318 /// Gets route hints for use in receiving [phantom node payments].
6320 /// [phantom node payments]: crate::sign::PhantomKeysManager
6321 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
6323 channels: self.list_usable_channels(),
6324 phantom_scid: self.get_phantom_scid(),
6325 real_node_pubkey: self.get_our_node_id(),
6329 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
6330 /// used when constructing the route hints for HTLCs intended to be intercepted. See
6331 /// [`ChannelManager::forward_intercepted_htlc`].
6333 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
6334 /// times to get a unique scid.
6335 pub fn get_intercept_scid(&self) -> u64 {
6336 let best_block_height = self.best_block.read().unwrap().height();
6337 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
6339 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
6340 // Ensure the generated scid doesn't conflict with a real channel.
6341 if short_to_chan_info.contains_key(&scid_candidate) { continue }
6342 return scid_candidate
6346 /// Gets inflight HTLC information by processing pending outbound payments that are in
6347 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
6348 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
6349 let mut inflight_htlcs = InFlightHtlcs::new();
6351 let per_peer_state = self.per_peer_state.read().unwrap();
6352 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6353 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6354 let peer_state = &mut *peer_state_lock;
6355 for chan in peer_state.channel_by_id.values() {
6356 for (htlc_source, _) in chan.inflight_htlc_sources() {
6357 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
6358 inflight_htlcs.process_path(path, self.get_our_node_id());
6367 #[cfg(any(test, feature = "_test_utils"))]
6368 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
6369 let events = core::cell::RefCell::new(Vec::new());
6370 let event_handler = |event: events::Event| events.borrow_mut().push(event);
6371 self.process_pending_events(&event_handler);
6375 #[cfg(feature = "_test_utils")]
6376 pub fn push_pending_event(&self, event: events::Event) {
6377 let mut events = self.pending_events.lock().unwrap();
6378 events.push_back((event, None));
6382 pub fn pop_pending_event(&self) -> Option<events::Event> {
6383 let mut events = self.pending_events.lock().unwrap();
6384 events.pop_front().map(|(e, _)| e)
6388 pub fn has_pending_payments(&self) -> bool {
6389 self.pending_outbound_payments.has_pending_payments()
6393 pub fn clear_pending_payments(&self) {
6394 self.pending_outbound_payments.clear_pending_payments()
6397 /// When something which was blocking a channel from updating its [`ChannelMonitor`] (e.g. an
6398 /// [`Event`] being handled) completes, this should be called to restore the channel to normal
6399 /// operation. It will double-check that nothing *else* is also blocking the same channel from
6400 /// making progress and then let any blocked [`ChannelMonitorUpdate`]s fly.
6401 fn handle_monitor_update_release(&self, counterparty_node_id: PublicKey, channel_funding_outpoint: OutPoint, mut completed_blocker: Option<RAAMonitorUpdateBlockingAction>) {
6402 let mut errors = Vec::new();
6404 let per_peer_state = self.per_peer_state.read().unwrap();
6405 if let Some(peer_state_mtx) = per_peer_state.get(&counterparty_node_id) {
6406 let mut peer_state_lck = peer_state_mtx.lock().unwrap();
6407 let peer_state = &mut *peer_state_lck;
6409 if let Some(blocker) = completed_blocker.take() {
6410 // Only do this on the first iteration of the loop.
6411 if let Some(blockers) = peer_state.actions_blocking_raa_monitor_updates
6412 .get_mut(&channel_funding_outpoint.to_channel_id())
6414 blockers.retain(|iter| iter != &blocker);
6418 if self.raa_monitor_updates_held(&peer_state.actions_blocking_raa_monitor_updates,
6419 channel_funding_outpoint, counterparty_node_id) {
6420 // Check that, while holding the peer lock, we don't have anything else
6421 // blocking monitor updates for this channel. If we do, release the monitor
6422 // update(s) when those blockers complete.
6423 log_trace!(self.logger, "Delaying monitor unlock for channel {} as another channel's mon update needs to complete first",
6424 log_bytes!(&channel_funding_outpoint.to_channel_id()[..]));
6428 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(channel_funding_outpoint.to_channel_id()) {
6429 debug_assert_eq!(chan.get().context.get_funding_txo().unwrap(), channel_funding_outpoint);
6430 if let Some((monitor_update, further_update_exists)) = chan.get_mut().unblock_next_blocked_monitor_update() {
6431 log_debug!(self.logger, "Unlocking monitor updating for channel {} and updating monitor",
6432 log_bytes!(&channel_funding_outpoint.to_channel_id()[..]));
6433 if let Err(e) = handle_new_monitor_update!(self, channel_funding_outpoint, monitor_update,
6434 peer_state_lck, peer_state, per_peer_state, chan)
6436 errors.push((e, counterparty_node_id));
6438 if further_update_exists {
6439 // If there are more `ChannelMonitorUpdate`s to process, restart at the
6444 log_trace!(self.logger, "Unlocked monitor updating for channel {} without monitors to update",
6445 log_bytes!(&channel_funding_outpoint.to_channel_id()[..]));
6449 log_debug!(self.logger,
6450 "Got a release post-RAA monitor update for peer {} but the channel is gone",
6451 log_pubkey!(counterparty_node_id));
6455 for (err, counterparty_node_id) in errors {
6456 let res = Err::<(), _>(err);
6457 let _ = handle_error!(self, res, counterparty_node_id);
6461 fn handle_post_event_actions(&self, actions: Vec<EventCompletionAction>) {
6462 for action in actions {
6464 EventCompletionAction::ReleaseRAAChannelMonitorUpdate {
6465 channel_funding_outpoint, counterparty_node_id
6467 self.handle_monitor_update_release(counterparty_node_id, channel_funding_outpoint, None);
6473 /// Processes any events asynchronously in the order they were generated since the last call
6474 /// using the given event handler.
6476 /// See the trait-level documentation of [`EventsProvider`] for requirements.
6477 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
6481 process_events_body!(self, ev, { handler(ev).await });
6485 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>
6487 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6488 T::Target: BroadcasterInterface,
6489 ES::Target: EntropySource,
6490 NS::Target: NodeSigner,
6491 SP::Target: SignerProvider,
6492 F::Target: FeeEstimator,
6496 /// Returns `MessageSendEvent`s strictly ordered per-peer, in the order they were generated.
6497 /// The returned array will contain `MessageSendEvent`s for different peers if
6498 /// `MessageSendEvent`s to more than one peer exists, but `MessageSendEvent`s to the same peer
6499 /// is always placed next to each other.
6501 /// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
6502 /// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
6503 /// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
6504 /// will randomly be placed first or last in the returned array.
6506 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
6507 /// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
6508 /// the `MessageSendEvent`s to the specific peer they were generated under.
6509 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
6510 let events = RefCell::new(Vec::new());
6511 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
6512 let mut result = self.process_background_events();
6514 // TODO: This behavior should be documented. It's unintuitive that we query
6515 // ChannelMonitors when clearing other events.
6516 if self.process_pending_monitor_events() {
6517 result = NotifyOption::DoPersist;
6520 if self.check_free_holding_cells() {
6521 result = NotifyOption::DoPersist;
6523 if self.maybe_generate_initial_closing_signed() {
6524 result = NotifyOption::DoPersist;
6527 let mut pending_events = Vec::new();
6528 let per_peer_state = self.per_peer_state.read().unwrap();
6529 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6530 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6531 let peer_state = &mut *peer_state_lock;
6532 if peer_state.pending_msg_events.len() > 0 {
6533 pending_events.append(&mut peer_state.pending_msg_events);
6537 if !pending_events.is_empty() {
6538 events.replace(pending_events);
6547 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>
6549 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6550 T::Target: BroadcasterInterface,
6551 ES::Target: EntropySource,
6552 NS::Target: NodeSigner,
6553 SP::Target: SignerProvider,
6554 F::Target: FeeEstimator,
6558 /// Processes events that must be periodically handled.
6560 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
6561 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
6562 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
6564 process_events_body!(self, ev, handler.handle_event(ev));
6568 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>
6570 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6571 T::Target: BroadcasterInterface,
6572 ES::Target: EntropySource,
6573 NS::Target: NodeSigner,
6574 SP::Target: SignerProvider,
6575 F::Target: FeeEstimator,
6579 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
6581 let best_block = self.best_block.read().unwrap();
6582 assert_eq!(best_block.block_hash(), header.prev_blockhash,
6583 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
6584 assert_eq!(best_block.height(), height - 1,
6585 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
6588 self.transactions_confirmed(header, txdata, height);
6589 self.best_block_updated(header, height);
6592 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
6593 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
6594 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
6595 let new_height = height - 1;
6597 let mut best_block = self.best_block.write().unwrap();
6598 assert_eq!(best_block.block_hash(), header.block_hash(),
6599 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
6600 assert_eq!(best_block.height(), height,
6601 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
6602 *best_block = BestBlock::new(header.prev_blockhash, new_height)
6605 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));
6609 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>
6611 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6612 T::Target: BroadcasterInterface,
6613 ES::Target: EntropySource,
6614 NS::Target: NodeSigner,
6615 SP::Target: SignerProvider,
6616 F::Target: FeeEstimator,
6620 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
6621 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
6622 // during initialization prior to the chain_monitor being fully configured in some cases.
6623 // See the docs for `ChannelManagerReadArgs` for more.
6625 let block_hash = header.block_hash();
6626 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
6628 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
6629 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
6630 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)
6631 .map(|(a, b)| (a, Vec::new(), b)));
6633 let last_best_block_height = self.best_block.read().unwrap().height();
6634 if height < last_best_block_height {
6635 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
6636 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));
6640 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
6641 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
6642 // during initialization prior to the chain_monitor being fully configured in some cases.
6643 // See the docs for `ChannelManagerReadArgs` for more.
6645 let block_hash = header.block_hash();
6646 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
6648 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
6649 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
6650 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
6652 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));
6654 macro_rules! max_time {
6655 ($timestamp: expr) => {
6657 // Update $timestamp to be the max of its current value and the block
6658 // timestamp. This should keep us close to the current time without relying on
6659 // having an explicit local time source.
6660 // Just in case we end up in a race, we loop until we either successfully
6661 // update $timestamp or decide we don't need to.
6662 let old_serial = $timestamp.load(Ordering::Acquire);
6663 if old_serial >= header.time as usize { break; }
6664 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
6670 max_time!(self.highest_seen_timestamp);
6671 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
6672 payment_secrets.retain(|_, inbound_payment| {
6673 inbound_payment.expiry_time > header.time as u64
6677 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
6678 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
6679 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
6680 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6681 let peer_state = &mut *peer_state_lock;
6682 for chan in peer_state.channel_by_id.values() {
6683 if let (Some(funding_txo), Some(block_hash)) = (chan.context.get_funding_txo(), chan.context.get_funding_tx_confirmed_in()) {
6684 res.push((funding_txo.txid, Some(block_hash)));
6691 fn transaction_unconfirmed(&self, txid: &Txid) {
6692 let _persistence_guard = PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock,
6693 &self.persistence_notifier, || -> NotifyOption { NotifyOption::DoPersist });
6694 self.do_chain_event(None, |channel| {
6695 if let Some(funding_txo) = channel.context.get_funding_txo() {
6696 if funding_txo.txid == *txid {
6697 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
6698 } else { Ok((None, Vec::new(), None)) }
6699 } else { Ok((None, Vec::new(), None)) }
6704 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>
6706 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6707 T::Target: BroadcasterInterface,
6708 ES::Target: EntropySource,
6709 NS::Target: NodeSigner,
6710 SP::Target: SignerProvider,
6711 F::Target: FeeEstimator,
6715 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
6716 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
6718 fn do_chain_event<FN: Fn(&mut Channel<<SP::Target as SignerProvider>::Signer>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
6719 (&self, height_opt: Option<u32>, f: FN) {
6720 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
6721 // during initialization prior to the chain_monitor being fully configured in some cases.
6722 // See the docs for `ChannelManagerReadArgs` for more.
6724 let mut failed_channels = Vec::new();
6725 let mut timed_out_htlcs = Vec::new();
6727 let per_peer_state = self.per_peer_state.read().unwrap();
6728 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6729 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6730 let peer_state = &mut *peer_state_lock;
6731 let pending_msg_events = &mut peer_state.pending_msg_events;
6732 peer_state.channel_by_id.retain(|_, channel| {
6733 let res = f(channel);
6734 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
6735 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
6736 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
6737 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
6738 HTLCDestination::NextHopChannel { node_id: Some(channel.context.get_counterparty_node_id()), channel_id: channel.context.channel_id() }));
6740 if let Some(channel_ready) = channel_ready_opt {
6741 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
6742 if channel.context.is_usable() {
6743 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", log_bytes!(channel.context.channel_id()));
6744 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
6745 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
6746 node_id: channel.context.get_counterparty_node_id(),
6751 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", log_bytes!(channel.context.channel_id()));
6756 let mut pending_events = self.pending_events.lock().unwrap();
6757 emit_channel_ready_event!(pending_events, channel);
6760 if let Some(announcement_sigs) = announcement_sigs {
6761 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(channel.context.channel_id()));
6762 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
6763 node_id: channel.context.get_counterparty_node_id(),
6764 msg: announcement_sigs,
6766 if let Some(height) = height_opt {
6767 if let Some(announcement) = channel.get_signed_channel_announcement(&self.node_signer, self.genesis_hash, height, &self.default_configuration) {
6768 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
6770 // Note that announcement_signatures fails if the channel cannot be announced,
6771 // so get_channel_update_for_broadcast will never fail by the time we get here.
6772 update_msg: Some(self.get_channel_update_for_broadcast(channel).unwrap()),
6777 if channel.is_our_channel_ready() {
6778 if let Some(real_scid) = channel.context.get_short_channel_id() {
6779 // If we sent a 0conf channel_ready, and now have an SCID, we add it
6780 // to the short_to_chan_info map here. Note that we check whether we
6781 // can relay using the real SCID at relay-time (i.e.
6782 // enforce option_scid_alias then), and if the funding tx is ever
6783 // un-confirmed we force-close the channel, ensuring short_to_chan_info
6784 // is always consistent.
6785 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
6786 let scid_insert = short_to_chan_info.insert(real_scid, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
6787 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.context.get_counterparty_node_id(), channel.context.channel_id()),
6788 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
6789 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
6792 } else if let Err(reason) = res {
6793 update_maps_on_chan_removal!(self, &channel.context);
6794 // It looks like our counterparty went on-chain or funding transaction was
6795 // reorged out of the main chain. Close the channel.
6796 failed_channels.push(channel.context.force_shutdown(true));
6797 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
6798 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6802 let reason_message = format!("{}", reason);
6803 self.issue_channel_close_events(&channel.context, reason);
6804 pending_msg_events.push(events::MessageSendEvent::HandleError {
6805 node_id: channel.context.get_counterparty_node_id(),
6806 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
6807 channel_id: channel.context.channel_id(),
6808 data: reason_message,
6818 if let Some(height) = height_opt {
6819 self.claimable_payments.lock().unwrap().claimable_payments.retain(|payment_hash, payment| {
6820 payment.htlcs.retain(|htlc| {
6821 // If height is approaching the number of blocks we think it takes us to get
6822 // our commitment transaction confirmed before the HTLC expires, plus the
6823 // number of blocks we generally consider it to take to do a commitment update,
6824 // just give up on it and fail the HTLC.
6825 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
6826 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
6827 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
6829 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
6830 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
6831 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
6835 !payment.htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
6838 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
6839 intercepted_htlcs.retain(|_, htlc| {
6840 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
6841 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
6842 short_channel_id: htlc.prev_short_channel_id,
6843 htlc_id: htlc.prev_htlc_id,
6844 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
6845 phantom_shared_secret: None,
6846 outpoint: htlc.prev_funding_outpoint,
6849 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
6850 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
6851 _ => unreachable!(),
6853 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
6854 HTLCFailReason::from_failure_code(0x2000 | 2),
6855 HTLCDestination::InvalidForward { requested_forward_scid }));
6856 log_trace!(self.logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
6862 self.handle_init_event_channel_failures(failed_channels);
6864 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
6865 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
6869 /// Gets a [`Future`] that completes when this [`ChannelManager`] needs to be persisted.
6871 /// Note that callbacks registered on the [`Future`] MUST NOT call back into this
6872 /// [`ChannelManager`] and should instead register actions to be taken later.
6874 pub fn get_persistable_update_future(&self) -> Future {
6875 self.persistence_notifier.get_future()
6878 #[cfg(any(test, feature = "_test_utils"))]
6879 pub fn get_persistence_condvar_value(&self) -> bool {
6880 self.persistence_notifier.notify_pending()
6883 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
6884 /// [`chain::Confirm`] interfaces.
6885 pub fn current_best_block(&self) -> BestBlock {
6886 self.best_block.read().unwrap().clone()
6889 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
6890 /// [`ChannelManager`].
6891 pub fn node_features(&self) -> NodeFeatures {
6892 provided_node_features(&self.default_configuration)
6895 /// Fetches the set of [`InvoiceFeatures`] flags which are provided by or required by
6896 /// [`ChannelManager`].
6898 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
6899 /// or not. Thus, this method is not public.
6900 #[cfg(any(feature = "_test_utils", test))]
6901 pub fn invoice_features(&self) -> InvoiceFeatures {
6902 provided_invoice_features(&self.default_configuration)
6905 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
6906 /// [`ChannelManager`].
6907 pub fn channel_features(&self) -> ChannelFeatures {
6908 provided_channel_features(&self.default_configuration)
6911 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
6912 /// [`ChannelManager`].
6913 pub fn channel_type_features(&self) -> ChannelTypeFeatures {
6914 provided_channel_type_features(&self.default_configuration)
6917 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
6918 /// [`ChannelManager`].
6919 pub fn init_features(&self) -> InitFeatures {
6920 provided_init_features(&self.default_configuration)
6924 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
6925 ChannelMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
6927 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6928 T::Target: BroadcasterInterface,
6929 ES::Target: EntropySource,
6930 NS::Target: NodeSigner,
6931 SP::Target: SignerProvider,
6932 F::Target: FeeEstimator,
6936 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) {
6937 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6938 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, msg), *counterparty_node_id);
6941 fn handle_open_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
6942 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
6943 "Dual-funded channels not supported".to_owned(),
6944 msg.temporary_channel_id.clone())), *counterparty_node_id);
6947 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
6948 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6949 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, msg), *counterparty_node_id);
6952 fn handle_accept_channel_v2(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
6953 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
6954 "Dual-funded channels not supported".to_owned(),
6955 msg.temporary_channel_id.clone())), *counterparty_node_id);
6958 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
6959 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6960 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
6963 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
6964 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6965 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
6968 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
6969 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6970 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
6973 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
6974 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6975 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
6978 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
6979 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6980 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
6983 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
6984 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6985 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
6988 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
6989 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6990 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
6993 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
6994 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
6995 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
6998 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
6999 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7000 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
7003 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
7004 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7005 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
7008 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
7009 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7010 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
7013 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
7014 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7015 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
7018 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
7019 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7020 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
7023 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
7024 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
7025 let force_persist = self.process_background_events();
7026 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
7027 if force_persist == NotifyOption::DoPersist { NotifyOption::DoPersist } else { persist }
7029 NotifyOption::SkipPersist
7034 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
7035 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7036 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
7039 fn peer_disconnected(&self, counterparty_node_id: &PublicKey) {
7040 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7041 let mut failed_channels = Vec::new();
7042 let mut per_peer_state = self.per_peer_state.write().unwrap();
7044 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates.",
7045 log_pubkey!(counterparty_node_id));
7046 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
7047 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7048 let peer_state = &mut *peer_state_lock;
7049 let pending_msg_events = &mut peer_state.pending_msg_events;
7050 peer_state.channel_by_id.retain(|_, chan| {
7051 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
7052 if chan.is_shutdown() {
7053 update_maps_on_chan_removal!(self, &chan.context);
7054 self.issue_channel_close_events(&chan.context, ClosureReason::DisconnectedPeer);
7059 peer_state.inbound_v1_channel_by_id.retain(|_, chan| {
7060 update_maps_on_chan_removal!(self, &chan.context);
7061 self.issue_channel_close_events(&chan.context, ClosureReason::DisconnectedPeer);
7064 peer_state.outbound_v1_channel_by_id.retain(|_, chan| {
7065 update_maps_on_chan_removal!(self, &chan.context);
7066 self.issue_channel_close_events(&chan.context, ClosureReason::DisconnectedPeer);
7069 pending_msg_events.retain(|msg| {
7071 // V1 Channel Establishment
7072 &events::MessageSendEvent::SendAcceptChannel { .. } => false,
7073 &events::MessageSendEvent::SendOpenChannel { .. } => false,
7074 &events::MessageSendEvent::SendFundingCreated { .. } => false,
7075 &events::MessageSendEvent::SendFundingSigned { .. } => false,
7076 // V2 Channel Establishment
7077 &events::MessageSendEvent::SendAcceptChannelV2 { .. } => false,
7078 &events::MessageSendEvent::SendOpenChannelV2 { .. } => false,
7079 // Common Channel Establishment
7080 &events::MessageSendEvent::SendChannelReady { .. } => false,
7081 &events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
7082 // Interactive Transaction Construction
7083 &events::MessageSendEvent::SendTxAddInput { .. } => false,
7084 &events::MessageSendEvent::SendTxAddOutput { .. } => false,
7085 &events::MessageSendEvent::SendTxRemoveInput { .. } => false,
7086 &events::MessageSendEvent::SendTxRemoveOutput { .. } => false,
7087 &events::MessageSendEvent::SendTxComplete { .. } => false,
7088 &events::MessageSendEvent::SendTxSignatures { .. } => false,
7089 &events::MessageSendEvent::SendTxInitRbf { .. } => false,
7090 &events::MessageSendEvent::SendTxAckRbf { .. } => false,
7091 &events::MessageSendEvent::SendTxAbort { .. } => false,
7092 // Channel Operations
7093 &events::MessageSendEvent::UpdateHTLCs { .. } => false,
7094 &events::MessageSendEvent::SendRevokeAndACK { .. } => false,
7095 &events::MessageSendEvent::SendClosingSigned { .. } => false,
7096 &events::MessageSendEvent::SendShutdown { .. } => false,
7097 &events::MessageSendEvent::SendChannelReestablish { .. } => false,
7098 &events::MessageSendEvent::HandleError { .. } => false,
7100 &events::MessageSendEvent::SendChannelAnnouncement { .. } => false,
7101 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
7102 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
7103 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
7104 &events::MessageSendEvent::SendChannelUpdate { .. } => false,
7105 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
7106 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
7107 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
7108 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
7111 debug_assert!(peer_state.is_connected, "A disconnected peer cannot disconnect");
7112 peer_state.is_connected = false;
7113 peer_state.ok_to_remove(true)
7114 } else { debug_assert!(false, "Unconnected peer disconnected"); true }
7117 per_peer_state.remove(counterparty_node_id);
7119 mem::drop(per_peer_state);
7121 for failure in failed_channels.drain(..) {
7122 self.finish_force_close_channel(failure);
7126 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init, inbound: bool) -> Result<(), ()> {
7127 if !init_msg.features.supports_static_remote_key() {
7128 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting", log_pubkey!(counterparty_node_id));
7132 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7134 // If we have too many peers connected which don't have funded channels, disconnect the
7135 // peer immediately (as long as it doesn't have funded channels). If we have a bunch of
7136 // unfunded channels taking up space in memory for disconnected peers, we still let new
7137 // peers connect, but we'll reject new channels from them.
7138 let connected_peers_without_funded_channels = self.peers_without_funded_channels(|node| node.is_connected);
7139 let inbound_peer_limited = inbound && connected_peers_without_funded_channels >= MAX_NO_CHANNEL_PEERS;
7142 let mut peer_state_lock = self.per_peer_state.write().unwrap();
7143 match peer_state_lock.entry(counterparty_node_id.clone()) {
7144 hash_map::Entry::Vacant(e) => {
7145 if inbound_peer_limited {
7148 e.insert(Mutex::new(PeerState {
7149 channel_by_id: HashMap::new(),
7150 outbound_v1_channel_by_id: HashMap::new(),
7151 inbound_v1_channel_by_id: HashMap::new(),
7152 latest_features: init_msg.features.clone(),
7153 pending_msg_events: Vec::new(),
7154 in_flight_monitor_updates: BTreeMap::new(),
7155 monitor_update_blocked_actions: BTreeMap::new(),
7156 actions_blocking_raa_monitor_updates: BTreeMap::new(),
7160 hash_map::Entry::Occupied(e) => {
7161 let mut peer_state = e.get().lock().unwrap();
7162 peer_state.latest_features = init_msg.features.clone();
7164 let best_block_height = self.best_block.read().unwrap().height();
7165 if inbound_peer_limited &&
7166 Self::unfunded_channel_count(&*peer_state, best_block_height) ==
7167 peer_state.channel_by_id.len()
7172 debug_assert!(!peer_state.is_connected, "A peer shouldn't be connected twice");
7173 peer_state.is_connected = true;
7178 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
7180 let per_peer_state = self.per_peer_state.read().unwrap();
7181 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
7182 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7183 let peer_state = &mut *peer_state_lock;
7184 let pending_msg_events = &mut peer_state.pending_msg_events;
7185 peer_state.channel_by_id.retain(|_, chan| {
7186 let retain = if chan.context.get_counterparty_node_id() == *counterparty_node_id {
7187 if !chan.context.have_received_message() {
7188 // If we created this (outbound) channel while we were disconnected from the
7189 // peer we probably failed to send the open_channel message, which is now
7190 // lost. We can't have had anything pending related to this channel, so we just
7194 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
7195 node_id: chan.context.get_counterparty_node_id(),
7196 msg: chan.get_channel_reestablish(&self.logger),
7201 if retain && chan.context.get_counterparty_node_id() != *counterparty_node_id {
7202 if let Some(msg) = chan.get_signed_channel_announcement(&self.node_signer, self.genesis_hash.clone(), self.best_block.read().unwrap().height(), &self.default_configuration) {
7203 if let Ok(update_msg) = self.get_channel_update_for_broadcast(chan) {
7204 pending_msg_events.push(events::MessageSendEvent::SendChannelAnnouncement {
7205 node_id: *counterparty_node_id,
7214 //TODO: Also re-broadcast announcement_signatures
7218 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
7219 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(self);
7221 if msg.channel_id == [0; 32] {
7222 let channel_ids: Vec<[u8; 32]> = {
7223 let per_peer_state = self.per_peer_state.read().unwrap();
7224 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
7225 if peer_state_mutex_opt.is_none() { return; }
7226 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
7227 let peer_state = &mut *peer_state_lock;
7228 peer_state.channel_by_id.keys().cloned()
7229 .chain(peer_state.outbound_v1_channel_by_id.keys().cloned())
7230 .chain(peer_state.inbound_v1_channel_by_id.keys().cloned()).collect()
7232 for channel_id in channel_ids {
7233 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
7234 let _ = self.force_close_channel_with_peer(&channel_id, counterparty_node_id, Some(&msg.data), true);
7238 // First check if we can advance the channel type and try again.
7239 let per_peer_state = self.per_peer_state.read().unwrap();
7240 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
7241 if peer_state_mutex_opt.is_none() { return; }
7242 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
7243 let peer_state = &mut *peer_state_lock;
7244 if let Some(chan) = peer_state.outbound_v1_channel_by_id.get_mut(&msg.channel_id) {
7245 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash) {
7246 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
7247 node_id: *counterparty_node_id,
7255 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
7256 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
7260 fn provided_node_features(&self) -> NodeFeatures {
7261 provided_node_features(&self.default_configuration)
7264 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
7265 provided_init_features(&self.default_configuration)
7268 fn get_genesis_hashes(&self) -> Option<Vec<ChainHash>> {
7269 Some(vec![ChainHash::from(&self.genesis_hash[..])])
7272 fn handle_tx_add_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddInput) {
7273 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7274 "Dual-funded channels not supported".to_owned(),
7275 msg.channel_id.clone())), *counterparty_node_id);
7278 fn handle_tx_add_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
7279 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7280 "Dual-funded channels not supported".to_owned(),
7281 msg.channel_id.clone())), *counterparty_node_id);
7284 fn handle_tx_remove_input(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
7285 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7286 "Dual-funded channels not supported".to_owned(),
7287 msg.channel_id.clone())), *counterparty_node_id);
7290 fn handle_tx_remove_output(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
7291 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7292 "Dual-funded channels not supported".to_owned(),
7293 msg.channel_id.clone())), *counterparty_node_id);
7296 fn handle_tx_complete(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxComplete) {
7297 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7298 "Dual-funded channels not supported".to_owned(),
7299 msg.channel_id.clone())), *counterparty_node_id);
7302 fn handle_tx_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxSignatures) {
7303 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7304 "Dual-funded channels not supported".to_owned(),
7305 msg.channel_id.clone())), *counterparty_node_id);
7308 fn handle_tx_init_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
7309 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7310 "Dual-funded channels not supported".to_owned(),
7311 msg.channel_id.clone())), *counterparty_node_id);
7314 fn handle_tx_ack_rbf(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
7315 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7316 "Dual-funded channels not supported".to_owned(),
7317 msg.channel_id.clone())), *counterparty_node_id);
7320 fn handle_tx_abort(&self, counterparty_node_id: &PublicKey, msg: &msgs::TxAbort) {
7321 let _: Result<(), _> = handle_error!(self, Err(MsgHandleErrInternal::send_err_msg_no_close(
7322 "Dual-funded channels not supported".to_owned(),
7323 msg.channel_id.clone())), *counterparty_node_id);
7327 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
7328 /// [`ChannelManager`].
7329 pub(crate) fn provided_node_features(config: &UserConfig) -> NodeFeatures {
7330 provided_init_features(config).to_context()
7333 /// Fetches the set of [`InvoiceFeatures`] flags which are provided by or required by
7334 /// [`ChannelManager`].
7336 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
7337 /// or not. Thus, this method is not public.
7338 #[cfg(any(feature = "_test_utils", test))]
7339 pub(crate) fn provided_invoice_features(config: &UserConfig) -> InvoiceFeatures {
7340 provided_init_features(config).to_context()
7343 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
7344 /// [`ChannelManager`].
7345 pub(crate) fn provided_channel_features(config: &UserConfig) -> ChannelFeatures {
7346 provided_init_features(config).to_context()
7349 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
7350 /// [`ChannelManager`].
7351 pub(crate) fn provided_channel_type_features(config: &UserConfig) -> ChannelTypeFeatures {
7352 ChannelTypeFeatures::from_init(&provided_init_features(config))
7355 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
7356 /// [`ChannelManager`].
7357 pub fn provided_init_features(config: &UserConfig) -> InitFeatures {
7358 // Note that if new features are added here which other peers may (eventually) require, we
7359 // should also add the corresponding (optional) bit to the [`ChannelMessageHandler`] impl for
7360 // [`ErroringMessageHandler`].
7361 let mut features = InitFeatures::empty();
7362 features.set_data_loss_protect_required();
7363 features.set_upfront_shutdown_script_optional();
7364 features.set_variable_length_onion_required();
7365 features.set_static_remote_key_required();
7366 features.set_payment_secret_required();
7367 features.set_basic_mpp_optional();
7368 features.set_wumbo_optional();
7369 features.set_shutdown_any_segwit_optional();
7370 features.set_channel_type_optional();
7371 features.set_scid_privacy_optional();
7372 features.set_zero_conf_optional();
7373 if config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx {
7374 features.set_anchors_zero_fee_htlc_tx_optional();
7379 const SERIALIZATION_VERSION: u8 = 1;
7380 const MIN_SERIALIZATION_VERSION: u8 = 1;
7382 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
7383 (2, fee_base_msat, required),
7384 (4, fee_proportional_millionths, required),
7385 (6, cltv_expiry_delta, required),
7388 impl_writeable_tlv_based!(ChannelCounterparty, {
7389 (2, node_id, required),
7390 (4, features, required),
7391 (6, unspendable_punishment_reserve, required),
7392 (8, forwarding_info, option),
7393 (9, outbound_htlc_minimum_msat, option),
7394 (11, outbound_htlc_maximum_msat, option),
7397 impl Writeable for ChannelDetails {
7398 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
7399 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
7400 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
7401 let user_channel_id_low = self.user_channel_id as u64;
7402 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
7403 write_tlv_fields!(writer, {
7404 (1, self.inbound_scid_alias, option),
7405 (2, self.channel_id, required),
7406 (3, self.channel_type, option),
7407 (4, self.counterparty, required),
7408 (5, self.outbound_scid_alias, option),
7409 (6, self.funding_txo, option),
7410 (7, self.config, option),
7411 (8, self.short_channel_id, option),
7412 (9, self.confirmations, option),
7413 (10, self.channel_value_satoshis, required),
7414 (12, self.unspendable_punishment_reserve, option),
7415 (14, user_channel_id_low, required),
7416 (16, self.balance_msat, required),
7417 (18, self.outbound_capacity_msat, required),
7418 (19, self.next_outbound_htlc_limit_msat, required),
7419 (20, self.inbound_capacity_msat, required),
7420 (21, self.next_outbound_htlc_minimum_msat, required),
7421 (22, self.confirmations_required, option),
7422 (24, self.force_close_spend_delay, option),
7423 (26, self.is_outbound, required),
7424 (28, self.is_channel_ready, required),
7425 (30, self.is_usable, required),
7426 (32, self.is_public, required),
7427 (33, self.inbound_htlc_minimum_msat, option),
7428 (35, self.inbound_htlc_maximum_msat, option),
7429 (37, user_channel_id_high_opt, option),
7430 (39, self.feerate_sat_per_1000_weight, option),
7431 (41, self.channel_shutdown_state, option),
7437 impl Readable for ChannelDetails {
7438 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
7439 _init_and_read_tlv_fields!(reader, {
7440 (1, inbound_scid_alias, option),
7441 (2, channel_id, required),
7442 (3, channel_type, option),
7443 (4, counterparty, required),
7444 (5, outbound_scid_alias, option),
7445 (6, funding_txo, option),
7446 (7, config, option),
7447 (8, short_channel_id, option),
7448 (9, confirmations, option),
7449 (10, channel_value_satoshis, required),
7450 (12, unspendable_punishment_reserve, option),
7451 (14, user_channel_id_low, required),
7452 (16, balance_msat, required),
7453 (18, outbound_capacity_msat, required),
7454 // Note that by the time we get past the required read above, outbound_capacity_msat will be
7455 // filled in, so we can safely unwrap it here.
7456 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
7457 (20, inbound_capacity_msat, required),
7458 (21, next_outbound_htlc_minimum_msat, (default_value, 0)),
7459 (22, confirmations_required, option),
7460 (24, force_close_spend_delay, option),
7461 (26, is_outbound, required),
7462 (28, is_channel_ready, required),
7463 (30, is_usable, required),
7464 (32, is_public, required),
7465 (33, inbound_htlc_minimum_msat, option),
7466 (35, inbound_htlc_maximum_msat, option),
7467 (37, user_channel_id_high_opt, option),
7468 (39, feerate_sat_per_1000_weight, option),
7469 (41, channel_shutdown_state, option),
7472 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
7473 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
7474 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
7475 let user_channel_id = user_channel_id_low as u128 +
7476 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
7480 channel_id: channel_id.0.unwrap(),
7482 counterparty: counterparty.0.unwrap(),
7483 outbound_scid_alias,
7487 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
7488 unspendable_punishment_reserve,
7490 balance_msat: balance_msat.0.unwrap(),
7491 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
7492 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
7493 next_outbound_htlc_minimum_msat: next_outbound_htlc_minimum_msat.0.unwrap(),
7494 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
7495 confirmations_required,
7497 force_close_spend_delay,
7498 is_outbound: is_outbound.0.unwrap(),
7499 is_channel_ready: is_channel_ready.0.unwrap(),
7500 is_usable: is_usable.0.unwrap(),
7501 is_public: is_public.0.unwrap(),
7502 inbound_htlc_minimum_msat,
7503 inbound_htlc_maximum_msat,
7504 feerate_sat_per_1000_weight,
7505 channel_shutdown_state,
7510 impl_writeable_tlv_based!(PhantomRouteHints, {
7511 (2, channels, vec_type),
7512 (4, phantom_scid, required),
7513 (6, real_node_pubkey, required),
7516 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
7518 (0, onion_packet, required),
7519 (2, short_channel_id, required),
7522 (0, payment_data, required),
7523 (1, phantom_shared_secret, option),
7524 (2, incoming_cltv_expiry, required),
7525 (3, payment_metadata, option),
7527 (2, ReceiveKeysend) => {
7528 (0, payment_preimage, required),
7529 (2, incoming_cltv_expiry, required),
7530 (3, payment_metadata, option),
7531 (4, payment_data, option), // Added in 0.0.116
7535 impl_writeable_tlv_based!(PendingHTLCInfo, {
7536 (0, routing, required),
7537 (2, incoming_shared_secret, required),
7538 (4, payment_hash, required),
7539 (6, outgoing_amt_msat, required),
7540 (8, outgoing_cltv_value, required),
7541 (9, incoming_amt_msat, option),
7542 (10, skimmed_fee_msat, option),
7546 impl Writeable for HTLCFailureMsg {
7547 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
7549 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
7551 channel_id.write(writer)?;
7552 htlc_id.write(writer)?;
7553 reason.write(writer)?;
7555 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
7556 channel_id, htlc_id, sha256_of_onion, failure_code
7559 channel_id.write(writer)?;
7560 htlc_id.write(writer)?;
7561 sha256_of_onion.write(writer)?;
7562 failure_code.write(writer)?;
7569 impl Readable for HTLCFailureMsg {
7570 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
7571 let id: u8 = Readable::read(reader)?;
7574 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
7575 channel_id: Readable::read(reader)?,
7576 htlc_id: Readable::read(reader)?,
7577 reason: Readable::read(reader)?,
7581 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
7582 channel_id: Readable::read(reader)?,
7583 htlc_id: Readable::read(reader)?,
7584 sha256_of_onion: Readable::read(reader)?,
7585 failure_code: Readable::read(reader)?,
7588 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
7589 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
7590 // messages contained in the variants.
7591 // In version 0.0.101, support for reading the variants with these types was added, and
7592 // we should migrate to writing these variants when UpdateFailHTLC or
7593 // UpdateFailMalformedHTLC get TLV fields.
7595 let length: BigSize = Readable::read(reader)?;
7596 let mut s = FixedLengthReader::new(reader, length.0);
7597 let res = Readable::read(&mut s)?;
7598 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
7599 Ok(HTLCFailureMsg::Relay(res))
7602 let length: BigSize = Readable::read(reader)?;
7603 let mut s = FixedLengthReader::new(reader, length.0);
7604 let res = Readable::read(&mut s)?;
7605 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
7606 Ok(HTLCFailureMsg::Malformed(res))
7608 _ => Err(DecodeError::UnknownRequiredFeature),
7613 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
7618 impl_writeable_tlv_based!(HTLCPreviousHopData, {
7619 (0, short_channel_id, required),
7620 (1, phantom_shared_secret, option),
7621 (2, outpoint, required),
7622 (4, htlc_id, required),
7623 (6, incoming_packet_shared_secret, required)
7626 impl Writeable for ClaimableHTLC {
7627 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
7628 let (payment_data, keysend_preimage) = match &self.onion_payload {
7629 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
7630 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
7632 write_tlv_fields!(writer, {
7633 (0, self.prev_hop, required),
7634 (1, self.total_msat, required),
7635 (2, self.value, required),
7636 (3, self.sender_intended_value, required),
7637 (4, payment_data, option),
7638 (5, self.total_value_received, option),
7639 (6, self.cltv_expiry, required),
7640 (8, keysend_preimage, option),
7641 (10, self.counterparty_skimmed_fee_msat, option),
7647 impl Readable for ClaimableHTLC {
7648 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
7649 _init_and_read_tlv_fields!(reader, {
7650 (0, prev_hop, required),
7651 (1, total_msat, option),
7652 (2, value_ser, required),
7653 (3, sender_intended_value, option),
7654 (4, payment_data_opt, option),
7655 (5, total_value_received, option),
7656 (6, cltv_expiry, required),
7657 (8, keysend_preimage, option),
7658 (10, counterparty_skimmed_fee_msat, option),
7660 let payment_data: Option<msgs::FinalOnionHopData> = payment_data_opt;
7661 let value = value_ser.0.unwrap();
7662 let onion_payload = match keysend_preimage {
7664 if payment_data.is_some() {
7665 return Err(DecodeError::InvalidValue)
7667 if total_msat.is_none() {
7668 total_msat = Some(value);
7670 OnionPayload::Spontaneous(p)
7673 if total_msat.is_none() {
7674 if payment_data.is_none() {
7675 return Err(DecodeError::InvalidValue)
7677 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
7679 OnionPayload::Invoice { _legacy_hop_data: payment_data }
7683 prev_hop: prev_hop.0.unwrap(),
7686 sender_intended_value: sender_intended_value.unwrap_or(value),
7687 total_value_received,
7688 total_msat: total_msat.unwrap(),
7690 cltv_expiry: cltv_expiry.0.unwrap(),
7691 counterparty_skimmed_fee_msat,
7696 impl Readable for HTLCSource {
7697 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
7698 let id: u8 = Readable::read(reader)?;
7701 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
7702 let mut first_hop_htlc_msat: u64 = 0;
7703 let mut path_hops: Option<Vec<RouteHop>> = Some(Vec::new());
7704 let mut payment_id = None;
7705 let mut payment_params: Option<PaymentParameters> = None;
7706 let mut blinded_tail: Option<BlindedTail> = None;
7707 read_tlv_fields!(reader, {
7708 (0, session_priv, required),
7709 (1, payment_id, option),
7710 (2, first_hop_htlc_msat, required),
7711 (4, path_hops, vec_type),
7712 (5, payment_params, (option: ReadableArgs, 0)),
7713 (6, blinded_tail, option),
7715 if payment_id.is_none() {
7716 // For backwards compat, if there was no payment_id written, use the session_priv bytes
7718 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
7720 let path = Path { hops: path_hops.ok_or(DecodeError::InvalidValue)?, blinded_tail };
7721 if path.hops.len() == 0 {
7722 return Err(DecodeError::InvalidValue);
7724 if let Some(params) = payment_params.as_mut() {
7725 if let Payee::Clear { ref mut final_cltv_expiry_delta, .. } = params.payee {
7726 if final_cltv_expiry_delta == &0 {
7727 *final_cltv_expiry_delta = path.final_cltv_expiry_delta().ok_or(DecodeError::InvalidValue)?;
7731 Ok(HTLCSource::OutboundRoute {
7732 session_priv: session_priv.0.unwrap(),
7733 first_hop_htlc_msat,
7735 payment_id: payment_id.unwrap(),
7738 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
7739 _ => Err(DecodeError::UnknownRequiredFeature),
7744 impl Writeable for HTLCSource {
7745 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
7747 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id } => {
7749 let payment_id_opt = Some(payment_id);
7750 write_tlv_fields!(writer, {
7751 (0, session_priv, required),
7752 (1, payment_id_opt, option),
7753 (2, first_hop_htlc_msat, required),
7754 // 3 was previously used to write a PaymentSecret for the payment.
7755 (4, path.hops, vec_type),
7756 (5, None::<PaymentParameters>, option), // payment_params in LDK versions prior to 0.0.115
7757 (6, path.blinded_tail, option),
7760 HTLCSource::PreviousHopData(ref field) => {
7762 field.write(writer)?;
7769 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
7770 (0, forward_info, required),
7771 (1, prev_user_channel_id, (default_value, 0)),
7772 (2, prev_short_channel_id, required),
7773 (4, prev_htlc_id, required),
7774 (6, prev_funding_outpoint, required),
7777 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
7779 (0, htlc_id, required),
7780 (2, err_packet, required),
7785 impl_writeable_tlv_based!(PendingInboundPayment, {
7786 (0, payment_secret, required),
7787 (2, expiry_time, required),
7788 (4, user_payment_id, required),
7789 (6, payment_preimage, required),
7790 (8, min_value_msat, required),
7793 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>
7795 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7796 T::Target: BroadcasterInterface,
7797 ES::Target: EntropySource,
7798 NS::Target: NodeSigner,
7799 SP::Target: SignerProvider,
7800 F::Target: FeeEstimator,
7804 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
7805 let _consistency_lock = self.total_consistency_lock.write().unwrap();
7807 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
7809 self.genesis_hash.write(writer)?;
7811 let best_block = self.best_block.read().unwrap();
7812 best_block.height().write(writer)?;
7813 best_block.block_hash().write(writer)?;
7816 let mut serializable_peer_count: u64 = 0;
7818 let per_peer_state = self.per_peer_state.read().unwrap();
7819 let mut unfunded_channels = 0;
7820 let mut number_of_channels = 0;
7821 for (_, peer_state_mutex) in per_peer_state.iter() {
7822 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7823 let peer_state = &mut *peer_state_lock;
7824 if !peer_state.ok_to_remove(false) {
7825 serializable_peer_count += 1;
7827 number_of_channels += peer_state.channel_by_id.len();
7828 for (_, channel) in peer_state.channel_by_id.iter() {
7829 if !channel.context.is_funding_initiated() {
7830 unfunded_channels += 1;
7835 ((number_of_channels - unfunded_channels) as u64).write(writer)?;
7837 for (_, peer_state_mutex) in per_peer_state.iter() {
7838 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7839 let peer_state = &mut *peer_state_lock;
7840 for (_, channel) in peer_state.channel_by_id.iter() {
7841 if channel.context.is_funding_initiated() {
7842 channel.write(writer)?;
7849 let forward_htlcs = self.forward_htlcs.lock().unwrap();
7850 (forward_htlcs.len() as u64).write(writer)?;
7851 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
7852 short_channel_id.write(writer)?;
7853 (pending_forwards.len() as u64).write(writer)?;
7854 for forward in pending_forwards {
7855 forward.write(writer)?;
7860 let per_peer_state = self.per_peer_state.write().unwrap();
7862 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
7863 let claimable_payments = self.claimable_payments.lock().unwrap();
7864 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
7866 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
7867 let mut htlc_onion_fields: Vec<&_> = Vec::new();
7868 (claimable_payments.claimable_payments.len() as u64).write(writer)?;
7869 for (payment_hash, payment) in claimable_payments.claimable_payments.iter() {
7870 payment_hash.write(writer)?;
7871 (payment.htlcs.len() as u64).write(writer)?;
7872 for htlc in payment.htlcs.iter() {
7873 htlc.write(writer)?;
7875 htlc_purposes.push(&payment.purpose);
7876 htlc_onion_fields.push(&payment.onion_fields);
7879 let mut monitor_update_blocked_actions_per_peer = None;
7880 let mut peer_states = Vec::new();
7881 for (_, peer_state_mutex) in per_peer_state.iter() {
7882 // Because we're holding the owning `per_peer_state` write lock here there's no chance
7883 // of a lockorder violation deadlock - no other thread can be holding any
7884 // per_peer_state lock at all.
7885 peer_states.push(peer_state_mutex.unsafe_well_ordered_double_lock_self());
7888 (serializable_peer_count).write(writer)?;
7889 for ((peer_pubkey, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
7890 // Peers which we have no channels to should be dropped once disconnected. As we
7891 // disconnect all peers when shutting down and serializing the ChannelManager, we
7892 // consider all peers as disconnected here. There's therefore no need write peers with
7894 if !peer_state.ok_to_remove(false) {
7895 peer_pubkey.write(writer)?;
7896 peer_state.latest_features.write(writer)?;
7897 if !peer_state.monitor_update_blocked_actions.is_empty() {
7898 monitor_update_blocked_actions_per_peer
7899 .get_or_insert_with(Vec::new)
7900 .push((*peer_pubkey, &peer_state.monitor_update_blocked_actions));
7905 let events = self.pending_events.lock().unwrap();
7906 // LDK versions prior to 0.0.115 don't support post-event actions, thus if there's no
7907 // actions at all, skip writing the required TLV. Otherwise, pre-0.0.115 versions will
7908 // refuse to read the new ChannelManager.
7909 let events_not_backwards_compatible = events.iter().any(|(_, action)| action.is_some());
7910 if events_not_backwards_compatible {
7911 // If we're gonna write a even TLV that will overwrite our events anyway we might as
7912 // well save the space and not write any events here.
7913 0u64.write(writer)?;
7915 (events.len() as u64).write(writer)?;
7916 for (event, _) in events.iter() {
7917 event.write(writer)?;
7921 // LDK versions prior to 0.0.116 wrote the `pending_background_events`
7922 // `MonitorUpdateRegeneratedOnStartup`s here, however there was never a reason to do so -
7923 // the closing monitor updates were always effectively replayed on startup (either directly
7924 // by calling `broadcast_latest_holder_commitment_txn` on a `ChannelMonitor` during
7925 // deserialization or, in 0.0.115, by regenerating the monitor update itself).
7926 0u64.write(writer)?;
7928 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
7929 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
7930 // likely to be identical.
7931 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
7932 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
7934 (pending_inbound_payments.len() as u64).write(writer)?;
7935 for (hash, pending_payment) in pending_inbound_payments.iter() {
7936 hash.write(writer)?;
7937 pending_payment.write(writer)?;
7940 // For backwards compat, write the session privs and their total length.
7941 let mut num_pending_outbounds_compat: u64 = 0;
7942 for (_, outbound) in pending_outbound_payments.iter() {
7943 if !outbound.is_fulfilled() && !outbound.abandoned() {
7944 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
7947 num_pending_outbounds_compat.write(writer)?;
7948 for (_, outbound) in pending_outbound_payments.iter() {
7950 PendingOutboundPayment::Legacy { session_privs } |
7951 PendingOutboundPayment::Retryable { session_privs, .. } => {
7952 for session_priv in session_privs.iter() {
7953 session_priv.write(writer)?;
7956 PendingOutboundPayment::Fulfilled { .. } => {},
7957 PendingOutboundPayment::Abandoned { .. } => {},
7961 // Encode without retry info for 0.0.101 compatibility.
7962 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
7963 for (id, outbound) in pending_outbound_payments.iter() {
7965 PendingOutboundPayment::Legacy { session_privs } |
7966 PendingOutboundPayment::Retryable { session_privs, .. } => {
7967 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
7973 let mut pending_intercepted_htlcs = None;
7974 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
7975 if our_pending_intercepts.len() != 0 {
7976 pending_intercepted_htlcs = Some(our_pending_intercepts);
7979 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
7980 if pending_claiming_payments.as_ref().unwrap().is_empty() {
7981 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
7982 // map. Thus, if there are no entries we skip writing a TLV for it.
7983 pending_claiming_payments = None;
7986 let mut in_flight_monitor_updates: Option<HashMap<(&PublicKey, &OutPoint), &Vec<ChannelMonitorUpdate>>> = None;
7987 for ((counterparty_id, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
7988 for (funding_outpoint, updates) in peer_state.in_flight_monitor_updates.iter() {
7989 if !updates.is_empty() {
7990 if in_flight_monitor_updates.is_none() { in_flight_monitor_updates = Some(HashMap::new()); }
7991 in_flight_monitor_updates.as_mut().unwrap().insert((counterparty_id, funding_outpoint), updates);
7996 write_tlv_fields!(writer, {
7997 (1, pending_outbound_payments_no_retry, required),
7998 (2, pending_intercepted_htlcs, option),
7999 (3, pending_outbound_payments, required),
8000 (4, pending_claiming_payments, option),
8001 (5, self.our_network_pubkey, required),
8002 (6, monitor_update_blocked_actions_per_peer, option),
8003 (7, self.fake_scid_rand_bytes, required),
8004 (8, if events_not_backwards_compatible { Some(&*events) } else { None }, option),
8005 (9, htlc_purposes, vec_type),
8006 (10, in_flight_monitor_updates, option),
8007 (11, self.probing_cookie_secret, required),
8008 (13, htlc_onion_fields, optional_vec),
8015 impl Writeable for VecDeque<(Event, Option<EventCompletionAction>)> {
8016 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
8017 (self.len() as u64).write(w)?;
8018 for (event, action) in self.iter() {
8021 #[cfg(debug_assertions)] {
8022 // Events are MaybeReadable, in some cases indicating that they shouldn't actually
8023 // be persisted and are regenerated on restart. However, if such an event has a
8024 // post-event-handling action we'll write nothing for the event and would have to
8025 // either forget the action or fail on deserialization (which we do below). Thus,
8026 // check that the event is sane here.
8027 let event_encoded = event.encode();
8028 let event_read: Option<Event> =
8029 MaybeReadable::read(&mut &event_encoded[..]).unwrap();
8030 if action.is_some() { assert!(event_read.is_some()); }
8036 impl Readable for VecDeque<(Event, Option<EventCompletionAction>)> {
8037 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
8038 let len: u64 = Readable::read(reader)?;
8039 const MAX_ALLOC_SIZE: u64 = 1024 * 16;
8040 let mut events: Self = VecDeque::with_capacity(cmp::min(
8041 MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>() as u64,
8044 let ev_opt = MaybeReadable::read(reader)?;
8045 let action = Readable::read(reader)?;
8046 if let Some(ev) = ev_opt {
8047 events.push_back((ev, action));
8048 } else if action.is_some() {
8049 return Err(DecodeError::InvalidValue);
8056 impl_writeable_tlv_based_enum!(ChannelShutdownState,
8057 (0, NotShuttingDown) => {},
8058 (2, ShutdownInitiated) => {},
8059 (4, ResolvingHTLCs) => {},
8060 (6, NegotiatingClosingFee) => {},
8061 (8, ShutdownComplete) => {}, ;
8064 /// Arguments for the creation of a ChannelManager that are not deserialized.
8066 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
8068 /// 1) Deserialize all stored [`ChannelMonitor`]s.
8069 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
8070 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
8071 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
8072 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
8073 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
8074 /// same way you would handle a [`chain::Filter`] call using
8075 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
8076 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
8077 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
8078 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
8079 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
8080 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
8082 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
8083 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
8085 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
8086 /// call any other methods on the newly-deserialized [`ChannelManager`].
8088 /// Note that because some channels may be closed during deserialization, it is critical that you
8089 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
8090 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
8091 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
8092 /// not force-close the same channels but consider them live), you may end up revoking a state for
8093 /// which you've already broadcasted the transaction.
8095 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
8096 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8098 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8099 T::Target: BroadcasterInterface,
8100 ES::Target: EntropySource,
8101 NS::Target: NodeSigner,
8102 SP::Target: SignerProvider,
8103 F::Target: FeeEstimator,
8107 /// A cryptographically secure source of entropy.
8108 pub entropy_source: ES,
8110 /// A signer that is able to perform node-scoped cryptographic operations.
8111 pub node_signer: NS,
8113 /// The keys provider which will give us relevant keys. Some keys will be loaded during
8114 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
8116 pub signer_provider: SP,
8118 /// The fee_estimator for use in the ChannelManager in the future.
8120 /// No calls to the FeeEstimator will be made during deserialization.
8121 pub fee_estimator: F,
8122 /// The chain::Watch for use in the ChannelManager in the future.
8124 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
8125 /// you have deserialized ChannelMonitors separately and will add them to your
8126 /// chain::Watch after deserializing this ChannelManager.
8127 pub chain_monitor: M,
8129 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
8130 /// used to broadcast the latest local commitment transactions of channels which must be
8131 /// force-closed during deserialization.
8132 pub tx_broadcaster: T,
8133 /// The router which will be used in the ChannelManager in the future for finding routes
8134 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
8136 /// No calls to the router will be made during deserialization.
8138 /// The Logger for use in the ChannelManager and which may be used to log information during
8139 /// deserialization.
8141 /// Default settings used for new channels. Any existing channels will continue to use the
8142 /// runtime settings which were stored when the ChannelManager was serialized.
8143 pub default_config: UserConfig,
8145 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
8146 /// value.context.get_funding_txo() should be the key).
8148 /// If a monitor is inconsistent with the channel state during deserialization the channel will
8149 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
8150 /// is true for missing channels as well. If there is a monitor missing for which we find
8151 /// channel data Err(DecodeError::InvalidValue) will be returned.
8153 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
8156 /// This is not exported to bindings users because we have no HashMap bindings
8157 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>,
8160 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8161 ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>
8163 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8164 T::Target: BroadcasterInterface,
8165 ES::Target: EntropySource,
8166 NS::Target: NodeSigner,
8167 SP::Target: SignerProvider,
8168 F::Target: FeeEstimator,
8172 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
8173 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
8174 /// populate a HashMap directly from C.
8175 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,
8176 mut channel_monitors: Vec<&'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>) -> Self {
8178 entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
8179 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
8184 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
8185 // SipmleArcChannelManager type:
8186 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8187 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, ES, NS, SP, F, R, L>>)
8189 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8190 T::Target: BroadcasterInterface,
8191 ES::Target: EntropySource,
8192 NS::Target: NodeSigner,
8193 SP::Target: SignerProvider,
8194 F::Target: FeeEstimator,
8198 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
8199 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)>::read(reader, args)?;
8200 Ok((blockhash, Arc::new(chan_manager)))
8204 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
8205 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)
8207 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
8208 T::Target: BroadcasterInterface,
8209 ES::Target: EntropySource,
8210 NS::Target: NodeSigner,
8211 SP::Target: SignerProvider,
8212 F::Target: FeeEstimator,
8216 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
8217 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
8219 let genesis_hash: BlockHash = Readable::read(reader)?;
8220 let best_block_height: u32 = Readable::read(reader)?;
8221 let best_block_hash: BlockHash = Readable::read(reader)?;
8223 let mut failed_htlcs = Vec::new();
8225 let channel_count: u64 = Readable::read(reader)?;
8226 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
8227 let mut peer_channels: HashMap<PublicKey, HashMap<[u8; 32], Channel<<SP::Target as SignerProvider>::Signer>>> = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8228 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8229 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
8230 let mut channel_closures = VecDeque::new();
8231 let mut close_background_events = Vec::new();
8232 for _ in 0..channel_count {
8233 let mut channel: Channel<<SP::Target as SignerProvider>::Signer> = Channel::read(reader, (
8234 &args.entropy_source, &args.signer_provider, best_block_height, &provided_channel_type_features(&args.default_config)
8236 let funding_txo = channel.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
8237 funding_txo_set.insert(funding_txo.clone());
8238 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
8239 if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
8240 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
8241 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
8242 channel.context.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
8243 // But if the channel is behind of the monitor, close the channel:
8244 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
8245 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
8246 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
8247 log_bytes!(channel.context.channel_id()), monitor.get_latest_update_id(), channel.context.get_latest_monitor_update_id());
8248 let (monitor_update, mut new_failed_htlcs) = channel.context.force_shutdown(true);
8249 if let Some((counterparty_node_id, funding_txo, update)) = monitor_update {
8250 close_background_events.push(BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
8251 counterparty_node_id, funding_txo, update
8254 failed_htlcs.append(&mut new_failed_htlcs);
8255 channel_closures.push_back((events::Event::ChannelClosed {
8256 channel_id: channel.context.channel_id(),
8257 user_channel_id: channel.context.get_user_id(),
8258 reason: ClosureReason::OutdatedChannelManager
8260 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
8261 let mut found_htlc = false;
8262 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
8263 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
8266 // If we have some HTLCs in the channel which are not present in the newer
8267 // ChannelMonitor, they have been removed and should be failed back to
8268 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
8269 // were actually claimed we'd have generated and ensured the previous-hop
8270 // claim update ChannelMonitor updates were persisted prior to persising
8271 // the ChannelMonitor update for the forward leg, so attempting to fail the
8272 // backwards leg of the HTLC will simply be rejected.
8273 log_info!(args.logger,
8274 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
8275 log_bytes!(channel.context.channel_id()), log_bytes!(payment_hash.0));
8276 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8280 log_info!(args.logger, "Successfully loaded channel {} at update_id {} against monitor at update id {}",
8281 log_bytes!(channel.context.channel_id()), channel.context.get_latest_monitor_update_id(),
8282 monitor.get_latest_update_id());
8283 if let Some(short_channel_id) = channel.context.get_short_channel_id() {
8284 short_to_chan_info.insert(short_channel_id, (channel.context.get_counterparty_node_id(), channel.context.channel_id()));
8286 if channel.context.is_funding_initiated() {
8287 id_to_peer.insert(channel.context.channel_id(), channel.context.get_counterparty_node_id());
8289 match peer_channels.entry(channel.context.get_counterparty_node_id()) {
8290 hash_map::Entry::Occupied(mut entry) => {
8291 let by_id_map = entry.get_mut();
8292 by_id_map.insert(channel.context.channel_id(), channel);
8294 hash_map::Entry::Vacant(entry) => {
8295 let mut by_id_map = HashMap::new();
8296 by_id_map.insert(channel.context.channel_id(), channel);
8297 entry.insert(by_id_map);
8301 } else if channel.is_awaiting_initial_mon_persist() {
8302 // If we were persisted and shut down while the initial ChannelMonitor persistence
8303 // was in-progress, we never broadcasted the funding transaction and can still
8304 // safely discard the channel.
8305 let _ = channel.context.force_shutdown(false);
8306 channel_closures.push_back((events::Event::ChannelClosed {
8307 channel_id: channel.context.channel_id(),
8308 user_channel_id: channel.context.get_user_id(),
8309 reason: ClosureReason::DisconnectedPeer,
8312 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.context.channel_id()));
8313 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
8314 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
8315 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
8316 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");
8317 return Err(DecodeError::InvalidValue);
8321 for (funding_txo, _) in args.channel_monitors.iter() {
8322 if !funding_txo_set.contains(funding_txo) {
8323 log_info!(args.logger, "Queueing monitor update to ensure missing channel {} is force closed",
8324 log_bytes!(funding_txo.to_channel_id()));
8325 let monitor_update = ChannelMonitorUpdate {
8326 update_id: CLOSED_CHANNEL_UPDATE_ID,
8327 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast: true }],
8329 close_background_events.push(BackgroundEvent::ClosedMonitorUpdateRegeneratedOnStartup((*funding_txo, monitor_update)));
8333 const MAX_ALLOC_SIZE: usize = 1024 * 64;
8334 let forward_htlcs_count: u64 = Readable::read(reader)?;
8335 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
8336 for _ in 0..forward_htlcs_count {
8337 let short_channel_id = Readable::read(reader)?;
8338 let pending_forwards_count: u64 = Readable::read(reader)?;
8339 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
8340 for _ in 0..pending_forwards_count {
8341 pending_forwards.push(Readable::read(reader)?);
8343 forward_htlcs.insert(short_channel_id, pending_forwards);
8346 let claimable_htlcs_count: u64 = Readable::read(reader)?;
8347 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
8348 for _ in 0..claimable_htlcs_count {
8349 let payment_hash = Readable::read(reader)?;
8350 let previous_hops_len: u64 = Readable::read(reader)?;
8351 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
8352 for _ in 0..previous_hops_len {
8353 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
8355 claimable_htlcs_list.push((payment_hash, previous_hops));
8358 let peer_state_from_chans = |channel_by_id| {
8361 outbound_v1_channel_by_id: HashMap::new(),
8362 inbound_v1_channel_by_id: HashMap::new(),
8363 latest_features: InitFeatures::empty(),
8364 pending_msg_events: Vec::new(),
8365 in_flight_monitor_updates: BTreeMap::new(),
8366 monitor_update_blocked_actions: BTreeMap::new(),
8367 actions_blocking_raa_monitor_updates: BTreeMap::new(),
8368 is_connected: false,
8372 let peer_count: u64 = Readable::read(reader)?;
8373 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>)>()));
8374 for _ in 0..peer_count {
8375 let peer_pubkey = Readable::read(reader)?;
8376 let peer_chans = peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new());
8377 let mut peer_state = peer_state_from_chans(peer_chans);
8378 peer_state.latest_features = Readable::read(reader)?;
8379 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
8382 let event_count: u64 = Readable::read(reader)?;
8383 let mut pending_events_read: VecDeque<(events::Event, Option<EventCompletionAction>)> =
8384 VecDeque::with_capacity(cmp::min(event_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(events::Event, Option<EventCompletionAction>)>()));
8385 for _ in 0..event_count {
8386 match MaybeReadable::read(reader)? {
8387 Some(event) => pending_events_read.push_back((event, None)),
8392 let background_event_count: u64 = Readable::read(reader)?;
8393 for _ in 0..background_event_count {
8394 match <u8 as Readable>::read(reader)? {
8396 // LDK versions prior to 0.0.116 wrote pending `MonitorUpdateRegeneratedOnStartup`s here,
8397 // however we really don't (and never did) need them - we regenerate all
8398 // on-startup monitor updates.
8399 let _: OutPoint = Readable::read(reader)?;
8400 let _: ChannelMonitorUpdate = Readable::read(reader)?;
8402 _ => return Err(DecodeError::InvalidValue),
8406 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
8407 let highest_seen_timestamp: u32 = Readable::read(reader)?;
8409 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
8410 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
8411 for _ in 0..pending_inbound_payment_count {
8412 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
8413 return Err(DecodeError::InvalidValue);
8417 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
8418 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
8419 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
8420 for _ in 0..pending_outbound_payments_count_compat {
8421 let session_priv = Readable::read(reader)?;
8422 let payment = PendingOutboundPayment::Legacy {
8423 session_privs: [session_priv].iter().cloned().collect()
8425 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
8426 return Err(DecodeError::InvalidValue)
8430 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
8431 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
8432 let mut pending_outbound_payments = None;
8433 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
8434 let mut received_network_pubkey: Option<PublicKey> = None;
8435 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
8436 let mut probing_cookie_secret: Option<[u8; 32]> = None;
8437 let mut claimable_htlc_purposes = None;
8438 let mut claimable_htlc_onion_fields = None;
8439 let mut pending_claiming_payments = Some(HashMap::new());
8440 let mut monitor_update_blocked_actions_per_peer: Option<Vec<(_, BTreeMap<_, Vec<_>>)>> = Some(Vec::new());
8441 let mut events_override = None;
8442 let mut in_flight_monitor_updates: Option<HashMap<(PublicKey, OutPoint), Vec<ChannelMonitorUpdate>>> = None;
8443 read_tlv_fields!(reader, {
8444 (1, pending_outbound_payments_no_retry, option),
8445 (2, pending_intercepted_htlcs, option),
8446 (3, pending_outbound_payments, option),
8447 (4, pending_claiming_payments, option),
8448 (5, received_network_pubkey, option),
8449 (6, monitor_update_blocked_actions_per_peer, option),
8450 (7, fake_scid_rand_bytes, option),
8451 (8, events_override, option),
8452 (9, claimable_htlc_purposes, vec_type),
8453 (10, in_flight_monitor_updates, option),
8454 (11, probing_cookie_secret, option),
8455 (13, claimable_htlc_onion_fields, optional_vec),
8457 if fake_scid_rand_bytes.is_none() {
8458 fake_scid_rand_bytes = Some(args.entropy_source.get_secure_random_bytes());
8461 if probing_cookie_secret.is_none() {
8462 probing_cookie_secret = Some(args.entropy_source.get_secure_random_bytes());
8465 if let Some(events) = events_override {
8466 pending_events_read = events;
8469 if !channel_closures.is_empty() {
8470 pending_events_read.append(&mut channel_closures);
8473 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
8474 pending_outbound_payments = Some(pending_outbound_payments_compat);
8475 } else if pending_outbound_payments.is_none() {
8476 let mut outbounds = HashMap::new();
8477 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
8478 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
8480 pending_outbound_payments = Some(outbounds);
8482 let pending_outbounds = OutboundPayments {
8483 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
8484 retry_lock: Mutex::new(())
8487 // We have to replay (or skip, if they were completed after we wrote the `ChannelManager`)
8488 // each `ChannelMonitorUpdate` in `in_flight_monitor_updates`. After doing so, we have to
8489 // check that each channel we have isn't newer than the latest `ChannelMonitorUpdate`(s) we
8490 // replayed, and for each monitor update we have to replay we have to ensure there's a
8491 // `ChannelMonitor` for it.
8493 // In order to do so we first walk all of our live channels (so that we can check their
8494 // state immediately after doing the update replays, when we have the `update_id`s
8495 // available) and then walk any remaining in-flight updates.
8497 // Because the actual handling of the in-flight updates is the same, it's macro'ized here:
8498 let mut pending_background_events = Vec::new();
8499 macro_rules! handle_in_flight_updates {
8500 ($counterparty_node_id: expr, $chan_in_flight_upds: expr, $funding_txo: expr,
8501 $monitor: expr, $peer_state: expr, $channel_info_log: expr
8503 let mut max_in_flight_update_id = 0;
8504 $chan_in_flight_upds.retain(|upd| upd.update_id > $monitor.get_latest_update_id());
8505 for update in $chan_in_flight_upds.iter() {
8506 log_trace!(args.logger, "Replaying ChannelMonitorUpdate {} for {}channel {}",
8507 update.update_id, $channel_info_log, log_bytes!($funding_txo.to_channel_id()));
8508 max_in_flight_update_id = cmp::max(max_in_flight_update_id, update.update_id);
8509 pending_background_events.push(
8510 BackgroundEvent::MonitorUpdateRegeneratedOnStartup {
8511 counterparty_node_id: $counterparty_node_id,
8512 funding_txo: $funding_txo,
8513 update: update.clone(),
8516 if $peer_state.in_flight_monitor_updates.insert($funding_txo, $chan_in_flight_upds).is_some() {
8517 log_error!(args.logger, "Duplicate in-flight monitor update set for the same channel!");
8518 return Err(DecodeError::InvalidValue);
8520 max_in_flight_update_id
8524 for (counterparty_id, peer_state_mtx) in per_peer_state.iter_mut() {
8525 let mut peer_state_lock = peer_state_mtx.lock().unwrap();
8526 let peer_state = &mut *peer_state_lock;
8527 for (_, chan) in peer_state.channel_by_id.iter() {
8528 // Channels that were persisted have to be funded, otherwise they should have been
8530 let funding_txo = chan.context.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
8531 let monitor = args.channel_monitors.get(&funding_txo)
8532 .expect("We already checked for monitor presence when loading channels");
8533 let mut max_in_flight_update_id = monitor.get_latest_update_id();
8534 if let Some(in_flight_upds) = &mut in_flight_monitor_updates {
8535 if let Some(mut chan_in_flight_upds) = in_flight_upds.remove(&(*counterparty_id, funding_txo)) {
8536 max_in_flight_update_id = cmp::max(max_in_flight_update_id,
8537 handle_in_flight_updates!(*counterparty_id, chan_in_flight_upds,
8538 funding_txo, monitor, peer_state, ""));
8541 if chan.get_latest_unblocked_monitor_update_id() > max_in_flight_update_id {
8542 // If the channel is ahead of the monitor, return InvalidValue:
8543 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
8544 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} with update_id through {} in-flight",
8545 log_bytes!(chan.context.channel_id()), monitor.get_latest_update_id(), max_in_flight_update_id);
8546 log_error!(args.logger, " but the ChannelManager is at update_id {}.", chan.get_latest_unblocked_monitor_update_id());
8547 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
8548 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
8549 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
8550 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");
8551 return Err(DecodeError::InvalidValue);
8556 if let Some(in_flight_upds) = in_flight_monitor_updates {
8557 for ((counterparty_id, funding_txo), mut chan_in_flight_updates) in in_flight_upds {
8558 if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
8559 // Now that we've removed all the in-flight monitor updates for channels that are
8560 // still open, we need to replay any monitor updates that are for closed channels,
8561 // creating the neccessary peer_state entries as we go.
8562 let peer_state_mutex = per_peer_state.entry(counterparty_id).or_insert_with(|| {
8563 Mutex::new(peer_state_from_chans(HashMap::new()))
8565 let mut peer_state = peer_state_mutex.lock().unwrap();
8566 handle_in_flight_updates!(counterparty_id, chan_in_flight_updates,
8567 funding_txo, monitor, peer_state, "closed ");
8569 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!");
8570 log_error!(args.logger, " The ChannelMonitor for channel {} is missing.",
8571 log_bytes!(funding_txo.to_channel_id()));
8572 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
8573 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
8574 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
8575 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");
8576 return Err(DecodeError::InvalidValue);
8581 // Note that we have to do the above replays before we push new monitor updates.
8582 pending_background_events.append(&mut close_background_events);
8584 // If there's any preimages for forwarded HTLCs hanging around in ChannelMonitors we
8585 // should ensure we try them again on the inbound edge. We put them here and do so after we
8586 // have a fully-constructed `ChannelManager` at the end.
8587 let mut pending_claims_to_replay = Vec::new();
8590 // If we're tracking pending payments, ensure we haven't lost any by looking at the
8591 // ChannelMonitor data for any channels for which we do not have authorative state
8592 // (i.e. those for which we just force-closed above or we otherwise don't have a
8593 // corresponding `Channel` at all).
8594 // This avoids several edge-cases where we would otherwise "forget" about pending
8595 // payments which are still in-flight via their on-chain state.
8596 // We only rebuild the pending payments map if we were most recently serialized by
8598 for (_, monitor) in args.channel_monitors.iter() {
8599 let counterparty_opt = id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id());
8600 if counterparty_opt.is_none() {
8601 for (htlc_source, (htlc, _)) in monitor.get_pending_or_resolved_outbound_htlcs() {
8602 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } = htlc_source {
8603 if path.hops.is_empty() {
8604 log_error!(args.logger, "Got an empty path for a pending payment");
8605 return Err(DecodeError::InvalidValue);
8608 let path_amt = path.final_value_msat();
8609 let mut session_priv_bytes = [0; 32];
8610 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
8611 match pending_outbounds.pending_outbound_payments.lock().unwrap().entry(payment_id) {
8612 hash_map::Entry::Occupied(mut entry) => {
8613 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
8614 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
8615 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), log_bytes!(htlc.payment_hash.0));
8617 hash_map::Entry::Vacant(entry) => {
8618 let path_fee = path.fee_msat();
8619 entry.insert(PendingOutboundPayment::Retryable {
8620 retry_strategy: None,
8621 attempts: PaymentAttempts::new(),
8622 payment_params: None,
8623 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
8624 payment_hash: htlc.payment_hash,
8625 payment_secret: None, // only used for retries, and we'll never retry on startup
8626 payment_metadata: None, // only used for retries, and we'll never retry on startup
8627 keysend_preimage: None, // only used for retries, and we'll never retry on startup
8628 pending_amt_msat: path_amt,
8629 pending_fee_msat: Some(path_fee),
8630 total_msat: path_amt,
8631 starting_block_height: best_block_height,
8633 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
8634 path_amt, log_bytes!(htlc.payment_hash.0), log_bytes!(session_priv_bytes));
8639 for (htlc_source, (htlc, preimage_opt)) in monitor.get_all_current_outbound_htlcs() {
8641 HTLCSource::PreviousHopData(prev_hop_data) => {
8642 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
8643 info.prev_funding_outpoint == prev_hop_data.outpoint &&
8644 info.prev_htlc_id == prev_hop_data.htlc_id
8646 // The ChannelMonitor is now responsible for this HTLC's
8647 // failure/success and will let us know what its outcome is. If we
8648 // still have an entry for this HTLC in `forward_htlcs` or
8649 // `pending_intercepted_htlcs`, we were apparently not persisted after
8650 // the monitor was when forwarding the payment.
8651 forward_htlcs.retain(|_, forwards| {
8652 forwards.retain(|forward| {
8653 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
8654 if pending_forward_matches_htlc(&htlc_info) {
8655 log_info!(args.logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
8656 log_bytes!(htlc.payment_hash.0), log_bytes!(monitor.get_funding_txo().0.to_channel_id()));
8661 !forwards.is_empty()
8663 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
8664 if pending_forward_matches_htlc(&htlc_info) {
8665 log_info!(args.logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
8666 log_bytes!(htlc.payment_hash.0), log_bytes!(monitor.get_funding_txo().0.to_channel_id()));
8667 pending_events_read.retain(|(event, _)| {
8668 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
8669 intercepted_id != ev_id
8676 HTLCSource::OutboundRoute { payment_id, session_priv, path, .. } => {
8677 if let Some(preimage) = preimage_opt {
8678 let pending_events = Mutex::new(pending_events_read);
8679 // Note that we set `from_onchain` to "false" here,
8680 // deliberately keeping the pending payment around forever.
8681 // Given it should only occur when we have a channel we're
8682 // force-closing for being stale that's okay.
8683 // The alternative would be to wipe the state when claiming,
8684 // generating a `PaymentPathSuccessful` event but regenerating
8685 // it and the `PaymentSent` on every restart until the
8686 // `ChannelMonitor` is removed.
8687 pending_outbounds.claim_htlc(payment_id, preimage, session_priv, path, false, &pending_events, &args.logger);
8688 pending_events_read = pending_events.into_inner().unwrap();
8695 // Whether the downstream channel was closed or not, try to re-apply any payment
8696 // preimages from it which may be needed in upstream channels for forwarded
8698 let outbound_claimed_htlcs_iter = monitor.get_all_current_outbound_htlcs()
8700 .filter_map(|(htlc_source, (htlc, preimage_opt))| {
8701 if let HTLCSource::PreviousHopData(_) = htlc_source {
8702 if let Some(payment_preimage) = preimage_opt {
8703 Some((htlc_source, payment_preimage, htlc.amount_msat,
8704 // Check if `counterparty_opt.is_none()` to see if the
8705 // downstream chan is closed (because we don't have a
8706 // channel_id -> peer map entry).
8707 counterparty_opt.is_none(),
8708 monitor.get_funding_txo().0.to_channel_id()))
8711 // If it was an outbound payment, we've handled it above - if a preimage
8712 // came in and we persisted the `ChannelManager` we either handled it and
8713 // are good to go or the channel force-closed - we don't have to handle the
8714 // channel still live case here.
8718 for tuple in outbound_claimed_htlcs_iter {
8719 pending_claims_to_replay.push(tuple);
8724 if !forward_htlcs.is_empty() || pending_outbounds.needs_abandon() {
8725 // If we have pending HTLCs to forward, assume we either dropped a
8726 // `PendingHTLCsForwardable` or the user received it but never processed it as they
8727 // shut down before the timer hit. Either way, set the time_forwardable to a small
8728 // constant as enough time has likely passed that we should simply handle the forwards
8729 // now, or at least after the user gets a chance to reconnect to our peers.
8730 pending_events_read.push_back((events::Event::PendingHTLCsForwardable {
8731 time_forwardable: Duration::from_secs(2),
8735 let inbound_pmt_key_material = args.node_signer.get_inbound_payment_key_material();
8736 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
8738 let mut claimable_payments = HashMap::with_capacity(claimable_htlcs_list.len());
8739 if let Some(purposes) = claimable_htlc_purposes {
8740 if purposes.len() != claimable_htlcs_list.len() {
8741 return Err(DecodeError::InvalidValue);
8743 if let Some(onion_fields) = claimable_htlc_onion_fields {
8744 if onion_fields.len() != claimable_htlcs_list.len() {
8745 return Err(DecodeError::InvalidValue);
8747 for (purpose, (onion, (payment_hash, htlcs))) in
8748 purposes.into_iter().zip(onion_fields.into_iter().zip(claimable_htlcs_list.into_iter()))
8750 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
8751 purpose, htlcs, onion_fields: onion,
8753 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
8756 for (purpose, (payment_hash, htlcs)) in purposes.into_iter().zip(claimable_htlcs_list.into_iter()) {
8757 let existing_payment = claimable_payments.insert(payment_hash, ClaimablePayment {
8758 purpose, htlcs, onion_fields: None,
8760 if existing_payment.is_some() { return Err(DecodeError::InvalidValue); }
8764 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
8765 // include a `_legacy_hop_data` in the `OnionPayload`.
8766 for (payment_hash, htlcs) in claimable_htlcs_list.drain(..) {
8767 if htlcs.is_empty() {
8768 return Err(DecodeError::InvalidValue);
8770 let purpose = match &htlcs[0].onion_payload {
8771 OnionPayload::Invoice { _legacy_hop_data } => {
8772 if let Some(hop_data) = _legacy_hop_data {
8773 events::PaymentPurpose::InvoicePayment {
8774 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
8775 Some(inbound_payment) => inbound_payment.payment_preimage,
8776 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
8777 Ok((payment_preimage, _)) => payment_preimage,
8779 log_error!(args.logger, "Failed to read claimable payment data for HTLC with payment hash {} - was not a pending inbound payment and didn't match our payment key", log_bytes!(payment_hash.0));
8780 return Err(DecodeError::InvalidValue);
8784 payment_secret: hop_data.payment_secret,
8786 } else { return Err(DecodeError::InvalidValue); }
8788 OnionPayload::Spontaneous(payment_preimage) =>
8789 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
8791 claimable_payments.insert(payment_hash, ClaimablePayment {
8792 purpose, htlcs, onion_fields: None,
8797 let mut secp_ctx = Secp256k1::new();
8798 secp_ctx.seeded_randomize(&args.entropy_source.get_secure_random_bytes());
8800 let our_network_pubkey = match args.node_signer.get_node_id(Recipient::Node) {
8802 Err(()) => return Err(DecodeError::InvalidValue)
8804 if let Some(network_pubkey) = received_network_pubkey {
8805 if network_pubkey != our_network_pubkey {
8806 log_error!(args.logger, "Key that was generated does not match the existing key.");
8807 return Err(DecodeError::InvalidValue);
8811 let mut outbound_scid_aliases = HashSet::new();
8812 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
8813 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8814 let peer_state = &mut *peer_state_lock;
8815 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
8816 if chan.context.outbound_scid_alias() == 0 {
8817 let mut outbound_scid_alias;
8819 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
8820 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.entropy_source);
8821 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
8823 chan.context.set_outbound_scid_alias(outbound_scid_alias);
8824 } else if !outbound_scid_aliases.insert(chan.context.outbound_scid_alias()) {
8825 // Note that in rare cases its possible to hit this while reading an older
8826 // channel if we just happened to pick a colliding outbound alias above.
8827 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
8828 return Err(DecodeError::InvalidValue);
8830 if chan.context.is_usable() {
8831 if short_to_chan_info.insert(chan.context.outbound_scid_alias(), (chan.context.get_counterparty_node_id(), *chan_id)).is_some() {
8832 // Note that in rare cases its possible to hit this while reading an older
8833 // channel if we just happened to pick a colliding outbound alias above.
8834 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.context.outbound_scid_alias());
8835 return Err(DecodeError::InvalidValue);
8841 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
8843 for (_, monitor) in args.channel_monitors.iter() {
8844 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
8845 if let Some(payment) = claimable_payments.remove(&payment_hash) {
8846 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", log_bytes!(payment_hash.0));
8847 let mut claimable_amt_msat = 0;
8848 let mut receiver_node_id = Some(our_network_pubkey);
8849 let phantom_shared_secret = payment.htlcs[0].prev_hop.phantom_shared_secret;
8850 if phantom_shared_secret.is_some() {
8851 let phantom_pubkey = args.node_signer.get_node_id(Recipient::PhantomNode)
8852 .expect("Failed to get node_id for phantom node recipient");
8853 receiver_node_id = Some(phantom_pubkey)
8855 for claimable_htlc in payment.htlcs {
8856 claimable_amt_msat += claimable_htlc.value;
8858 // Add a holding-cell claim of the payment to the Channel, which should be
8859 // applied ~immediately on peer reconnection. Because it won't generate a
8860 // new commitment transaction we can just provide the payment preimage to
8861 // the corresponding ChannelMonitor and nothing else.
8863 // We do so directly instead of via the normal ChannelMonitor update
8864 // procedure as the ChainMonitor hasn't yet been initialized, implying
8865 // we're not allowed to call it directly yet. Further, we do the update
8866 // without incrementing the ChannelMonitor update ID as there isn't any
8868 // If we were to generate a new ChannelMonitor update ID here and then
8869 // crash before the user finishes block connect we'd end up force-closing
8870 // this channel as well. On the flip side, there's no harm in restarting
8871 // without the new monitor persisted - we'll end up right back here on
8873 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
8874 if let Some(peer_node_id) = id_to_peer.get(&previous_channel_id){
8875 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
8876 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
8877 let peer_state = &mut *peer_state_lock;
8878 if let Some(channel) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
8879 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
8882 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
8883 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
8886 pending_events_read.push_back((events::Event::PaymentClaimed {
8889 purpose: payment.purpose,
8890 amount_msat: claimable_amt_msat,
8896 for (node_id, monitor_update_blocked_actions) in monitor_update_blocked_actions_per_peer.unwrap() {
8897 if let Some(peer_state) = per_peer_state.get(&node_id) {
8898 for (_, actions) in monitor_update_blocked_actions.iter() {
8899 for action in actions.iter() {
8900 if let MonitorUpdateCompletionAction::EmitEventAndFreeOtherChannel {
8901 downstream_counterparty_and_funding_outpoint:
8902 Some((blocked_node_id, blocked_channel_outpoint, blocking_action)), ..
8904 if let Some(blocked_peer_state) = per_peer_state.get(&blocked_node_id) {
8905 blocked_peer_state.lock().unwrap().actions_blocking_raa_monitor_updates
8906 .entry(blocked_channel_outpoint.to_channel_id())
8907 .or_insert_with(Vec::new).push(blocking_action.clone());
8912 peer_state.lock().unwrap().monitor_update_blocked_actions = monitor_update_blocked_actions;
8914 log_error!(args.logger, "Got blocked actions without a per-peer-state for {}", node_id);
8915 return Err(DecodeError::InvalidValue);
8919 let channel_manager = ChannelManager {
8921 fee_estimator: bounded_fee_estimator,
8922 chain_monitor: args.chain_monitor,
8923 tx_broadcaster: args.tx_broadcaster,
8924 router: args.router,
8926 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
8928 inbound_payment_key: expanded_inbound_key,
8929 pending_inbound_payments: Mutex::new(pending_inbound_payments),
8930 pending_outbound_payments: pending_outbounds,
8931 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
8933 forward_htlcs: Mutex::new(forward_htlcs),
8934 claimable_payments: Mutex::new(ClaimablePayments { claimable_payments, pending_claiming_payments: pending_claiming_payments.unwrap() }),
8935 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
8936 id_to_peer: Mutex::new(id_to_peer),
8937 short_to_chan_info: FairRwLock::new(short_to_chan_info),
8938 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
8940 probing_cookie_secret: probing_cookie_secret.unwrap(),
8945 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
8947 per_peer_state: FairRwLock::new(per_peer_state),
8949 pending_events: Mutex::new(pending_events_read),
8950 pending_events_processor: AtomicBool::new(false),
8951 pending_background_events: Mutex::new(pending_background_events),
8952 total_consistency_lock: RwLock::new(()),
8953 background_events_processed_since_startup: AtomicBool::new(false),
8954 persistence_notifier: Notifier::new(),
8956 entropy_source: args.entropy_source,
8957 node_signer: args.node_signer,
8958 signer_provider: args.signer_provider,
8960 logger: args.logger,
8961 default_configuration: args.default_config,
8964 for htlc_source in failed_htlcs.drain(..) {
8965 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
8966 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
8967 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
8968 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
8971 for (source, preimage, downstream_value, downstream_closed, downstream_chan_id) in pending_claims_to_replay {
8972 // We use `downstream_closed` in place of `from_onchain` here just as a guess - we
8973 // don't remember in the `ChannelMonitor` where we got a preimage from, but if the
8974 // channel is closed we just assume that it probably came from an on-chain claim.
8975 channel_manager.claim_funds_internal(source, preimage, Some(downstream_value),
8976 downstream_closed, downstream_chan_id);
8979 //TODO: Broadcast channel update for closed channels, but only after we've made a
8980 //connection or two.
8982 Ok((best_block_hash.clone(), channel_manager))
8988 use bitcoin::hashes::Hash;
8989 use bitcoin::hashes::sha256::Hash as Sha256;
8990 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
8991 use core::sync::atomic::Ordering;
8992 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
8993 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
8994 use crate::ln::channelmanager::{inbound_payment, PaymentId, PaymentSendFailure, RecipientOnionFields, InterceptId};
8995 use crate::ln::functional_test_utils::*;
8996 use crate::ln::msgs::{self, ErrorAction};
8997 use crate::ln::msgs::ChannelMessageHandler;
8998 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
8999 use crate::util::errors::APIError;
9000 use crate::util::test_utils;
9001 use crate::util::config::{ChannelConfig, ChannelConfigUpdate};
9002 use crate::sign::EntropySource;
9005 fn test_notify_limits() {
9006 // Check that a few cases which don't require the persistence of a new ChannelManager,
9007 // indeed, do not cause the persistence of a new ChannelManager.
9008 let chanmon_cfgs = create_chanmon_cfgs(3);
9009 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9010 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9011 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9013 // All nodes start with a persistable update pending as `create_network` connects each node
9014 // with all other nodes to make most tests simpler.
9015 assert!(nodes[0].node.get_persistable_update_future().poll_is_complete());
9016 assert!(nodes[1].node.get_persistable_update_future().poll_is_complete());
9017 assert!(nodes[2].node.get_persistable_update_future().poll_is_complete());
9019 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1);
9021 // We check that the channel info nodes have doesn't change too early, even though we try
9022 // to connect messages with new values
9023 chan.0.contents.fee_base_msat *= 2;
9024 chan.1.contents.fee_base_msat *= 2;
9025 let node_a_chan_info = nodes[0].node.list_channels_with_counterparty(
9026 &nodes[1].node.get_our_node_id()).pop().unwrap();
9027 let node_b_chan_info = nodes[1].node.list_channels_with_counterparty(
9028 &nodes[0].node.get_our_node_id()).pop().unwrap();
9030 // The first two nodes (which opened a channel) should now require fresh persistence
9031 assert!(nodes[0].node.get_persistable_update_future().poll_is_complete());
9032 assert!(nodes[1].node.get_persistable_update_future().poll_is_complete());
9033 // ... but the last node should not.
9034 assert!(!nodes[2].node.get_persistable_update_future().poll_is_complete());
9035 // After persisting the first two nodes they should no longer need fresh persistence.
9036 assert!(!nodes[0].node.get_persistable_update_future().poll_is_complete());
9037 assert!(!nodes[1].node.get_persistable_update_future().poll_is_complete());
9039 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
9040 // about the channel.
9041 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
9042 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
9043 assert!(!nodes[2].node.get_persistable_update_future().poll_is_complete());
9045 // The nodes which are a party to the channel should also ignore messages from unrelated
9047 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
9048 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
9049 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
9050 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
9051 assert!(!nodes[0].node.get_persistable_update_future().poll_is_complete());
9052 assert!(!nodes[1].node.get_persistable_update_future().poll_is_complete());
9054 // At this point the channel info given by peers should still be the same.
9055 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
9056 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
9058 // An earlier version of handle_channel_update didn't check the directionality of the
9059 // update message and would always update the local fee info, even if our peer was
9060 // (spuriously) forwarding us our own channel_update.
9061 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
9062 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
9063 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
9065 // First deliver each peers' own message, checking that the node doesn't need to be
9066 // persisted and that its channel info remains the same.
9067 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
9068 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
9069 assert!(!nodes[0].node.get_persistable_update_future().poll_is_complete());
9070 assert!(!nodes[1].node.get_persistable_update_future().poll_is_complete());
9071 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
9072 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
9074 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
9075 // the channel info has updated.
9076 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
9077 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
9078 assert!(nodes[0].node.get_persistable_update_future().poll_is_complete());
9079 assert!(nodes[1].node.get_persistable_update_future().poll_is_complete());
9080 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
9081 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
9085 fn test_keysend_dup_hash_partial_mpp() {
9086 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
9088 let chanmon_cfgs = create_chanmon_cfgs(2);
9089 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9090 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9091 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9092 create_announced_chan_between_nodes(&nodes, 0, 1);
9094 // First, send a partial MPP payment.
9095 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
9096 let mut mpp_route = route.clone();
9097 mpp_route.paths.push(mpp_route.paths[0].clone());
9099 let payment_id = PaymentId([42; 32]);
9100 // Use the utility function send_payment_along_path to send the payment with MPP data which
9101 // indicates there are more HTLCs coming.
9102 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.
9103 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
9104 RecipientOnionFields::secret_only(payment_secret), payment_id, &mpp_route).unwrap();
9105 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[0], &our_payment_hash,
9106 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
9107 check_added_monitors!(nodes[0], 1);
9108 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9109 assert_eq!(events.len(), 1);
9110 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
9112 // Next, send a keysend payment with the same payment_hash and make sure it fails.
9113 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9114 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9115 check_added_monitors!(nodes[0], 1);
9116 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9117 assert_eq!(events.len(), 1);
9118 let ev = events.drain(..).next().unwrap();
9119 let payment_event = SendEvent::from_event(ev);
9120 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9121 check_added_monitors!(nodes[1], 0);
9122 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9123 expect_pending_htlcs_forwardable!(nodes[1]);
9124 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
9125 check_added_monitors!(nodes[1], 1);
9126 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9127 assert!(updates.update_add_htlcs.is_empty());
9128 assert!(updates.update_fulfill_htlcs.is_empty());
9129 assert_eq!(updates.update_fail_htlcs.len(), 1);
9130 assert!(updates.update_fail_malformed_htlcs.is_empty());
9131 assert!(updates.update_fee.is_none());
9132 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9133 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9134 expect_payment_failed!(nodes[0], our_payment_hash, true);
9136 // Send the second half of the original MPP payment.
9137 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[1], &our_payment_hash,
9138 RecipientOnionFields::secret_only(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
9139 check_added_monitors!(nodes[0], 1);
9140 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9141 assert_eq!(events.len(), 1);
9142 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
9144 // Claim the full MPP payment. Note that we can't use a test utility like
9145 // claim_funds_along_route because the ordering of the messages causes the second half of the
9146 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
9147 // lightning messages manually.
9148 nodes[1].node.claim_funds(payment_preimage);
9149 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
9150 check_added_monitors!(nodes[1], 2);
9152 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9153 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
9154 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
9155 check_added_monitors!(nodes[0], 1);
9156 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9157 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
9158 check_added_monitors!(nodes[1], 1);
9159 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9160 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
9161 check_added_monitors!(nodes[1], 1);
9162 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
9163 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
9164 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
9165 check_added_monitors!(nodes[0], 1);
9166 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
9167 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
9168 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9169 check_added_monitors!(nodes[0], 1);
9170 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
9171 check_added_monitors!(nodes[1], 1);
9172 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
9173 check_added_monitors!(nodes[1], 1);
9174 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
9175 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
9176 check_added_monitors!(nodes[0], 1);
9178 // Note that successful MPP payments will generate a single PaymentSent event upon the first
9179 // path's success and a PaymentPathSuccessful event for each path's success.
9180 let events = nodes[0].node.get_and_clear_pending_events();
9181 assert_eq!(events.len(), 3);
9183 Event::PaymentSent { payment_id: ref id, payment_preimage: ref preimage, payment_hash: ref hash, .. } => {
9184 assert_eq!(Some(payment_id), *id);
9185 assert_eq!(payment_preimage, *preimage);
9186 assert_eq!(our_payment_hash, *hash);
9188 _ => panic!("Unexpected event"),
9191 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
9192 assert_eq!(payment_id, *actual_payment_id);
9193 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
9194 assert_eq!(route.paths[0], *path);
9196 _ => panic!("Unexpected event"),
9199 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
9200 assert_eq!(payment_id, *actual_payment_id);
9201 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
9202 assert_eq!(route.paths[0], *path);
9204 _ => panic!("Unexpected event"),
9209 fn test_keysend_dup_payment_hash() {
9210 do_test_keysend_dup_payment_hash(false);
9211 do_test_keysend_dup_payment_hash(true);
9214 fn do_test_keysend_dup_payment_hash(accept_mpp_keysend: bool) {
9215 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
9216 // outbound regular payment fails as expected.
9217 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
9218 // fails as expected.
9219 // (3): Test that a keysend payment with a duplicate payment hash to an existing keysend
9220 // payment fails as expected. When `accept_mpp_keysend` is false, this tests that we
9221 // reject MPP keysend payments, since in this case where the payment has no payment
9222 // secret, a keysend payment with a duplicate hash is basically an MPP keysend. If
9223 // `accept_mpp_keysend` is true, this tests that we only accept MPP keysends with
9224 // payment secrets and reject otherwise.
9225 let chanmon_cfgs = create_chanmon_cfgs(2);
9226 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9227 let mut mpp_keysend_cfg = test_default_channel_config();
9228 mpp_keysend_cfg.accept_mpp_keysend = accept_mpp_keysend;
9229 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(mpp_keysend_cfg)]);
9230 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9231 create_announced_chan_between_nodes(&nodes, 0, 1);
9232 let scorer = test_utils::TestScorer::new();
9233 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9235 // To start (1), send a regular payment but don't claim it.
9236 let expected_route = [&nodes[1]];
9237 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
9239 // Next, attempt a keysend payment and make sure it fails.
9240 let route_params = RouteParameters {
9241 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
9242 final_value_msat: 100_000,
9244 let route = find_route(
9245 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
9246 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
9248 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9249 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9250 check_added_monitors!(nodes[0], 1);
9251 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9252 assert_eq!(events.len(), 1);
9253 let ev = events.drain(..).next().unwrap();
9254 let payment_event = SendEvent::from_event(ev);
9255 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9256 check_added_monitors!(nodes[1], 0);
9257 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9258 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
9259 // fails), the second will process the resulting failure and fail the HTLC backward
9260 expect_pending_htlcs_forwardable!(nodes[1]);
9261 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9262 check_added_monitors!(nodes[1], 1);
9263 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9264 assert!(updates.update_add_htlcs.is_empty());
9265 assert!(updates.update_fulfill_htlcs.is_empty());
9266 assert_eq!(updates.update_fail_htlcs.len(), 1);
9267 assert!(updates.update_fail_malformed_htlcs.is_empty());
9268 assert!(updates.update_fee.is_none());
9269 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9270 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9271 expect_payment_failed!(nodes[0], payment_hash, true);
9273 // Finally, claim the original payment.
9274 claim_payment(&nodes[0], &expected_route, payment_preimage);
9276 // To start (2), send a keysend payment but don't claim it.
9277 let payment_preimage = PaymentPreimage([42; 32]);
9278 let route = find_route(
9279 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
9280 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
9282 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9283 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_preimage.0)).unwrap();
9284 check_added_monitors!(nodes[0], 1);
9285 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9286 assert_eq!(events.len(), 1);
9287 let event = events.pop().unwrap();
9288 let path = vec![&nodes[1]];
9289 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
9291 // Next, attempt a regular payment and make sure it fails.
9292 let payment_secret = PaymentSecret([43; 32]);
9293 nodes[0].node.send_payment_with_route(&route, payment_hash,
9294 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
9295 check_added_monitors!(nodes[0], 1);
9296 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9297 assert_eq!(events.len(), 1);
9298 let ev = events.drain(..).next().unwrap();
9299 let payment_event = SendEvent::from_event(ev);
9300 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9301 check_added_monitors!(nodes[1], 0);
9302 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9303 expect_pending_htlcs_forwardable!(nodes[1]);
9304 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9305 check_added_monitors!(nodes[1], 1);
9306 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9307 assert!(updates.update_add_htlcs.is_empty());
9308 assert!(updates.update_fulfill_htlcs.is_empty());
9309 assert_eq!(updates.update_fail_htlcs.len(), 1);
9310 assert!(updates.update_fail_malformed_htlcs.is_empty());
9311 assert!(updates.update_fee.is_none());
9312 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9313 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9314 expect_payment_failed!(nodes[0], payment_hash, true);
9316 // Finally, succeed the keysend payment.
9317 claim_payment(&nodes[0], &expected_route, payment_preimage);
9319 // To start (3), send a keysend payment but don't claim it.
9320 let payment_id_1 = PaymentId([44; 32]);
9321 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9322 RecipientOnionFields::spontaneous_empty(), payment_id_1).unwrap();
9323 check_added_monitors!(nodes[0], 1);
9324 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9325 assert_eq!(events.len(), 1);
9326 let event = events.pop().unwrap();
9327 let path = vec![&nodes[1]];
9328 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
9330 // Next, attempt a keysend payment and make sure it fails.
9331 let route_params = RouteParameters {
9332 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV, false),
9333 final_value_msat: 100_000,
9335 let route = find_route(
9336 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
9337 None, nodes[0].logger, &scorer, &(), &random_seed_bytes
9339 let payment_id_2 = PaymentId([45; 32]);
9340 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
9341 RecipientOnionFields::spontaneous_empty(), payment_id_2).unwrap();
9342 check_added_monitors!(nodes[0], 1);
9343 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9344 assert_eq!(events.len(), 1);
9345 let ev = events.drain(..).next().unwrap();
9346 let payment_event = SendEvent::from_event(ev);
9347 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9348 check_added_monitors!(nodes[1], 0);
9349 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9350 expect_pending_htlcs_forwardable!(nodes[1]);
9351 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
9352 check_added_monitors!(nodes[1], 1);
9353 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9354 assert!(updates.update_add_htlcs.is_empty());
9355 assert!(updates.update_fulfill_htlcs.is_empty());
9356 assert_eq!(updates.update_fail_htlcs.len(), 1);
9357 assert!(updates.update_fail_malformed_htlcs.is_empty());
9358 assert!(updates.update_fee.is_none());
9359 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9360 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9361 expect_payment_failed!(nodes[0], payment_hash, true);
9363 // Finally, claim the original payment.
9364 claim_payment(&nodes[0], &expected_route, payment_preimage);
9368 fn test_keysend_hash_mismatch() {
9369 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
9370 // preimage doesn't match the msg's payment hash.
9371 let chanmon_cfgs = create_chanmon_cfgs(2);
9372 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9373 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9374 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9376 let payer_pubkey = nodes[0].node.get_our_node_id();
9377 let payee_pubkey = nodes[1].node.get_our_node_id();
9379 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
9380 let route_params = RouteParameters {
9381 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
9382 final_value_msat: 10_000,
9384 let network_graph = nodes[0].network_graph.clone();
9385 let first_hops = nodes[0].node.list_usable_channels();
9386 let scorer = test_utils::TestScorer::new();
9387 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9388 let route = find_route(
9389 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
9390 nodes[0].logger, &scorer, &(), &random_seed_bytes
9393 let test_preimage = PaymentPreimage([42; 32]);
9394 let mismatch_payment_hash = PaymentHash([43; 32]);
9395 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash,
9396 RecipientOnionFields::spontaneous_empty(), PaymentId(mismatch_payment_hash.0), &route).unwrap();
9397 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash,
9398 RecipientOnionFields::spontaneous_empty(), Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
9399 check_added_monitors!(nodes[0], 1);
9401 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9402 assert_eq!(updates.update_add_htlcs.len(), 1);
9403 assert!(updates.update_fulfill_htlcs.is_empty());
9404 assert!(updates.update_fail_htlcs.is_empty());
9405 assert!(updates.update_fail_malformed_htlcs.is_empty());
9406 assert!(updates.update_fee.is_none());
9407 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
9409 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "Payment preimage didn't match payment hash", 1);
9413 fn test_keysend_msg_with_secret_err() {
9414 // Test that we error as expected if we receive a keysend payment that includes a payment
9415 // secret when we don't support MPP keysend.
9416 let mut reject_mpp_keysend_cfg = test_default_channel_config();
9417 reject_mpp_keysend_cfg.accept_mpp_keysend = false;
9418 let chanmon_cfgs = create_chanmon_cfgs(2);
9419 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9420 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(reject_mpp_keysend_cfg)]);
9421 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9423 let payer_pubkey = nodes[0].node.get_our_node_id();
9424 let payee_pubkey = nodes[1].node.get_our_node_id();
9426 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
9427 let route_params = RouteParameters {
9428 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40, false),
9429 final_value_msat: 10_000,
9431 let network_graph = nodes[0].network_graph.clone();
9432 let first_hops = nodes[0].node.list_usable_channels();
9433 let scorer = test_utils::TestScorer::new();
9434 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9435 let route = find_route(
9436 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
9437 nodes[0].logger, &scorer, &(), &random_seed_bytes
9440 let test_preimage = PaymentPreimage([42; 32]);
9441 let test_secret = PaymentSecret([43; 32]);
9442 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
9443 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash,
9444 RecipientOnionFields::secret_only(test_secret), PaymentId(payment_hash.0), &route).unwrap();
9445 nodes[0].node.test_send_payment_internal(&route, payment_hash,
9446 RecipientOnionFields::secret_only(test_secret), Some(test_preimage),
9447 PaymentId(payment_hash.0), None, session_privs).unwrap();
9448 check_added_monitors!(nodes[0], 1);
9450 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
9451 assert_eq!(updates.update_add_htlcs.len(), 1);
9452 assert!(updates.update_fulfill_htlcs.is_empty());
9453 assert!(updates.update_fail_htlcs.is_empty());
9454 assert!(updates.update_fail_malformed_htlcs.is_empty());
9455 assert!(updates.update_fee.is_none());
9456 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
9458 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager", "We don't support MPP keysend payments", 1);
9462 fn test_multi_hop_missing_secret() {
9463 let chanmon_cfgs = create_chanmon_cfgs(4);
9464 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
9465 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
9466 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
9468 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
9469 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
9470 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
9471 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
9473 // Marshall an MPP route.
9474 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
9475 let path = route.paths[0].clone();
9476 route.paths.push(path);
9477 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
9478 route.paths[0].hops[0].short_channel_id = chan_1_id;
9479 route.paths[0].hops[1].short_channel_id = chan_3_id;
9480 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
9481 route.paths[1].hops[0].short_channel_id = chan_2_id;
9482 route.paths[1].hops[1].short_channel_id = chan_4_id;
9484 match nodes[0].node.send_payment_with_route(&route, payment_hash,
9485 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0))
9487 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
9488 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err))
9490 _ => panic!("unexpected error")
9495 fn test_drop_disconnected_peers_when_removing_channels() {
9496 let chanmon_cfgs = create_chanmon_cfgs(2);
9497 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9498 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9499 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9501 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
9503 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
9504 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
9506 nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
9507 check_closed_broadcast!(nodes[0], true);
9508 check_added_monitors!(nodes[0], 1);
9509 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
9512 // Assert that nodes[1] is awaiting removal for nodes[0] once nodes[1] has been
9513 // disconnected and the channel between has been force closed.
9514 let nodes_0_per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
9515 // Assert that nodes[1] isn't removed before `timer_tick_occurred` has been executed.
9516 assert_eq!(nodes_0_per_peer_state.len(), 1);
9517 assert!(nodes_0_per_peer_state.get(&nodes[1].node.get_our_node_id()).is_some());
9520 nodes[0].node.timer_tick_occurred();
9523 // Assert that nodes[1] has now been removed.
9524 assert_eq!(nodes[0].node.per_peer_state.read().unwrap().len(), 0);
9529 fn bad_inbound_payment_hash() {
9530 // Add coverage for checking that a user-provided payment hash matches the payment secret.
9531 let chanmon_cfgs = create_chanmon_cfgs(2);
9532 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9533 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9534 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9536 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
9537 let payment_data = msgs::FinalOnionHopData {
9539 total_msat: 100_000,
9542 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
9543 // payment verification fails as expected.
9544 let mut bad_payment_hash = payment_hash.clone();
9545 bad_payment_hash.0[0] += 1;
9546 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) {
9547 Ok(_) => panic!("Unexpected ok"),
9549 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment", "Failing HTLC with user-generated payment_hash", 1);
9553 // Check that using the original payment hash succeeds.
9554 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());
9558 fn test_id_to_peer_coverage() {
9559 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
9560 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
9561 // the channel is successfully closed.
9562 let chanmon_cfgs = create_chanmon_cfgs(2);
9563 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9564 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9565 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9567 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
9568 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9569 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
9570 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9571 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
9573 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
9574 let channel_id = &tx.txid().into_inner();
9576 // Ensure that the `id_to_peer` map is empty until either party has received the
9577 // funding transaction, and have the real `channel_id`.
9578 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
9579 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
9582 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
9584 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
9585 // as it has the funding transaction.
9586 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
9587 assert_eq!(nodes_0_lock.len(), 1);
9588 assert!(nodes_0_lock.contains_key(channel_id));
9591 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
9593 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9595 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9597 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
9598 assert_eq!(nodes_0_lock.len(), 1);
9599 assert!(nodes_0_lock.contains_key(channel_id));
9601 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
9604 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
9605 // as it has the funding transaction.
9606 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
9607 assert_eq!(nodes_1_lock.len(), 1);
9608 assert!(nodes_1_lock.contains_key(channel_id));
9610 check_added_monitors!(nodes[1], 1);
9611 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9612 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
9613 check_added_monitors!(nodes[0], 1);
9614 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
9615 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9616 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
9617 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
9619 nodes[0].node.close_channel(channel_id, &nodes[1].node.get_our_node_id()).unwrap();
9620 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()));
9621 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
9622 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &nodes_1_shutdown);
9624 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
9625 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
9627 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
9628 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
9629 // fee for the closing transaction has been negotiated and the parties has the other
9630 // party's signature for the fee negotiated closing transaction.)
9631 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
9632 assert_eq!(nodes_0_lock.len(), 1);
9633 assert!(nodes_0_lock.contains_key(channel_id));
9637 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
9638 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
9639 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
9640 // kept in the `nodes[1]`'s `id_to_peer` map.
9641 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
9642 assert_eq!(nodes_1_lock.len(), 1);
9643 assert!(nodes_1_lock.contains_key(channel_id));
9646 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()));
9648 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
9649 // therefore has all it needs to fully close the channel (both signatures for the
9650 // closing transaction).
9651 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
9652 // fully closed by `nodes[0]`.
9653 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
9655 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
9656 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
9657 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
9658 assert_eq!(nodes_1_lock.len(), 1);
9659 assert!(nodes_1_lock.contains_key(channel_id));
9662 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
9664 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
9666 // Assert that the channel has now been removed from both parties `id_to_peer` map once
9667 // they both have everything required to fully close the channel.
9668 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
9670 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
9672 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
9673 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
9676 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
9677 let expected_message = format!("Not connected to node: {}", expected_public_key);
9678 check_api_error_message(expected_message, res_err)
9681 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
9682 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
9683 check_api_error_message(expected_message, res_err)
9686 fn check_api_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
9688 Err(APIError::APIMisuseError { err }) => {
9689 assert_eq!(err, expected_err_message);
9691 Err(APIError::ChannelUnavailable { err }) => {
9692 assert_eq!(err, expected_err_message);
9694 Ok(_) => panic!("Unexpected Ok"),
9695 Err(_) => panic!("Unexpected Error"),
9700 fn test_api_calls_with_unkown_counterparty_node() {
9701 // Tests that our API functions that expects a `counterparty_node_id` as input, behaves as
9702 // expected if the `counterparty_node_id` is an unkown peer in the
9703 // `ChannelManager::per_peer_state` map.
9704 let chanmon_cfg = create_chanmon_cfgs(2);
9705 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
9706 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
9707 let nodes = create_network(2, &node_cfg, &node_chanmgr);
9710 let channel_id = [4; 32];
9711 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
9712 let intercept_id = InterceptId([0; 32]);
9714 // Test the API functions.
9715 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);
9717 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&channel_id, &unkown_public_key, 42), unkown_public_key);
9719 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
9721 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
9723 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
9725 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
9727 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
9731 fn test_connection_limiting() {
9732 // Test that we limit un-channel'd peers and un-funded channels properly.
9733 let chanmon_cfgs = create_chanmon_cfgs(2);
9734 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9735 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9736 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9738 // Note that create_network connects the nodes together for us
9740 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
9741 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9743 let mut funding_tx = None;
9744 for idx in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
9745 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
9746 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9749 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
9750 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
9751 funding_tx = Some(tx.clone());
9752 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx).unwrap();
9753 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9755 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9756 check_added_monitors!(nodes[1], 1);
9757 expect_channel_pending_event(&nodes[1], &nodes[0].node.get_our_node_id());
9759 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9761 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
9762 check_added_monitors!(nodes[0], 1);
9763 expect_channel_pending_event(&nodes[0], &nodes[1].node.get_our_node_id());
9765 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
9768 // A MAX_UNFUNDED_CHANS_PER_PEER + 1 channel will be summarily rejected
9769 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
9770 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
9771 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
9772 open_channel_msg.temporary_channel_id);
9774 // Further, because all of our channels with nodes[0] are inbound, and none of them funded,
9775 // it doesn't count as a "protected" peer, i.e. it counts towards the MAX_NO_CHANNEL_PEERS
9777 let mut peer_pks = Vec::with_capacity(super::MAX_NO_CHANNEL_PEERS);
9778 for _ in 1..super::MAX_NO_CHANNEL_PEERS {
9779 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
9780 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
9781 peer_pks.push(random_pk);
9782 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
9783 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
9786 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
9787 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
9788 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
9789 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
9790 }, true).unwrap_err();
9792 // Also importantly, because nodes[0] isn't "protected", we will refuse a reconnection from
9793 // them if we have too many un-channel'd peers.
9794 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
9795 let chan_closed_events = nodes[1].node.get_and_clear_pending_events();
9796 assert_eq!(chan_closed_events.len(), super::MAX_UNFUNDED_CHANS_PER_PEER - 1);
9797 for ev in chan_closed_events {
9798 if let Event::ChannelClosed { .. } = ev { } else { panic!(); }
9800 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
9801 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
9803 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
9804 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
9805 }, true).unwrap_err();
9807 // but of course if the connection is outbound its allowed...
9808 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
9809 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
9811 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
9813 // Now nodes[0] is disconnected but still has a pending, un-funded channel lying around.
9814 // Even though we accept one more connection from new peers, we won't actually let them
9816 assert!(peer_pks.len() > super::MAX_UNFUNDED_CHANNEL_PEERS - 1);
9817 for i in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
9818 nodes[1].node.handle_open_channel(&peer_pks[i], &open_channel_msg);
9819 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, peer_pks[i]);
9820 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
9822 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
9823 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
9824 open_channel_msg.temporary_channel_id);
9826 // Of course, however, outbound channels are always allowed
9827 nodes[1].node.create_channel(last_random_pk, 100_000, 0, 42, None).unwrap();
9828 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, last_random_pk);
9830 // If we fund the first channel, nodes[0] has a live on-chain channel with us, it is now
9831 // "protected" and can connect again.
9832 mine_transaction(&nodes[1], funding_tx.as_ref().unwrap());
9833 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
9834 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
9836 get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
9838 // Further, because the first channel was funded, we can open another channel with
9840 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
9841 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
9845 fn test_outbound_chans_unlimited() {
9846 // Test that we never refuse an outbound channel even if a peer is unfuned-channel-limited
9847 let chanmon_cfgs = create_chanmon_cfgs(2);
9848 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9849 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9850 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9852 // Note that create_network connects the nodes together for us
9854 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
9855 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9857 for _ in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
9858 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
9859 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9860 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
9863 // Once we have MAX_UNFUNDED_CHANS_PER_PEER unfunded channels, new inbound channels will be
9865 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
9866 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
9867 open_channel_msg.temporary_channel_id);
9869 // but we can still open an outbound channel.
9870 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
9871 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
9873 // but even with such an outbound channel, additional inbound channels will still fail.
9874 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
9875 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
9876 open_channel_msg.temporary_channel_id);
9880 fn test_0conf_limiting() {
9881 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
9882 // flag set and (sometimes) accept channels as 0conf.
9883 let chanmon_cfgs = create_chanmon_cfgs(2);
9884 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9885 let mut settings = test_default_channel_config();
9886 settings.manually_accept_inbound_channels = true;
9887 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(settings)]);
9888 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9890 // Note that create_network connects the nodes together for us
9892 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
9893 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9895 // First, get us up to MAX_UNFUNDED_CHANNEL_PEERS so we can test at the edge
9896 for _ in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
9897 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
9898 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
9899 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
9900 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
9903 nodes[1].node.handle_open_channel(&random_pk, &open_channel_msg);
9904 let events = nodes[1].node.get_and_clear_pending_events();
9906 Event::OpenChannelRequest { temporary_channel_id, .. } => {
9907 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23).unwrap();
9909 _ => panic!("Unexpected event"),
9911 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, random_pk);
9912 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
9915 // If we try to accept a channel from another peer non-0conf it will fail.
9916 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
9917 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
9918 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
9919 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
9921 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
9922 let events = nodes[1].node.get_and_clear_pending_events();
9924 Event::OpenChannelRequest { temporary_channel_id, .. } => {
9925 match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23) {
9926 Err(APIError::APIMisuseError { err }) =>
9927 assert_eq!(err, "Too many peers with unfunded channels, refusing to accept new ones"),
9931 _ => panic!("Unexpected event"),
9933 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
9934 open_channel_msg.temporary_channel_id);
9936 // ...however if we accept the same channel 0conf it should work just fine.
9937 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
9938 let events = nodes[1].node.get_and_clear_pending_events();
9940 Event::OpenChannelRequest { temporary_channel_id, .. } => {
9941 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23).unwrap();
9943 _ => panic!("Unexpected event"),
9945 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
9949 fn reject_excessively_underpaying_htlcs() {
9950 let chanmon_cfg = create_chanmon_cfgs(1);
9951 let node_cfg = create_node_cfgs(1, &chanmon_cfg);
9952 let node_chanmgr = create_node_chanmgrs(1, &node_cfg, &[None]);
9953 let node = create_network(1, &node_cfg, &node_chanmgr);
9954 let sender_intended_amt_msat = 100;
9955 let extra_fee_msat = 10;
9956 let hop_data = msgs::OnionHopData {
9957 amt_to_forward: 100,
9958 outgoing_cltv_value: 42,
9959 format: msgs::OnionHopDataFormat::FinalNode {
9960 keysend_preimage: None,
9961 payment_metadata: None,
9962 payment_data: Some(msgs::FinalOnionHopData {
9963 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
9967 // Check that if the amount we received + the penultimate hop extra fee is less than the sender
9968 // intended amount, we fail the payment.
9969 if let Err(crate::ln::channelmanager::ReceiveError { err_code, .. }) =
9970 node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
9971 sender_intended_amt_msat - extra_fee_msat - 1, 42, None, true, Some(extra_fee_msat))
9973 assert_eq!(err_code, 19);
9974 } else { panic!(); }
9976 // If amt_received + extra_fee is equal to the sender intended amount, we're fine.
9977 let hop_data = msgs::OnionHopData { // This is the same hop_data as above, OnionHopData doesn't implement Clone
9978 amt_to_forward: 100,
9979 outgoing_cltv_value: 42,
9980 format: msgs::OnionHopDataFormat::FinalNode {
9981 keysend_preimage: None,
9982 payment_metadata: None,
9983 payment_data: Some(msgs::FinalOnionHopData {
9984 payment_secret: PaymentSecret([0; 32]), total_msat: sender_intended_amt_msat,
9988 assert!(node[0].node.construct_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
9989 sender_intended_amt_msat - extra_fee_msat, 42, None, true, Some(extra_fee_msat)).is_ok());
9993 fn test_inbound_anchors_manual_acceptance() {
9994 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
9995 // flag set and (sometimes) accept channels as 0conf.
9996 let mut anchors_cfg = test_default_channel_config();
9997 anchors_cfg.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
9999 let mut anchors_manual_accept_cfg = anchors_cfg.clone();
10000 anchors_manual_accept_cfg.manually_accept_inbound_channels = true;
10002 let chanmon_cfgs = create_chanmon_cfgs(3);
10003 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
10004 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs,
10005 &[Some(anchors_cfg.clone()), Some(anchors_cfg.clone()), Some(anchors_manual_accept_cfg.clone())]);
10006 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
10008 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
10009 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10011 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10012 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
10013 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
10014 match &msg_events[0] {
10015 MessageSendEvent::HandleError { node_id, action } => {
10016 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
10018 ErrorAction::SendErrorMessage { msg } =>
10019 assert_eq!(msg.data, "No channels with anchor outputs accepted".to_owned()),
10020 _ => panic!("Unexpected error action"),
10023 _ => panic!("Unexpected event"),
10026 nodes[2].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10027 let events = nodes[2].node.get_and_clear_pending_events();
10029 Event::OpenChannelRequest { temporary_channel_id, .. } =>
10030 nodes[2].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap(),
10031 _ => panic!("Unexpected event"),
10033 get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
10037 fn test_anchors_zero_fee_htlc_tx_fallback() {
10038 // Tests that if both nodes support anchors, but the remote node does not want to accept
10039 // anchor channels at the moment, an error it sent to the local node such that it can retry
10040 // the channel without the anchors feature.
10041 let chanmon_cfgs = create_chanmon_cfgs(2);
10042 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
10043 let mut anchors_config = test_default_channel_config();
10044 anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
10045 anchors_config.manually_accept_inbound_channels = true;
10046 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config.clone()), Some(anchors_config.clone())]);
10047 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
10049 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 0, None).unwrap();
10050 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10051 assert!(open_channel_msg.channel_type.as_ref().unwrap().supports_anchors_zero_fee_htlc_tx());
10053 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
10054 let events = nodes[1].node.get_and_clear_pending_events();
10056 Event::OpenChannelRequest { temporary_channel_id, .. } => {
10057 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
10059 _ => panic!("Unexpected event"),
10062 let error_msg = get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id());
10063 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &error_msg);
10065 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
10066 assert!(!open_channel_msg.channel_type.unwrap().supports_anchors_zero_fee_htlc_tx());
10068 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
10072 fn test_update_channel_config() {
10073 let chanmon_cfg = create_chanmon_cfgs(2);
10074 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
10075 let mut user_config = test_default_channel_config();
10076 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[Some(user_config), Some(user_config)]);
10077 let nodes = create_network(2, &node_cfg, &node_chanmgr);
10078 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
10079 let channel = &nodes[0].node.list_channels()[0];
10081 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
10082 let events = nodes[0].node.get_and_clear_pending_msg_events();
10083 assert_eq!(events.len(), 0);
10085 user_config.channel_config.forwarding_fee_base_msat += 10;
10086 nodes[0].node.update_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &user_config.channel_config).unwrap();
10087 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_base_msat, user_config.channel_config.forwarding_fee_base_msat);
10088 let events = nodes[0].node.get_and_clear_pending_msg_events();
10089 assert_eq!(events.len(), 1);
10091 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10092 _ => panic!("expected BroadcastChannelUpdate event"),
10095 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate::default()).unwrap();
10096 let events = nodes[0].node.get_and_clear_pending_msg_events();
10097 assert_eq!(events.len(), 0);
10099 let new_cltv_expiry_delta = user_config.channel_config.cltv_expiry_delta + 6;
10100 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
10101 cltv_expiry_delta: Some(new_cltv_expiry_delta),
10102 ..Default::default()
10104 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
10105 let events = nodes[0].node.get_and_clear_pending_msg_events();
10106 assert_eq!(events.len(), 1);
10108 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10109 _ => panic!("expected BroadcastChannelUpdate event"),
10112 let new_fee = user_config.channel_config.forwarding_fee_proportional_millionths + 100;
10113 nodes[0].node.update_partial_channel_config(&channel.counterparty.node_id, &[channel.channel_id], &ChannelConfigUpdate {
10114 forwarding_fee_proportional_millionths: Some(new_fee),
10115 ..Default::default()
10117 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().cltv_expiry_delta, new_cltv_expiry_delta);
10118 assert_eq!(nodes[0].node.list_channels()[0].config.unwrap().forwarding_fee_proportional_millionths, new_fee);
10119 let events = nodes[0].node.get_and_clear_pending_msg_events();
10120 assert_eq!(events.len(), 1);
10122 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
10123 _ => panic!("expected BroadcastChannelUpdate event"),
10130 use crate::chain::Listen;
10131 use crate::chain::chainmonitor::{ChainMonitor, Persist};
10132 use crate::sign::{KeysManager, InMemorySigner};
10133 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider};
10134 use crate::ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId, RecipientOnionFields, Retry};
10135 use crate::ln::functional_test_utils::*;
10136 use crate::ln::msgs::{ChannelMessageHandler, Init};
10137 use crate::routing::gossip::NetworkGraph;
10138 use crate::routing::router::{PaymentParameters, RouteParameters};
10139 use crate::util::test_utils;
10140 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
10142 use bitcoin::hashes::Hash;
10143 use bitcoin::hashes::sha256::Hash as Sha256;
10144 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
10146 use crate::sync::{Arc, Mutex};
10148 use criterion::Criterion;
10150 type Manager<'a, P> = ChannelManager<
10151 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
10152 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
10153 &'a test_utils::TestLogger, &'a P>,
10154 &'a test_utils::TestBroadcaster, &'a KeysManager, &'a KeysManager, &'a KeysManager,
10155 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
10156 &'a test_utils::TestLogger>;
10158 struct ANodeHolder<'a, P: Persist<InMemorySigner>> {
10159 node: &'a Manager<'a, P>,
10161 impl<'a, P: Persist<InMemorySigner>> NodeHolder for ANodeHolder<'a, P> {
10162 type CM = Manager<'a, P>;
10164 fn node(&self) -> &Manager<'a, P> { self.node }
10166 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { None }
10169 pub fn bench_sends(bench: &mut Criterion) {
10170 bench_two_sends(bench, "bench_sends", test_utils::TestPersister::new(), test_utils::TestPersister::new());
10173 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Criterion, bench_name: &str, persister_a: P, persister_b: P) {
10174 // Do a simple benchmark of sending a payment back and forth between two nodes.
10175 // Note that this is unrealistic as each payment send will require at least two fsync
10177 let network = bitcoin::Network::Testnet;
10178 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
10180 let tx_broadcaster = test_utils::TestBroadcaster::new(network);
10181 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
10182 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
10183 let scorer = Mutex::new(test_utils::TestScorer::new());
10184 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(network, &logger_a)), &scorer);
10186 let mut config: UserConfig = Default::default();
10187 config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
10188 config.channel_handshake_config.minimum_depth = 1;
10190 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
10191 let seed_a = [1u8; 32];
10192 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
10193 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 {
10195 best_block: BestBlock::from_network(network),
10196 }, genesis_block.header.time);
10197 let node_a_holder = ANodeHolder { node: &node_a };
10199 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
10200 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
10201 let seed_b = [2u8; 32];
10202 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
10203 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 {
10205 best_block: BestBlock::from_network(network),
10206 }, genesis_block.header.time);
10207 let node_b_holder = ANodeHolder { node: &node_b };
10209 node_a.peer_connected(&node_b.get_our_node_id(), &Init {
10210 features: node_b.init_features(), networks: None, remote_network_address: None
10212 node_b.peer_connected(&node_a.get_our_node_id(), &Init {
10213 features: node_a.init_features(), networks: None, remote_network_address: None
10214 }, false).unwrap();
10215 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
10216 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()));
10217 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()));
10220 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
10221 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
10222 value: 8_000_000, script_pubkey: output_script,
10224 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
10225 } else { panic!(); }
10227 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()));
10228 let events_b = node_b.get_and_clear_pending_events();
10229 assert_eq!(events_b.len(), 1);
10230 match events_b[0] {
10231 Event::ChannelPending{ ref counterparty_node_id, .. } => {
10232 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
10234 _ => panic!("Unexpected event"),
10237 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()));
10238 let events_a = node_a.get_and_clear_pending_events();
10239 assert_eq!(events_a.len(), 1);
10240 match events_a[0] {
10241 Event::ChannelPending{ ref counterparty_node_id, .. } => {
10242 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
10244 _ => panic!("Unexpected event"),
10247 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
10249 let block = create_dummy_block(BestBlock::from_network(network).block_hash(), 42, vec![tx]);
10250 Listen::block_connected(&node_a, &block, 1);
10251 Listen::block_connected(&node_b, &block, 1);
10253 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()));
10254 let msg_events = node_a.get_and_clear_pending_msg_events();
10255 assert_eq!(msg_events.len(), 2);
10256 match msg_events[0] {
10257 MessageSendEvent::SendChannelReady { ref msg, .. } => {
10258 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
10259 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
10263 match msg_events[1] {
10264 MessageSendEvent::SendChannelUpdate { .. } => {},
10268 let events_a = node_a.get_and_clear_pending_events();
10269 assert_eq!(events_a.len(), 1);
10270 match events_a[0] {
10271 Event::ChannelReady{ ref counterparty_node_id, .. } => {
10272 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
10274 _ => panic!("Unexpected event"),
10277 let events_b = node_b.get_and_clear_pending_events();
10278 assert_eq!(events_b.len(), 1);
10279 match events_b[0] {
10280 Event::ChannelReady{ ref counterparty_node_id, .. } => {
10281 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
10283 _ => panic!("Unexpected event"),
10286 let mut payment_count: u64 = 0;
10287 macro_rules! send_payment {
10288 ($node_a: expr, $node_b: expr) => {
10289 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id(), TEST_FINAL_CLTV)
10290 .with_bolt11_features($node_b.invoice_features()).unwrap();
10291 let mut payment_preimage = PaymentPreimage([0; 32]);
10292 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
10293 payment_count += 1;
10294 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
10295 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
10297 $node_a.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
10298 PaymentId(payment_hash.0), RouteParameters {
10299 payment_params, final_value_msat: 10_000,
10300 }, Retry::Attempts(0)).unwrap();
10301 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
10302 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
10303 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
10304 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_b }, &$node_a.get_our_node_id());
10305 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
10306 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
10307 $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()));
10309 expect_pending_htlcs_forwardable!(ANodeHolder { node: &$node_b });
10310 expect_payment_claimable!(ANodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
10311 $node_b.claim_funds(payment_preimage);
10312 expect_payment_claimed!(ANodeHolder { node: &$node_b }, payment_hash, 10_000);
10314 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
10315 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
10316 assert_eq!(node_id, $node_a.get_our_node_id());
10317 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
10318 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
10320 _ => panic!("Failed to generate claim event"),
10323 let (raa, cs) = get_revoke_commit_msgs(&ANodeHolder { node: &$node_a }, &$node_b.get_our_node_id());
10324 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
10325 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
10326 $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()));
10328 expect_payment_sent!(ANodeHolder { node: &$node_a }, payment_preimage);
10332 bench.bench_function(bench_name, |b| b.iter(|| {
10333 send_payment!(node_a, node_b);
10334 send_payment!(node_b, node_a);