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 [`find_route`] 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 //! [`find_route`]: crate::routing::router::find_route
22 use bitcoin::blockdata::block::BlockHeader;
23 use bitcoin::blockdata::transaction::Transaction;
24 use bitcoin::blockdata::constants::genesis_block;
25 use bitcoin::network::constants::Network;
27 use bitcoin::hashes::Hash;
28 use bitcoin::hashes::sha256::Hash as Sha256;
29 use bitcoin::hash_types::{BlockHash, Txid};
31 use bitcoin::secp256k1::{SecretKey,PublicKey};
32 use bitcoin::secp256k1::Secp256k1;
33 use bitcoin::{LockTime, secp256k1, Sequence};
36 use crate::chain::{Confirm, ChannelMonitorUpdateStatus, Watch, BestBlock};
37 use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator};
38 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};
39 use crate::chain::transaction::{OutPoint, TransactionData};
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, ChannelError, ChannelUpdateStatus, UpdateFulfillCommitFetch};
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::{DefaultRouter, InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, RoutePath, Router};
49 use crate::routing::scoring::ProbabilisticScorer;
51 use crate::ln::onion_utils;
52 use crate::ln::onion_utils::HTLCFailReason;
53 use crate::ln::msgs::{ChannelMessageHandler, DecodeError, LightningError, MAX_VALUE_MSAT};
55 use crate::ln::outbound_payment;
56 use crate::ln::outbound_payment::{OutboundPayments, PaymentAttempts, PendingOutboundPayment};
57 use crate::ln::wire::Encode;
58 use crate::chain::keysinterface::{EntropySource, KeysManager, NodeSigner, Recipient, SignerProvider, ChannelSigner};
59 use crate::util::config::{UserConfig, ChannelConfig};
60 use crate::util::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
61 use crate::util::events;
62 use crate::util::wakers::{Future, Notifier};
63 use crate::util::scid_utils::fake_scid;
64 use crate::util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
65 use crate::util::logger::{Level, Logger};
66 use crate::util::errors::APIError;
68 use alloc::collections::BTreeMap;
71 use crate::prelude::*;
73 use core::cell::RefCell;
75 use crate::sync::{Arc, Mutex, RwLock, RwLockReadGuard, FairRwLock, LockTestExt, LockHeldState};
76 use core::sync::atomic::{AtomicUsize, Ordering};
77 use core::time::Duration;
80 // Re-export this for use in the public API.
81 pub use crate::ln::outbound_payment::{PaymentSendFailure, Retry, RetryableSendFailure};
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 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
111 phantom_shared_secret: Option<[u8; 32]>,
114 payment_preimage: PaymentPreimage,
115 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
119 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
120 pub(super) struct PendingHTLCInfo {
121 pub(super) routing: PendingHTLCRouting,
122 pub(super) incoming_shared_secret: [u8; 32],
123 payment_hash: PaymentHash,
124 pub(super) incoming_amt_msat: Option<u64>, // Added in 0.0.113
125 pub(super) outgoing_amt_msat: u64,
126 pub(super) outgoing_cltv_value: u32,
129 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
130 pub(super) enum HTLCFailureMsg {
131 Relay(msgs::UpdateFailHTLC),
132 Malformed(msgs::UpdateFailMalformedHTLC),
135 /// Stores whether we can't forward an HTLC or relevant forwarding info
136 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
137 pub(super) enum PendingHTLCStatus {
138 Forward(PendingHTLCInfo),
139 Fail(HTLCFailureMsg),
142 pub(super) struct PendingAddHTLCInfo {
143 pub(super) forward_info: PendingHTLCInfo,
145 // These fields are produced in `forward_htlcs()` and consumed in
146 // `process_pending_htlc_forwards()` for constructing the
147 // `HTLCSource::PreviousHopData` for failed and forwarded
150 // Note that this may be an outbound SCID alias for the associated channel.
151 prev_short_channel_id: u64,
153 prev_funding_outpoint: OutPoint,
154 prev_user_channel_id: u128,
157 pub(super) enum HTLCForwardInfo {
158 AddHTLC(PendingAddHTLCInfo),
161 err_packet: msgs::OnionErrorPacket,
165 /// Tracks the inbound corresponding to an outbound HTLC
166 #[derive(Clone, Hash, PartialEq, Eq)]
167 pub(crate) struct HTLCPreviousHopData {
168 // Note that this may be an outbound SCID alias for the associated channel.
169 short_channel_id: u64,
171 incoming_packet_shared_secret: [u8; 32],
172 phantom_shared_secret: Option<[u8; 32]>,
174 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
175 // channel with a preimage provided by the forward channel.
180 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
182 /// This is only here for backwards-compatibility in serialization, in the future it can be
183 /// removed, breaking clients running 0.0.106 and earlier.
184 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
186 /// Contains the payer-provided preimage.
187 Spontaneous(PaymentPreimage),
190 /// HTLCs that are to us and can be failed/claimed by the user
191 struct ClaimableHTLC {
192 prev_hop: HTLCPreviousHopData,
194 /// The amount (in msats) of this MPP part
196 onion_payload: OnionPayload,
198 /// The sum total of all MPP parts
202 /// A payment identifier used to uniquely identify a payment to LDK.
203 /// (C-not exported) as we just use [u8; 32] directly
204 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
205 pub struct PaymentId(pub [u8; 32]);
207 impl Writeable for PaymentId {
208 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
213 impl Readable for PaymentId {
214 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
215 let buf: [u8; 32] = Readable::read(r)?;
220 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
221 /// (C-not exported) as we just use [u8; 32] directly
222 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
223 pub struct InterceptId(pub [u8; 32]);
225 impl Writeable for InterceptId {
226 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
231 impl Readable for InterceptId {
232 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
233 let buf: [u8; 32] = Readable::read(r)?;
237 /// Tracks the inbound corresponding to an outbound HTLC
238 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
239 #[derive(Clone, PartialEq, Eq)]
240 pub(crate) enum HTLCSource {
241 PreviousHopData(HTLCPreviousHopData),
244 session_priv: SecretKey,
245 /// Technically we can recalculate this from the route, but we cache it here to avoid
246 /// doing a double-pass on route when we get a failure back
247 first_hop_htlc_msat: u64,
248 payment_id: PaymentId,
249 payment_secret: Option<PaymentSecret>,
250 /// Note that this is now "deprecated" - we write it for forwards (and read it for
251 /// backwards) compatibility reasons, but prefer to use the data in the
252 /// [`super::outbound_payment`] module, which stores per-payment data once instead of in
254 payment_params: Option<PaymentParameters>,
257 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
258 impl core::hash::Hash for HTLCSource {
259 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
261 HTLCSource::PreviousHopData(prev_hop_data) => {
263 prev_hop_data.hash(hasher);
265 HTLCSource::OutboundRoute { path, session_priv, payment_id, payment_secret, first_hop_htlc_msat, payment_params } => {
268 session_priv[..].hash(hasher);
269 payment_id.hash(hasher);
270 payment_secret.hash(hasher);
271 first_hop_htlc_msat.hash(hasher);
272 payment_params.hash(hasher);
277 #[cfg(not(feature = "grind_signatures"))]
280 pub fn dummy() -> Self {
281 HTLCSource::OutboundRoute {
283 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
284 first_hop_htlc_msat: 0,
285 payment_id: PaymentId([2; 32]),
286 payment_secret: None,
287 payment_params: None,
292 struct ReceiveError {
298 /// This enum is used to specify which error data to send to peers when failing back an HTLC
299 /// using [`ChannelManager::fail_htlc_backwards_with_reason`].
301 /// For more info on failure codes, see <https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages>.
302 #[derive(Clone, Copy)]
303 pub enum FailureCode {
304 /// We had a temporary error processing the payment. Useful if no other error codes fit
305 /// and you want to indicate that the payer may want to retry.
306 TemporaryNodeFailure = 0x2000 | 2,
307 /// We have a required feature which was not in this onion. For example, you may require
308 /// some additional metadata that was not provided with this payment.
309 RequiredNodeFeatureMissing = 0x4000 | 0x2000 | 3,
310 /// You may wish to use this when a `payment_preimage` is unknown, or the CLTV expiry of
311 /// the HTLC is too close to the current block height for safe handling.
312 /// Using this failure code in [`ChannelManager::fail_htlc_backwards_with_reason`] is
313 /// equivalent to calling [`ChannelManager::fail_htlc_backwards`].
314 IncorrectOrUnknownPaymentDetails = 0x4000 | 15,
317 type ShutdownResult = (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash, PublicKey, [u8; 32])>);
319 /// Error type returned across the peer_state mutex boundary. When an Err is generated for a
320 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
321 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
322 /// peer_state lock. We then return the set of things that need to be done outside the lock in
323 /// this struct and call handle_error!() on it.
325 struct MsgHandleErrInternal {
326 err: msgs::LightningError,
327 chan_id: Option<([u8; 32], u128)>, // If Some a channel of ours has been closed
328 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
330 impl MsgHandleErrInternal {
332 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
334 err: LightningError {
336 action: msgs::ErrorAction::SendErrorMessage {
337 msg: msgs::ErrorMessage {
344 shutdown_finish: None,
348 fn from_no_close(err: msgs::LightningError) -> Self {
349 Self { err, chan_id: None, shutdown_finish: None }
352 fn from_finish_shutdown(err: String, channel_id: [u8; 32], user_channel_id: u128, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
354 err: LightningError {
356 action: msgs::ErrorAction::SendErrorMessage {
357 msg: msgs::ErrorMessage {
363 chan_id: Some((channel_id, user_channel_id)),
364 shutdown_finish: Some((shutdown_res, channel_update)),
368 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
371 ChannelError::Warn(msg) => LightningError {
373 action: msgs::ErrorAction::SendWarningMessage {
374 msg: msgs::WarningMessage {
378 log_level: Level::Warn,
381 ChannelError::Ignore(msg) => LightningError {
383 action: msgs::ErrorAction::IgnoreError,
385 ChannelError::Close(msg) => LightningError {
387 action: msgs::ErrorAction::SendErrorMessage {
388 msg: msgs::ErrorMessage {
396 shutdown_finish: None,
401 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
402 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
403 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
404 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
405 pub(super) const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
407 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
408 /// be sent in the order they appear in the return value, however sometimes the order needs to be
409 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
410 /// they were originally sent). In those cases, this enum is also returned.
411 #[derive(Clone, PartialEq)]
412 pub(super) enum RAACommitmentOrder {
413 /// Send the CommitmentUpdate messages first
415 /// Send the RevokeAndACK message first
419 /// Information about a payment which is currently being claimed.
420 struct ClaimingPayment {
422 payment_purpose: events::PaymentPurpose,
423 receiver_node_id: PublicKey,
425 impl_writeable_tlv_based!(ClaimingPayment, {
426 (0, amount_msat, required),
427 (2, payment_purpose, required),
428 (4, receiver_node_id, required),
431 /// Information about claimable or being-claimed payments
432 struct ClaimablePayments {
433 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
434 /// failed/claimed by the user.
436 /// Note that, no consistency guarantees are made about the channels given here actually
437 /// existing anymore by the time you go to read them!
439 /// When adding to the map, [`Self::pending_claiming_payments`] must also be checked to ensure
440 /// we don't get a duplicate payment.
441 claimable_htlcs: HashMap<PaymentHash, (events::PaymentPurpose, Vec<ClaimableHTLC>)>,
443 /// Map from payment hash to the payment data for HTLCs which we have begun claiming, but which
444 /// are waiting on a [`ChannelMonitorUpdate`] to complete in order to be surfaced to the user
445 /// as an [`events::Event::PaymentClaimed`].
446 pending_claiming_payments: HashMap<PaymentHash, ClaimingPayment>,
449 /// Events which we process internally but cannot be procsesed immediately at the generation site
450 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
451 /// quite some time lag.
452 enum BackgroundEvent {
453 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
454 /// commitment transaction.
455 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
459 pub(crate) enum MonitorUpdateCompletionAction {
460 /// Indicates that a payment ultimately destined for us was claimed and we should emit an
461 /// [`events::Event::PaymentClaimed`] to the user if we haven't yet generated such an event for
462 /// this payment. Note that this is only best-effort. On restart it's possible such a duplicate
463 /// event can be generated.
464 PaymentClaimed { payment_hash: PaymentHash },
465 /// Indicates an [`events::Event`] should be surfaced to the user.
466 EmitEvent { event: events::Event },
469 impl_writeable_tlv_based_enum_upgradable!(MonitorUpdateCompletionAction,
470 (0, PaymentClaimed) => { (0, payment_hash, required) },
471 (2, EmitEvent) => { (0, event, upgradable_required) },
474 /// State we hold per-peer.
475 pub(super) struct PeerState<Signer: ChannelSigner> {
476 /// `temporary_channel_id` or `channel_id` -> `channel`.
478 /// Holds all channels where the peer is the counterparty. Once a channel has been assigned a
479 /// `channel_id`, the `temporary_channel_id` key in the map is updated and is replaced by the
481 pub(super) channel_by_id: HashMap<[u8; 32], Channel<Signer>>,
482 /// The latest `InitFeatures` we heard from the peer.
483 latest_features: InitFeatures,
484 /// Messages to send to the peer - pushed to in the same lock that they are generated in (except
485 /// for broadcast messages, where ordering isn't as strict).
486 pub(super) pending_msg_events: Vec<MessageSendEvent>,
487 /// Map from a specific channel to some action(s) that should be taken when all pending
488 /// [`ChannelMonitorUpdate`]s for the channel complete updating.
490 /// Note that because we generally only have one entry here a HashMap is pretty overkill. A
491 /// BTreeMap currently stores more than ten elements per leaf node, so even up to a few
492 /// channels with a peer this will just be one allocation and will amount to a linear list of
493 /// channels to walk, avoiding the whole hashing rigmarole.
495 /// Note that the channel may no longer exist. For example, if a channel was closed but we
496 /// later needed to claim an HTLC which is pending on-chain, we may generate a monitor update
497 /// for a missing channel. While a malicious peer could construct a second channel with the
498 /// same `temporary_channel_id` (or final `channel_id` in the case of 0conf channels or prior
499 /// to funding appearing on-chain), the downstream `ChannelMonitor` set is required to ensure
500 /// duplicates do not occur, so such channels should fail without a monitor update completing.
501 monitor_update_blocked_actions: BTreeMap<[u8; 32], Vec<MonitorUpdateCompletionAction>>,
502 /// The peer is currently connected (i.e. we've seen a
503 /// [`ChannelMessageHandler::peer_connected`] and no corresponding
504 /// [`ChannelMessageHandler::peer_disconnected`].
508 impl <Signer: ChannelSigner> PeerState<Signer> {
509 /// Indicates that a peer meets the criteria where we're ok to remove it from our storage.
510 /// If true is passed for `require_disconnected`, the function will return false if we haven't
511 /// disconnected from the node already, ie. `PeerState::is_connected` is set to `true`.
512 fn ok_to_remove(&self, require_disconnected: bool) -> bool {
513 if require_disconnected && self.is_connected {
516 self.channel_by_id.is_empty() && self.monitor_update_blocked_actions.is_empty()
520 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
521 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
523 /// For users who don't want to bother doing their own payment preimage storage, we also store that
526 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
527 /// and instead encoding it in the payment secret.
528 struct PendingInboundPayment {
529 /// The payment secret that the sender must use for us to accept this payment
530 payment_secret: PaymentSecret,
531 /// Time at which this HTLC expires - blocks with a header time above this value will result in
532 /// this payment being removed.
534 /// Arbitrary identifier the user specifies (or not)
535 user_payment_id: u64,
536 // Other required attributes of the payment, optionally enforced:
537 payment_preimage: Option<PaymentPreimage>,
538 min_value_msat: Option<u64>,
541 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
542 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
543 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
544 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
545 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
546 /// that implements KeysInterface or Router for its keys manager and router, respectively, but this
547 /// type alias chooses the concrete types of KeysManager and DefaultRouter.
549 /// (C-not exported) as Arcs don't make sense in bindings
550 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
558 Arc<NetworkGraph<Arc<L>>>,
560 Arc<Mutex<ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>>
565 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
566 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
567 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
568 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
569 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
570 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
571 /// that implements KeysInterface or Router for its keys manager and router, respectively, but this
572 /// type alias chooses the concrete types of KeysManager and DefaultRouter.
574 /// (C-not exported) as Arcs don't make sense in bindings
575 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> = ChannelManager<&'a M, &'b T, &'c KeysManager, &'c KeysManager, &'c KeysManager, &'d F, &'e DefaultRouter<&'f NetworkGraph<&'g L>, &'g L, &'h Mutex<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>>, &'g L>;
577 /// Manager which keeps track of a number of channels and sends messages to the appropriate
578 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
580 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
581 /// to individual Channels.
583 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
584 /// all peers during write/read (though does not modify this instance, only the instance being
585 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
586 /// called funding_transaction_generated for outbound channels).
588 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
589 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
590 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
591 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
592 /// the serialization process). If the deserialized version is out-of-date compared to the
593 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
594 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
596 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
597 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
598 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
599 /// block_connected() to step towards your best block) upon deserialization before using the
602 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
603 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
604 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
605 /// offline for a full minute. In order to track this, you must call
606 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
608 /// To avoid trivial DoS issues, ChannelManager limits the number of inbound connections and
609 /// inbound channels without confirmed funding transactions. This may result in nodes which we do
610 /// not have a channel with being unable to connect to us or open new channels with us if we have
611 /// many peers with unfunded channels.
613 /// Because it is an indication of trust, inbound channels which we've accepted as 0conf are
614 /// exempted from the count of unfunded channels. Similarly, outbound channels and connections are
615 /// never limited. Please ensure you limit the count of such channels yourself.
617 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
618 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
619 /// essentially you should default to using a SimpleRefChannelManager, and use a
620 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
621 /// you're using lightning-net-tokio.
624 // The tree structure below illustrates the lock order requirements for the different locks of the
625 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
626 // and should then be taken in the order of the lowest to the highest level in the tree.
627 // Note that locks on different branches shall not be taken at the same time, as doing so will
628 // create a new lock order for those specific locks in the order they were taken.
632 // `total_consistency_lock`
634 // |__`forward_htlcs`
636 // | |__`pending_intercepted_htlcs`
638 // |__`per_peer_state`
640 // | |__`pending_inbound_payments`
642 // | |__`claimable_payments`
644 // | |__`pending_outbound_payments` // This field's struct contains a map of pending outbounds
650 // | |__`short_to_chan_info`
652 // | |__`outbound_scid_aliases`
656 // | |__`pending_events`
658 // | |__`pending_background_events`
660 pub struct ChannelManager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
662 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
663 T::Target: BroadcasterInterface,
664 ES::Target: EntropySource,
665 NS::Target: NodeSigner,
666 SP::Target: SignerProvider,
667 F::Target: FeeEstimator,
671 default_configuration: UserConfig,
672 genesis_hash: BlockHash,
673 fee_estimator: LowerBoundedFeeEstimator<F>,
679 /// See `ChannelManager` struct-level documentation for lock order requirements.
681 pub(super) best_block: RwLock<BestBlock>,
683 best_block: RwLock<BestBlock>,
684 secp_ctx: Secp256k1<secp256k1::All>,
686 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
687 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
688 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
689 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
691 /// See `ChannelManager` struct-level documentation for lock order requirements.
692 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
694 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
695 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
696 /// (if the channel has been force-closed), however we track them here to prevent duplicative
697 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
698 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
699 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
700 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
701 /// after reloading from disk while replaying blocks against ChannelMonitors.
703 /// See `PendingOutboundPayment` documentation for more info.
705 /// See `ChannelManager` struct-level documentation for lock order requirements.
706 pending_outbound_payments: OutboundPayments,
708 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
710 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
711 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
712 /// and via the classic SCID.
714 /// Note that no consistency guarantees are made about the existence of a channel with the
715 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
717 /// See `ChannelManager` struct-level documentation for lock order requirements.
719 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
721 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
722 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
723 /// until the user tells us what we should do with them.
725 /// See `ChannelManager` struct-level documentation for lock order requirements.
726 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
728 /// The sets of payments which are claimable or currently being claimed. See
729 /// [`ClaimablePayments`]' individual field docs for more info.
731 /// See `ChannelManager` struct-level documentation for lock order requirements.
732 claimable_payments: Mutex<ClaimablePayments>,
734 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
735 /// and some closed channels which reached a usable state prior to being closed. This is used
736 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
737 /// active channel list on load.
739 /// See `ChannelManager` struct-level documentation for lock order requirements.
740 outbound_scid_aliases: Mutex<HashSet<u64>>,
742 /// `channel_id` -> `counterparty_node_id`.
744 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
745 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
746 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
748 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
749 /// the corresponding channel for the event, as we only have access to the `channel_id` during
750 /// the handling of the events.
752 /// Note that no consistency guarantees are made about the existence of a peer with the
753 /// `counterparty_node_id` in our other maps.
756 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
757 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
758 /// would break backwards compatability.
759 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
760 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
761 /// required to access the channel with the `counterparty_node_id`.
763 /// See `ChannelManager` struct-level documentation for lock order requirements.
764 id_to_peer: Mutex<HashMap<[u8; 32], PublicKey>>,
766 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
768 /// Outbound SCID aliases are added here once the channel is available for normal use, with
769 /// SCIDs being added once the funding transaction is confirmed at the channel's required
770 /// confirmation depth.
772 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
773 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
774 /// channel with the `channel_id` in our other maps.
776 /// See `ChannelManager` struct-level documentation for lock order requirements.
778 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
780 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
782 our_network_pubkey: PublicKey,
784 inbound_payment_key: inbound_payment::ExpandedKey,
786 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
787 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
788 /// we encrypt the namespace identifier using these bytes.
790 /// [fake scids]: crate::util::scid_utils::fake_scid
791 fake_scid_rand_bytes: [u8; 32],
793 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
794 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
795 /// keeping additional state.
796 probing_cookie_secret: [u8; 32],
798 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
799 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
800 /// very far in the past, and can only ever be up to two hours in the future.
801 highest_seen_timestamp: AtomicUsize,
803 /// The bulk of our storage. Currently the `per_peer_state` stores our channels on a per-peer
804 /// basis, as well as the peer's latest features.
806 /// If we are connected to a peer we always at least have an entry here, even if no channels
807 /// are currently open with that peer.
809 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
810 /// operate on the inner value freely. This opens up for parallel per-peer operation for
813 /// Note that the same thread must never acquire two inner `PeerState` locks at the same time.
815 /// See `ChannelManager` struct-level documentation for lock order requirements.
816 #[cfg(not(any(test, feature = "_test_utils")))]
817 per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>>>,
818 #[cfg(any(test, feature = "_test_utils"))]
819 pub(super) per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>>>,
821 /// See `ChannelManager` struct-level documentation for lock order requirements.
822 pending_events: Mutex<Vec<events::Event>>,
823 /// See `ChannelManager` struct-level documentation for lock order requirements.
824 pending_background_events: Mutex<Vec<BackgroundEvent>>,
825 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
826 /// Essentially just when we're serializing ourselves out.
827 /// Taken first everywhere where we are making changes before any other locks.
828 /// When acquiring this lock in read mode, rather than acquiring it directly, call
829 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
830 /// Notifier the lock contains sends out a notification when the lock is released.
831 total_consistency_lock: RwLock<()>,
833 persistence_notifier: Notifier,
842 /// Chain-related parameters used to construct a new `ChannelManager`.
844 /// Typically, the block-specific parameters are derived from the best block hash for the network,
845 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
846 /// are not needed when deserializing a previously constructed `ChannelManager`.
847 #[derive(Clone, Copy, PartialEq)]
848 pub struct ChainParameters {
849 /// The network for determining the `chain_hash` in Lightning messages.
850 pub network: Network,
852 /// The hash and height of the latest block successfully connected.
854 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
855 pub best_block: BestBlock,
858 #[derive(Copy, Clone, PartialEq)]
864 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
865 /// desirable to notify any listeners on `await_persistable_update_timeout`/
866 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
867 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
868 /// sending the aforementioned notification (since the lock being released indicates that the
869 /// updates are ready for persistence).
871 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
872 /// notify or not based on whether relevant changes have been made, providing a closure to
873 /// `optionally_notify` which returns a `NotifyOption`.
874 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
875 persistence_notifier: &'a Notifier,
877 // We hold onto this result so the lock doesn't get released immediately.
878 _read_guard: RwLockReadGuard<'a, ()>,
881 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
882 fn notify_on_drop(lock: &'a RwLock<()>, notifier: &'a Notifier) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
883 PersistenceNotifierGuard::optionally_notify(lock, notifier, || -> NotifyOption { NotifyOption::DoPersist })
886 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a Notifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
887 let read_guard = lock.read().unwrap();
889 PersistenceNotifierGuard {
890 persistence_notifier: notifier,
891 should_persist: persist_check,
892 _read_guard: read_guard,
897 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
899 if (self.should_persist)() == NotifyOption::DoPersist {
900 self.persistence_notifier.notify();
905 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
906 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
908 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
910 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
911 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
912 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
913 /// the maximum required amount in lnd as of March 2021.
914 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
916 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
917 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
919 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
921 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
922 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
923 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
924 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
925 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
926 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
927 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
928 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
929 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
930 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
931 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
932 // routing failure for any HTLC sender picking up an LDK node among the first hops.
933 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
935 /// Minimum CLTV difference between the current block height and received inbound payments.
936 /// Invoices generated for payment to us must set their `min_final_cltv_expiry_delta` field to at least
938 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
939 // any payments to succeed. Further, we don't want payments to fail if a block was found while
940 // a payment was being routed, so we add an extra block to be safe.
941 pub const MIN_FINAL_CLTV_EXPIRY_DELTA: u16 = HTLC_FAIL_BACK_BUFFER as u16 + 3;
943 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
944 // ie that if the next-hop peer fails the HTLC within
945 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
946 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
947 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
948 // LATENCY_GRACE_PERIOD_BLOCKS.
951 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;
953 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
954 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
957 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
959 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
960 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
962 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until we time-out the
963 /// idempotency of payments by [`PaymentId`]. See
964 /// [`OutboundPayments::remove_stale_resolved_payments`].
965 pub(crate) const IDEMPOTENCY_TIMEOUT_TICKS: u8 = 7;
967 /// The maximum number of unfunded channels we can have per-peer before we start rejecting new
968 /// (inbound) ones. The number of peers with unfunded channels is limited separately in
969 /// [`MAX_UNFUNDED_CHANNEL_PEERS`].
970 const MAX_UNFUNDED_CHANS_PER_PEER: usize = 4;
972 /// The maximum number of peers from which we will allow pending unfunded channels. Once we reach
973 /// this many peers we reject new (inbound) channels from peers with which we don't have a channel.
974 const MAX_UNFUNDED_CHANNEL_PEERS: usize = 50;
976 /// The maximum number of peers which we do not have a (funded) channel with. Once we reach this
977 /// many peers we reject new (inbound) connections.
978 const MAX_NO_CHANNEL_PEERS: usize = 250;
980 /// Information needed for constructing an invoice route hint for this channel.
981 #[derive(Clone, Debug, PartialEq)]
982 pub struct CounterpartyForwardingInfo {
983 /// Base routing fee in millisatoshis.
984 pub fee_base_msat: u32,
985 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
986 pub fee_proportional_millionths: u32,
987 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
988 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
989 /// `cltv_expiry_delta` for more details.
990 pub cltv_expiry_delta: u16,
993 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
994 /// to better separate parameters.
995 #[derive(Clone, Debug, PartialEq)]
996 pub struct ChannelCounterparty {
997 /// The node_id of our counterparty
998 pub node_id: PublicKey,
999 /// The Features the channel counterparty provided upon last connection.
1000 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
1001 /// many routing-relevant features are present in the init context.
1002 pub features: InitFeatures,
1003 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
1004 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
1005 /// claiming at least this value on chain.
1007 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
1009 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
1010 pub unspendable_punishment_reserve: u64,
1011 /// Information on the fees and requirements that the counterparty requires when forwarding
1012 /// payments to us through this channel.
1013 pub forwarding_info: Option<CounterpartyForwardingInfo>,
1014 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
1015 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
1016 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
1017 pub outbound_htlc_minimum_msat: Option<u64>,
1018 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
1019 pub outbound_htlc_maximum_msat: Option<u64>,
1022 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
1023 #[derive(Clone, Debug, PartialEq)]
1024 pub struct ChannelDetails {
1025 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
1026 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
1027 /// Note that this means this value is *not* persistent - it can change once during the
1028 /// lifetime of the channel.
1029 pub channel_id: [u8; 32],
1030 /// Parameters which apply to our counterparty. See individual fields for more information.
1031 pub counterparty: ChannelCounterparty,
1032 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
1033 /// our counterparty already.
1035 /// Note that, if this has been set, `channel_id` will be equivalent to
1036 /// `funding_txo.unwrap().to_channel_id()`.
1037 pub funding_txo: Option<OutPoint>,
1038 /// The features which this channel operates with. See individual features for more info.
1040 /// `None` until negotiation completes and the channel type is finalized.
1041 pub channel_type: Option<ChannelTypeFeatures>,
1042 /// The position of the funding transaction in the chain. None if the funding transaction has
1043 /// not yet been confirmed and the channel fully opened.
1045 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1046 /// payments instead of this. See [`get_inbound_payment_scid`].
1048 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1049 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1051 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1052 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1053 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1054 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1055 /// [`confirmations_required`]: Self::confirmations_required
1056 pub short_channel_id: Option<u64>,
1057 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1058 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1059 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1062 /// This will be `None` as long as the channel is not available for routing outbound payments.
1064 /// [`short_channel_id`]: Self::short_channel_id
1065 /// [`confirmations_required`]: Self::confirmations_required
1066 pub outbound_scid_alias: Option<u64>,
1067 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1068 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1069 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1070 /// when they see a payment to be routed to us.
1072 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1073 /// previous values for inbound payment forwarding.
1075 /// [`short_channel_id`]: Self::short_channel_id
1076 pub inbound_scid_alias: Option<u64>,
1077 /// The value, in satoshis, of this channel as appears in the funding output
1078 pub channel_value_satoshis: u64,
1079 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1080 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1081 /// this value on chain.
1083 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1085 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1087 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1088 pub unspendable_punishment_reserve: Option<u64>,
1089 /// The `user_channel_id` passed in to create_channel, or a random value if the channel was
1090 /// inbound. This may be zero for inbound channels serialized with LDK versions prior to
1092 pub user_channel_id: u128,
1093 /// Our total balance. This is the amount we would get if we close the channel.
1094 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1095 /// amount is not likely to be recoverable on close.
1097 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1098 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1099 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1100 /// This does not consider any on-chain fees.
1102 /// See also [`ChannelDetails::outbound_capacity_msat`]
1103 pub balance_msat: u64,
1104 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1105 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1106 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1107 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1109 /// See also [`ChannelDetails::balance_msat`]
1111 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1112 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1113 /// should be able to spend nearly this amount.
1114 pub outbound_capacity_msat: u64,
1115 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1116 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1117 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1118 /// to use a limit as close as possible to the HTLC limit we can currently send.
1120 /// See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
1121 pub next_outbound_htlc_limit_msat: u64,
1122 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1123 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1124 /// available for inclusion in new inbound HTLCs).
1125 /// Note that there are some corner cases not fully handled here, so the actual available
1126 /// inbound capacity may be slightly higher than this.
1128 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1129 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1130 /// However, our counterparty should be able to spend nearly this amount.
1131 pub inbound_capacity_msat: u64,
1132 /// The number of required confirmations on the funding transaction before the funding will be
1133 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1134 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1135 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1136 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1138 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1140 /// [`is_outbound`]: ChannelDetails::is_outbound
1141 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1142 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1143 pub confirmations_required: Option<u32>,
1144 /// The current number of confirmations on the funding transaction.
1146 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1147 pub confirmations: Option<u32>,
1148 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1149 /// until we can claim our funds after we force-close the channel. During this time our
1150 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1151 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1152 /// time to claim our non-HTLC-encumbered funds.
1154 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1155 pub force_close_spend_delay: Option<u16>,
1156 /// True if the channel was initiated (and thus funded) by us.
1157 pub is_outbound: bool,
1158 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1159 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1160 /// required confirmation count has been reached (and we were connected to the peer at some
1161 /// point after the funding transaction received enough confirmations). The required
1162 /// confirmation count is provided in [`confirmations_required`].
1164 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1165 pub is_channel_ready: bool,
1166 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1167 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1169 /// This is a strict superset of `is_channel_ready`.
1170 pub is_usable: bool,
1171 /// True if this channel is (or will be) publicly-announced.
1172 pub is_public: bool,
1173 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1174 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1175 pub inbound_htlc_minimum_msat: Option<u64>,
1176 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1177 pub inbound_htlc_maximum_msat: Option<u64>,
1178 /// Set of configurable parameters that affect channel operation.
1180 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1181 pub config: Option<ChannelConfig>,
1184 impl ChannelDetails {
1185 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1186 /// This should be used for providing invoice hints or in any other context where our
1187 /// counterparty will forward a payment to us.
1189 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1190 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1191 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1192 self.inbound_scid_alias.or(self.short_channel_id)
1195 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1196 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1197 /// we're sending or forwarding a payment outbound over this channel.
1199 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1200 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1201 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1202 self.short_channel_id.or(self.outbound_scid_alias)
1206 /// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
1207 /// These include payments that have yet to find a successful path, or have unresolved HTLCs.
1208 #[derive(Debug, PartialEq)]
1209 pub enum RecentPaymentDetails {
1210 /// When a payment is still being sent and awaiting successful delivery.
1212 /// Hash of the payment that is currently being sent but has yet to be fulfilled or
1214 payment_hash: PaymentHash,
1215 /// Total amount (in msat, excluding fees) across all paths for this payment,
1216 /// not just the amount currently inflight.
1219 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
1220 /// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
1221 /// payment is removed from tracking.
1223 /// Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
1224 /// made before LDK version 0.0.104.
1225 payment_hash: Option<PaymentHash>,
1227 /// After a payment's retries are exhausted per the provided [`Retry`], or it is explicitly
1228 /// abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
1229 /// pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
1231 /// Hash of the payment that we have given up trying to send.
1232 payment_hash: PaymentHash,
1236 /// Route hints used in constructing invoices for [phantom node payents].
1238 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
1240 pub struct PhantomRouteHints {
1241 /// The list of channels to be included in the invoice route hints.
1242 pub channels: Vec<ChannelDetails>,
1243 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1245 pub phantom_scid: u64,
1246 /// The pubkey of the real backing node that would ultimately receive the payment.
1247 pub real_node_pubkey: PublicKey,
1250 macro_rules! handle_error {
1251 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
1254 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish }) => {
1255 // In testing, ensure there are no deadlocks where the lock is already held upon
1256 // entering the macro.
1257 debug_assert_ne!($self.pending_events.held_by_thread(), LockHeldState::HeldByThread);
1258 debug_assert_ne!($self.per_peer_state.held_by_thread(), LockHeldState::HeldByThread);
1260 let mut msg_events = Vec::with_capacity(2);
1262 if let Some((shutdown_res, update_option)) = shutdown_finish {
1263 $self.finish_force_close_channel(shutdown_res);
1264 if let Some(update) = update_option {
1265 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1269 if let Some((channel_id, user_channel_id)) = chan_id {
1270 $self.pending_events.lock().unwrap().push(events::Event::ChannelClosed {
1271 channel_id, user_channel_id,
1272 reason: ClosureReason::ProcessingError { err: err.err.clone() }
1277 log_error!($self.logger, "{}", err.err);
1278 if let msgs::ErrorAction::IgnoreError = err.action {
1280 msg_events.push(events::MessageSendEvent::HandleError {
1281 node_id: $counterparty_node_id,
1282 action: err.action.clone()
1286 if !msg_events.is_empty() {
1287 let per_peer_state = $self.per_peer_state.read().unwrap();
1288 if let Some(peer_state_mutex) = per_peer_state.get(&$counterparty_node_id) {
1289 let mut peer_state = peer_state_mutex.lock().unwrap();
1290 peer_state.pending_msg_events.append(&mut msg_events);
1294 // Return error in case higher-API need one
1301 macro_rules! update_maps_on_chan_removal {
1302 ($self: expr, $channel: expr) => {{
1303 $self.id_to_peer.lock().unwrap().remove(&$channel.channel_id());
1304 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1305 if let Some(short_id) = $channel.get_short_channel_id() {
1306 short_to_chan_info.remove(&short_id);
1308 // If the channel was never confirmed on-chain prior to its closure, remove the
1309 // outbound SCID alias we used for it from the collision-prevention set. While we
1310 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1311 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1312 // opening a million channels with us which are closed before we ever reach the funding
1314 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel.outbound_scid_alias());
1315 debug_assert!(alias_removed);
1317 short_to_chan_info.remove(&$channel.outbound_scid_alias());
1321 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1322 macro_rules! convert_chan_err {
1323 ($self: ident, $err: expr, $channel: expr, $channel_id: expr) => {
1325 ChannelError::Warn(msg) => {
1326 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), $channel_id.clone()))
1328 ChannelError::Ignore(msg) => {
1329 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
1331 ChannelError::Close(msg) => {
1332 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
1333 update_maps_on_chan_removal!($self, $channel);
1334 let shutdown_res = $channel.force_shutdown(true);
1335 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
1336 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
1342 macro_rules! break_chan_entry {
1343 ($self: ident, $res: expr, $entry: expr) => {
1347 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1349 $entry.remove_entry();
1357 macro_rules! try_chan_entry {
1358 ($self: ident, $res: expr, $entry: expr) => {
1362 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1364 $entry.remove_entry();
1372 macro_rules! remove_channel {
1373 ($self: expr, $entry: expr) => {
1375 let channel = $entry.remove_entry().1;
1376 update_maps_on_chan_removal!($self, channel);
1382 macro_rules! send_channel_ready {
1383 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
1384 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1385 node_id: $channel.get_counterparty_node_id(),
1386 msg: $channel_ready_msg,
1388 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1389 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1390 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1391 let outbound_alias_insert = short_to_chan_info.insert($channel.outbound_scid_alias(), ($channel.get_counterparty_node_id(), $channel.channel_id()));
1392 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1393 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1394 if let Some(real_scid) = $channel.get_short_channel_id() {
1395 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.get_counterparty_node_id(), $channel.channel_id()));
1396 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1397 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1402 macro_rules! emit_channel_ready_event {
1403 ($self: expr, $channel: expr) => {
1404 if $channel.should_emit_channel_ready_event() {
1406 let mut pending_events = $self.pending_events.lock().unwrap();
1407 pending_events.push(events::Event::ChannelReady {
1408 channel_id: $channel.channel_id(),
1409 user_channel_id: $channel.get_user_id(),
1410 counterparty_node_id: $channel.get_counterparty_node_id(),
1411 channel_type: $channel.get_channel_type().clone(),
1414 $channel.set_channel_ready_event_emitted();
1419 macro_rules! handle_monitor_update_completion {
1420 ($self: ident, $update_id: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr) => { {
1421 let mut updates = $chan.monitor_updating_restored(&$self.logger,
1422 &$self.node_signer, $self.genesis_hash, &$self.default_configuration,
1423 $self.best_block.read().unwrap().height());
1424 let counterparty_node_id = $chan.get_counterparty_node_id();
1425 let channel_update = if updates.channel_ready.is_some() && $chan.is_usable() {
1426 // We only send a channel_update in the case where we are just now sending a
1427 // channel_ready and the channel is in a usable state. We may re-send a
1428 // channel_update later through the announcement_signatures process for public
1429 // channels, but there's no reason not to just inform our counterparty of our fees
1431 if let Ok(msg) = $self.get_channel_update_for_unicast($chan) {
1432 Some(events::MessageSendEvent::SendChannelUpdate {
1433 node_id: counterparty_node_id,
1439 let update_actions = $peer_state.monitor_update_blocked_actions
1440 .remove(&$chan.channel_id()).unwrap_or(Vec::new());
1442 let htlc_forwards = $self.handle_channel_resumption(
1443 &mut $peer_state.pending_msg_events, $chan, updates.raa,
1444 updates.commitment_update, updates.order, updates.accepted_htlcs,
1445 updates.funding_broadcastable, updates.channel_ready,
1446 updates.announcement_sigs);
1447 if let Some(upd) = channel_update {
1448 $peer_state.pending_msg_events.push(upd);
1451 let channel_id = $chan.channel_id();
1452 core::mem::drop($peer_state_lock);
1453 core::mem::drop($per_peer_state_lock);
1455 $self.handle_monitor_update_completion_actions(update_actions);
1457 if let Some(forwards) = htlc_forwards {
1458 $self.forward_htlcs(&mut [forwards][..]);
1460 $self.finalize_claims(updates.finalized_claimed_htlcs);
1461 for failure in updates.failed_htlcs.drain(..) {
1462 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
1463 $self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
1468 macro_rules! handle_new_monitor_update {
1469 ($self: ident, $update_res: expr, $update_id: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan: expr, MANUALLY_REMOVING, $remove: expr) => { {
1470 // update_maps_on_chan_removal needs to be able to take id_to_peer, so make sure we can in
1471 // any case so that it won't deadlock.
1472 debug_assert!($self.id_to_peer.try_lock().is_ok());
1474 ChannelMonitorUpdateStatus::InProgress => {
1475 log_debug!($self.logger, "ChannelMonitor update for {} in flight, holding messages until the update completes.",
1476 log_bytes!($chan.channel_id()[..]));
1479 ChannelMonitorUpdateStatus::PermanentFailure => {
1480 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateStatus::PermanentFailure",
1481 log_bytes!($chan.channel_id()[..]));
1482 update_maps_on_chan_removal!($self, $chan);
1483 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown(
1484 "ChannelMonitor storage failure".to_owned(), $chan.channel_id(),
1485 $chan.get_user_id(), $chan.force_shutdown(false),
1486 $self.get_channel_update_for_broadcast(&$chan).ok()));
1490 ChannelMonitorUpdateStatus::Completed => {
1491 if ($update_id == 0 || $chan.get_next_monitor_update()
1492 .expect("We can't be processing a monitor update if it isn't queued")
1493 .update_id == $update_id) &&
1494 $chan.get_latest_monitor_update_id() == $update_id
1496 handle_monitor_update_completion!($self, $update_id, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan);
1502 ($self: ident, $update_res: expr, $update_id: expr, $peer_state_lock: expr, $peer_state: expr, $per_peer_state_lock: expr, $chan_entry: expr) => {
1503 handle_new_monitor_update!($self, $update_res, $update_id, $peer_state_lock, $peer_state, $per_peer_state_lock, $chan_entry.get_mut(), MANUALLY_REMOVING, $chan_entry.remove_entry())
1507 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>
1509 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
1510 T::Target: BroadcasterInterface,
1511 ES::Target: EntropySource,
1512 NS::Target: NodeSigner,
1513 SP::Target: SignerProvider,
1514 F::Target: FeeEstimator,
1518 /// Constructs a new ChannelManager to hold several channels and route between them.
1520 /// This is the main "logic hub" for all channel-related actions, and implements
1521 /// ChannelMessageHandler.
1523 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1525 /// Users need to notify the new ChannelManager when a new block is connected or
1526 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
1527 /// from after `params.latest_hash`.
1528 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, entropy_source: ES, node_signer: NS, signer_provider: SP, config: UserConfig, params: ChainParameters) -> Self {
1529 let mut secp_ctx = Secp256k1::new();
1530 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
1531 let inbound_pmt_key_material = node_signer.get_inbound_payment_key_material();
1532 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
1534 default_configuration: config.clone(),
1535 genesis_hash: genesis_block(params.network).header.block_hash(),
1536 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
1541 best_block: RwLock::new(params.best_block),
1543 outbound_scid_aliases: Mutex::new(HashSet::new()),
1544 pending_inbound_payments: Mutex::new(HashMap::new()),
1545 pending_outbound_payments: OutboundPayments::new(),
1546 forward_htlcs: Mutex::new(HashMap::new()),
1547 claimable_payments: Mutex::new(ClaimablePayments { claimable_htlcs: HashMap::new(), pending_claiming_payments: HashMap::new() }),
1548 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
1549 id_to_peer: Mutex::new(HashMap::new()),
1550 short_to_chan_info: FairRwLock::new(HashMap::new()),
1552 our_network_pubkey: node_signer.get_node_id(Recipient::Node).unwrap(),
1555 inbound_payment_key: expanded_inbound_key,
1556 fake_scid_rand_bytes: entropy_source.get_secure_random_bytes(),
1558 probing_cookie_secret: entropy_source.get_secure_random_bytes(),
1560 highest_seen_timestamp: AtomicUsize::new(0),
1562 per_peer_state: FairRwLock::new(HashMap::new()),
1564 pending_events: Mutex::new(Vec::new()),
1565 pending_background_events: Mutex::new(Vec::new()),
1566 total_consistency_lock: RwLock::new(()),
1567 persistence_notifier: Notifier::new(),
1577 /// Gets the current configuration applied to all new channels.
1578 pub fn get_current_default_configuration(&self) -> &UserConfig {
1579 &self.default_configuration
1582 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
1583 let height = self.best_block.read().unwrap().height();
1584 let mut outbound_scid_alias = 0;
1587 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
1588 outbound_scid_alias += 1;
1590 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
1592 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
1596 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"); }
1601 /// Creates a new outbound channel to the given remote node and with the given value.
1603 /// `user_channel_id` will be provided back as in
1604 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
1605 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
1606 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
1607 /// is simply copied to events and otherwise ignored.
1609 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
1610 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
1612 /// Note that we do not check if you are currently connected to the given peer. If no
1613 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
1614 /// the channel eventually being silently forgotten (dropped on reload).
1616 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
1617 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
1618 /// [`ChannelDetails::channel_id`] until after
1619 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
1620 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
1621 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
1623 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
1624 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
1625 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
1626 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> {
1627 if channel_value_satoshis < 1000 {
1628 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
1631 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1632 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
1633 debug_assert!(&self.total_consistency_lock.try_write().is_err());
1635 let per_peer_state = self.per_peer_state.read().unwrap();
1637 let peer_state_mutex = per_peer_state.get(&their_network_key)
1638 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Not connected to node: {}", their_network_key) })?;
1640 let mut peer_state = peer_state_mutex.lock().unwrap();
1642 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
1643 let their_features = &peer_state.latest_features;
1644 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
1645 match Channel::new_outbound(&self.fee_estimator, &self.entropy_source, &self.signer_provider, their_network_key,
1646 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
1647 self.best_block.read().unwrap().height(), outbound_scid_alias)
1651 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
1656 let res = channel.get_open_channel(self.genesis_hash.clone());
1658 let temporary_channel_id = channel.channel_id();
1659 match peer_state.channel_by_id.entry(temporary_channel_id) {
1660 hash_map::Entry::Occupied(_) => {
1662 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
1664 panic!("RNG is bad???");
1667 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
1670 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
1671 node_id: their_network_key,
1674 Ok(temporary_channel_id)
1677 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<<SP::Target as SignerProvider>::Signer>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
1678 // Allocate our best estimate of the number of channels we have in the `res`
1679 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
1680 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
1681 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
1682 // unlikely as the `short_to_chan_info` map often contains 2 entries for
1683 // the same channel.
1684 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
1686 let best_block_height = self.best_block.read().unwrap().height();
1687 let per_peer_state = self.per_peer_state.read().unwrap();
1688 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
1689 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
1690 let peer_state = &mut *peer_state_lock;
1691 for (channel_id, channel) in peer_state.channel_by_id.iter().filter(f) {
1692 let balance = channel.get_available_balances();
1693 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1694 channel.get_holder_counterparty_selected_channel_reserve_satoshis();
1695 res.push(ChannelDetails {
1696 channel_id: (*channel_id).clone(),
1697 counterparty: ChannelCounterparty {
1698 node_id: channel.get_counterparty_node_id(),
1699 features: peer_state.latest_features.clone(),
1700 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1701 forwarding_info: channel.counterparty_forwarding_info(),
1702 // Ensures that we have actually received the `htlc_minimum_msat` value
1703 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1704 // message (as they are always the first message from the counterparty).
1705 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1706 // default `0` value set by `Channel::new_outbound`.
1707 outbound_htlc_minimum_msat: if channel.have_received_message() {
1708 Some(channel.get_counterparty_htlc_minimum_msat()) } else { None },
1709 outbound_htlc_maximum_msat: channel.get_counterparty_htlc_maximum_msat(),
1711 funding_txo: channel.get_funding_txo(),
1712 // Note that accept_channel (or open_channel) is always the first message, so
1713 // `have_received_message` indicates that type negotiation has completed.
1714 channel_type: if channel.have_received_message() { Some(channel.get_channel_type().clone()) } else { None },
1715 short_channel_id: channel.get_short_channel_id(),
1716 outbound_scid_alias: if channel.is_usable() { Some(channel.outbound_scid_alias()) } else { None },
1717 inbound_scid_alias: channel.latest_inbound_scid_alias(),
1718 channel_value_satoshis: channel.get_value_satoshis(),
1719 unspendable_punishment_reserve: to_self_reserve_satoshis,
1720 balance_msat: balance.balance_msat,
1721 inbound_capacity_msat: balance.inbound_capacity_msat,
1722 outbound_capacity_msat: balance.outbound_capacity_msat,
1723 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1724 user_channel_id: channel.get_user_id(),
1725 confirmations_required: channel.minimum_depth(),
1726 confirmations: Some(channel.get_funding_tx_confirmations(best_block_height)),
1727 force_close_spend_delay: channel.get_counterparty_selected_contest_delay(),
1728 is_outbound: channel.is_outbound(),
1729 is_channel_ready: channel.is_usable(),
1730 is_usable: channel.is_live(),
1731 is_public: channel.should_announce(),
1732 inbound_htlc_minimum_msat: Some(channel.get_holder_htlc_minimum_msat()),
1733 inbound_htlc_maximum_msat: channel.get_holder_htlc_maximum_msat(),
1734 config: Some(channel.config()),
1742 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
1743 /// more information.
1744 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1745 self.list_channels_with_filter(|_| true)
1748 /// Gets the list of usable channels, in random order. Useful as an argument to [`find_route`]
1749 /// to ensure non-announced channels are used.
1751 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1752 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1755 /// [`find_route`]: crate::routing::router::find_route
1756 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1757 // Note we use is_live here instead of usable which leads to somewhat confused
1758 // internal/external nomenclature, but that's ok cause that's probably what the user
1759 // really wanted anyway.
1760 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1763 /// Returns in an undefined order recent payments that -- if not fulfilled -- have yet to find a
1764 /// successful path, or have unresolved HTLCs.
1766 /// This can be useful for payments that may have been prepared, but ultimately not sent, as a
1767 /// result of a crash. If such a payment exists, is not listed here, and an
1768 /// [`Event::PaymentSent`] has not been received, you may consider resending the payment.
1770 /// [`Event::PaymentSent`]: events::Event::PaymentSent
1771 pub fn list_recent_payments(&self) -> Vec<RecentPaymentDetails> {
1772 self.pending_outbound_payments.pending_outbound_payments.lock().unwrap().iter()
1773 .filter_map(|(_, pending_outbound_payment)| match pending_outbound_payment {
1774 PendingOutboundPayment::Retryable { payment_hash, total_msat, .. } => {
1775 Some(RecentPaymentDetails::Pending {
1776 payment_hash: *payment_hash,
1777 total_msat: *total_msat,
1780 PendingOutboundPayment::Abandoned { payment_hash, .. } => {
1781 Some(RecentPaymentDetails::Abandoned { payment_hash: *payment_hash })
1783 PendingOutboundPayment::Fulfilled { payment_hash, .. } => {
1784 Some(RecentPaymentDetails::Fulfilled { payment_hash: *payment_hash })
1786 PendingOutboundPayment::Legacy { .. } => None
1791 /// Helper function that issues the channel close events
1792 fn issue_channel_close_events(&self, channel: &Channel<<SP::Target as SignerProvider>::Signer>, closure_reason: ClosureReason) {
1793 let mut pending_events_lock = self.pending_events.lock().unwrap();
1794 match channel.unbroadcasted_funding() {
1795 Some(transaction) => {
1796 pending_events_lock.push(events::Event::DiscardFunding { channel_id: channel.channel_id(), transaction })
1800 pending_events_lock.push(events::Event::ChannelClosed {
1801 channel_id: channel.channel_id(),
1802 user_channel_id: channel.get_user_id(),
1803 reason: closure_reason
1807 fn close_channel_internal(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>) -> Result<(), APIError> {
1808 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1810 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
1811 let result: Result<(), _> = loop {
1812 let per_peer_state = self.per_peer_state.read().unwrap();
1814 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
1815 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
1817 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
1818 let peer_state = &mut *peer_state_lock;
1819 match peer_state.channel_by_id.entry(channel_id.clone()) {
1820 hash_map::Entry::Occupied(mut chan_entry) => {
1821 let funding_txo_opt = chan_entry.get().get_funding_txo();
1822 let their_features = &peer_state.latest_features;
1823 let (shutdown_msg, mut monitor_update_opt, htlcs) = chan_entry.get_mut()
1824 .get_shutdown(&self.signer_provider, their_features, target_feerate_sats_per_1000_weight)?;
1825 failed_htlcs = htlcs;
1827 // We can send the `shutdown` message before updating the `ChannelMonitor`
1828 // here as we don't need the monitor update to complete until we send a
1829 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
1830 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1831 node_id: *counterparty_node_id,
1835 // Update the monitor with the shutdown script if necessary.
1836 if let Some(monitor_update) = monitor_update_opt.take() {
1837 let update_id = monitor_update.update_id;
1838 let update_res = self.chain_monitor.update_channel(funding_txo_opt.unwrap(), monitor_update);
1839 break handle_new_monitor_update!(self, update_res, update_id, peer_state_lock, peer_state, per_peer_state, chan_entry);
1842 if chan_entry.get().is_shutdown() {
1843 let channel = remove_channel!(self, chan_entry);
1844 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
1845 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1849 self.issue_channel_close_events(&channel, ClosureReason::HolderForceClosed);
1853 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) })
1857 for htlc_source in failed_htlcs.drain(..) {
1858 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
1859 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
1860 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
1863 let _ = handle_error!(self, result, *counterparty_node_id);
1867 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1868 /// will be accepted on the given channel, and after additional timeout/the closing of all
1869 /// pending HTLCs, the channel will be closed on chain.
1871 /// * If we are the channel initiator, we will pay between our [`Background`] and
1872 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1874 /// * If our counterparty is the channel initiator, we will require a channel closing
1875 /// transaction feerate of at least our [`Background`] feerate or the feerate which
1876 /// would appear on a force-closure transaction, whichever is lower. We will allow our
1877 /// counterparty to pay as much fee as they'd like, however.
1879 /// May generate a SendShutdown message event on success, which should be relayed.
1881 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1882 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1883 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1884 pub fn close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
1885 self.close_channel_internal(channel_id, counterparty_node_id, None)
1888 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1889 /// will be accepted on the given channel, and after additional timeout/the closing of all
1890 /// pending HTLCs, the channel will be closed on chain.
1892 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
1893 /// the channel being closed or not:
1894 /// * If we are the channel initiator, we will pay at least this feerate on the closing
1895 /// transaction. The upper-bound is set by
1896 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1897 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
1898 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
1899 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
1900 /// will appear on a force-closure transaction, whichever is lower).
1902 /// May generate a SendShutdown message event on success, which should be relayed.
1904 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1905 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1906 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1907 pub fn close_channel_with_target_feerate(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: u32) -> Result<(), APIError> {
1908 self.close_channel_internal(channel_id, counterparty_node_id, Some(target_feerate_sats_per_1000_weight))
1912 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1913 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1914 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
1915 for htlc_source in failed_htlcs.drain(..) {
1916 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
1917 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
1918 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
1919 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
1921 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1922 // There isn't anything we can do if we get an update failure - we're already
1923 // force-closing. The monitor update on the required in-memory copy should broadcast
1924 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1925 // ignore the result here.
1926 let _ = self.chain_monitor.update_channel(funding_txo, &monitor_update);
1930 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
1931 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
1932 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
1933 -> Result<PublicKey, APIError> {
1934 let per_peer_state = self.per_peer_state.read().unwrap();
1935 let peer_state_mutex = per_peer_state.get(peer_node_id)
1936 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", peer_node_id) })?;
1938 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
1939 let peer_state = &mut *peer_state_lock;
1940 if let hash_map::Entry::Occupied(chan) = peer_state.channel_by_id.entry(channel_id.clone()) {
1941 if let Some(peer_msg) = peer_msg {
1942 self.issue_channel_close_events(chan.get(),ClosureReason::CounterpartyForceClosed { peer_msg: peer_msg.to_string() });
1944 self.issue_channel_close_events(chan.get(),ClosureReason::HolderForceClosed);
1946 remove_channel!(self, chan)
1948 return Err(APIError::ChannelUnavailable{ err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*channel_id), peer_node_id) });
1951 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
1952 self.finish_force_close_channel(chan.force_shutdown(broadcast));
1953 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
1954 let mut peer_state = peer_state_mutex.lock().unwrap();
1955 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1960 Ok(chan.get_counterparty_node_id())
1963 fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
1964 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1965 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
1966 Ok(counterparty_node_id) => {
1967 let per_peer_state = self.per_peer_state.read().unwrap();
1968 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
1969 let mut peer_state = peer_state_mutex.lock().unwrap();
1970 peer_state.pending_msg_events.push(
1971 events::MessageSendEvent::HandleError {
1972 node_id: counterparty_node_id,
1973 action: msgs::ErrorAction::SendErrorMessage {
1974 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
1985 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
1986 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
1987 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
1989 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
1990 -> Result<(), APIError> {
1991 self.force_close_sending_error(channel_id, counterparty_node_id, true)
1994 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
1995 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
1996 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
1998 /// You can always get the latest local transaction(s) to broadcast from
1999 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
2000 pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
2001 -> Result<(), APIError> {
2002 self.force_close_sending_error(channel_id, counterparty_node_id, false)
2005 /// Force close all channels, immediately broadcasting the latest local commitment transaction
2006 /// for each to the chain and rejecting new HTLCs on each.
2007 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
2008 for chan in self.list_channels() {
2009 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
2013 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
2014 /// local transaction(s).
2015 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
2016 for chan in self.list_channels() {
2017 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
2021 fn construct_recv_pending_htlc_info(&self, hop_data: msgs::OnionHopData, shared_secret: [u8; 32],
2022 payment_hash: PaymentHash, amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>) -> Result<PendingHTLCInfo, ReceiveError>
2024 // final_incorrect_cltv_expiry
2025 if hop_data.outgoing_cltv_value != cltv_expiry {
2026 return Err(ReceiveError {
2027 msg: "Upstream node set CLTV to the wrong value",
2029 err_data: cltv_expiry.to_be_bytes().to_vec()
2032 // final_expiry_too_soon
2033 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
2034 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
2036 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
2037 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
2038 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
2039 let current_height: u32 = self.best_block.read().unwrap().height();
2040 if (hop_data.outgoing_cltv_value as u64) <= current_height as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
2041 let mut err_data = Vec::with_capacity(12);
2042 err_data.extend_from_slice(&amt_msat.to_be_bytes());
2043 err_data.extend_from_slice(¤t_height.to_be_bytes());
2044 return Err(ReceiveError {
2045 err_code: 0x4000 | 15, err_data,
2046 msg: "The final CLTV expiry is too soon to handle",
2049 if hop_data.amt_to_forward > amt_msat {
2050 return Err(ReceiveError {
2052 err_data: amt_msat.to_be_bytes().to_vec(),
2053 msg: "Upstream node sent less than we were supposed to receive in payment",
2057 let routing = match hop_data.format {
2058 msgs::OnionHopDataFormat::NonFinalNode { .. } => {
2059 return Err(ReceiveError {
2060 err_code: 0x4000|22,
2061 err_data: Vec::new(),
2062 msg: "Got non final data with an HMAC of 0",
2065 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage } => {
2066 if payment_data.is_some() && keysend_preimage.is_some() {
2067 return Err(ReceiveError {
2068 err_code: 0x4000|22,
2069 err_data: Vec::new(),
2070 msg: "We don't support MPP keysend payments",
2072 } else if let Some(data) = payment_data {
2073 PendingHTLCRouting::Receive {
2075 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2076 phantom_shared_secret,
2078 } else if let Some(payment_preimage) = keysend_preimage {
2079 // We need to check that the sender knows the keysend preimage before processing this
2080 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
2081 // could discover the final destination of X, by probing the adjacent nodes on the route
2082 // with a keysend payment of identical payment hash to X and observing the processing
2083 // time discrepancies due to a hash collision with X.
2084 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2085 if hashed_preimage != payment_hash {
2086 return Err(ReceiveError {
2087 err_code: 0x4000|22,
2088 err_data: Vec::new(),
2089 msg: "Payment preimage didn't match payment hash",
2093 PendingHTLCRouting::ReceiveKeysend {
2095 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2098 return Err(ReceiveError {
2099 err_code: 0x4000|0x2000|3,
2100 err_data: Vec::new(),
2101 msg: "We require payment_secrets",
2106 Ok(PendingHTLCInfo {
2109 incoming_shared_secret: shared_secret,
2110 incoming_amt_msat: Some(amt_msat),
2111 outgoing_amt_msat: amt_msat,
2112 outgoing_cltv_value: hop_data.outgoing_cltv_value,
2116 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> PendingHTLCStatus {
2117 macro_rules! return_malformed_err {
2118 ($msg: expr, $err_code: expr) => {
2120 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2121 return PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
2122 channel_id: msg.channel_id,
2123 htlc_id: msg.htlc_id,
2124 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
2125 failure_code: $err_code,
2131 if let Err(_) = msg.onion_routing_packet.public_key {
2132 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2135 let shared_secret = self.node_signer.ecdh(
2136 Recipient::Node, &msg.onion_routing_packet.public_key.unwrap(), None
2137 ).unwrap().secret_bytes();
2139 if msg.onion_routing_packet.version != 0 {
2140 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2141 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2142 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2143 //receiving node would have to brute force to figure out which version was put in the
2144 //packet by the node that send us the message, in the case of hashing the hop_data, the
2145 //node knows the HMAC matched, so they already know what is there...
2146 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2148 macro_rules! return_err {
2149 ($msg: expr, $err_code: expr, $data: expr) => {
2151 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2152 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2153 channel_id: msg.channel_id,
2154 htlc_id: msg.htlc_id,
2155 reason: HTLCFailReason::reason($err_code, $data.to_vec())
2156 .get_encrypted_failure_packet(&shared_secret, &None),
2162 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) {
2164 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2165 return_malformed_err!(err_msg, err_code);
2167 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2168 return_err!(err_msg, err_code, &[0; 0]);
2172 let pending_forward_info = match next_hop {
2173 onion_utils::Hop::Receive(next_hop_data) => {
2175 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash, msg.amount_msat, msg.cltv_expiry, None) {
2177 // Note that we could obviously respond immediately with an update_fulfill_htlc
2178 // message, however that would leak that we are the recipient of this payment, so
2179 // instead we stay symmetric with the forwarding case, only responding (after a
2180 // delay) once they've send us a commitment_signed!
2181 PendingHTLCStatus::Forward(info)
2183 Err(ReceiveError { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
2186 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
2187 let new_pubkey = msg.onion_routing_packet.public_key.unwrap();
2188 let outgoing_packet = msgs::OnionPacket {
2190 public_key: onion_utils::next_hop_packet_pubkey(&self.secp_ctx, new_pubkey, &shared_secret),
2191 hop_data: new_packet_bytes,
2192 hmac: next_hop_hmac.clone(),
2195 let short_channel_id = match next_hop_data.format {
2196 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
2197 msgs::OnionHopDataFormat::FinalNode { .. } => {
2198 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
2202 PendingHTLCStatus::Forward(PendingHTLCInfo {
2203 routing: PendingHTLCRouting::Forward {
2204 onion_packet: outgoing_packet,
2207 payment_hash: msg.payment_hash.clone(),
2208 incoming_shared_secret: shared_secret,
2209 incoming_amt_msat: Some(msg.amount_msat),
2210 outgoing_amt_msat: next_hop_data.amt_to_forward,
2211 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
2216 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref outgoing_amt_msat, ref outgoing_cltv_value, .. }) = &pending_forward_info {
2217 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
2218 // with a short_channel_id of 0. This is important as various things later assume
2219 // short_channel_id is non-0 in any ::Forward.
2220 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
2221 if let Some((err, mut code, chan_update)) = loop {
2222 let id_option = self.short_to_chan_info.read().unwrap().get(short_channel_id).cloned();
2223 let forwarding_chan_info_opt = match id_option {
2224 None => { // unknown_next_peer
2225 // Note that this is likely a timing oracle for detecting whether an scid is a
2226 // phantom or an intercept.
2227 if (self.default_configuration.accept_intercept_htlcs &&
2228 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, *short_channel_id, &self.genesis_hash)) ||
2229 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, *short_channel_id, &self.genesis_hash)
2233 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2236 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
2238 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
2239 let per_peer_state = self.per_peer_state.read().unwrap();
2240 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
2241 if peer_state_mutex_opt.is_none() {
2242 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2244 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
2245 let peer_state = &mut *peer_state_lock;
2246 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id) {
2248 // Channel was removed. The short_to_chan_info and channel_by_id maps
2249 // have no consistency guarantees.
2250 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2254 if !chan.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
2255 // Note that the behavior here should be identical to the above block - we
2256 // should NOT reveal the existence or non-existence of a private channel if
2257 // we don't allow forwards outbound over them.
2258 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
2260 if chan.get_channel_type().supports_scid_privacy() && *short_channel_id != chan.outbound_scid_alias() {
2261 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
2262 // "refuse to forward unless the SCID alias was used", so we pretend
2263 // we don't have the channel here.
2264 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
2266 let chan_update_opt = self.get_channel_update_for_onion(*short_channel_id, chan).ok();
2268 // Note that we could technically not return an error yet here and just hope
2269 // that the connection is reestablished or monitor updated by the time we get
2270 // around to doing the actual forward, but better to fail early if we can and
2271 // hopefully an attacker trying to path-trace payments cannot make this occur
2272 // on a small/per-node/per-channel scale.
2273 if !chan.is_live() { // channel_disabled
2274 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, chan_update_opt));
2276 if *outgoing_amt_msat < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
2277 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
2279 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, *outgoing_amt_msat, *outgoing_cltv_value) {
2280 break Some((err, code, chan_update_opt));
2284 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 {
2285 // We really should set `incorrect_cltv_expiry` here but as we're not
2286 // forwarding over a real channel we can't generate a channel_update
2287 // for it. Instead we just return a generic temporary_node_failure.
2289 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
2296 let cur_height = self.best_block.read().unwrap().height() + 1;
2297 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
2298 // but we want to be robust wrt to counterparty packet sanitization (see
2299 // HTLC_FAIL_BACK_BUFFER rationale).
2300 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
2301 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
2303 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
2304 break Some(("CLTV expiry is too far in the future", 21, None));
2306 // If the HTLC expires ~now, don't bother trying to forward it to our
2307 // counterparty. They should fail it anyway, but we don't want to bother with
2308 // the round-trips or risk them deciding they definitely want the HTLC and
2309 // force-closing to ensure they get it if we're offline.
2310 // We previously had a much more aggressive check here which tried to ensure
2311 // our counterparty receives an HTLC which has *our* risk threshold met on it,
2312 // but there is no need to do that, and since we're a bit conservative with our
2313 // risk threshold it just results in failing to forward payments.
2314 if (*outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
2315 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
2321 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
2322 if let Some(chan_update) = chan_update {
2323 if code == 0x1000 | 11 || code == 0x1000 | 12 {
2324 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
2326 else if code == 0x1000 | 13 {
2327 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
2329 else if code == 0x1000 | 20 {
2330 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
2331 0u16.write(&mut res).expect("Writes cannot fail");
2333 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
2334 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
2335 chan_update.write(&mut res).expect("Writes cannot fail");
2336 } else if code & 0x1000 == 0x1000 {
2337 // If we're trying to return an error that requires a `channel_update` but
2338 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
2339 // generate an update), just use the generic "temporary_node_failure"
2343 return_err!(err, code, &res.0[..]);
2348 pending_forward_info
2351 /// Gets the current channel_update for the given channel. This first checks if the channel is
2352 /// public, and thus should be called whenever the result is going to be passed out in a
2353 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
2355 /// Note that in `internal_closing_signed`, this function is called without the `peer_state`
2356 /// corresponding to the channel's counterparty locked, as the channel been removed from the
2357 /// storage and the `peer_state` lock has been dropped.
2358 fn get_channel_update_for_broadcast(&self, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2359 if !chan.should_announce() {
2360 return Err(LightningError {
2361 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
2362 action: msgs::ErrorAction::IgnoreError
2365 if chan.get_short_channel_id().is_none() {
2366 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
2368 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.channel_id()));
2369 self.get_channel_update_for_unicast(chan)
2372 /// Gets the current channel_update for the given channel. This does not check if the channel
2373 /// is public (only returning an Err if the channel does not yet have an assigned short_id),
2374 /// and thus MUST NOT be called unless the recipient of the resulting message has already
2375 /// provided evidence that they know about the existence of the channel.
2377 /// Note that through `internal_closing_signed`, this function is called without the
2378 /// `peer_state` corresponding to the channel's counterparty locked, as the channel been
2379 /// removed from the storage and the `peer_state` lock has been dropped.
2380 fn get_channel_update_for_unicast(&self, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2381 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.channel_id()));
2382 let short_channel_id = match chan.get_short_channel_id().or(chan.latest_inbound_scid_alias()) {
2383 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
2387 self.get_channel_update_for_onion(short_channel_id, chan)
2389 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2390 log_trace!(self.logger, "Generating channel update for channel {}", log_bytes!(chan.channel_id()));
2391 let were_node_one = self.our_network_pubkey.serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
2393 let unsigned = msgs::UnsignedChannelUpdate {
2394 chain_hash: self.genesis_hash,
2396 timestamp: chan.get_update_time_counter(),
2397 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
2398 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
2399 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
2400 htlc_maximum_msat: chan.get_announced_htlc_max_msat(),
2401 fee_base_msat: chan.get_outbound_forwarding_fee_base_msat(),
2402 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
2403 excess_data: Vec::new(),
2405 // Panic on failure to signal LDK should be restarted to retry signing the `ChannelUpdate`.
2406 // If we returned an error and the `node_signer` cannot provide a signature for whatever
2407 // reason`, we wouldn't be able to receive inbound payments through the corresponding
2409 let sig = self.node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelUpdate(&unsigned)).unwrap();
2411 Ok(msgs::ChannelUpdate {
2418 pub(crate) fn test_send_payment_along_path(&self, path: &Vec<RouteHop>, payment_params: &Option<PaymentParameters>, payment_hash: &PaymentHash, payment_secret: &Option<PaymentSecret>, total_value: u64, cur_height: u32, payment_id: PaymentId, keysend_preimage: &Option<PaymentPreimage>, session_priv_bytes: [u8; 32]) -> Result<(), APIError> {
2419 let _lck = self.total_consistency_lock.read().unwrap();
2420 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv_bytes)
2423 fn send_payment_along_path(&self, path: &Vec<RouteHop>, payment_params: &Option<PaymentParameters>, payment_hash: &PaymentHash, payment_secret: &Option<PaymentSecret>, total_value: u64, cur_height: u32, payment_id: PaymentId, keysend_preimage: &Option<PaymentPreimage>, session_priv_bytes: [u8; 32]) -> Result<(), APIError> {
2424 // The top-level caller should hold the total_consistency_lock read lock.
2425 debug_assert!(self.total_consistency_lock.try_write().is_err());
2427 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
2428 let prng_seed = self.entropy_source.get_secure_random_bytes();
2429 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
2431 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
2432 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected".to_owned()})?;
2433 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
2434 if onion_utils::route_size_insane(&onion_payloads) {
2435 return Err(APIError::InvalidRoute{err: "Route size too large considering onion data".to_owned()});
2437 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
2439 let err: Result<(), _> = loop {
2440 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.first().unwrap().short_channel_id) {
2441 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
2442 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
2445 let per_peer_state = self.per_peer_state.read().unwrap();
2446 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
2447 .ok_or_else(|| APIError::ChannelUnavailable{err: "No peer matching the path's first hop found!".to_owned() })?;
2448 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2449 let peer_state = &mut *peer_state_lock;
2450 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(id) {
2451 if !chan.get().is_live() {
2452 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected".to_owned()});
2454 let funding_txo = chan.get().get_funding_txo().unwrap();
2455 let send_res = chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(),
2456 htlc_cltv, HTLCSource::OutboundRoute {
2458 session_priv: session_priv.clone(),
2459 first_hop_htlc_msat: htlc_msat,
2461 payment_secret: payment_secret.clone(),
2462 payment_params: payment_params.clone(),
2463 }, onion_packet, &self.logger);
2464 match break_chan_entry!(self, send_res, chan) {
2465 Some(monitor_update) => {
2466 let update_id = monitor_update.update_id;
2467 let update_res = self.chain_monitor.update_channel(funding_txo, monitor_update);
2468 if let Err(e) = handle_new_monitor_update!(self, update_res, update_id, peer_state_lock, peer_state, per_peer_state, chan) {
2471 if update_res == ChannelMonitorUpdateStatus::InProgress {
2472 // Note that MonitorUpdateInProgress here indicates (per function
2473 // docs) that we will resend the commitment update once monitor
2474 // updating completes. Therefore, we must return an error
2475 // indicating that it is unsafe to retry the payment wholesale,
2476 // which we do in the send_payment check for
2477 // MonitorUpdateInProgress, below.
2478 return Err(APIError::MonitorUpdateInProgress);
2484 // The channel was likely removed after we fetched the id from the
2485 // `short_to_chan_info` map, but before we successfully locked the
2486 // `channel_by_id` map.
2487 // This can occur as no consistency guarantees exists between the two maps.
2488 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
2493 match handle_error!(self, err, path.first().unwrap().pubkey) {
2494 Ok(_) => unreachable!(),
2496 Err(APIError::ChannelUnavailable { err: e.err })
2501 /// Sends a payment along a given route.
2503 /// Value parameters are provided via the last hop in route, see documentation for [`RouteHop`]
2504 /// fields for more info.
2506 /// May generate SendHTLCs message(s) event on success, which should be relayed (e.g. via
2507 /// [`PeerManager::process_events`]).
2509 /// # Avoiding Duplicate Payments
2511 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
2512 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
2513 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
2514 /// [`Event::PaymentSent`] or [`Event::PaymentFailed`]) LDK will not stop you from sending a
2515 /// second payment with the same [`PaymentId`].
2517 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
2518 /// tracking of payments, including state to indicate once a payment has completed. Because you
2519 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
2520 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
2521 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
2523 /// Additionally, in the scenario where we begin the process of sending a payment, but crash
2524 /// before `send_payment` returns (or prior to [`ChannelMonitorUpdate`] persistence if you're
2525 /// using [`ChannelMonitorUpdateStatus::InProgress`]), the payment may be lost on restart. See
2526 /// [`ChannelManager::list_recent_payments`] for more information.
2528 /// # Possible Error States on [`PaymentSendFailure`]
2530 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
2531 /// each entry matching the corresponding-index entry in the route paths, see
2532 /// [`PaymentSendFailure`] for more info.
2534 /// In general, a path may raise:
2535 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
2536 /// node public key) is specified.
2537 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
2538 /// (including due to previous monitor update failure or new permanent monitor update
2540 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
2541 /// relevant updates.
2543 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
2544 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
2545 /// different route unless you intend to pay twice!
2547 /// # A caution on `payment_secret`
2549 /// `payment_secret` is unrelated to `payment_hash` (or [`PaymentPreimage`]) and exists to
2550 /// authenticate the sender to the recipient and prevent payment-probing (deanonymization)
2551 /// attacks. For newer nodes, it will be provided to you in the invoice. If you do not have one,
2552 /// the [`Route`] must not contain multiple paths as multi-path payments require a
2553 /// recipient-provided `payment_secret`.
2555 /// If a `payment_secret` *is* provided, we assume that the invoice had the payment_secret
2556 /// feature bit set (either as required or as available). If multiple paths are present in the
2557 /// [`Route`], we assume the invoice had the basic_mpp feature set.
2559 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2560 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
2561 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
2562 /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
2563 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2564 let best_block_height = self.best_block.read().unwrap().height();
2565 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2566 self.pending_outbound_payments
2567 .send_payment_with_route(route, payment_hash, payment_secret, payment_id, &self.entropy_source, &self.node_signer, best_block_height,
2568 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2569 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2572 /// Similar to [`ChannelManager::send_payment`], but will automatically find a route based on
2573 /// `route_params` and retry failed payment paths based on `retry_strategy`.
2574 pub fn send_payment_with_retry(&self, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<(), RetryableSendFailure> {
2575 let best_block_height = self.best_block.read().unwrap().height();
2576 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2577 self.pending_outbound_payments
2578 .send_payment(payment_hash, payment_secret, payment_id, retry_strategy, route_params,
2579 &self.router, self.list_usable_channels(), || self.compute_inflight_htlcs(),
2580 &self.entropy_source, &self.node_signer, best_block_height, &self.logger,
2581 &self.pending_events,
2582 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2583 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2587 fn test_send_payment_internal(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>, onion_session_privs: Vec<[u8; 32]>) -> Result<(), PaymentSendFailure> {
2588 let best_block_height = self.best_block.read().unwrap().height();
2589 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2590 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, payment_secret, keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.node_signer, best_block_height,
2591 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2592 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2596 pub(crate) fn test_add_new_pending_payment(&self, payment_hash: PaymentHash, payment_secret: Option<PaymentSecret>, payment_id: PaymentId, route: &Route) -> Result<Vec<[u8; 32]>, PaymentSendFailure> {
2597 let best_block_height = self.best_block.read().unwrap().height();
2598 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, payment_secret, payment_id, route, None, &self.entropy_source, best_block_height)
2602 /// Signals that no further retries for the given payment should occur. Useful if you have a
2603 /// pending outbound payment with retries remaining, but wish to stop retrying the payment before
2604 /// retries are exhausted.
2606 /// If no [`Event::PaymentFailed`] event had been generated before, one will be generated as soon
2607 /// as there are no remaining pending HTLCs for this payment.
2609 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
2610 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
2611 /// determine the ultimate status of a payment.
2613 /// If an [`Event::PaymentFailed`] event is generated and we restart without this
2614 /// [`ChannelManager`] having been persisted, another [`Event::PaymentFailed`] may be generated.
2616 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
2617 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2618 pub fn abandon_payment(&self, payment_id: PaymentId) {
2619 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2620 self.pending_outbound_payments.abandon_payment(payment_id, &self.pending_events);
2623 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
2624 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
2625 /// the preimage, it must be a cryptographically secure random value that no intermediate node
2626 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
2627 /// never reach the recipient.
2629 /// See [`send_payment`] documentation for more details on the return value of this function
2630 /// and idempotency guarantees provided by the [`PaymentId`] key.
2632 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
2633 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
2635 /// Note that `route` must have exactly one path.
2637 /// [`send_payment`]: Self::send_payment
2638 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
2639 let best_block_height = self.best_block.read().unwrap().height();
2640 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2641 self.pending_outbound_payments.send_spontaneous_payment_with_route(
2642 route, payment_preimage, payment_id, &self.entropy_source, &self.node_signer,
2644 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2645 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2648 /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
2649 /// based on `route_params` and retry failed payment paths based on `retry_strategy`.
2651 /// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous
2654 /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
2655 pub fn send_spontaneous_payment_with_retry(&self, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<PaymentHash, RetryableSendFailure> {
2656 let best_block_height = self.best_block.read().unwrap().height();
2657 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2658 self.pending_outbound_payments.send_spontaneous_payment(payment_preimage, payment_id,
2659 retry_strategy, route_params, &self.router, self.list_usable_channels(),
2660 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
2661 &self.logger, &self.pending_events,
2662 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2663 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2666 /// Send a payment that is probing the given route for liquidity. We calculate the
2667 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
2668 /// us to easily discern them from real payments.
2669 pub fn send_probe(&self, hops: Vec<RouteHop>) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
2670 let best_block_height = self.best_block.read().unwrap().height();
2671 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2672 self.pending_outbound_payments.send_probe(hops, self.probing_cookie_secret, &self.entropy_source, &self.node_signer, best_block_height,
2673 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2674 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2677 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
2680 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
2681 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
2684 /// Handles the generation of a funding transaction, optionally (for tests) with a function
2685 /// which checks the correctness of the funding transaction given the associated channel.
2686 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<<SP::Target as SignerProvider>::Signer>, &Transaction) -> Result<OutPoint, APIError>>(
2687 &self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
2688 ) -> Result<(), APIError> {
2689 let per_peer_state = self.per_peer_state.read().unwrap();
2690 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2691 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2693 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2694 let peer_state = &mut *peer_state_lock;
2697 match peer_state.channel_by_id.remove(temporary_channel_id) {
2699 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
2701 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
2702 .map_err(|e| if let ChannelError::Close(msg) = e {
2703 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.get_user_id(), chan.force_shutdown(true), None)
2704 } else { unreachable!(); })
2707 None => { 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) }) },
2710 match handle_error!(self, res, chan.get_counterparty_node_id()) {
2711 Ok(funding_msg) => {
2714 Err(_) => { return Err(APIError::ChannelUnavailable {
2715 err: "Signer refused to sign the initial commitment transaction".to_owned()
2720 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
2721 node_id: chan.get_counterparty_node_id(),
2724 match peer_state.channel_by_id.entry(chan.channel_id()) {
2725 hash_map::Entry::Occupied(_) => {
2726 panic!("Generated duplicate funding txid?");
2728 hash_map::Entry::Vacant(e) => {
2729 let mut id_to_peer = self.id_to_peer.lock().unwrap();
2730 if id_to_peer.insert(chan.channel_id(), chan.get_counterparty_node_id()).is_some() {
2731 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
2740 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> {
2741 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
2742 Ok(OutPoint { txid: tx.txid(), index: output_index })
2746 /// Call this upon creation of a funding transaction for the given channel.
2748 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
2749 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
2751 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
2752 /// across the p2p network.
2754 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
2755 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
2757 /// May panic if the output found in the funding transaction is duplicative with some other
2758 /// channel (note that this should be trivially prevented by using unique funding transaction
2759 /// keys per-channel).
2761 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
2762 /// counterparty's signature the funding transaction will automatically be broadcast via the
2763 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
2765 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
2766 /// not currently support replacing a funding transaction on an existing channel. Instead,
2767 /// create a new channel with a conflicting funding transaction.
2769 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
2770 /// the wallet software generating the funding transaction to apply anti-fee sniping as
2771 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
2772 /// for more details.
2774 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
2775 /// [`Event::ChannelClosed`]: crate::util::events::Event::ChannelClosed
2776 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
2777 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2779 for inp in funding_transaction.input.iter() {
2780 if inp.witness.is_empty() {
2781 return Err(APIError::APIMisuseError {
2782 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
2787 let height = self.best_block.read().unwrap().height();
2788 // Transactions are evaluated as final by network mempools at the next block. However, the modules
2789 // constituting our Lightning node might not have perfect sync about their blockchain views. Thus, if
2790 // the wallet module is in advance on the LDK view, allow one more block of headroom.
2791 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 + 2 {
2792 return Err(APIError::APIMisuseError {
2793 err: "Funding transaction absolute timelock is non-final".to_owned()
2797 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
2798 let mut output_index = None;
2799 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
2800 for (idx, outp) in tx.output.iter().enumerate() {
2801 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
2802 if output_index.is_some() {
2803 return Err(APIError::APIMisuseError {
2804 err: "Multiple outputs matched the expected script and value".to_owned()
2807 if idx > u16::max_value() as usize {
2808 return Err(APIError::APIMisuseError {
2809 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
2812 output_index = Some(idx as u16);
2815 if output_index.is_none() {
2816 return Err(APIError::APIMisuseError {
2817 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
2820 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
2824 /// Atomically updates the [`ChannelConfig`] for the given channels.
2826 /// Once the updates are applied, each eligible channel (advertised with a known short channel
2827 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
2828 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
2829 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
2831 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
2832 /// `counterparty_node_id` is provided.
2834 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
2835 /// below [`MIN_CLTV_EXPIRY_DELTA`].
2837 /// If an error is returned, none of the updates should be considered applied.
2839 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
2840 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
2841 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
2842 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
2843 /// [`ChannelUpdate`]: msgs::ChannelUpdate
2844 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
2845 /// [`APIMisuseError`]: APIError::APIMisuseError
2846 pub fn update_channel_config(
2847 &self, counterparty_node_id: &PublicKey, channel_ids: &[[u8; 32]], config: &ChannelConfig,
2848 ) -> Result<(), APIError> {
2849 if config.cltv_expiry_delta < MIN_CLTV_EXPIRY_DELTA {
2850 return Err(APIError::APIMisuseError {
2851 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
2855 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(
2856 &self.total_consistency_lock, &self.persistence_notifier,
2858 let per_peer_state = self.per_peer_state.read().unwrap();
2859 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2860 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2861 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2862 let peer_state = &mut *peer_state_lock;
2863 for channel_id in channel_ids {
2864 if !peer_state.channel_by_id.contains_key(channel_id) {
2865 return Err(APIError::ChannelUnavailable {
2866 err: format!("Channel with ID {} was not found for the passed counterparty_node_id {}", log_bytes!(*channel_id), counterparty_node_id),
2870 for channel_id in channel_ids {
2871 let channel = peer_state.channel_by_id.get_mut(channel_id).unwrap();
2872 if !channel.update_config(config) {
2875 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
2876 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
2877 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
2878 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
2879 node_id: channel.get_counterparty_node_id(),
2887 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
2888 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
2890 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
2891 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
2893 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
2894 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
2895 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
2896 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
2897 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
2899 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
2900 /// you from forwarding more than you received.
2902 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
2905 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
2906 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
2907 // TODO: when we move to deciding the best outbound channel at forward time, only take
2908 // `next_node_id` and not `next_hop_channel_id`
2909 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> {
2910 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2912 let next_hop_scid = {
2913 let peer_state_lock = self.per_peer_state.read().unwrap();
2914 let peer_state_mutex = peer_state_lock.get(&next_node_id)
2915 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) })?;
2916 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2917 let peer_state = &mut *peer_state_lock;
2918 match peer_state.channel_by_id.get(next_hop_channel_id) {
2920 if !chan.is_usable() {
2921 return Err(APIError::ChannelUnavailable {
2922 err: format!("Channel with id {} not fully established", log_bytes!(*next_hop_channel_id))
2925 chan.get_short_channel_id().unwrap_or(chan.outbound_scid_alias())
2927 None => return Err(APIError::ChannelUnavailable {
2928 err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*next_hop_channel_id), next_node_id)
2933 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
2934 .ok_or_else(|| APIError::APIMisuseError {
2935 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
2938 let routing = match payment.forward_info.routing {
2939 PendingHTLCRouting::Forward { onion_packet, .. } => {
2940 PendingHTLCRouting::Forward { onion_packet, short_channel_id: next_hop_scid }
2942 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
2944 let pending_htlc_info = PendingHTLCInfo {
2945 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
2948 let mut per_source_pending_forward = [(
2949 payment.prev_short_channel_id,
2950 payment.prev_funding_outpoint,
2951 payment.prev_user_channel_id,
2952 vec![(pending_htlc_info, payment.prev_htlc_id)]
2954 self.forward_htlcs(&mut per_source_pending_forward);
2958 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
2959 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
2961 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
2964 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
2965 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
2966 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2968 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
2969 .ok_or_else(|| APIError::APIMisuseError {
2970 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
2973 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
2974 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2975 short_channel_id: payment.prev_short_channel_id,
2976 outpoint: payment.prev_funding_outpoint,
2977 htlc_id: payment.prev_htlc_id,
2978 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
2979 phantom_shared_secret: None,
2982 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
2983 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
2984 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
2985 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
2990 /// Processes HTLCs which are pending waiting on random forward delay.
2992 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
2993 /// Will likely generate further events.
2994 pub fn process_pending_htlc_forwards(&self) {
2995 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2997 let mut new_events = Vec::new();
2998 let mut failed_forwards = Vec::new();
2999 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
3001 let mut forward_htlcs = HashMap::new();
3002 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
3004 for (short_chan_id, mut pending_forwards) in forward_htlcs {
3005 if short_chan_id != 0 {
3006 macro_rules! forwarding_channel_not_found {
3008 for forward_info in pending_forwards.drain(..) {
3009 match forward_info {
3010 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3011 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3012 forward_info: PendingHTLCInfo {
3013 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
3014 outgoing_cltv_value, incoming_amt_msat: _
3017 macro_rules! failure_handler {
3018 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
3019 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3021 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3022 short_channel_id: prev_short_channel_id,
3023 outpoint: prev_funding_outpoint,
3024 htlc_id: prev_htlc_id,
3025 incoming_packet_shared_secret: incoming_shared_secret,
3026 phantom_shared_secret: $phantom_ss,
3029 let reason = if $next_hop_unknown {
3030 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
3032 HTLCDestination::FailedPayment{ payment_hash }
3035 failed_forwards.push((htlc_source, payment_hash,
3036 HTLCFailReason::reason($err_code, $err_data),
3042 macro_rules! fail_forward {
3043 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3045 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
3049 macro_rules! failed_payment {
3050 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3052 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
3056 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
3057 let phantom_pubkey_res = self.node_signer.get_node_id(Recipient::PhantomNode);
3058 if phantom_pubkey_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.genesis_hash) {
3059 let phantom_shared_secret = self.node_signer.ecdh(Recipient::PhantomNode, &onion_packet.public_key.unwrap(), None).unwrap().secret_bytes();
3060 let next_hop = match onion_utils::decode_next_payment_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
3062 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
3063 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
3064 // In this scenario, the phantom would have sent us an
3065 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
3066 // if it came from us (the second-to-last hop) but contains the sha256
3068 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
3070 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3071 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
3075 onion_utils::Hop::Receive(hop_data) => {
3076 match self.construct_recv_pending_htlc_info(hop_data, incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value, Some(phantom_shared_secret)) {
3077 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
3078 Err(ReceiveError { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
3084 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3087 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3090 HTLCForwardInfo::FailHTLC { .. } => {
3091 // Channel went away before we could fail it. This implies
3092 // the channel is now on chain and our counterparty is
3093 // trying to broadcast the HTLC-Timeout, but that's their
3094 // problem, not ours.
3100 let (counterparty_node_id, forward_chan_id) = match self.short_to_chan_info.read().unwrap().get(&short_chan_id) {
3101 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3103 forwarding_channel_not_found!();
3107 let per_peer_state = self.per_peer_state.read().unwrap();
3108 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3109 if peer_state_mutex_opt.is_none() {
3110 forwarding_channel_not_found!();
3113 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
3114 let peer_state = &mut *peer_state_lock;
3115 match peer_state.channel_by_id.entry(forward_chan_id) {
3116 hash_map::Entry::Vacant(_) => {
3117 forwarding_channel_not_found!();
3120 hash_map::Entry::Occupied(mut chan) => {
3121 for forward_info in pending_forwards.drain(..) {
3122 match forward_info {
3123 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3124 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id: _,
3125 forward_info: PendingHTLCInfo {
3126 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
3127 routing: PendingHTLCRouting::Forward { onion_packet, .. }, incoming_amt_msat: _,
3130 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);
3131 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3132 short_channel_id: prev_short_channel_id,
3133 outpoint: prev_funding_outpoint,
3134 htlc_id: prev_htlc_id,
3135 incoming_packet_shared_secret: incoming_shared_secret,
3136 // Phantom payments are only PendingHTLCRouting::Receive.
3137 phantom_shared_secret: None,
3139 if let Err(e) = chan.get_mut().queue_add_htlc(outgoing_amt_msat,
3140 payment_hash, outgoing_cltv_value, htlc_source.clone(),
3141 onion_packet, &self.logger)
3143 if let ChannelError::Ignore(msg) = e {
3144 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
3146 panic!("Stated return value requirements in send_htlc() were not met");
3148 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan.get());
3149 failed_forwards.push((htlc_source, payment_hash,
3150 HTLCFailReason::reason(failure_code, data),
3151 HTLCDestination::NextHopChannel { node_id: Some(chan.get().get_counterparty_node_id()), channel_id: forward_chan_id }
3156 HTLCForwardInfo::AddHTLC { .. } => {
3157 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
3159 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
3160 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
3161 if let Err(e) = chan.get_mut().queue_fail_htlc(
3162 htlc_id, err_packet, &self.logger
3164 if let ChannelError::Ignore(msg) = e {
3165 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
3167 panic!("Stated return value requirements in queue_fail_htlc() were not met");
3169 // fail-backs are best-effort, we probably already have one
3170 // pending, and if not that's OK, if not, the channel is on
3171 // the chain and sending the HTLC-Timeout is their problem.
3180 for forward_info in pending_forwards.drain(..) {
3181 match forward_info {
3182 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3183 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3184 forward_info: PendingHTLCInfo {
3185 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat, ..
3188 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret) = match routing {
3189 PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry, phantom_shared_secret } => {
3190 let _legacy_hop_data = Some(payment_data.clone());
3191 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data }, Some(payment_data), phantom_shared_secret)
3193 PendingHTLCRouting::ReceiveKeysend { payment_preimage, incoming_cltv_expiry } =>
3194 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage), None, None),
3196 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
3199 let claimable_htlc = ClaimableHTLC {
3200 prev_hop: HTLCPreviousHopData {
3201 short_channel_id: prev_short_channel_id,
3202 outpoint: prev_funding_outpoint,
3203 htlc_id: prev_htlc_id,
3204 incoming_packet_shared_secret: incoming_shared_secret,
3205 phantom_shared_secret,
3207 value: outgoing_amt_msat,
3209 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
3214 macro_rules! fail_htlc {
3215 ($htlc: expr, $payment_hash: expr) => {
3216 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
3217 htlc_msat_height_data.extend_from_slice(
3218 &self.best_block.read().unwrap().height().to_be_bytes(),
3220 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
3221 short_channel_id: $htlc.prev_hop.short_channel_id,
3222 outpoint: prev_funding_outpoint,
3223 htlc_id: $htlc.prev_hop.htlc_id,
3224 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
3225 phantom_shared_secret,
3227 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
3228 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
3232 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
3233 let mut receiver_node_id = self.our_network_pubkey;
3234 if phantom_shared_secret.is_some() {
3235 receiver_node_id = self.node_signer.get_node_id(Recipient::PhantomNode)
3236 .expect("Failed to get node_id for phantom node recipient");
3239 macro_rules! check_total_value {
3240 ($payment_data: expr, $payment_preimage: expr) => {{
3241 let mut payment_claimable_generated = false;
3243 events::PaymentPurpose::InvoicePayment {
3244 payment_preimage: $payment_preimage,
3245 payment_secret: $payment_data.payment_secret,
3248 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3249 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
3250 fail_htlc!(claimable_htlc, payment_hash);
3253 let (_, htlcs) = claimable_payments.claimable_htlcs.entry(payment_hash)
3254 .or_insert_with(|| (purpose(), Vec::new()));
3255 if htlcs.len() == 1 {
3256 if let OnionPayload::Spontaneous(_) = htlcs[0].onion_payload {
3257 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as we already had an existing keysend HTLC with the same payment hash", log_bytes!(payment_hash.0));
3258 fail_htlc!(claimable_htlc, payment_hash);
3262 let mut total_value = claimable_htlc.value;
3263 for htlc in htlcs.iter() {
3264 total_value += htlc.value;
3265 match &htlc.onion_payload {
3266 OnionPayload::Invoice { .. } => {
3267 if htlc.total_msat != $payment_data.total_msat {
3268 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
3269 log_bytes!(payment_hash.0), $payment_data.total_msat, htlc.total_msat);
3270 total_value = msgs::MAX_VALUE_MSAT;
3272 if total_value >= msgs::MAX_VALUE_MSAT { break; }
3274 _ => unreachable!(),
3277 if total_value >= msgs::MAX_VALUE_MSAT || total_value > $payment_data.total_msat {
3278 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
3279 log_bytes!(payment_hash.0), total_value, $payment_data.total_msat);
3280 fail_htlc!(claimable_htlc, payment_hash);
3281 } else if total_value == $payment_data.total_msat {
3282 let prev_channel_id = prev_funding_outpoint.to_channel_id();
3283 htlcs.push(claimable_htlc);
3284 new_events.push(events::Event::PaymentClaimable {
3285 receiver_node_id: Some(receiver_node_id),
3288 amount_msat: total_value,
3289 via_channel_id: Some(prev_channel_id),
3290 via_user_channel_id: Some(prev_user_channel_id),
3292 payment_claimable_generated = true;
3294 // Nothing to do - we haven't reached the total
3295 // payment value yet, wait until we receive more
3297 htlcs.push(claimable_htlc);
3299 payment_claimable_generated
3303 // Check that the payment hash and secret are known. Note that we
3304 // MUST take care to handle the "unknown payment hash" and
3305 // "incorrect payment secret" cases here identically or we'd expose
3306 // that we are the ultimate recipient of the given payment hash.
3307 // Further, we must not expose whether we have any other HTLCs
3308 // associated with the same payment_hash pending or not.
3309 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
3310 match payment_secrets.entry(payment_hash) {
3311 hash_map::Entry::Vacant(_) => {
3312 match claimable_htlc.onion_payload {
3313 OnionPayload::Invoice { .. } => {
3314 let payment_data = payment_data.unwrap();
3315 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) {
3316 Ok(result) => result,
3318 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as payment verification failed", log_bytes!(payment_hash.0));
3319 fail_htlc!(claimable_htlc, payment_hash);
3323 if let Some(min_final_cltv_expiry_delta) = min_final_cltv_expiry_delta {
3324 let expected_min_expiry_height = (self.current_best_block().height() + min_final_cltv_expiry_delta as u32) as u64;
3325 if (cltv_expiry as u64) < expected_min_expiry_height {
3326 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as its CLTV expiry was too soon (had {}, earliest expected {})",
3327 log_bytes!(payment_hash.0), cltv_expiry, expected_min_expiry_height);
3328 fail_htlc!(claimable_htlc, payment_hash);
3332 check_total_value!(payment_data, payment_preimage);
3334 OnionPayload::Spontaneous(preimage) => {
3335 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3336 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
3337 fail_htlc!(claimable_htlc, payment_hash);
3340 match claimable_payments.claimable_htlcs.entry(payment_hash) {
3341 hash_map::Entry::Vacant(e) => {
3342 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
3343 e.insert((purpose.clone(), vec![claimable_htlc]));
3344 let prev_channel_id = prev_funding_outpoint.to_channel_id();
3345 new_events.push(events::Event::PaymentClaimable {
3346 receiver_node_id: Some(receiver_node_id),
3348 amount_msat: outgoing_amt_msat,
3350 via_channel_id: Some(prev_channel_id),
3351 via_user_channel_id: Some(prev_user_channel_id),
3354 hash_map::Entry::Occupied(_) => {
3355 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
3356 fail_htlc!(claimable_htlc, payment_hash);
3362 hash_map::Entry::Occupied(inbound_payment) => {
3363 if payment_data.is_none() {
3364 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));
3365 fail_htlc!(claimable_htlc, payment_hash);
3368 let payment_data = payment_data.unwrap();
3369 if inbound_payment.get().payment_secret != payment_data.payment_secret {
3370 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
3371 fail_htlc!(claimable_htlc, payment_hash);
3372 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
3373 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
3374 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
3375 fail_htlc!(claimable_htlc, payment_hash);
3377 let payment_claimable_generated = check_total_value!(payment_data, inbound_payment.get().payment_preimage);
3378 if payment_claimable_generated {
3379 inbound_payment.remove_entry();
3385 HTLCForwardInfo::FailHTLC { .. } => {
3386 panic!("Got pending fail of our own HTLC");
3394 let best_block_height = self.best_block.read().unwrap().height();
3395 self.pending_outbound_payments.check_retry_payments(&self.router, || self.list_usable_channels(),
3396 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
3397 &self.pending_events, &self.logger,
3398 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
3399 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv));
3401 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
3402 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
3404 self.forward_htlcs(&mut phantom_receives);
3406 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
3407 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
3408 // nice to do the work now if we can rather than while we're trying to get messages in the
3410 self.check_free_holding_cells();
3412 if new_events.is_empty() { return }
3413 let mut events = self.pending_events.lock().unwrap();
3414 events.append(&mut new_events);
3417 /// Free the background events, generally called from timer_tick_occurred.
3419 /// Exposed for testing to allow us to process events quickly without generating accidental
3420 /// BroadcastChannelUpdate events in timer_tick_occurred.
3422 /// Expects the caller to have a total_consistency_lock read lock.
3423 fn process_background_events(&self) -> bool {
3424 let mut background_events = Vec::new();
3425 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
3426 if background_events.is_empty() {
3430 for event in background_events.drain(..) {
3432 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
3433 // The channel has already been closed, so no use bothering to care about the
3434 // monitor updating completing.
3435 let _ = self.chain_monitor.update_channel(funding_txo, &update);
3442 #[cfg(any(test, feature = "_test_utils"))]
3443 /// Process background events, for functional testing
3444 pub fn test_process_background_events(&self) {
3445 self.process_background_events();
3448 fn update_channel_fee(&self, chan_id: &[u8; 32], chan: &mut Channel<<SP::Target as SignerProvider>::Signer>, new_feerate: u32) -> NotifyOption {
3449 if !chan.is_outbound() { return NotifyOption::SkipPersist; }
3450 // If the feerate has decreased by less than half, don't bother
3451 if new_feerate <= chan.get_feerate() && new_feerate * 2 > chan.get_feerate() {
3452 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
3453 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3454 return NotifyOption::SkipPersist;
3456 if !chan.is_live() {
3457 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).",
3458 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3459 return NotifyOption::SkipPersist;
3461 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
3462 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3464 chan.queue_update_fee(new_feerate, &self.logger);
3465 NotifyOption::DoPersist
3469 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
3470 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
3471 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
3472 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
3473 pub fn maybe_update_chan_fees(&self) {
3474 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3475 let mut should_persist = NotifyOption::SkipPersist;
3477 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3479 let per_peer_state = self.per_peer_state.read().unwrap();
3480 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
3481 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3482 let peer_state = &mut *peer_state_lock;
3483 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
3484 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
3485 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3493 /// Performs actions which should happen on startup and roughly once per minute thereafter.
3495 /// This currently includes:
3496 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
3497 /// * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
3498 /// than a minute, informing the network that they should no longer attempt to route over
3500 /// * Expiring a channel's previous `ChannelConfig` if necessary to only allow forwarding HTLCs
3501 /// with the current `ChannelConfig`.
3502 /// * Removing peers which have disconnected but and no longer have any channels.
3504 /// Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
3505 /// estimate fetches.
3506 pub fn timer_tick_occurred(&self) {
3507 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3508 let mut should_persist = NotifyOption::SkipPersist;
3509 if self.process_background_events() { should_persist = NotifyOption::DoPersist; }
3511 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3513 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
3514 let mut timed_out_mpp_htlcs = Vec::new();
3515 let mut pending_peers_awaiting_removal = Vec::new();
3517 let per_peer_state = self.per_peer_state.read().unwrap();
3518 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
3519 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3520 let peer_state = &mut *peer_state_lock;
3521 let pending_msg_events = &mut peer_state.pending_msg_events;
3522 let counterparty_node_id = *counterparty_node_id;
3523 peer_state.channel_by_id.retain(|chan_id, chan| {
3524 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
3525 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3527 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
3528 let (needs_close, err) = convert_chan_err!(self, e, chan, chan_id);
3529 handle_errors.push((Err(err), counterparty_node_id));
3530 if needs_close { return false; }
3533 match chan.channel_update_status() {
3534 ChannelUpdateStatus::Enabled if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged),
3535 ChannelUpdateStatus::Disabled if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged),
3536 ChannelUpdateStatus::DisabledStaged if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
3537 ChannelUpdateStatus::EnabledStaged if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
3538 ChannelUpdateStatus::DisabledStaged if !chan.is_live() => {
3539 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3540 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3544 should_persist = NotifyOption::DoPersist;
3545 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
3547 ChannelUpdateStatus::EnabledStaged if chan.is_live() => {
3548 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3549 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3553 should_persist = NotifyOption::DoPersist;
3554 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
3559 chan.maybe_expire_prev_config();
3563 if peer_state.ok_to_remove(true) {
3564 pending_peers_awaiting_removal.push(counterparty_node_id);
3569 // When a peer disconnects but still has channels, the peer's `peer_state` entry in the
3570 // `per_peer_state` is not removed by the `peer_disconnected` function. If the channels
3571 // of to that peer is later closed while still being disconnected (i.e. force closed),
3572 // we therefore need to remove the peer from `peer_state` separately.
3573 // To avoid having to take the `per_peer_state` `write` lock once the channels are
3574 // closed, we instead remove such peers awaiting removal here on a timer, to limit the
3575 // negative effects on parallelism as much as possible.
3576 if pending_peers_awaiting_removal.len() > 0 {
3577 let mut per_peer_state = self.per_peer_state.write().unwrap();
3578 for counterparty_node_id in pending_peers_awaiting_removal {
3579 match per_peer_state.entry(counterparty_node_id) {
3580 hash_map::Entry::Occupied(entry) => {
3581 // Remove the entry if the peer is still disconnected and we still
3582 // have no channels to the peer.
3583 let remove_entry = {
3584 let peer_state = entry.get().lock().unwrap();
3585 peer_state.ok_to_remove(true)
3588 entry.remove_entry();
3591 hash_map::Entry::Vacant(_) => { /* The PeerState has already been removed */ }
3596 self.claimable_payments.lock().unwrap().claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
3597 if htlcs.is_empty() {
3598 // This should be unreachable
3599 debug_assert!(false);
3602 if let OnionPayload::Invoice { .. } = htlcs[0].onion_payload {
3603 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
3604 // In this case we're not going to handle any timeouts of the parts here.
3605 if htlcs[0].total_msat == htlcs.iter().fold(0, |total, htlc| total + htlc.value) {
3607 } else if htlcs.into_iter().any(|htlc| {
3608 htlc.timer_ticks += 1;
3609 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
3611 timed_out_mpp_htlcs.extend(htlcs.drain(..).map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
3618 for htlc_source in timed_out_mpp_htlcs.drain(..) {
3619 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
3620 let reason = HTLCFailReason::from_failure_code(23);
3621 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
3622 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
3625 for (err, counterparty_node_id) in handle_errors.drain(..) {
3626 let _ = handle_error!(self, err, counterparty_node_id);
3629 self.pending_outbound_payments.remove_stale_resolved_payments(&self.pending_events);
3631 // Technically we don't need to do this here, but if we have holding cell entries in a
3632 // channel that need freeing, it's better to do that here and block a background task
3633 // than block the message queueing pipeline.
3634 if self.check_free_holding_cells() {
3635 should_persist = NotifyOption::DoPersist;
3642 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
3643 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
3644 /// along the path (including in our own channel on which we received it).
3646 /// Note that in some cases around unclean shutdown, it is possible the payment may have
3647 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
3648 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
3649 /// may have already been failed automatically by LDK if it was nearing its expiration time.
3651 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
3652 /// [`ChannelManager::claim_funds`]), you should still monitor for
3653 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
3654 /// startup during which time claims that were in-progress at shutdown may be replayed.
3655 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
3656 self.fail_htlc_backwards_with_reason(payment_hash, &FailureCode::IncorrectOrUnknownPaymentDetails);
3659 /// This is a variant of [`ChannelManager::fail_htlc_backwards`] that allows you to specify the
3660 /// reason for the failure.
3662 /// See [`FailureCode`] for valid failure codes.
3663 pub fn fail_htlc_backwards_with_reason(&self, payment_hash: &PaymentHash, failure_code: &FailureCode) {
3664 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3666 let removed_source = self.claimable_payments.lock().unwrap().claimable_htlcs.remove(payment_hash);
3667 if let Some((_, mut sources)) = removed_source {
3668 for htlc in sources.drain(..) {
3669 let reason = self.get_htlc_fail_reason_from_failure_code(failure_code, &htlc);
3670 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
3671 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
3672 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
3677 /// Gets error data to form an [`HTLCFailReason`] given a [`FailureCode`] and [`ClaimableHTLC`].
3678 fn get_htlc_fail_reason_from_failure_code(&self, failure_code: &FailureCode, htlc: &ClaimableHTLC) -> HTLCFailReason {
3679 match failure_code {
3680 FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(*failure_code as u16),
3681 FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(*failure_code as u16),
3682 FailureCode::IncorrectOrUnknownPaymentDetails => {
3683 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
3684 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
3685 HTLCFailReason::reason(*failure_code as u16, htlc_msat_height_data)
3690 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3691 /// that we want to return and a channel.
3693 /// This is for failures on the channel on which the HTLC was *received*, not failures
3695 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> (u16, Vec<u8>) {
3696 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
3697 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
3698 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
3699 // an inbound SCID alias before the real SCID.
3700 let scid_pref = if chan.should_announce() {
3701 chan.get_short_channel_id().or(chan.latest_inbound_scid_alias())
3703 chan.latest_inbound_scid_alias().or(chan.get_short_channel_id())
3705 if let Some(scid) = scid_pref {
3706 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
3708 (0x4000|10, Vec::new())
3713 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3714 /// that we want to return and a channel.
3715 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>) {
3716 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
3717 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
3718 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
3719 if desired_err_code == 0x1000 | 20 {
3720 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
3721 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
3722 0u16.write(&mut enc).expect("Writes cannot fail");
3724 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
3725 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
3726 upd.write(&mut enc).expect("Writes cannot fail");
3727 (desired_err_code, enc.0)
3729 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
3730 // which means we really shouldn't have gotten a payment to be forwarded over this
3731 // channel yet, or if we did it's from a route hint. Either way, returning an error of
3732 // PERM|no_such_channel should be fine.
3733 (0x4000|10, Vec::new())
3737 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
3738 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
3739 // be surfaced to the user.
3740 fn fail_holding_cell_htlcs(
3741 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32],
3742 counterparty_node_id: &PublicKey
3744 let (failure_code, onion_failure_data) = {
3745 let per_peer_state = self.per_peer_state.read().unwrap();
3746 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
3747 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3748 let peer_state = &mut *peer_state_lock;
3749 match peer_state.channel_by_id.entry(channel_id) {
3750 hash_map::Entry::Occupied(chan_entry) => {
3751 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan_entry.get())
3753 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
3755 } else { (0x4000|10, Vec::new()) }
3758 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
3759 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
3760 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
3761 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
3765 /// Fails an HTLC backwards to the sender of it to us.
3766 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
3767 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
3768 // Ensure that no peer state channel storage lock is held when calling this function.
3769 // This ensures that future code doesn't introduce a lock-order requirement for
3770 // `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
3771 // this function with any `per_peer_state` peer lock acquired would.
3772 for (_, peer) in self.per_peer_state.read().unwrap().iter() {
3773 debug_assert_ne!(peer.held_by_thread(), LockHeldState::HeldByThread);
3776 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
3777 //identify whether we sent it or not based on the (I presume) very different runtime
3778 //between the branches here. We should make this async and move it into the forward HTLCs
3781 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3782 // from block_connected which may run during initialization prior to the chain_monitor
3783 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
3785 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, ref payment_params, .. } => {
3786 if self.pending_outbound_payments.fail_htlc(source, payment_hash, onion_error, path,
3787 session_priv, payment_id, payment_params, self.probing_cookie_secret, &self.secp_ctx,
3788 &self.pending_events, &self.logger)
3789 { self.push_pending_forwards_ev(); }
3791 HTLCSource::PreviousHopData(HTLCPreviousHopData { ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret, ref phantom_shared_secret, ref outpoint }) => {
3792 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with {:?}", log_bytes!(payment_hash.0), onion_error);
3793 let err_packet = onion_error.get_encrypted_failure_packet(incoming_packet_shared_secret, phantom_shared_secret);
3795 let mut push_forward_ev = false;
3796 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
3797 if forward_htlcs.is_empty() {
3798 push_forward_ev = true;
3800 match forward_htlcs.entry(*short_channel_id) {
3801 hash_map::Entry::Occupied(mut entry) => {
3802 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet });
3804 hash_map::Entry::Vacant(entry) => {
3805 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }));
3808 mem::drop(forward_htlcs);
3809 if push_forward_ev { self.push_pending_forwards_ev(); }
3810 let mut pending_events = self.pending_events.lock().unwrap();
3811 pending_events.push(events::Event::HTLCHandlingFailed {
3812 prev_channel_id: outpoint.to_channel_id(),
3813 failed_next_destination: destination,
3819 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
3820 /// [`MessageSendEvent`]s needed to claim the payment.
3822 /// Note that calling this method does *not* guarantee that the payment has been claimed. You
3823 /// *must* wait for an [`Event::PaymentClaimed`] event which upon a successful claim will be
3824 /// provided to your [`EventHandler`] when [`process_pending_events`] is next called.
3826 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
3827 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
3828 /// event matches your expectation. If you fail to do so and call this method, you may provide
3829 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
3831 /// [`Event::PaymentClaimable`]: crate::util::events::Event::PaymentClaimable
3832 /// [`Event::PaymentClaimed`]: crate::util::events::Event::PaymentClaimed
3833 /// [`process_pending_events`]: EventsProvider::process_pending_events
3834 /// [`create_inbound_payment`]: Self::create_inbound_payment
3835 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
3836 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
3837 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
3839 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3842 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3843 if let Some((payment_purpose, sources)) = claimable_payments.claimable_htlcs.remove(&payment_hash) {
3844 let mut receiver_node_id = self.our_network_pubkey;
3845 for htlc in sources.iter() {
3846 if htlc.prev_hop.phantom_shared_secret.is_some() {
3847 let phantom_pubkey = self.node_signer.get_node_id(Recipient::PhantomNode)
3848 .expect("Failed to get node_id for phantom node recipient");
3849 receiver_node_id = phantom_pubkey;
3854 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
3855 ClaimingPayment { amount_msat: sources.iter().map(|source| source.value).sum(),
3856 payment_purpose, receiver_node_id,
3858 if dup_purpose.is_some() {
3859 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
3860 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
3861 log_bytes!(payment_hash.0));
3866 debug_assert!(!sources.is_empty());
3868 // If we are claiming an MPP payment, we check that all channels which contain a claimable
3869 // HTLC still exist. While this isn't guaranteed to remain true if a channel closes while
3870 // we're claiming (or even after we claim, before the commitment update dance completes),
3871 // it should be a relatively rare race, and we'd rather not claim HTLCs that require us to
3872 // go on-chain (and lose the on-chain fee to do so) than just reject the payment.
3874 // Note that we'll still always get our funds - as long as the generated
3875 // `ChannelMonitorUpdate` makes it out to the relevant monitor we can claim on-chain.
3877 // If we find an HTLC which we would need to claim but for which we do not have a
3878 // channel, we will fail all parts of the MPP payment. While we could wait and see if
3879 // the sender retries the already-failed path(s), it should be a pretty rare case where
3880 // we got all the HTLCs and then a channel closed while we were waiting for the user to
3881 // provide the preimage, so worrying too much about the optimal handling isn't worth
3883 let mut claimable_amt_msat = 0;
3884 let mut expected_amt_msat = None;
3885 let mut valid_mpp = true;
3886 let mut errs = Vec::new();
3887 let per_peer_state = self.per_peer_state.read().unwrap();
3888 for htlc in sources.iter() {
3889 let (counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&htlc.prev_hop.short_channel_id) {
3890 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3897 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3898 if peer_state_mutex_opt.is_none() {
3903 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
3904 let peer_state = &mut *peer_state_lock;
3906 if peer_state.channel_by_id.get(&chan_id).is_none() {
3911 if expected_amt_msat.is_some() && expected_amt_msat != Some(htlc.total_msat) {
3912 log_error!(self.logger, "Somehow ended up with an MPP payment with different total amounts - this should not be reachable!");
3913 debug_assert!(false);
3918 expected_amt_msat = Some(htlc.total_msat);
3919 if let OnionPayload::Spontaneous(_) = &htlc.onion_payload {
3920 // We don't currently support MPP for spontaneous payments, so just check
3921 // that there's one payment here and move on.
3922 if sources.len() != 1 {
3923 log_error!(self.logger, "Somehow ended up with an MPP spontaneous payment - this should not be reachable!");
3924 debug_assert!(false);
3930 claimable_amt_msat += htlc.value;
3932 mem::drop(per_peer_state);
3933 if sources.is_empty() || expected_amt_msat.is_none() {
3934 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
3935 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
3938 if claimable_amt_msat != expected_amt_msat.unwrap() {
3939 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
3940 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
3941 expected_amt_msat.unwrap(), claimable_amt_msat);
3945 for htlc in sources.drain(..) {
3946 if let Err((pk, err)) = self.claim_funds_from_hop(
3947 htlc.prev_hop, payment_preimage,
3948 |_| Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash }))
3950 if let msgs::ErrorAction::IgnoreError = err.err.action {
3951 // We got a temporary failure updating monitor, but will claim the
3952 // HTLC when the monitor updating is restored (or on chain).
3953 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
3954 } else { errs.push((pk, err)); }
3959 for htlc in sources.drain(..) {
3960 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
3961 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
3962 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
3963 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
3964 let receiver = HTLCDestination::FailedPayment { payment_hash };
3965 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
3967 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
3970 // Now we can handle any errors which were generated.
3971 for (counterparty_node_id, err) in errs.drain(..) {
3972 let res: Result<(), _> = Err(err);
3973 let _ = handle_error!(self, res, counterparty_node_id);
3977 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>) -> Option<MonitorUpdateCompletionAction>>(&self,
3978 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
3979 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
3980 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
3982 let per_peer_state = self.per_peer_state.read().unwrap();
3983 let chan_id = prev_hop.outpoint.to_channel_id();
3984 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
3985 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
3989 let mut peer_state_opt = counterparty_node_id_opt.as_ref().map(
3990 |counterparty_node_id| per_peer_state.get(counterparty_node_id).map(
3991 |peer_mutex| peer_mutex.lock().unwrap()
3995 if peer_state_opt.is_some() {
3996 let mut peer_state_lock = peer_state_opt.unwrap();
3997 let peer_state = &mut *peer_state_lock;
3998 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(chan_id) {
3999 let counterparty_node_id = chan.get().get_counterparty_node_id();
4000 let fulfill_res = chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger);
4002 if let UpdateFulfillCommitFetch::NewClaim { htlc_value_msat, monitor_update } = fulfill_res {
4003 if let Some(action) = completion_action(Some(htlc_value_msat)) {
4004 log_trace!(self.logger, "Tracking monitor update completion action for channel {}: {:?}",
4005 log_bytes!(chan_id), action);
4006 peer_state.monitor_update_blocked_actions.entry(chan_id).or_insert(Vec::new()).push(action);
4008 let update_id = monitor_update.update_id;
4009 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, monitor_update);
4010 let res = handle_new_monitor_update!(self, update_res, update_id, peer_state_lock,
4011 peer_state, per_peer_state, chan);
4012 if let Err(e) = res {
4013 // TODO: This is a *critical* error - we probably updated the outbound edge
4014 // of the HTLC's monitor with a preimage. We should retry this monitor
4015 // update over and over again until morale improves.
4016 log_error!(self.logger, "Failed to update channel monitor with preimage {:?}", payment_preimage);
4017 return Err((counterparty_node_id, e));
4023 let preimage_update = ChannelMonitorUpdate {
4024 update_id: CLOSED_CHANNEL_UPDATE_ID,
4025 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
4029 // We update the ChannelMonitor on the backward link, after
4030 // receiving an `update_fulfill_htlc` from the forward link.
4031 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, &preimage_update);
4032 if update_res != ChannelMonitorUpdateStatus::Completed {
4033 // TODO: This needs to be handled somehow - if we receive a monitor update
4034 // with a preimage we *must* somehow manage to propagate it to the upstream
4035 // channel, or we must have an ability to receive the same event and try
4036 // again on restart.
4037 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
4038 payment_preimage, update_res);
4040 // Note that we do process the completion action here. This totally could be a
4041 // duplicate claim, but we have no way of knowing without interrogating the
4042 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
4043 // generally always allowed to be duplicative (and it's specifically noted in
4044 // `PaymentForwarded`).
4045 self.handle_monitor_update_completion_actions(completion_action(None));
4049 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
4050 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
4053 fn claim_funds_internal(&self, source: HTLCSource, payment_preimage: PaymentPreimage, forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, next_channel_id: [u8; 32]) {
4055 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
4056 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage, session_priv, path, from_onchain, &self.pending_events, &self.logger);
4058 HTLCSource::PreviousHopData(hop_data) => {
4059 let prev_outpoint = hop_data.outpoint;
4060 let res = self.claim_funds_from_hop(hop_data, payment_preimage,
4061 |htlc_claim_value_msat| {
4062 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
4063 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
4064 Some(claimed_htlc_value - forwarded_htlc_value)
4067 let prev_channel_id = Some(prev_outpoint.to_channel_id());
4068 let next_channel_id = Some(next_channel_id);
4070 Some(MonitorUpdateCompletionAction::EmitEvent { event: events::Event::PaymentForwarded {
4072 claim_from_onchain_tx: from_onchain,
4078 if let Err((pk, err)) = res {
4079 let result: Result<(), _> = Err(err);
4080 let _ = handle_error!(self, result, pk);
4086 /// Gets the node_id held by this ChannelManager
4087 pub fn get_our_node_id(&self) -> PublicKey {
4088 self.our_network_pubkey.clone()
4091 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
4092 for action in actions.into_iter() {
4094 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
4095 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4096 if let Some(ClaimingPayment { amount_msat, payment_purpose: purpose, receiver_node_id }) = payment {
4097 self.pending_events.lock().unwrap().push(events::Event::PaymentClaimed {
4098 payment_hash, purpose, amount_msat, receiver_node_id: Some(receiver_node_id),
4102 MonitorUpdateCompletionAction::EmitEvent { event } => {
4103 self.pending_events.lock().unwrap().push(event);
4109 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
4110 /// update completion.
4111 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
4112 channel: &mut Channel<<SP::Target as SignerProvider>::Signer>, raa: Option<msgs::RevokeAndACK>,
4113 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
4114 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
4115 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
4116 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
4117 log_trace!(self.logger, "Handling channel resumption for channel {} with {} RAA, {} commitment update, {} pending forwards, {}broadcasting funding, {} channel ready, {} announcement",
4118 log_bytes!(channel.channel_id()),
4119 if raa.is_some() { "an" } else { "no" },
4120 if commitment_update.is_some() { "a" } else { "no" }, pending_forwards.len(),
4121 if funding_broadcastable.is_some() { "" } else { "not " },
4122 if channel_ready.is_some() { "sending" } else { "without" },
4123 if announcement_sigs.is_some() { "sending" } else { "without" });
4125 let mut htlc_forwards = None;
4127 let counterparty_node_id = channel.get_counterparty_node_id();
4128 if !pending_forwards.is_empty() {
4129 htlc_forwards = Some((channel.get_short_channel_id().unwrap_or(channel.outbound_scid_alias()),
4130 channel.get_funding_txo().unwrap(), channel.get_user_id(), pending_forwards));
4133 if let Some(msg) = channel_ready {
4134 send_channel_ready!(self, pending_msg_events, channel, msg);
4136 if let Some(msg) = announcement_sigs {
4137 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4138 node_id: counterparty_node_id,
4143 emit_channel_ready_event!(self, channel);
4145 macro_rules! handle_cs { () => {
4146 if let Some(update) = commitment_update {
4147 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4148 node_id: counterparty_node_id,
4153 macro_rules! handle_raa { () => {
4154 if let Some(revoke_and_ack) = raa {
4155 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
4156 node_id: counterparty_node_id,
4157 msg: revoke_and_ack,
4162 RAACommitmentOrder::CommitmentFirst => {
4166 RAACommitmentOrder::RevokeAndACKFirst => {
4172 if let Some(tx) = funding_broadcastable {
4173 log_info!(self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
4174 self.tx_broadcaster.broadcast_transaction(&tx);
4180 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
4181 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
4183 let counterparty_node_id = match counterparty_node_id {
4184 Some(cp_id) => cp_id.clone(),
4186 // TODO: Once we can rely on the counterparty_node_id from the
4187 // monitor event, this and the id_to_peer map should be removed.
4188 let id_to_peer = self.id_to_peer.lock().unwrap();
4189 match id_to_peer.get(&funding_txo.to_channel_id()) {
4190 Some(cp_id) => cp_id.clone(),
4195 let per_peer_state = self.per_peer_state.read().unwrap();
4196 let mut peer_state_lock;
4197 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
4198 if peer_state_mutex_opt.is_none() { return }
4199 peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4200 let peer_state = &mut *peer_state_lock;
4202 match peer_state.channel_by_id.entry(funding_txo.to_channel_id()){
4203 hash_map::Entry::Occupied(chan) => chan,
4204 hash_map::Entry::Vacant(_) => return,
4207 log_trace!(self.logger, "ChannelMonitor updated to {}. Current highest is {}",
4208 highest_applied_update_id, channel.get().get_latest_monitor_update_id());
4209 if !channel.get().is_awaiting_monitor_update() || channel.get().get_latest_monitor_update_id() != highest_applied_update_id {
4212 handle_monitor_update_completion!(self, highest_applied_update_id, peer_state_lock, peer_state, per_peer_state, channel.get_mut());
4215 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
4217 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
4218 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
4221 /// The `user_channel_id` parameter will be provided back in
4222 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4223 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4225 /// Note that this method will return an error and reject the channel, if it requires support
4226 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
4227 /// used to accept such channels.
4229 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4230 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4231 pub fn accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
4232 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
4235 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
4236 /// it as confirmed immediately.
4238 /// The `user_channel_id` parameter will be provided back in
4239 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4240 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4242 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
4243 /// and (if the counterparty agrees), enables forwarding of payments immediately.
4245 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
4246 /// transaction and blindly assumes that it will eventually confirm.
4248 /// If it does not confirm before we decide to close the channel, or if the funding transaction
4249 /// does not pay to the correct script the correct amount, *you will lose funds*.
4251 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4252 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4253 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> {
4254 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
4257 fn do_accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
4258 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4260 let peers_without_funded_channels = self.peers_without_funded_channels(|peer| !peer.channel_by_id.is_empty());
4261 let per_peer_state = self.per_peer_state.read().unwrap();
4262 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4263 .ok_or_else(|| APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
4264 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4265 let peer_state = &mut *peer_state_lock;
4266 let is_only_peer_channel = peer_state.channel_by_id.len() == 1;
4267 match peer_state.channel_by_id.entry(temporary_channel_id.clone()) {
4268 hash_map::Entry::Occupied(mut channel) => {
4269 if !channel.get().inbound_is_awaiting_accept() {
4270 return Err(APIError::APIMisuseError { err: "The channel isn't currently awaiting to be accepted.".to_owned() });
4273 channel.get_mut().set_0conf();
4274 } else if channel.get().get_channel_type().requires_zero_conf() {
4275 let send_msg_err_event = events::MessageSendEvent::HandleError {
4276 node_id: channel.get().get_counterparty_node_id(),
4277 action: msgs::ErrorAction::SendErrorMessage{
4278 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
4281 peer_state.pending_msg_events.push(send_msg_err_event);
4282 let _ = remove_channel!(self, channel);
4283 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
4285 // If this peer already has some channels, a new channel won't increase our number of peers
4286 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
4287 // channels per-peer we can accept channels from a peer with existing ones.
4288 if is_only_peer_channel && peers_without_funded_channels >= MAX_UNFUNDED_CHANNEL_PEERS {
4289 let send_msg_err_event = events::MessageSendEvent::HandleError {
4290 node_id: channel.get().get_counterparty_node_id(),
4291 action: msgs::ErrorAction::SendErrorMessage{
4292 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "Have too many peers with unfunded channels, not accepting new ones".to_owned(), }
4295 peer_state.pending_msg_events.push(send_msg_err_event);
4296 let _ = remove_channel!(self, channel);
4297 return Err(APIError::APIMisuseError { err: "Too many peers with unfunded channels, refusing to accept new ones".to_owned() });
4301 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4302 node_id: channel.get().get_counterparty_node_id(),
4303 msg: channel.get_mut().accept_inbound_channel(user_channel_id),
4306 hash_map::Entry::Vacant(_) => {
4307 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) });
4313 /// Gets the number of peers which match the given filter and do not have any funded, outbound,
4314 /// or 0-conf channels.
4316 /// The filter is called for each peer and provided with the number of unfunded, inbound, and
4317 /// non-0-conf channels we have with the peer.
4318 fn peers_without_funded_channels<Filter>(&self, maybe_count_peer: Filter) -> usize
4319 where Filter: Fn(&PeerState<<SP::Target as SignerProvider>::Signer>) -> bool {
4320 let mut peers_without_funded_channels = 0;
4321 let best_block_height = self.best_block.read().unwrap().height();
4323 let peer_state_lock = self.per_peer_state.read().unwrap();
4324 for (_, peer_mtx) in peer_state_lock.iter() {
4325 let peer = peer_mtx.lock().unwrap();
4326 if !maybe_count_peer(&*peer) { continue; }
4327 let num_unfunded_channels = Self::unfunded_channel_count(&peer, best_block_height);
4328 if num_unfunded_channels == peer.channel_by_id.len() {
4329 peers_without_funded_channels += 1;
4333 return peers_without_funded_channels;
4336 fn unfunded_channel_count(
4337 peer: &PeerState<<SP::Target as SignerProvider>::Signer>, best_block_height: u32
4339 let mut num_unfunded_channels = 0;
4340 for (_, chan) in peer.channel_by_id.iter() {
4341 if !chan.is_outbound() && chan.minimum_depth().unwrap_or(1) != 0 &&
4342 chan.get_funding_tx_confirmations(best_block_height) == 0
4344 num_unfunded_channels += 1;
4347 num_unfunded_channels
4350 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
4351 if msg.chain_hash != self.genesis_hash {
4352 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
4355 if !self.default_configuration.accept_inbound_channels {
4356 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4359 let mut random_bytes = [0u8; 16];
4360 random_bytes.copy_from_slice(&self.entropy_source.get_secure_random_bytes()[..16]);
4361 let user_channel_id = u128::from_be_bytes(random_bytes);
4362 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
4364 // Get the number of peers with channels, but without funded ones. We don't care too much
4365 // about peers that never open a channel, so we filter by peers that have at least one
4366 // channel, and then limit the number of those with unfunded channels.
4367 let channeled_peers_without_funding = self.peers_without_funded_channels(|node| !node.channel_by_id.is_empty());
4369 let per_peer_state = self.per_peer_state.read().unwrap();
4370 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4372 debug_assert!(false);
4373 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())
4375 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4376 let peer_state = &mut *peer_state_lock;
4378 // If this peer already has some channels, a new channel won't increase our number of peers
4379 // with unfunded channels, so as long as we aren't over the maximum number of unfunded
4380 // channels per-peer we can accept channels from a peer with existing ones.
4381 if peer_state.channel_by_id.is_empty() &&
4382 channeled_peers_without_funding >= MAX_UNFUNDED_CHANNEL_PEERS &&
4383 !self.default_configuration.manually_accept_inbound_channels
4385 return Err(MsgHandleErrInternal::send_err_msg_no_close(
4386 "Have too many peers with unfunded channels, not accepting new ones".to_owned(),
4387 msg.temporary_channel_id.clone()));
4390 let best_block_height = self.best_block.read().unwrap().height();
4391 if Self::unfunded_channel_count(peer_state, best_block_height) >= MAX_UNFUNDED_CHANS_PER_PEER {
4392 return Err(MsgHandleErrInternal::send_err_msg_no_close(
4393 format!("Refusing more than {} unfunded channels.", MAX_UNFUNDED_CHANS_PER_PEER),
4394 msg.temporary_channel_id.clone()));
4397 let mut channel = match Channel::new_from_req(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
4398 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id,
4399 &self.default_configuration, best_block_height, &self.logger, outbound_scid_alias)
4402 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4403 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
4407 match peer_state.channel_by_id.entry(channel.channel_id()) {
4408 hash_map::Entry::Occupied(_) => {
4409 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4410 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision for the same peer!".to_owned(), msg.temporary_channel_id.clone()))
4412 hash_map::Entry::Vacant(entry) => {
4413 if !self.default_configuration.manually_accept_inbound_channels {
4414 if channel.get_channel_type().requires_zero_conf() {
4415 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4417 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4418 node_id: counterparty_node_id.clone(),
4419 msg: channel.accept_inbound_channel(user_channel_id),
4422 let mut pending_events = self.pending_events.lock().unwrap();
4423 pending_events.push(
4424 events::Event::OpenChannelRequest {
4425 temporary_channel_id: msg.temporary_channel_id.clone(),
4426 counterparty_node_id: counterparty_node_id.clone(),
4427 funding_satoshis: msg.funding_satoshis,
4428 push_msat: msg.push_msat,
4429 channel_type: channel.get_channel_type().clone(),
4434 entry.insert(channel);
4440 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
4441 let (value, output_script, user_id) = {
4442 let per_peer_state = self.per_peer_state.read().unwrap();
4443 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4445 debug_assert!(false);
4446 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)
4448 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4449 let peer_state = &mut *peer_state_lock;
4450 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
4451 hash_map::Entry::Occupied(mut chan) => {
4452 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &peer_state.latest_features), chan);
4453 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
4455 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))
4458 let mut pending_events = self.pending_events.lock().unwrap();
4459 pending_events.push(events::Event::FundingGenerationReady {
4460 temporary_channel_id: msg.temporary_channel_id,
4461 counterparty_node_id: *counterparty_node_id,
4462 channel_value_satoshis: value,
4464 user_channel_id: user_id,
4469 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
4470 let best_block = *self.best_block.read().unwrap();
4472 let per_peer_state = self.per_peer_state.read().unwrap();
4473 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4475 debug_assert!(false);
4476 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)
4479 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4480 let peer_state = &mut *peer_state_lock;
4481 let ((funding_msg, monitor), chan) =
4482 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
4483 hash_map::Entry::Occupied(mut chan) => {
4484 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.signer_provider, &self.logger), chan), chan.remove())
4486 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))
4489 match peer_state.channel_by_id.entry(funding_msg.channel_id) {
4490 hash_map::Entry::Occupied(_) => {
4491 Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
4493 hash_map::Entry::Vacant(e) => {
4494 match self.id_to_peer.lock().unwrap().entry(chan.channel_id()) {
4495 hash_map::Entry::Occupied(_) => {
4496 return Err(MsgHandleErrInternal::send_err_msg_no_close(
4497 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
4498 funding_msg.channel_id))
4500 hash_map::Entry::Vacant(i_e) => {
4501 i_e.insert(chan.get_counterparty_node_id());
4505 // There's no problem signing a counterparty's funding transaction if our monitor
4506 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
4507 // accepted payment from yet. We do, however, need to wait to send our channel_ready
4508 // until we have persisted our monitor.
4509 let new_channel_id = funding_msg.channel_id;
4510 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
4511 node_id: counterparty_node_id.clone(),
4515 let monitor_res = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
4517 let chan = e.insert(chan);
4518 let mut res = handle_new_monitor_update!(self, monitor_res, 0, peer_state_lock, peer_state,
4519 per_peer_state, chan, MANUALLY_REMOVING, { peer_state.channel_by_id.remove(&new_channel_id) });
4521 // Note that we reply with the new channel_id in error messages if we gave up on the
4522 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
4523 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
4524 // any messages referencing a previously-closed channel anyway.
4525 // We do not propagate the monitor update to the user as it would be for a monitor
4526 // that we didn't manage to store (and that we don't care about - we don't respond
4527 // with the funding_signed so the channel can never go on chain).
4528 if let Err(MsgHandleErrInternal { shutdown_finish: Some((res, _)), .. }) = &mut res {
4536 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
4537 let best_block = *self.best_block.read().unwrap();
4538 let per_peer_state = self.per_peer_state.read().unwrap();
4539 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4541 debug_assert!(false);
4542 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4545 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4546 let peer_state = &mut *peer_state_lock;
4547 match peer_state.channel_by_id.entry(msg.channel_id) {
4548 hash_map::Entry::Occupied(mut chan) => {
4549 let monitor = try_chan_entry!(self,
4550 chan.get_mut().funding_signed(&msg, best_block, &self.signer_provider, &self.logger), chan);
4551 let update_res = self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor);
4552 let mut res = handle_new_monitor_update!(self, update_res, 0, peer_state_lock, peer_state, per_peer_state, chan);
4553 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
4554 // We weren't able to watch the channel to begin with, so no updates should be made on
4555 // it. Previously, full_stack_target found an (unreachable) panic when the
4556 // monitor update contained within `shutdown_finish` was applied.
4557 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
4558 shutdown_finish.0.take();
4563 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4567 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
4568 let per_peer_state = self.per_peer_state.read().unwrap();
4569 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4571 debug_assert!(false);
4572 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4574 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4575 let peer_state = &mut *peer_state_lock;
4576 match peer_state.channel_by_id.entry(msg.channel_id) {
4577 hash_map::Entry::Occupied(mut chan) => {
4578 let announcement_sigs_opt = try_chan_entry!(self, chan.get_mut().channel_ready(&msg, &self.node_signer,
4579 self.genesis_hash.clone(), &self.default_configuration, &self.best_block.read().unwrap(), &self.logger), chan);
4580 if let Some(announcement_sigs) = announcement_sigs_opt {
4581 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(chan.get().channel_id()));
4582 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4583 node_id: counterparty_node_id.clone(),
4584 msg: announcement_sigs,
4586 } else if chan.get().is_usable() {
4587 // If we're sending an announcement_signatures, we'll send the (public)
4588 // channel_update after sending a channel_announcement when we receive our
4589 // counterparty's announcement_signatures. Thus, we only bother to send a
4590 // channel_update here if the channel is not public, i.e. we're not sending an
4591 // announcement_signatures.
4592 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", log_bytes!(chan.get().channel_id()));
4593 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
4594 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4595 node_id: counterparty_node_id.clone(),
4601 emit_channel_ready_event!(self, chan.get_mut());
4605 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))
4609 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
4610 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
4611 let result: Result<(), _> = loop {
4612 let per_peer_state = self.per_peer_state.read().unwrap();
4613 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4615 debug_assert!(false);
4616 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4618 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4619 let peer_state = &mut *peer_state_lock;
4620 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
4621 hash_map::Entry::Occupied(mut chan_entry) => {
4623 if !chan_entry.get().received_shutdown() {
4624 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
4625 log_bytes!(msg.channel_id),
4626 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
4629 let funding_txo_opt = chan_entry.get().get_funding_txo();
4630 let (shutdown, monitor_update_opt, htlcs) = try_chan_entry!(self,
4631 chan_entry.get_mut().shutdown(&self.signer_provider, &peer_state.latest_features, &msg), chan_entry);
4632 dropped_htlcs = htlcs;
4634 if let Some(msg) = shutdown {
4635 // We can send the `shutdown` message before updating the `ChannelMonitor`
4636 // here as we don't need the monitor update to complete until we send a
4637 // `shutdown_signed`, which we'll delay if we're pending a monitor update.
4638 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
4639 node_id: *counterparty_node_id,
4644 // Update the monitor with the shutdown script if necessary.
4645 if let Some(monitor_update) = monitor_update_opt {
4646 let update_id = monitor_update.update_id;
4647 let update_res = self.chain_monitor.update_channel(funding_txo_opt.unwrap(), monitor_update);
4648 break handle_new_monitor_update!(self, update_res, update_id, peer_state_lock, peer_state, per_peer_state, chan_entry);
4652 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))
4655 for htlc_source in dropped_htlcs.drain(..) {
4656 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
4657 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
4658 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
4664 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
4665 let per_peer_state = self.per_peer_state.read().unwrap();
4666 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4668 debug_assert!(false);
4669 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4671 let (tx, chan_option) = {
4672 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4673 let peer_state = &mut *peer_state_lock;
4674 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
4675 hash_map::Entry::Occupied(mut chan_entry) => {
4676 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), chan_entry);
4677 if let Some(msg) = closing_signed {
4678 peer_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
4679 node_id: counterparty_node_id.clone(),
4684 // We're done with this channel, we've got a signed closing transaction and
4685 // will send the closing_signed back to the remote peer upon return. This
4686 // also implies there are no pending HTLCs left on the channel, so we can
4687 // fully delete it from tracking (the channel monitor is still around to
4688 // watch for old state broadcasts)!
4689 (tx, Some(remove_channel!(self, chan_entry)))
4690 } else { (tx, None) }
4692 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))
4695 if let Some(broadcast_tx) = tx {
4696 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
4697 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
4699 if let Some(chan) = chan_option {
4700 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4701 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4702 let peer_state = &mut *peer_state_lock;
4703 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4707 self.issue_channel_close_events(&chan, ClosureReason::CooperativeClosure);
4712 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
4713 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
4714 //determine the state of the payment based on our response/if we forward anything/the time
4715 //we take to respond. We should take care to avoid allowing such an attack.
4717 //TODO: There exists a further attack where a node may garble the onion data, forward it to
4718 //us repeatedly garbled in different ways, and compare our error messages, which are
4719 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
4720 //but we should prevent it anyway.
4722 let pending_forward_info = self.decode_update_add_htlc_onion(msg);
4723 let per_peer_state = self.per_peer_state.read().unwrap();
4724 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4726 debug_assert!(false);
4727 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4729 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4730 let peer_state = &mut *peer_state_lock;
4731 match peer_state.channel_by_id.entry(msg.channel_id) {
4732 hash_map::Entry::Occupied(mut chan) => {
4734 let create_pending_htlc_status = |chan: &Channel<<SP::Target as SignerProvider>::Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
4735 // If the update_add is completely bogus, the call will Err and we will close,
4736 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
4737 // want to reject the new HTLC and fail it backwards instead of forwarding.
4738 match pending_forward_info {
4739 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
4740 let reason = if (error_code & 0x1000) != 0 {
4741 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
4742 HTLCFailReason::reason(real_code, error_data)
4744 HTLCFailReason::from_failure_code(error_code)
4745 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
4746 let msg = msgs::UpdateFailHTLC {
4747 channel_id: msg.channel_id,
4748 htlc_id: msg.htlc_id,
4751 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
4753 _ => pending_forward_info
4756 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), chan);
4758 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))
4763 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
4764 let (htlc_source, forwarded_htlc_value) = {
4765 let per_peer_state = self.per_peer_state.read().unwrap();
4766 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4768 debug_assert!(false);
4769 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4771 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4772 let peer_state = &mut *peer_state_lock;
4773 match peer_state.channel_by_id.entry(msg.channel_id) {
4774 hash_map::Entry::Occupied(mut chan) => {
4775 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), chan)
4777 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))
4780 self.claim_funds_internal(htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, msg.channel_id);
4784 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
4785 let per_peer_state = self.per_peer_state.read().unwrap();
4786 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4788 debug_assert!(false);
4789 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4791 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4792 let peer_state = &mut *peer_state_lock;
4793 match peer_state.channel_by_id.entry(msg.channel_id) {
4794 hash_map::Entry::Occupied(mut chan) => {
4795 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan);
4797 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))
4802 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
4803 let per_peer_state = self.per_peer_state.read().unwrap();
4804 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4806 debug_assert!(false);
4807 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4809 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4810 let peer_state = &mut *peer_state_lock;
4811 match peer_state.channel_by_id.entry(msg.channel_id) {
4812 hash_map::Entry::Occupied(mut chan) => {
4813 if (msg.failure_code & 0x8000) == 0 {
4814 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
4815 try_chan_entry!(self, Err(chan_err), chan);
4817 try_chan_entry!(self, chan.get_mut().update_fail_malformed_htlc(&msg, HTLCFailReason::reason(msg.failure_code, msg.sha256_of_onion.to_vec())), chan);
4820 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))
4824 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
4825 let per_peer_state = self.per_peer_state.read().unwrap();
4826 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4828 debug_assert!(false);
4829 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4831 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4832 let peer_state = &mut *peer_state_lock;
4833 match peer_state.channel_by_id.entry(msg.channel_id) {
4834 hash_map::Entry::Occupied(mut chan) => {
4835 let funding_txo = chan.get().get_funding_txo();
4836 let monitor_update = try_chan_entry!(self, chan.get_mut().commitment_signed(&msg, &self.logger), chan);
4837 let update_res = self.chain_monitor.update_channel(funding_txo.unwrap(), monitor_update);
4838 let update_id = monitor_update.update_id;
4839 handle_new_monitor_update!(self, update_res, update_id, peer_state_lock,
4840 peer_state, per_peer_state, chan)
4842 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))
4847 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
4848 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
4849 let mut push_forward_event = false;
4850 let mut new_intercept_events = Vec::new();
4851 let mut failed_intercept_forwards = Vec::new();
4852 if !pending_forwards.is_empty() {
4853 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
4854 let scid = match forward_info.routing {
4855 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
4856 PendingHTLCRouting::Receive { .. } => 0,
4857 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
4859 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
4860 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
4862 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
4863 let forward_htlcs_empty = forward_htlcs.is_empty();
4864 match forward_htlcs.entry(scid) {
4865 hash_map::Entry::Occupied(mut entry) => {
4866 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4867 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
4869 hash_map::Entry::Vacant(entry) => {
4870 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
4871 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.genesis_hash)
4873 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).into_inner());
4874 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
4875 match pending_intercepts.entry(intercept_id) {
4876 hash_map::Entry::Vacant(entry) => {
4877 new_intercept_events.push(events::Event::HTLCIntercepted {
4878 requested_next_hop_scid: scid,
4879 payment_hash: forward_info.payment_hash,
4880 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
4881 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
4884 entry.insert(PendingAddHTLCInfo {
4885 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
4887 hash_map::Entry::Occupied(_) => {
4888 log_info!(self.logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
4889 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4890 short_channel_id: prev_short_channel_id,
4891 outpoint: prev_funding_outpoint,
4892 htlc_id: prev_htlc_id,
4893 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
4894 phantom_shared_secret: None,
4897 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
4898 HTLCFailReason::from_failure_code(0x4000 | 10),
4899 HTLCDestination::InvalidForward { requested_forward_scid: scid },
4904 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
4905 // payments are being processed.
4906 if forward_htlcs_empty {
4907 push_forward_event = true;
4909 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4910 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
4917 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
4918 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4921 if !new_intercept_events.is_empty() {
4922 let mut events = self.pending_events.lock().unwrap();
4923 events.append(&mut new_intercept_events);
4925 if push_forward_event { self.push_pending_forwards_ev() }
4929 // We only want to push a PendingHTLCsForwardable event if no others are queued.
4930 fn push_pending_forwards_ev(&self) {
4931 let mut pending_events = self.pending_events.lock().unwrap();
4932 let forward_ev_exists = pending_events.iter()
4933 .find(|ev| if let events::Event::PendingHTLCsForwardable { .. } = ev { true } else { false })
4935 if !forward_ev_exists {
4936 pending_events.push(events::Event::PendingHTLCsForwardable {
4938 Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
4943 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
4944 let (htlcs_to_fail, res) = {
4945 let per_peer_state = self.per_peer_state.read().unwrap();
4946 let mut peer_state_lock = per_peer_state.get(counterparty_node_id)
4948 debug_assert!(false);
4949 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4950 }).map(|mtx| mtx.lock().unwrap())?;
4951 let peer_state = &mut *peer_state_lock;
4952 match peer_state.channel_by_id.entry(msg.channel_id) {
4953 hash_map::Entry::Occupied(mut chan) => {
4954 let funding_txo = chan.get().get_funding_txo();
4955 let (htlcs_to_fail, monitor_update) = try_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &self.logger), chan);
4956 let update_res = self.chain_monitor.update_channel(funding_txo.unwrap(), monitor_update);
4957 let update_id = monitor_update.update_id;
4958 let res = handle_new_monitor_update!(self, update_res, update_id,
4959 peer_state_lock, peer_state, per_peer_state, chan);
4960 (htlcs_to_fail, res)
4962 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))
4965 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
4969 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
4970 let per_peer_state = self.per_peer_state.read().unwrap();
4971 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4973 debug_assert!(false);
4974 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4976 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4977 let peer_state = &mut *peer_state_lock;
4978 match peer_state.channel_by_id.entry(msg.channel_id) {
4979 hash_map::Entry::Occupied(mut chan) => {
4980 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg, &self.logger), chan);
4982 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))
4987 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
4988 let per_peer_state = self.per_peer_state.read().unwrap();
4989 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4991 debug_assert!(false);
4992 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
4994 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4995 let peer_state = &mut *peer_state_lock;
4996 match peer_state.channel_by_id.entry(msg.channel_id) {
4997 hash_map::Entry::Occupied(mut chan) => {
4998 if !chan.get().is_usable() {
4999 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
5002 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5003 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(
5004 &self.node_signer, self.genesis_hash.clone(), self.best_block.read().unwrap().height(),
5005 msg, &self.default_configuration
5007 // Note that announcement_signatures fails if the channel cannot be announced,
5008 // so get_channel_update_for_broadcast will never fail by the time we get here.
5009 update_msg: Some(self.get_channel_update_for_broadcast(chan.get()).unwrap()),
5012 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))
5017 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
5018 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
5019 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
5020 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
5022 // It's not a local channel
5023 return Ok(NotifyOption::SkipPersist)
5026 let per_peer_state = self.per_peer_state.read().unwrap();
5027 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
5028 if peer_state_mutex_opt.is_none() {
5029 return Ok(NotifyOption::SkipPersist)
5031 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5032 let peer_state = &mut *peer_state_lock;
5033 match peer_state.channel_by_id.entry(chan_id) {
5034 hash_map::Entry::Occupied(mut chan) => {
5035 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5036 if chan.get().should_announce() {
5037 // If the announcement is about a channel of ours which is public, some
5038 // other peer may simply be forwarding all its gossip to us. Don't provide
5039 // a scary-looking error message and return Ok instead.
5040 return Ok(NotifyOption::SkipPersist);
5042 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));
5044 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().get_counterparty_node_id().serialize()[..];
5045 let msg_from_node_one = msg.contents.flags & 1 == 0;
5046 if were_node_one == msg_from_node_one {
5047 return Ok(NotifyOption::SkipPersist);
5049 log_debug!(self.logger, "Received channel_update for channel {}.", log_bytes!(chan_id));
5050 try_chan_entry!(self, chan.get_mut().channel_update(&msg), chan);
5053 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersist)
5055 Ok(NotifyOption::DoPersist)
5058 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
5060 let need_lnd_workaround = {
5061 let per_peer_state = self.per_peer_state.read().unwrap();
5063 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5065 debug_assert!(false);
5066 MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id)
5068 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5069 let peer_state = &mut *peer_state_lock;
5070 match peer_state.channel_by_id.entry(msg.channel_id) {
5071 hash_map::Entry::Occupied(mut chan) => {
5072 // Currently, we expect all holding cell update_adds to be dropped on peer
5073 // disconnect, so Channel's reestablish will never hand us any holding cell
5074 // freed HTLCs to fail backwards. If in the future we no longer drop pending
5075 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
5076 let responses = try_chan_entry!(self, chan.get_mut().channel_reestablish(
5077 msg, &self.logger, &self.node_signer, self.genesis_hash,
5078 &self.default_configuration, &*self.best_block.read().unwrap()), chan);
5079 let mut channel_update = None;
5080 if let Some(msg) = responses.shutdown_msg {
5081 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5082 node_id: counterparty_node_id.clone(),
5085 } else if chan.get().is_usable() {
5086 // If the channel is in a usable state (ie the channel is not being shut
5087 // down), send a unicast channel_update to our counterparty to make sure
5088 // they have the latest channel parameters.
5089 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
5090 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
5091 node_id: chan.get().get_counterparty_node_id(),
5096 let need_lnd_workaround = chan.get_mut().workaround_lnd_bug_4006.take();
5097 htlc_forwards = self.handle_channel_resumption(
5098 &mut peer_state.pending_msg_events, chan.get_mut(), responses.raa, responses.commitment_update, responses.order,
5099 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
5100 if let Some(upd) = channel_update {
5101 peer_state.pending_msg_events.push(upd);
5105 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))
5109 if let Some(forwards) = htlc_forwards {
5110 self.forward_htlcs(&mut [forwards][..]);
5113 if let Some(channel_ready_msg) = need_lnd_workaround {
5114 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
5119 /// Process pending events from the `chain::Watch`, returning whether any events were processed.
5120 fn process_pending_monitor_events(&self) -> bool {
5121 debug_assert!(self.total_consistency_lock.try_write().is_err()); // Caller holds read lock
5123 let mut failed_channels = Vec::new();
5124 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
5125 let has_pending_monitor_events = !pending_monitor_events.is_empty();
5126 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
5127 for monitor_event in monitor_events.drain(..) {
5128 match monitor_event {
5129 MonitorEvent::HTLCEvent(htlc_update) => {
5130 if let Some(preimage) = htlc_update.payment_preimage {
5131 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
5132 self.claim_funds_internal(htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, funding_outpoint.to_channel_id());
5134 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
5135 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
5136 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
5137 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
5140 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
5141 MonitorEvent::UpdateFailed(funding_outpoint) => {
5142 let counterparty_node_id_opt = match counterparty_node_id {
5143 Some(cp_id) => Some(cp_id),
5145 // TODO: Once we can rely on the counterparty_node_id from the
5146 // monitor event, this and the id_to_peer map should be removed.
5147 let id_to_peer = self.id_to_peer.lock().unwrap();
5148 id_to_peer.get(&funding_outpoint.to_channel_id()).cloned()
5151 if let Some(counterparty_node_id) = counterparty_node_id_opt {
5152 let per_peer_state = self.per_peer_state.read().unwrap();
5153 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
5154 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5155 let peer_state = &mut *peer_state_lock;
5156 let pending_msg_events = &mut peer_state.pending_msg_events;
5157 if let hash_map::Entry::Occupied(chan_entry) = peer_state.channel_by_id.entry(funding_outpoint.to_channel_id()) {
5158 let mut chan = remove_channel!(self, chan_entry);
5159 failed_channels.push(chan.force_shutdown(false));
5160 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5161 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5165 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
5166 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
5168 ClosureReason::CommitmentTxConfirmed
5170 self.issue_channel_close_events(&chan, reason);
5171 pending_msg_events.push(events::MessageSendEvent::HandleError {
5172 node_id: chan.get_counterparty_node_id(),
5173 action: msgs::ErrorAction::SendErrorMessage {
5174 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
5181 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
5182 self.channel_monitor_updated(&funding_txo, monitor_update_id, counterparty_node_id.as_ref());
5188 for failure in failed_channels.drain(..) {
5189 self.finish_force_close_channel(failure);
5192 has_pending_monitor_events
5195 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
5196 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
5197 /// update events as a separate process method here.
5199 pub fn process_monitor_events(&self) {
5200 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5201 if self.process_pending_monitor_events() {
5202 NotifyOption::DoPersist
5204 NotifyOption::SkipPersist
5209 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
5210 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
5211 /// update was applied.
5212 fn check_free_holding_cells(&self) -> bool {
5213 let mut has_monitor_update = false;
5214 let mut failed_htlcs = Vec::new();
5215 let mut handle_errors = Vec::new();
5217 // Walk our list of channels and find any that need to update. Note that when we do find an
5218 // update, if it includes actions that must be taken afterwards, we have to drop the
5219 // per-peer state lock as well as the top level per_peer_state lock. Thus, we loop until we
5220 // manage to go through all our peers without finding a single channel to update.
5222 let per_peer_state = self.per_peer_state.read().unwrap();
5223 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5225 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5226 let peer_state: &mut PeerState<_> = &mut *peer_state_lock;
5227 for (channel_id, chan) in peer_state.channel_by_id.iter_mut() {
5228 let counterparty_node_id = chan.get_counterparty_node_id();
5229 let funding_txo = chan.get_funding_txo();
5230 let (monitor_opt, holding_cell_failed_htlcs) =
5231 chan.maybe_free_holding_cell_htlcs(&self.logger);
5232 if !holding_cell_failed_htlcs.is_empty() {
5233 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id, counterparty_node_id));
5235 if let Some(monitor_update) = monitor_opt {
5236 has_monitor_update = true;
5238 let update_res = self.chain_monitor.update_channel(
5239 funding_txo.expect("channel is live"), monitor_update);
5240 let update_id = monitor_update.update_id;
5241 let channel_id: [u8; 32] = *channel_id;
5242 let res = handle_new_monitor_update!(self, update_res, update_id,
5243 peer_state_lock, peer_state, per_peer_state, chan, MANUALLY_REMOVING,
5244 peer_state.channel_by_id.remove(&channel_id));
5246 handle_errors.push((counterparty_node_id, res));
5248 continue 'peer_loop;
5257 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
5258 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
5259 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
5262 for (counterparty_node_id, err) in handle_errors.drain(..) {
5263 let _ = handle_error!(self, err, counterparty_node_id);
5269 /// Check whether any channels have finished removing all pending updates after a shutdown
5270 /// exchange and can now send a closing_signed.
5271 /// Returns whether any closing_signed messages were generated.
5272 fn maybe_generate_initial_closing_signed(&self) -> bool {
5273 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
5274 let mut has_update = false;
5276 let per_peer_state = self.per_peer_state.read().unwrap();
5278 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5279 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5280 let peer_state = &mut *peer_state_lock;
5281 let pending_msg_events = &mut peer_state.pending_msg_events;
5282 peer_state.channel_by_id.retain(|channel_id, chan| {
5283 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
5284 Ok((msg_opt, tx_opt)) => {
5285 if let Some(msg) = msg_opt {
5287 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5288 node_id: chan.get_counterparty_node_id(), msg,
5291 if let Some(tx) = tx_opt {
5292 // We're done with this channel. We got a closing_signed and sent back
5293 // a closing_signed with a closing transaction to broadcast.
5294 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5295 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5300 self.issue_channel_close_events(chan, ClosureReason::CooperativeClosure);
5302 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
5303 self.tx_broadcaster.broadcast_transaction(&tx);
5304 update_maps_on_chan_removal!(self, chan);
5310 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
5311 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5319 for (counterparty_node_id, err) in handle_errors.drain(..) {
5320 let _ = handle_error!(self, err, counterparty_node_id);
5326 /// Handle a list of channel failures during a block_connected or block_disconnected call,
5327 /// pushing the channel monitor update (if any) to the background events queue and removing the
5329 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
5330 for mut failure in failed_channels.drain(..) {
5331 // Either a commitment transactions has been confirmed on-chain or
5332 // Channel::block_disconnected detected that the funding transaction has been
5333 // reorganized out of the main chain.
5334 // We cannot broadcast our latest local state via monitor update (as
5335 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
5336 // so we track the update internally and handle it when the user next calls
5337 // timer_tick_occurred, guaranteeing we're running normally.
5338 if let Some((funding_txo, update)) = failure.0.take() {
5339 assert_eq!(update.updates.len(), 1);
5340 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
5341 assert!(should_broadcast);
5342 } else { unreachable!(); }
5343 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
5345 self.finish_force_close_channel(failure);
5349 fn set_payment_hash_secret_map(&self, payment_hash: PaymentHash, payment_preimage: Option<PaymentPreimage>, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<PaymentSecret, APIError> {
5350 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
5352 if min_value_msat.is_some() && min_value_msat.unwrap() > MAX_VALUE_MSAT {
5353 return Err(APIError::APIMisuseError { err: format!("min_value_msat of {} greater than total 21 million bitcoin supply", min_value_msat.unwrap()) });
5356 let payment_secret = PaymentSecret(self.entropy_source.get_secure_random_bytes());
5358 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5359 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5360 match payment_secrets.entry(payment_hash) {
5361 hash_map::Entry::Vacant(e) => {
5362 e.insert(PendingInboundPayment {
5363 payment_secret, min_value_msat, payment_preimage,
5364 user_payment_id: 0, // For compatibility with version 0.0.103 and earlier
5365 // We assume that highest_seen_timestamp is pretty close to the current time -
5366 // it's updated when we receive a new block with the maximum time we've seen in
5367 // a header. It should never be more than two hours in the future.
5368 // Thus, we add two hours here as a buffer to ensure we absolutely
5369 // never fail a payment too early.
5370 // Note that we assume that received blocks have reasonably up-to-date
5372 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
5375 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
5380 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
5383 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
5384 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
5386 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
5387 /// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
5388 /// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
5389 /// passed directly to [`claim_funds`].
5391 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
5393 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5394 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5398 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5399 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5401 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5403 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
5404 /// on versions of LDK prior to 0.0.114.
5406 /// [`claim_funds`]: Self::claim_funds
5407 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
5408 /// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
5409 /// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
5410 /// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
5411 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5412 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
5413 min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
5414 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs,
5415 &self.entropy_source, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
5416 min_final_cltv_expiry_delta)
5419 /// Legacy version of [`create_inbound_payment`]. Use this method if you wish to share
5420 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5422 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5425 /// This method is deprecated and will be removed soon.
5427 /// [`create_inbound_payment`]: Self::create_inbound_payment
5429 pub fn create_inbound_payment_legacy(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), APIError> {
5430 let payment_preimage = PaymentPreimage(self.entropy_source.get_secure_random_bytes());
5431 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
5432 let payment_secret = self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs)?;
5433 Ok((payment_hash, payment_secret))
5436 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
5437 /// stored external to LDK.
5439 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
5440 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
5441 /// the `min_value_msat` provided here, if one is provided.
5443 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
5444 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
5447 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
5448 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
5449 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
5450 /// sender "proof-of-payment" unless they have paid the required amount.
5452 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
5453 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
5454 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
5455 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
5456 /// invoices when no timeout is set.
5458 /// Note that we use block header time to time-out pending inbound payments (with some margin
5459 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
5460 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
5461 /// If you need exact expiry semantics, you should enforce them upon receipt of
5462 /// [`PaymentClaimable`].
5464 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
5465 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
5467 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5468 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5472 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5473 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5475 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5477 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
5478 /// on versions of LDK prior to 0.0.114.
5480 /// [`create_inbound_payment`]: Self::create_inbound_payment
5481 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
5482 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>,
5483 invoice_expiry_delta_secs: u32, min_final_cltv_expiry: Option<u16>) -> Result<PaymentSecret, ()> {
5484 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash,
5485 invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
5486 min_final_cltv_expiry)
5489 /// Legacy version of [`create_inbound_payment_for_hash`]. Use this method if you wish to share
5490 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5492 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5495 /// This method is deprecated and will be removed soon.
5497 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5499 pub fn create_inbound_payment_for_hash_legacy(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<PaymentSecret, APIError> {
5500 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
5503 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
5504 /// previously returned from [`create_inbound_payment`].
5506 /// [`create_inbound_payment`]: Self::create_inbound_payment
5507 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
5508 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
5511 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
5512 /// are used when constructing the phantom invoice's route hints.
5514 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5515 pub fn get_phantom_scid(&self) -> u64 {
5516 let best_block_height = self.best_block.read().unwrap().height();
5517 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
5519 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
5520 // Ensure the generated scid doesn't conflict with a real channel.
5521 match short_to_chan_info.get(&scid_candidate) {
5522 Some(_) => continue,
5523 None => return scid_candidate
5528 /// Gets route hints for use in receiving [phantom node payments].
5530 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5531 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
5533 channels: self.list_usable_channels(),
5534 phantom_scid: self.get_phantom_scid(),
5535 real_node_pubkey: self.get_our_node_id(),
5539 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
5540 /// used when constructing the route hints for HTLCs intended to be intercepted. See
5541 /// [`ChannelManager::forward_intercepted_htlc`].
5543 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
5544 /// times to get a unique scid.
5545 pub fn get_intercept_scid(&self) -> u64 {
5546 let best_block_height = self.best_block.read().unwrap().height();
5547 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
5549 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
5550 // Ensure the generated scid doesn't conflict with a real channel.
5551 if short_to_chan_info.contains_key(&scid_candidate) { continue }
5552 return scid_candidate
5556 /// Gets inflight HTLC information by processing pending outbound payments that are in
5557 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
5558 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
5559 let mut inflight_htlcs = InFlightHtlcs::new();
5561 let per_peer_state = self.per_peer_state.read().unwrap();
5562 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5563 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5564 let peer_state = &mut *peer_state_lock;
5565 for chan in peer_state.channel_by_id.values() {
5566 for (htlc_source, _) in chan.inflight_htlc_sources() {
5567 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
5568 inflight_htlcs.process_path(path, self.get_our_node_id());
5577 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
5578 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
5579 let events = core::cell::RefCell::new(Vec::new());
5580 let event_handler = |event: events::Event| events.borrow_mut().push(event);
5581 self.process_pending_events(&event_handler);
5585 #[cfg(feature = "_test_utils")]
5586 pub fn push_pending_event(&self, event: events::Event) {
5587 let mut events = self.pending_events.lock().unwrap();
5592 pub fn pop_pending_event(&self) -> Option<events::Event> {
5593 let mut events = self.pending_events.lock().unwrap();
5594 if events.is_empty() { None } else { Some(events.remove(0)) }
5598 pub fn has_pending_payments(&self) -> bool {
5599 self.pending_outbound_payments.has_pending_payments()
5603 pub fn clear_pending_payments(&self) {
5604 self.pending_outbound_payments.clear_pending_payments()
5607 /// Processes any events asynchronously in the order they were generated since the last call
5608 /// using the given event handler.
5610 /// See the trait-level documentation of [`EventsProvider`] for requirements.
5611 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
5614 // We'll acquire our total consistency lock until the returned future completes so that
5615 // we can be sure no other persists happen while processing events.
5616 let _read_guard = self.total_consistency_lock.read().unwrap();
5618 let mut result = NotifyOption::SkipPersist;
5620 // TODO: This behavior should be documented. It's unintuitive that we query
5621 // ChannelMonitors when clearing other events.
5622 if self.process_pending_monitor_events() {
5623 result = NotifyOption::DoPersist;
5626 let pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5627 if !pending_events.is_empty() {
5628 result = NotifyOption::DoPersist;
5631 for event in pending_events {
5632 handler(event).await;
5635 if result == NotifyOption::DoPersist {
5636 self.persistence_notifier.notify();
5641 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>
5643 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5644 T::Target: BroadcasterInterface,
5645 ES::Target: EntropySource,
5646 NS::Target: NodeSigner,
5647 SP::Target: SignerProvider,
5648 F::Target: FeeEstimator,
5652 /// Returns `MessageSendEvent`s strictly ordered per-peer, in the order they were generated.
5653 /// The returned array will contain `MessageSendEvent`s for different peers if
5654 /// `MessageSendEvent`s to more than one peer exists, but `MessageSendEvent`s to the same peer
5655 /// is always placed next to each other.
5657 /// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
5658 /// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
5659 /// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
5660 /// will randomly be placed first or last in the returned array.
5662 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
5663 /// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
5664 /// the `MessageSendEvent`s to the specific peer they were generated under.
5665 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
5666 let events = RefCell::new(Vec::new());
5667 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5668 let mut result = NotifyOption::SkipPersist;
5670 // TODO: This behavior should be documented. It's unintuitive that we query
5671 // ChannelMonitors when clearing other events.
5672 if self.process_pending_monitor_events() {
5673 result = NotifyOption::DoPersist;
5676 if self.check_free_holding_cells() {
5677 result = NotifyOption::DoPersist;
5679 if self.maybe_generate_initial_closing_signed() {
5680 result = NotifyOption::DoPersist;
5683 let mut pending_events = Vec::new();
5684 let per_peer_state = self.per_peer_state.read().unwrap();
5685 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5686 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5687 let peer_state = &mut *peer_state_lock;
5688 if peer_state.pending_msg_events.len() > 0 {
5689 pending_events.append(&mut peer_state.pending_msg_events);
5693 if !pending_events.is_empty() {
5694 events.replace(pending_events);
5703 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>
5705 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5706 T::Target: BroadcasterInterface,
5707 ES::Target: EntropySource,
5708 NS::Target: NodeSigner,
5709 SP::Target: SignerProvider,
5710 F::Target: FeeEstimator,
5714 /// Processes events that must be periodically handled.
5716 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
5717 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
5718 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
5719 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5720 let mut result = NotifyOption::SkipPersist;
5722 // TODO: This behavior should be documented. It's unintuitive that we query
5723 // ChannelMonitors when clearing other events.
5724 if self.process_pending_monitor_events() {
5725 result = NotifyOption::DoPersist;
5728 let pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5729 if !pending_events.is_empty() {
5730 result = NotifyOption::DoPersist;
5733 for event in pending_events {
5734 handler.handle_event(event);
5742 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>
5744 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5745 T::Target: BroadcasterInterface,
5746 ES::Target: EntropySource,
5747 NS::Target: NodeSigner,
5748 SP::Target: SignerProvider,
5749 F::Target: FeeEstimator,
5753 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5755 let best_block = self.best_block.read().unwrap();
5756 assert_eq!(best_block.block_hash(), header.prev_blockhash,
5757 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
5758 assert_eq!(best_block.height(), height - 1,
5759 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
5762 self.transactions_confirmed(header, txdata, height);
5763 self.best_block_updated(header, height);
5766 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
5767 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5768 let new_height = height - 1;
5770 let mut best_block = self.best_block.write().unwrap();
5771 assert_eq!(best_block.block_hash(), header.block_hash(),
5772 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
5773 assert_eq!(best_block.height(), height,
5774 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
5775 *best_block = BestBlock::new(header.prev_blockhash, new_height)
5778 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));
5782 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>
5784 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5785 T::Target: BroadcasterInterface,
5786 ES::Target: EntropySource,
5787 NS::Target: NodeSigner,
5788 SP::Target: SignerProvider,
5789 F::Target: FeeEstimator,
5793 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5794 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5795 // during initialization prior to the chain_monitor being fully configured in some cases.
5796 // See the docs for `ChannelManagerReadArgs` for more.
5798 let block_hash = header.block_hash();
5799 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
5801 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5802 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)
5803 .map(|(a, b)| (a, Vec::new(), b)));
5805 let last_best_block_height = self.best_block.read().unwrap().height();
5806 if height < last_best_block_height {
5807 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
5808 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));
5812 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
5813 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5814 // during initialization prior to the chain_monitor being fully configured in some cases.
5815 // See the docs for `ChannelManagerReadArgs` for more.
5817 let block_hash = header.block_hash();
5818 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
5820 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5822 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
5824 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));
5826 macro_rules! max_time {
5827 ($timestamp: expr) => {
5829 // Update $timestamp to be the max of its current value and the block
5830 // timestamp. This should keep us close to the current time without relying on
5831 // having an explicit local time source.
5832 // Just in case we end up in a race, we loop until we either successfully
5833 // update $timestamp or decide we don't need to.
5834 let old_serial = $timestamp.load(Ordering::Acquire);
5835 if old_serial >= header.time as usize { break; }
5836 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
5842 max_time!(self.highest_seen_timestamp);
5843 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5844 payment_secrets.retain(|_, inbound_payment| {
5845 inbound_payment.expiry_time > header.time as u64
5849 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
5850 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
5851 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
5852 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5853 let peer_state = &mut *peer_state_lock;
5854 for chan in peer_state.channel_by_id.values() {
5855 if let (Some(funding_txo), Some(block_hash)) = (chan.get_funding_txo(), chan.get_funding_tx_confirmed_in()) {
5856 res.push((funding_txo.txid, Some(block_hash)));
5863 fn transaction_unconfirmed(&self, txid: &Txid) {
5864 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5865 self.do_chain_event(None, |channel| {
5866 if let Some(funding_txo) = channel.get_funding_txo() {
5867 if funding_txo.txid == *txid {
5868 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
5869 } else { Ok((None, Vec::new(), None)) }
5870 } else { Ok((None, Vec::new(), None)) }
5875 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>
5877 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5878 T::Target: BroadcasterInterface,
5879 ES::Target: EntropySource,
5880 NS::Target: NodeSigner,
5881 SP::Target: SignerProvider,
5882 F::Target: FeeEstimator,
5886 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
5887 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
5889 fn do_chain_event<FN: Fn(&mut Channel<<SP::Target as SignerProvider>::Signer>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
5890 (&self, height_opt: Option<u32>, f: FN) {
5891 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5892 // during initialization prior to the chain_monitor being fully configured in some cases.
5893 // See the docs for `ChannelManagerReadArgs` for more.
5895 let mut failed_channels = Vec::new();
5896 let mut timed_out_htlcs = Vec::new();
5898 let per_peer_state = self.per_peer_state.read().unwrap();
5899 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5900 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5901 let peer_state = &mut *peer_state_lock;
5902 let pending_msg_events = &mut peer_state.pending_msg_events;
5903 peer_state.channel_by_id.retain(|_, channel| {
5904 let res = f(channel);
5905 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
5906 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
5907 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
5908 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
5909 HTLCDestination::NextHopChannel { node_id: Some(channel.get_counterparty_node_id()), channel_id: channel.channel_id() }));
5911 if let Some(channel_ready) = channel_ready_opt {
5912 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
5913 if channel.is_usable() {
5914 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", log_bytes!(channel.channel_id()));
5915 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
5916 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
5917 node_id: channel.get_counterparty_node_id(),
5922 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", log_bytes!(channel.channel_id()));
5926 emit_channel_ready_event!(self, channel);
5928 if let Some(announcement_sigs) = announcement_sigs {
5929 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(channel.channel_id()));
5930 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5931 node_id: channel.get_counterparty_node_id(),
5932 msg: announcement_sigs,
5934 if let Some(height) = height_opt {
5935 if let Some(announcement) = channel.get_signed_channel_announcement(&self.node_signer, self.genesis_hash, height, &self.default_configuration) {
5936 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5938 // Note that announcement_signatures fails if the channel cannot be announced,
5939 // so get_channel_update_for_broadcast will never fail by the time we get here.
5940 update_msg: Some(self.get_channel_update_for_broadcast(channel).unwrap()),
5945 if channel.is_our_channel_ready() {
5946 if let Some(real_scid) = channel.get_short_channel_id() {
5947 // If we sent a 0conf channel_ready, and now have an SCID, we add it
5948 // to the short_to_chan_info map here. Note that we check whether we
5949 // can relay using the real SCID at relay-time (i.e.
5950 // enforce option_scid_alias then), and if the funding tx is ever
5951 // un-confirmed we force-close the channel, ensuring short_to_chan_info
5952 // is always consistent.
5953 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
5954 let scid_insert = short_to_chan_info.insert(real_scid, (channel.get_counterparty_node_id(), channel.channel_id()));
5955 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.get_counterparty_node_id(), channel.channel_id()),
5956 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
5957 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
5960 } else if let Err(reason) = res {
5961 update_maps_on_chan_removal!(self, channel);
5962 // It looks like our counterparty went on-chain or funding transaction was
5963 // reorged out of the main chain. Close the channel.
5964 failed_channels.push(channel.force_shutdown(true));
5965 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
5966 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5970 let reason_message = format!("{}", reason);
5971 self.issue_channel_close_events(channel, reason);
5972 pending_msg_events.push(events::MessageSendEvent::HandleError {
5973 node_id: channel.get_counterparty_node_id(),
5974 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
5975 channel_id: channel.channel_id(),
5976 data: reason_message,
5986 if let Some(height) = height_opt {
5987 self.claimable_payments.lock().unwrap().claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
5988 htlcs.retain(|htlc| {
5989 // If height is approaching the number of blocks we think it takes us to get
5990 // our commitment transaction confirmed before the HTLC expires, plus the
5991 // number of blocks we generally consider it to take to do a commitment update,
5992 // just give up on it and fail the HTLC.
5993 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
5994 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5995 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
5997 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
5998 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
5999 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
6003 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
6006 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
6007 intercepted_htlcs.retain(|_, htlc| {
6008 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
6009 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
6010 short_channel_id: htlc.prev_short_channel_id,
6011 htlc_id: htlc.prev_htlc_id,
6012 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
6013 phantom_shared_secret: None,
6014 outpoint: htlc.prev_funding_outpoint,
6017 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
6018 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
6019 _ => unreachable!(),
6021 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
6022 HTLCFailReason::from_failure_code(0x2000 | 2),
6023 HTLCDestination::InvalidForward { requested_forward_scid }));
6024 log_trace!(self.logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
6030 self.handle_init_event_channel_failures(failed_channels);
6032 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
6033 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
6037 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
6038 /// indicating whether persistence is necessary. Only one listener on
6039 /// [`await_persistable_update`], [`await_persistable_update_timeout`], or a future returned by
6040 /// [`get_persistable_update_future`] is guaranteed to be woken up.
6042 /// Note that this method is not available with the `no-std` feature.
6044 /// [`await_persistable_update`]: Self::await_persistable_update
6045 /// [`await_persistable_update_timeout`]: Self::await_persistable_update_timeout
6046 /// [`get_persistable_update_future`]: Self::get_persistable_update_future
6047 #[cfg(any(test, feature = "std"))]
6048 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
6049 self.persistence_notifier.wait_timeout(max_wait)
6052 /// Blocks until ChannelManager needs to be persisted. Only one listener on
6053 /// [`await_persistable_update`], `await_persistable_update_timeout`, or a future returned by
6054 /// [`get_persistable_update_future`] is guaranteed to be woken up.
6056 /// [`await_persistable_update`]: Self::await_persistable_update
6057 /// [`get_persistable_update_future`]: Self::get_persistable_update_future
6058 pub fn await_persistable_update(&self) {
6059 self.persistence_notifier.wait()
6062 /// Gets a [`Future`] that completes when a persistable update is available. Note that
6063 /// callbacks registered on the [`Future`] MUST NOT call back into this [`ChannelManager`] and
6064 /// should instead register actions to be taken later.
6065 pub fn get_persistable_update_future(&self) -> Future {
6066 self.persistence_notifier.get_future()
6069 #[cfg(any(test, feature = "_test_utils"))]
6070 pub fn get_persistence_condvar_value(&self) -> bool {
6071 self.persistence_notifier.notify_pending()
6074 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
6075 /// [`chain::Confirm`] interfaces.
6076 pub fn current_best_block(&self) -> BestBlock {
6077 self.best_block.read().unwrap().clone()
6080 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
6081 /// [`ChannelManager`].
6082 pub fn node_features(&self) -> NodeFeatures {
6083 provided_node_features(&self.default_configuration)
6086 /// Fetches the set of [`InvoiceFeatures`] flags which are provided by or required by
6087 /// [`ChannelManager`].
6089 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
6090 /// or not. Thus, this method is not public.
6091 #[cfg(any(feature = "_test_utils", test))]
6092 pub fn invoice_features(&self) -> InvoiceFeatures {
6093 provided_invoice_features(&self.default_configuration)
6096 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
6097 /// [`ChannelManager`].
6098 pub fn channel_features(&self) -> ChannelFeatures {
6099 provided_channel_features(&self.default_configuration)
6102 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
6103 /// [`ChannelManager`].
6104 pub fn channel_type_features(&self) -> ChannelTypeFeatures {
6105 provided_channel_type_features(&self.default_configuration)
6108 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
6109 /// [`ChannelManager`].
6110 pub fn init_features(&self) -> InitFeatures {
6111 provided_init_features(&self.default_configuration)
6115 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
6116 ChannelMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
6118 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6119 T::Target: BroadcasterInterface,
6120 ES::Target: EntropySource,
6121 NS::Target: NodeSigner,
6122 SP::Target: SignerProvider,
6123 F::Target: FeeEstimator,
6127 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) {
6128 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6129 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, msg), *counterparty_node_id);
6132 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
6133 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6134 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, msg), *counterparty_node_id);
6137 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
6138 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6139 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
6142 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
6143 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6144 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
6147 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
6148 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6149 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
6152 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
6153 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6154 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
6157 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
6158 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6159 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
6162 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
6163 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6164 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
6167 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
6168 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6169 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
6172 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
6173 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6174 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
6177 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
6178 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6179 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
6182 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
6183 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6184 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
6187 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
6188 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6189 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
6192 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
6193 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6194 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
6197 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
6198 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6199 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
6202 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
6203 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
6204 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
6207 NotifyOption::SkipPersist
6212 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
6213 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6214 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
6217 fn peer_disconnected(&self, counterparty_node_id: &PublicKey) {
6218 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6219 let mut failed_channels = Vec::new();
6220 let mut per_peer_state = self.per_peer_state.write().unwrap();
6222 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates.",
6223 log_pubkey!(counterparty_node_id));
6224 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
6225 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6226 let peer_state = &mut *peer_state_lock;
6227 let pending_msg_events = &mut peer_state.pending_msg_events;
6228 peer_state.channel_by_id.retain(|_, chan| {
6229 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
6230 if chan.is_shutdown() {
6231 update_maps_on_chan_removal!(self, chan);
6232 self.issue_channel_close_events(chan, ClosureReason::DisconnectedPeer);
6237 pending_msg_events.retain(|msg| {
6239 &events::MessageSendEvent::SendAcceptChannel { .. } => false,
6240 &events::MessageSendEvent::SendOpenChannel { .. } => false,
6241 &events::MessageSendEvent::SendFundingCreated { .. } => false,
6242 &events::MessageSendEvent::SendFundingSigned { .. } => false,
6243 &events::MessageSendEvent::SendChannelReady { .. } => false,
6244 &events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
6245 &events::MessageSendEvent::UpdateHTLCs { .. } => false,
6246 &events::MessageSendEvent::SendRevokeAndACK { .. } => false,
6247 &events::MessageSendEvent::SendClosingSigned { .. } => false,
6248 &events::MessageSendEvent::SendShutdown { .. } => false,
6249 &events::MessageSendEvent::SendChannelReestablish { .. } => false,
6250 &events::MessageSendEvent::SendChannelAnnouncement { .. } => false,
6251 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
6252 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
6253 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
6254 &events::MessageSendEvent::SendChannelUpdate { .. } => false,
6255 &events::MessageSendEvent::HandleError { .. } => false,
6256 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
6257 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
6258 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
6259 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
6262 debug_assert!(peer_state.is_connected, "A disconnected peer cannot disconnect");
6263 peer_state.is_connected = false;
6264 peer_state.ok_to_remove(true)
6265 } else { debug_assert!(false, "Unconnected peer disconnected"); true }
6268 per_peer_state.remove(counterparty_node_id);
6270 mem::drop(per_peer_state);
6272 for failure in failed_channels.drain(..) {
6273 self.finish_force_close_channel(failure);
6277 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init, inbound: bool) -> Result<(), ()> {
6278 if !init_msg.features.supports_static_remote_key() {
6279 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting", log_pubkey!(counterparty_node_id));
6283 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6285 // If we have too many peers connected which don't have funded channels, disconnect the
6286 // peer immediately (as long as it doesn't have funded channels). If we have a bunch of
6287 // unfunded channels taking up space in memory for disconnected peers, we still let new
6288 // peers connect, but we'll reject new channels from them.
6289 let connected_peers_without_funded_channels = self.peers_without_funded_channels(|node| node.is_connected);
6290 let inbound_peer_limited = inbound && connected_peers_without_funded_channels >= MAX_NO_CHANNEL_PEERS;
6293 let mut peer_state_lock = self.per_peer_state.write().unwrap();
6294 match peer_state_lock.entry(counterparty_node_id.clone()) {
6295 hash_map::Entry::Vacant(e) => {
6296 if inbound_peer_limited {
6299 e.insert(Mutex::new(PeerState {
6300 channel_by_id: HashMap::new(),
6301 latest_features: init_msg.features.clone(),
6302 pending_msg_events: Vec::new(),
6303 monitor_update_blocked_actions: BTreeMap::new(),
6307 hash_map::Entry::Occupied(e) => {
6308 let mut peer_state = e.get().lock().unwrap();
6309 peer_state.latest_features = init_msg.features.clone();
6311 let best_block_height = self.best_block.read().unwrap().height();
6312 if inbound_peer_limited &&
6313 Self::unfunded_channel_count(&*peer_state, best_block_height) ==
6314 peer_state.channel_by_id.len()
6319 debug_assert!(!peer_state.is_connected, "A peer shouldn't be connected twice");
6320 peer_state.is_connected = true;
6325 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
6327 let per_peer_state = self.per_peer_state.read().unwrap();
6328 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6329 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6330 let peer_state = &mut *peer_state_lock;
6331 let pending_msg_events = &mut peer_state.pending_msg_events;
6332 peer_state.channel_by_id.retain(|_, chan| {
6333 let retain = if chan.get_counterparty_node_id() == *counterparty_node_id {
6334 if !chan.have_received_message() {
6335 // If we created this (outbound) channel while we were disconnected from the
6336 // peer we probably failed to send the open_channel message, which is now
6337 // lost. We can't have had anything pending related to this channel, so we just
6341 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
6342 node_id: chan.get_counterparty_node_id(),
6343 msg: chan.get_channel_reestablish(&self.logger),
6348 if retain && chan.get_counterparty_node_id() != *counterparty_node_id {
6349 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) {
6350 if let Ok(update_msg) = self.get_channel_update_for_broadcast(chan) {
6351 pending_msg_events.push(events::MessageSendEvent::SendChannelAnnouncement {
6352 node_id: *counterparty_node_id,
6361 //TODO: Also re-broadcast announcement_signatures
6365 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
6366 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6368 if msg.channel_id == [0; 32] {
6369 let channel_ids: Vec<[u8; 32]> = {
6370 let per_peer_state = self.per_peer_state.read().unwrap();
6371 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
6372 if peer_state_mutex_opt.is_none() { return; }
6373 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
6374 let peer_state = &mut *peer_state_lock;
6375 peer_state.channel_by_id.keys().cloned().collect()
6377 for channel_id in channel_ids {
6378 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6379 let _ = self.force_close_channel_with_peer(&channel_id, counterparty_node_id, Some(&msg.data), true);
6383 // First check if we can advance the channel type and try again.
6384 let per_peer_state = self.per_peer_state.read().unwrap();
6385 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
6386 if peer_state_mutex_opt.is_none() { return; }
6387 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
6388 let peer_state = &mut *peer_state_lock;
6389 if let Some(chan) = peer_state.channel_by_id.get_mut(&msg.channel_id) {
6390 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash) {
6391 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
6392 node_id: *counterparty_node_id,
6400 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6401 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
6405 fn provided_node_features(&self) -> NodeFeatures {
6406 provided_node_features(&self.default_configuration)
6409 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
6410 provided_init_features(&self.default_configuration)
6414 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
6415 /// [`ChannelManager`].
6416 pub(crate) fn provided_node_features(config: &UserConfig) -> NodeFeatures {
6417 provided_init_features(config).to_context()
6420 /// Fetches the set of [`InvoiceFeatures`] flags which are provided by or required by
6421 /// [`ChannelManager`].
6423 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
6424 /// or not. Thus, this method is not public.
6425 #[cfg(any(feature = "_test_utils", test))]
6426 pub(crate) fn provided_invoice_features(config: &UserConfig) -> InvoiceFeatures {
6427 provided_init_features(config).to_context()
6430 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
6431 /// [`ChannelManager`].
6432 pub(crate) fn provided_channel_features(config: &UserConfig) -> ChannelFeatures {
6433 provided_init_features(config).to_context()
6436 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
6437 /// [`ChannelManager`].
6438 pub(crate) fn provided_channel_type_features(config: &UserConfig) -> ChannelTypeFeatures {
6439 ChannelTypeFeatures::from_init(&provided_init_features(config))
6442 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
6443 /// [`ChannelManager`].
6444 pub fn provided_init_features(_config: &UserConfig) -> InitFeatures {
6445 // Note that if new features are added here which other peers may (eventually) require, we
6446 // should also add the corresponding (optional) bit to the ChannelMessageHandler impl for
6447 // ErroringMessageHandler.
6448 let mut features = InitFeatures::empty();
6449 features.set_data_loss_protect_optional();
6450 features.set_upfront_shutdown_script_optional();
6451 features.set_variable_length_onion_required();
6452 features.set_static_remote_key_required();
6453 features.set_payment_secret_required();
6454 features.set_basic_mpp_optional();
6455 features.set_wumbo_optional();
6456 features.set_shutdown_any_segwit_optional();
6457 features.set_channel_type_optional();
6458 features.set_scid_privacy_optional();
6459 features.set_zero_conf_optional();
6461 { // Attributes are not allowed on if expressions on our current MSRV of 1.41.
6462 if _config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx {
6463 features.set_anchors_zero_fee_htlc_tx_optional();
6469 const SERIALIZATION_VERSION: u8 = 1;
6470 const MIN_SERIALIZATION_VERSION: u8 = 1;
6472 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
6473 (2, fee_base_msat, required),
6474 (4, fee_proportional_millionths, required),
6475 (6, cltv_expiry_delta, required),
6478 impl_writeable_tlv_based!(ChannelCounterparty, {
6479 (2, node_id, required),
6480 (4, features, required),
6481 (6, unspendable_punishment_reserve, required),
6482 (8, forwarding_info, option),
6483 (9, outbound_htlc_minimum_msat, option),
6484 (11, outbound_htlc_maximum_msat, option),
6487 impl Writeable for ChannelDetails {
6488 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6489 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
6490 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
6491 let user_channel_id_low = self.user_channel_id as u64;
6492 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
6493 write_tlv_fields!(writer, {
6494 (1, self.inbound_scid_alias, option),
6495 (2, self.channel_id, required),
6496 (3, self.channel_type, option),
6497 (4, self.counterparty, required),
6498 (5, self.outbound_scid_alias, option),
6499 (6, self.funding_txo, option),
6500 (7, self.config, option),
6501 (8, self.short_channel_id, option),
6502 (9, self.confirmations, option),
6503 (10, self.channel_value_satoshis, required),
6504 (12, self.unspendable_punishment_reserve, option),
6505 (14, user_channel_id_low, required),
6506 (16, self.balance_msat, required),
6507 (18, self.outbound_capacity_msat, required),
6508 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6509 // filled in, so we can safely unwrap it here.
6510 (19, self.next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6511 (20, self.inbound_capacity_msat, required),
6512 (22, self.confirmations_required, option),
6513 (24, self.force_close_spend_delay, option),
6514 (26, self.is_outbound, required),
6515 (28, self.is_channel_ready, required),
6516 (30, self.is_usable, required),
6517 (32, self.is_public, required),
6518 (33, self.inbound_htlc_minimum_msat, option),
6519 (35, self.inbound_htlc_maximum_msat, option),
6520 (37, user_channel_id_high_opt, option),
6526 impl Readable for ChannelDetails {
6527 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6528 _init_and_read_tlv_fields!(reader, {
6529 (1, inbound_scid_alias, option),
6530 (2, channel_id, required),
6531 (3, channel_type, option),
6532 (4, counterparty, required),
6533 (5, outbound_scid_alias, option),
6534 (6, funding_txo, option),
6535 (7, config, option),
6536 (8, short_channel_id, option),
6537 (9, confirmations, option),
6538 (10, channel_value_satoshis, required),
6539 (12, unspendable_punishment_reserve, option),
6540 (14, user_channel_id_low, required),
6541 (16, balance_msat, required),
6542 (18, outbound_capacity_msat, required),
6543 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6544 // filled in, so we can safely unwrap it here.
6545 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6546 (20, inbound_capacity_msat, required),
6547 (22, confirmations_required, option),
6548 (24, force_close_spend_delay, option),
6549 (26, is_outbound, required),
6550 (28, is_channel_ready, required),
6551 (30, is_usable, required),
6552 (32, is_public, required),
6553 (33, inbound_htlc_minimum_msat, option),
6554 (35, inbound_htlc_maximum_msat, option),
6555 (37, user_channel_id_high_opt, option),
6558 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
6559 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
6560 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
6561 let user_channel_id = user_channel_id_low as u128 +
6562 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
6566 channel_id: channel_id.0.unwrap(),
6568 counterparty: counterparty.0.unwrap(),
6569 outbound_scid_alias,
6573 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
6574 unspendable_punishment_reserve,
6576 balance_msat: balance_msat.0.unwrap(),
6577 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
6578 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
6579 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
6580 confirmations_required,
6582 force_close_spend_delay,
6583 is_outbound: is_outbound.0.unwrap(),
6584 is_channel_ready: is_channel_ready.0.unwrap(),
6585 is_usable: is_usable.0.unwrap(),
6586 is_public: is_public.0.unwrap(),
6587 inbound_htlc_minimum_msat,
6588 inbound_htlc_maximum_msat,
6593 impl_writeable_tlv_based!(PhantomRouteHints, {
6594 (2, channels, vec_type),
6595 (4, phantom_scid, required),
6596 (6, real_node_pubkey, required),
6599 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
6601 (0, onion_packet, required),
6602 (2, short_channel_id, required),
6605 (0, payment_data, required),
6606 (1, phantom_shared_secret, option),
6607 (2, incoming_cltv_expiry, required),
6609 (2, ReceiveKeysend) => {
6610 (0, payment_preimage, required),
6611 (2, incoming_cltv_expiry, required),
6615 impl_writeable_tlv_based!(PendingHTLCInfo, {
6616 (0, routing, required),
6617 (2, incoming_shared_secret, required),
6618 (4, payment_hash, required),
6619 (6, outgoing_amt_msat, required),
6620 (8, outgoing_cltv_value, required),
6621 (9, incoming_amt_msat, option),
6625 impl Writeable for HTLCFailureMsg {
6626 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6628 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
6630 channel_id.write(writer)?;
6631 htlc_id.write(writer)?;
6632 reason.write(writer)?;
6634 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6635 channel_id, htlc_id, sha256_of_onion, failure_code
6638 channel_id.write(writer)?;
6639 htlc_id.write(writer)?;
6640 sha256_of_onion.write(writer)?;
6641 failure_code.write(writer)?;
6648 impl Readable for HTLCFailureMsg {
6649 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6650 let id: u8 = Readable::read(reader)?;
6653 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
6654 channel_id: Readable::read(reader)?,
6655 htlc_id: Readable::read(reader)?,
6656 reason: Readable::read(reader)?,
6660 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6661 channel_id: Readable::read(reader)?,
6662 htlc_id: Readable::read(reader)?,
6663 sha256_of_onion: Readable::read(reader)?,
6664 failure_code: Readable::read(reader)?,
6667 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
6668 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
6669 // messages contained in the variants.
6670 // In version 0.0.101, support for reading the variants with these types was added, and
6671 // we should migrate to writing these variants when UpdateFailHTLC or
6672 // UpdateFailMalformedHTLC get TLV fields.
6674 let length: BigSize = Readable::read(reader)?;
6675 let mut s = FixedLengthReader::new(reader, length.0);
6676 let res = Readable::read(&mut s)?;
6677 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6678 Ok(HTLCFailureMsg::Relay(res))
6681 let length: BigSize = Readable::read(reader)?;
6682 let mut s = FixedLengthReader::new(reader, length.0);
6683 let res = Readable::read(&mut s)?;
6684 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6685 Ok(HTLCFailureMsg::Malformed(res))
6687 _ => Err(DecodeError::UnknownRequiredFeature),
6692 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
6697 impl_writeable_tlv_based!(HTLCPreviousHopData, {
6698 (0, short_channel_id, required),
6699 (1, phantom_shared_secret, option),
6700 (2, outpoint, required),
6701 (4, htlc_id, required),
6702 (6, incoming_packet_shared_secret, required)
6705 impl Writeable for ClaimableHTLC {
6706 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6707 let (payment_data, keysend_preimage) = match &self.onion_payload {
6708 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
6709 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
6711 write_tlv_fields!(writer, {
6712 (0, self.prev_hop, required),
6713 (1, self.total_msat, required),
6714 (2, self.value, required),
6715 (4, payment_data, option),
6716 (6, self.cltv_expiry, required),
6717 (8, keysend_preimage, option),
6723 impl Readable for ClaimableHTLC {
6724 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6725 let mut prev_hop = crate::util::ser::RequiredWrapper(None);
6727 let mut payment_data: Option<msgs::FinalOnionHopData> = None;
6728 let mut cltv_expiry = 0;
6729 let mut total_msat = None;
6730 let mut keysend_preimage: Option<PaymentPreimage> = None;
6731 read_tlv_fields!(reader, {
6732 (0, prev_hop, required),
6733 (1, total_msat, option),
6734 (2, value, required),
6735 (4, payment_data, option),
6736 (6, cltv_expiry, required),
6737 (8, keysend_preimage, option)
6739 let onion_payload = match keysend_preimage {
6741 if payment_data.is_some() {
6742 return Err(DecodeError::InvalidValue)
6744 if total_msat.is_none() {
6745 total_msat = Some(value);
6747 OnionPayload::Spontaneous(p)
6750 if total_msat.is_none() {
6751 if payment_data.is_none() {
6752 return Err(DecodeError::InvalidValue)
6754 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
6756 OnionPayload::Invoice { _legacy_hop_data: payment_data }
6760 prev_hop: prev_hop.0.unwrap(),
6763 total_msat: total_msat.unwrap(),
6770 impl Readable for HTLCSource {
6771 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6772 let id: u8 = Readable::read(reader)?;
6775 let mut session_priv: crate::util::ser::RequiredWrapper<SecretKey> = crate::util::ser::RequiredWrapper(None);
6776 let mut first_hop_htlc_msat: u64 = 0;
6777 let mut path: Option<Vec<RouteHop>> = Some(Vec::new());
6778 let mut payment_id = None;
6779 let mut payment_secret = None;
6780 let mut payment_params: Option<PaymentParameters> = None;
6781 read_tlv_fields!(reader, {
6782 (0, session_priv, required),
6783 (1, payment_id, option),
6784 (2, first_hop_htlc_msat, required),
6785 (3, payment_secret, option),
6786 (4, path, vec_type),
6787 (5, payment_params, (option: ReadableArgs, 0)),
6789 if payment_id.is_none() {
6790 // For backwards compat, if there was no payment_id written, use the session_priv bytes
6792 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
6794 if path.is_none() || path.as_ref().unwrap().is_empty() {
6795 return Err(DecodeError::InvalidValue);
6797 let path = path.unwrap();
6798 if let Some(params) = payment_params.as_mut() {
6799 if params.final_cltv_expiry_delta == 0 {
6800 params.final_cltv_expiry_delta = path.last().unwrap().cltv_expiry_delta;
6803 Ok(HTLCSource::OutboundRoute {
6804 session_priv: session_priv.0.unwrap(),
6805 first_hop_htlc_msat,
6807 payment_id: payment_id.unwrap(),
6812 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
6813 _ => Err(DecodeError::UnknownRequiredFeature),
6818 impl Writeable for HTLCSource {
6819 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
6821 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id, payment_secret, payment_params } => {
6823 let payment_id_opt = Some(payment_id);
6824 write_tlv_fields!(writer, {
6825 (0, session_priv, required),
6826 (1, payment_id_opt, option),
6827 (2, first_hop_htlc_msat, required),
6828 (3, payment_secret, option),
6829 (4, *path, vec_type),
6830 (5, payment_params, option),
6833 HTLCSource::PreviousHopData(ref field) => {
6835 field.write(writer)?;
6842 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
6843 (0, forward_info, required),
6844 (1, prev_user_channel_id, (default_value, 0)),
6845 (2, prev_short_channel_id, required),
6846 (4, prev_htlc_id, required),
6847 (6, prev_funding_outpoint, required),
6850 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
6852 (0, htlc_id, required),
6853 (2, err_packet, required),
6858 impl_writeable_tlv_based!(PendingInboundPayment, {
6859 (0, payment_secret, required),
6860 (2, expiry_time, required),
6861 (4, user_payment_id, required),
6862 (6, payment_preimage, required),
6863 (8, min_value_msat, required),
6866 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>
6868 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6869 T::Target: BroadcasterInterface,
6870 ES::Target: EntropySource,
6871 NS::Target: NodeSigner,
6872 SP::Target: SignerProvider,
6873 F::Target: FeeEstimator,
6877 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6878 let _consistency_lock = self.total_consistency_lock.write().unwrap();
6880 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
6882 self.genesis_hash.write(writer)?;
6884 let best_block = self.best_block.read().unwrap();
6885 best_block.height().write(writer)?;
6886 best_block.block_hash().write(writer)?;
6889 let mut serializable_peer_count: u64 = 0;
6891 let per_peer_state = self.per_peer_state.read().unwrap();
6892 let mut unfunded_channels = 0;
6893 let mut number_of_channels = 0;
6894 for (_, peer_state_mutex) in per_peer_state.iter() {
6895 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6896 let peer_state = &mut *peer_state_lock;
6897 if !peer_state.ok_to_remove(false) {
6898 serializable_peer_count += 1;
6900 number_of_channels += peer_state.channel_by_id.len();
6901 for (_, channel) in peer_state.channel_by_id.iter() {
6902 if !channel.is_funding_initiated() {
6903 unfunded_channels += 1;
6908 ((number_of_channels - unfunded_channels) as u64).write(writer)?;
6910 for (_, peer_state_mutex) in per_peer_state.iter() {
6911 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6912 let peer_state = &mut *peer_state_lock;
6913 for (_, channel) in peer_state.channel_by_id.iter() {
6914 if channel.is_funding_initiated() {
6915 channel.write(writer)?;
6922 let forward_htlcs = self.forward_htlcs.lock().unwrap();
6923 (forward_htlcs.len() as u64).write(writer)?;
6924 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
6925 short_channel_id.write(writer)?;
6926 (pending_forwards.len() as u64).write(writer)?;
6927 for forward in pending_forwards {
6928 forward.write(writer)?;
6933 let per_peer_state = self.per_peer_state.write().unwrap();
6935 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
6936 let claimable_payments = self.claimable_payments.lock().unwrap();
6937 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
6939 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
6940 (claimable_payments.claimable_htlcs.len() as u64).write(writer)?;
6941 for (payment_hash, (purpose, previous_hops)) in claimable_payments.claimable_htlcs.iter() {
6942 payment_hash.write(writer)?;
6943 (previous_hops.len() as u64).write(writer)?;
6944 for htlc in previous_hops.iter() {
6945 htlc.write(writer)?;
6947 htlc_purposes.push(purpose);
6950 let mut monitor_update_blocked_actions_per_peer = None;
6951 let mut peer_states = Vec::new();
6952 for (_, peer_state_mutex) in per_peer_state.iter() {
6953 // Because we're holding the owning `per_peer_state` write lock here there's no chance
6954 // of a lockorder violation deadlock - no other thread can be holding any
6955 // per_peer_state lock at all.
6956 peer_states.push(peer_state_mutex.unsafe_well_ordered_double_lock_self());
6959 (serializable_peer_count).write(writer)?;
6960 for ((peer_pubkey, _), peer_state) in per_peer_state.iter().zip(peer_states.iter()) {
6961 // Peers which we have no channels to should be dropped once disconnected. As we
6962 // disconnect all peers when shutting down and serializing the ChannelManager, we
6963 // consider all peers as disconnected here. There's therefore no need write peers with
6965 if !peer_state.ok_to_remove(false) {
6966 peer_pubkey.write(writer)?;
6967 peer_state.latest_features.write(writer)?;
6968 if !peer_state.monitor_update_blocked_actions.is_empty() {
6969 monitor_update_blocked_actions_per_peer
6970 .get_or_insert_with(Vec::new)
6971 .push((*peer_pubkey, &peer_state.monitor_update_blocked_actions));
6976 let events = self.pending_events.lock().unwrap();
6977 (events.len() as u64).write(writer)?;
6978 for event in events.iter() {
6979 event.write(writer)?;
6982 let background_events = self.pending_background_events.lock().unwrap();
6983 (background_events.len() as u64).write(writer)?;
6984 for event in background_events.iter() {
6986 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
6988 funding_txo.write(writer)?;
6989 monitor_update.write(writer)?;
6994 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
6995 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
6996 // likely to be identical.
6997 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
6998 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
7000 (pending_inbound_payments.len() as u64).write(writer)?;
7001 for (hash, pending_payment) in pending_inbound_payments.iter() {
7002 hash.write(writer)?;
7003 pending_payment.write(writer)?;
7006 // For backwards compat, write the session privs and their total length.
7007 let mut num_pending_outbounds_compat: u64 = 0;
7008 for (_, outbound) in pending_outbound_payments.iter() {
7009 if !outbound.is_fulfilled() && !outbound.abandoned() {
7010 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
7013 num_pending_outbounds_compat.write(writer)?;
7014 for (_, outbound) in pending_outbound_payments.iter() {
7016 PendingOutboundPayment::Legacy { session_privs } |
7017 PendingOutboundPayment::Retryable { session_privs, .. } => {
7018 for session_priv in session_privs.iter() {
7019 session_priv.write(writer)?;
7022 PendingOutboundPayment::Fulfilled { .. } => {},
7023 PendingOutboundPayment::Abandoned { .. } => {},
7027 // Encode without retry info for 0.0.101 compatibility.
7028 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
7029 for (id, outbound) in pending_outbound_payments.iter() {
7031 PendingOutboundPayment::Legacy { session_privs } |
7032 PendingOutboundPayment::Retryable { session_privs, .. } => {
7033 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
7039 let mut pending_intercepted_htlcs = None;
7040 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
7041 if our_pending_intercepts.len() != 0 {
7042 pending_intercepted_htlcs = Some(our_pending_intercepts);
7045 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
7046 if pending_claiming_payments.as_ref().unwrap().is_empty() {
7047 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
7048 // map. Thus, if there are no entries we skip writing a TLV for it.
7049 pending_claiming_payments = None;
7052 write_tlv_fields!(writer, {
7053 (1, pending_outbound_payments_no_retry, required),
7054 (2, pending_intercepted_htlcs, option),
7055 (3, pending_outbound_payments, required),
7056 (4, pending_claiming_payments, option),
7057 (5, self.our_network_pubkey, required),
7058 (6, monitor_update_blocked_actions_per_peer, option),
7059 (7, self.fake_scid_rand_bytes, required),
7060 (9, htlc_purposes, vec_type),
7061 (11, self.probing_cookie_secret, required),
7068 /// Arguments for the creation of a ChannelManager that are not deserialized.
7070 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
7072 /// 1) Deserialize all stored [`ChannelMonitor`]s.
7073 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
7074 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
7075 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
7076 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
7077 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
7078 /// same way you would handle a [`chain::Filter`] call using
7079 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
7080 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
7081 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
7082 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
7083 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
7084 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
7086 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
7087 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
7089 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
7090 /// call any other methods on the newly-deserialized [`ChannelManager`].
7092 /// Note that because some channels may be closed during deserialization, it is critical that you
7093 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
7094 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
7095 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
7096 /// not force-close the same channels but consider them live), you may end up revoking a state for
7097 /// which you've already broadcasted the transaction.
7099 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
7100 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7102 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7103 T::Target: BroadcasterInterface,
7104 ES::Target: EntropySource,
7105 NS::Target: NodeSigner,
7106 SP::Target: SignerProvider,
7107 F::Target: FeeEstimator,
7111 /// A cryptographically secure source of entropy.
7112 pub entropy_source: ES,
7114 /// A signer that is able to perform node-scoped cryptographic operations.
7115 pub node_signer: NS,
7117 /// The keys provider which will give us relevant keys. Some keys will be loaded during
7118 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
7120 pub signer_provider: SP,
7122 /// The fee_estimator for use in the ChannelManager in the future.
7124 /// No calls to the FeeEstimator will be made during deserialization.
7125 pub fee_estimator: F,
7126 /// The chain::Watch for use in the ChannelManager in the future.
7128 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
7129 /// you have deserialized ChannelMonitors separately and will add them to your
7130 /// chain::Watch after deserializing this ChannelManager.
7131 pub chain_monitor: M,
7133 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
7134 /// used to broadcast the latest local commitment transactions of channels which must be
7135 /// force-closed during deserialization.
7136 pub tx_broadcaster: T,
7137 /// The router which will be used in the ChannelManager in the future for finding routes
7138 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
7140 /// No calls to the router will be made during deserialization.
7142 /// The Logger for use in the ChannelManager and which may be used to log information during
7143 /// deserialization.
7145 /// Default settings used for new channels. Any existing channels will continue to use the
7146 /// runtime settings which were stored when the ChannelManager was serialized.
7147 pub default_config: UserConfig,
7149 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
7150 /// value.get_funding_txo() should be the key).
7152 /// If a monitor is inconsistent with the channel state during deserialization the channel will
7153 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
7154 /// is true for missing channels as well. If there is a monitor missing for which we find
7155 /// channel data Err(DecodeError::InvalidValue) will be returned.
7157 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
7160 /// (C-not exported) because we have no HashMap bindings
7161 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>,
7164 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7165 ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>
7167 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7168 T::Target: BroadcasterInterface,
7169 ES::Target: EntropySource,
7170 NS::Target: NodeSigner,
7171 SP::Target: SignerProvider,
7172 F::Target: FeeEstimator,
7176 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
7177 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
7178 /// populate a HashMap directly from C.
7179 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,
7180 mut channel_monitors: Vec<&'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>) -> Self {
7182 entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
7183 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
7188 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
7189 // SipmleArcChannelManager type:
7190 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7191 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, ES, NS, SP, F, R, L>>)
7193 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7194 T::Target: BroadcasterInterface,
7195 ES::Target: EntropySource,
7196 NS::Target: NodeSigner,
7197 SP::Target: SignerProvider,
7198 F::Target: FeeEstimator,
7202 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
7203 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)>::read(reader, args)?;
7204 Ok((blockhash, Arc::new(chan_manager)))
7208 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7209 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)
7211 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7212 T::Target: BroadcasterInterface,
7213 ES::Target: EntropySource,
7214 NS::Target: NodeSigner,
7215 SP::Target: SignerProvider,
7216 F::Target: FeeEstimator,
7220 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
7221 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
7223 let genesis_hash: BlockHash = Readable::read(reader)?;
7224 let best_block_height: u32 = Readable::read(reader)?;
7225 let best_block_hash: BlockHash = Readable::read(reader)?;
7227 let mut failed_htlcs = Vec::new();
7229 let channel_count: u64 = Readable::read(reader)?;
7230 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
7231 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));
7232 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7233 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7234 let mut channel_closures = Vec::new();
7235 for _ in 0..channel_count {
7236 let mut channel: Channel<<SP::Target as SignerProvider>::Signer> = Channel::read(reader, (
7237 &args.entropy_source, &args.signer_provider, best_block_height, &provided_channel_type_features(&args.default_config)
7239 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
7240 funding_txo_set.insert(funding_txo.clone());
7241 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
7242 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
7243 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
7244 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
7245 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
7246 // If the channel is ahead of the monitor, return InvalidValue:
7247 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
7248 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
7249 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
7250 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
7251 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
7252 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
7253 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");
7254 return Err(DecodeError::InvalidValue);
7255 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
7256 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
7257 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
7258 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
7259 // But if the channel is behind of the monitor, close the channel:
7260 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
7261 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
7262 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
7263 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
7264 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
7265 failed_htlcs.append(&mut new_failed_htlcs);
7266 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
7267 channel_closures.push(events::Event::ChannelClosed {
7268 channel_id: channel.channel_id(),
7269 user_channel_id: channel.get_user_id(),
7270 reason: ClosureReason::OutdatedChannelManager
7272 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
7273 let mut found_htlc = false;
7274 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
7275 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
7278 // If we have some HTLCs in the channel which are not present in the newer
7279 // ChannelMonitor, they have been removed and should be failed back to
7280 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
7281 // were actually claimed we'd have generated and ensured the previous-hop
7282 // claim update ChannelMonitor updates were persisted prior to persising
7283 // the ChannelMonitor update for the forward leg, so attempting to fail the
7284 // backwards leg of the HTLC will simply be rejected.
7285 log_info!(args.logger,
7286 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
7287 log_bytes!(channel.channel_id()), log_bytes!(payment_hash.0));
7288 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.get_counterparty_node_id(), channel.channel_id()));
7292 log_info!(args.logger, "Successfully loaded channel {}", log_bytes!(channel.channel_id()));
7293 if let Some(short_channel_id) = channel.get_short_channel_id() {
7294 short_to_chan_info.insert(short_channel_id, (channel.get_counterparty_node_id(), channel.channel_id()));
7296 if channel.is_funding_initiated() {
7297 id_to_peer.insert(channel.channel_id(), channel.get_counterparty_node_id());
7299 match peer_channels.entry(channel.get_counterparty_node_id()) {
7300 hash_map::Entry::Occupied(mut entry) => {
7301 let by_id_map = entry.get_mut();
7302 by_id_map.insert(channel.channel_id(), channel);
7304 hash_map::Entry::Vacant(entry) => {
7305 let mut by_id_map = HashMap::new();
7306 by_id_map.insert(channel.channel_id(), channel);
7307 entry.insert(by_id_map);
7311 } else if channel.is_awaiting_initial_mon_persist() {
7312 // If we were persisted and shut down while the initial ChannelMonitor persistence
7313 // was in-progress, we never broadcasted the funding transaction and can still
7314 // safely discard the channel.
7315 let _ = channel.force_shutdown(false);
7316 channel_closures.push(events::Event::ChannelClosed {
7317 channel_id: channel.channel_id(),
7318 user_channel_id: channel.get_user_id(),
7319 reason: ClosureReason::DisconnectedPeer,
7322 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.channel_id()));
7323 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
7324 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
7325 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
7326 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");
7327 return Err(DecodeError::InvalidValue);
7331 for (funding_txo, monitor) in args.channel_monitors.iter_mut() {
7332 if !funding_txo_set.contains(funding_txo) {
7333 log_info!(args.logger, "Broadcasting latest holder commitment transaction for closed channel {}", log_bytes!(funding_txo.to_channel_id()));
7334 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
7338 const MAX_ALLOC_SIZE: usize = 1024 * 64;
7339 let forward_htlcs_count: u64 = Readable::read(reader)?;
7340 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
7341 for _ in 0..forward_htlcs_count {
7342 let short_channel_id = Readable::read(reader)?;
7343 let pending_forwards_count: u64 = Readable::read(reader)?;
7344 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
7345 for _ in 0..pending_forwards_count {
7346 pending_forwards.push(Readable::read(reader)?);
7348 forward_htlcs.insert(short_channel_id, pending_forwards);
7351 let claimable_htlcs_count: u64 = Readable::read(reader)?;
7352 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
7353 for _ in 0..claimable_htlcs_count {
7354 let payment_hash = Readable::read(reader)?;
7355 let previous_hops_len: u64 = Readable::read(reader)?;
7356 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
7357 for _ in 0..previous_hops_len {
7358 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
7360 claimable_htlcs_list.push((payment_hash, previous_hops));
7363 let peer_count: u64 = Readable::read(reader)?;
7364 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>>)>()));
7365 for _ in 0..peer_count {
7366 let peer_pubkey = Readable::read(reader)?;
7367 let peer_state = PeerState {
7368 channel_by_id: peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new()),
7369 latest_features: Readable::read(reader)?,
7370 pending_msg_events: Vec::new(),
7371 monitor_update_blocked_actions: BTreeMap::new(),
7372 is_connected: false,
7374 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
7377 let event_count: u64 = Readable::read(reader)?;
7378 let mut pending_events_read: Vec<events::Event> = Vec::with_capacity(cmp::min(event_count as usize, MAX_ALLOC_SIZE/mem::size_of::<events::Event>()));
7379 for _ in 0..event_count {
7380 match MaybeReadable::read(reader)? {
7381 Some(event) => pending_events_read.push(event),
7386 let background_event_count: u64 = Readable::read(reader)?;
7387 let mut pending_background_events_read: Vec<BackgroundEvent> = Vec::with_capacity(cmp::min(background_event_count as usize, MAX_ALLOC_SIZE/mem::size_of::<BackgroundEvent>()));
7388 for _ in 0..background_event_count {
7389 match <u8 as Readable>::read(reader)? {
7390 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
7391 _ => return Err(DecodeError::InvalidValue),
7395 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
7396 let highest_seen_timestamp: u32 = Readable::read(reader)?;
7398 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
7399 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
7400 for _ in 0..pending_inbound_payment_count {
7401 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
7402 return Err(DecodeError::InvalidValue);
7406 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
7407 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
7408 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
7409 for _ in 0..pending_outbound_payments_count_compat {
7410 let session_priv = Readable::read(reader)?;
7411 let payment = PendingOutboundPayment::Legacy {
7412 session_privs: [session_priv].iter().cloned().collect()
7414 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
7415 return Err(DecodeError::InvalidValue)
7419 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
7420 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
7421 let mut pending_outbound_payments = None;
7422 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
7423 let mut received_network_pubkey: Option<PublicKey> = None;
7424 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
7425 let mut probing_cookie_secret: Option<[u8; 32]> = None;
7426 let mut claimable_htlc_purposes = None;
7427 let mut pending_claiming_payments = Some(HashMap::new());
7428 let mut monitor_update_blocked_actions_per_peer = Some(Vec::new());
7429 read_tlv_fields!(reader, {
7430 (1, pending_outbound_payments_no_retry, option),
7431 (2, pending_intercepted_htlcs, option),
7432 (3, pending_outbound_payments, option),
7433 (4, pending_claiming_payments, option),
7434 (5, received_network_pubkey, option),
7435 (6, monitor_update_blocked_actions_per_peer, option),
7436 (7, fake_scid_rand_bytes, option),
7437 (9, claimable_htlc_purposes, vec_type),
7438 (11, probing_cookie_secret, option),
7440 if fake_scid_rand_bytes.is_none() {
7441 fake_scid_rand_bytes = Some(args.entropy_source.get_secure_random_bytes());
7444 if probing_cookie_secret.is_none() {
7445 probing_cookie_secret = Some(args.entropy_source.get_secure_random_bytes());
7448 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
7449 pending_outbound_payments = Some(pending_outbound_payments_compat);
7450 } else if pending_outbound_payments.is_none() {
7451 let mut outbounds = HashMap::new();
7452 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
7453 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
7455 pending_outbound_payments = Some(outbounds);
7457 // If we're tracking pending payments, ensure we haven't lost any by looking at the
7458 // ChannelMonitor data for any channels for which we do not have authorative state
7459 // (i.e. those for which we just force-closed above or we otherwise don't have a
7460 // corresponding `Channel` at all).
7461 // This avoids several edge-cases where we would otherwise "forget" about pending
7462 // payments which are still in-flight via their on-chain state.
7463 // We only rebuild the pending payments map if we were most recently serialized by
7465 for (_, monitor) in args.channel_monitors.iter() {
7466 if id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id()).is_none() {
7467 for (htlc_source, htlc) in monitor.get_pending_outbound_htlcs() {
7468 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, payment_secret, .. } = htlc_source {
7469 if path.is_empty() {
7470 log_error!(args.logger, "Got an empty path for a pending payment");
7471 return Err(DecodeError::InvalidValue);
7473 let path_amt = path.last().unwrap().fee_msat;
7474 let mut session_priv_bytes = [0; 32];
7475 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
7476 match pending_outbound_payments.as_mut().unwrap().entry(payment_id) {
7477 hash_map::Entry::Occupied(mut entry) => {
7478 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
7479 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
7480 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), log_bytes!(htlc.payment_hash.0));
7482 hash_map::Entry::Vacant(entry) => {
7483 let path_fee = path.get_path_fees();
7484 entry.insert(PendingOutboundPayment::Retryable {
7485 retry_strategy: None,
7486 attempts: PaymentAttempts::new(),
7487 payment_params: None,
7488 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
7489 payment_hash: htlc.payment_hash,
7491 keysend_preimage: None, // only used for retries, and we'll never retry on startup
7492 pending_amt_msat: path_amt,
7493 pending_fee_msat: Some(path_fee),
7494 total_msat: path_amt,
7495 starting_block_height: best_block_height,
7497 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
7498 path_amt, log_bytes!(htlc.payment_hash.0), log_bytes!(session_priv_bytes));
7503 for (htlc_source, htlc) in monitor.get_all_current_outbound_htlcs() {
7504 if let HTLCSource::PreviousHopData(prev_hop_data) = htlc_source {
7505 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
7506 info.prev_funding_outpoint == prev_hop_data.outpoint &&
7507 info.prev_htlc_id == prev_hop_data.htlc_id
7509 // The ChannelMonitor is now responsible for this HTLC's
7510 // failure/success and will let us know what its outcome is. If we
7511 // still have an entry for this HTLC in `forward_htlcs` or
7512 // `pending_intercepted_htlcs`, we were apparently not persisted after
7513 // the monitor was when forwarding the payment.
7514 forward_htlcs.retain(|_, forwards| {
7515 forwards.retain(|forward| {
7516 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
7517 if pending_forward_matches_htlc(&htlc_info) {
7518 log_info!(args.logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
7519 log_bytes!(htlc.payment_hash.0), log_bytes!(monitor.get_funding_txo().0.to_channel_id()));
7524 !forwards.is_empty()
7526 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
7527 if pending_forward_matches_htlc(&htlc_info) {
7528 log_info!(args.logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
7529 log_bytes!(htlc.payment_hash.0), log_bytes!(monitor.get_funding_txo().0.to_channel_id()));
7530 pending_events_read.retain(|event| {
7531 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
7532 intercepted_id != ev_id
7544 let pending_outbounds = OutboundPayments {
7545 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
7546 retry_lock: Mutex::new(())
7548 if !forward_htlcs.is_empty() || pending_outbounds.needs_abandon() {
7549 // If we have pending HTLCs to forward, assume we either dropped a
7550 // `PendingHTLCsForwardable` or the user received it but never processed it as they
7551 // shut down before the timer hit. Either way, set the time_forwardable to a small
7552 // constant as enough time has likely passed that we should simply handle the forwards
7553 // now, or at least after the user gets a chance to reconnect to our peers.
7554 pending_events_read.push(events::Event::PendingHTLCsForwardable {
7555 time_forwardable: Duration::from_secs(2),
7559 let inbound_pmt_key_material = args.node_signer.get_inbound_payment_key_material();
7560 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
7562 let mut claimable_htlcs = HashMap::with_capacity(claimable_htlcs_list.len());
7563 if let Some(mut purposes) = claimable_htlc_purposes {
7564 if purposes.len() != claimable_htlcs_list.len() {
7565 return Err(DecodeError::InvalidValue);
7567 for (purpose, (payment_hash, previous_hops)) in purposes.drain(..).zip(claimable_htlcs_list.drain(..)) {
7568 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7571 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
7572 // include a `_legacy_hop_data` in the `OnionPayload`.
7573 for (payment_hash, previous_hops) in claimable_htlcs_list.drain(..) {
7574 if previous_hops.is_empty() {
7575 return Err(DecodeError::InvalidValue);
7577 let purpose = match &previous_hops[0].onion_payload {
7578 OnionPayload::Invoice { _legacy_hop_data } => {
7579 if let Some(hop_data) = _legacy_hop_data {
7580 events::PaymentPurpose::InvoicePayment {
7581 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
7582 Some(inbound_payment) => inbound_payment.payment_preimage,
7583 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
7584 Ok((payment_preimage, _)) => payment_preimage,
7586 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));
7587 return Err(DecodeError::InvalidValue);
7591 payment_secret: hop_data.payment_secret,
7593 } else { return Err(DecodeError::InvalidValue); }
7595 OnionPayload::Spontaneous(payment_preimage) =>
7596 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
7598 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7602 let mut secp_ctx = Secp256k1::new();
7603 secp_ctx.seeded_randomize(&args.entropy_source.get_secure_random_bytes());
7605 if !channel_closures.is_empty() {
7606 pending_events_read.append(&mut channel_closures);
7609 let our_network_pubkey = match args.node_signer.get_node_id(Recipient::Node) {
7611 Err(()) => return Err(DecodeError::InvalidValue)
7613 if let Some(network_pubkey) = received_network_pubkey {
7614 if network_pubkey != our_network_pubkey {
7615 log_error!(args.logger, "Key that was generated does not match the existing key.");
7616 return Err(DecodeError::InvalidValue);
7620 let mut outbound_scid_aliases = HashSet::new();
7621 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
7622 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7623 let peer_state = &mut *peer_state_lock;
7624 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
7625 if chan.outbound_scid_alias() == 0 {
7626 let mut outbound_scid_alias;
7628 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
7629 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.entropy_source);
7630 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
7632 chan.set_outbound_scid_alias(outbound_scid_alias);
7633 } else if !outbound_scid_aliases.insert(chan.outbound_scid_alias()) {
7634 // Note that in rare cases its possible to hit this while reading an older
7635 // channel if we just happened to pick a colliding outbound alias above.
7636 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7637 return Err(DecodeError::InvalidValue);
7639 if chan.is_usable() {
7640 if short_to_chan_info.insert(chan.outbound_scid_alias(), (chan.get_counterparty_node_id(), *chan_id)).is_some() {
7641 // Note that in rare cases its possible to hit this while reading an older
7642 // channel if we just happened to pick a colliding outbound alias above.
7643 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7644 return Err(DecodeError::InvalidValue);
7650 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
7652 for (_, monitor) in args.channel_monitors.iter() {
7653 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
7654 if let Some((payment_purpose, claimable_htlcs)) = claimable_htlcs.remove(&payment_hash) {
7655 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", log_bytes!(payment_hash.0));
7656 let mut claimable_amt_msat = 0;
7657 let mut receiver_node_id = Some(our_network_pubkey);
7658 let phantom_shared_secret = claimable_htlcs[0].prev_hop.phantom_shared_secret;
7659 if phantom_shared_secret.is_some() {
7660 let phantom_pubkey = args.node_signer.get_node_id(Recipient::PhantomNode)
7661 .expect("Failed to get node_id for phantom node recipient");
7662 receiver_node_id = Some(phantom_pubkey)
7664 for claimable_htlc in claimable_htlcs {
7665 claimable_amt_msat += claimable_htlc.value;
7667 // Add a holding-cell claim of the payment to the Channel, which should be
7668 // applied ~immediately on peer reconnection. Because it won't generate a
7669 // new commitment transaction we can just provide the payment preimage to
7670 // the corresponding ChannelMonitor and nothing else.
7672 // We do so directly instead of via the normal ChannelMonitor update
7673 // procedure as the ChainMonitor hasn't yet been initialized, implying
7674 // we're not allowed to call it directly yet. Further, we do the update
7675 // without incrementing the ChannelMonitor update ID as there isn't any
7677 // If we were to generate a new ChannelMonitor update ID here and then
7678 // crash before the user finishes block connect we'd end up force-closing
7679 // this channel as well. On the flip side, there's no harm in restarting
7680 // without the new monitor persisted - we'll end up right back here on
7682 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
7683 if let Some(peer_node_id) = id_to_peer.get(&previous_channel_id){
7684 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
7685 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7686 let peer_state = &mut *peer_state_lock;
7687 if let Some(channel) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
7688 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
7691 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
7692 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
7695 pending_events_read.push(events::Event::PaymentClaimed {
7698 purpose: payment_purpose,
7699 amount_msat: claimable_amt_msat,
7705 for (node_id, monitor_update_blocked_actions) in monitor_update_blocked_actions_per_peer.unwrap() {
7706 if let Some(peer_state) = per_peer_state.get_mut(&node_id) {
7707 peer_state.lock().unwrap().monitor_update_blocked_actions = monitor_update_blocked_actions;
7709 log_error!(args.logger, "Got blocked actions without a per-peer-state for {}", node_id);
7710 return Err(DecodeError::InvalidValue);
7714 let channel_manager = ChannelManager {
7716 fee_estimator: bounded_fee_estimator,
7717 chain_monitor: args.chain_monitor,
7718 tx_broadcaster: args.tx_broadcaster,
7719 router: args.router,
7721 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
7723 inbound_payment_key: expanded_inbound_key,
7724 pending_inbound_payments: Mutex::new(pending_inbound_payments),
7725 pending_outbound_payments: pending_outbounds,
7726 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
7728 forward_htlcs: Mutex::new(forward_htlcs),
7729 claimable_payments: Mutex::new(ClaimablePayments { claimable_htlcs, pending_claiming_payments: pending_claiming_payments.unwrap() }),
7730 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
7731 id_to_peer: Mutex::new(id_to_peer),
7732 short_to_chan_info: FairRwLock::new(short_to_chan_info),
7733 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
7735 probing_cookie_secret: probing_cookie_secret.unwrap(),
7740 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
7742 per_peer_state: FairRwLock::new(per_peer_state),
7744 pending_events: Mutex::new(pending_events_read),
7745 pending_background_events: Mutex::new(pending_background_events_read),
7746 total_consistency_lock: RwLock::new(()),
7747 persistence_notifier: Notifier::new(),
7749 entropy_source: args.entropy_source,
7750 node_signer: args.node_signer,
7751 signer_provider: args.signer_provider,
7753 logger: args.logger,
7754 default_configuration: args.default_config,
7757 for htlc_source in failed_htlcs.drain(..) {
7758 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
7759 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
7760 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
7761 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
7764 //TODO: Broadcast channel update for closed channels, but only after we've made a
7765 //connection or two.
7767 Ok((best_block_hash.clone(), channel_manager))
7773 use bitcoin::hashes::Hash;
7774 use bitcoin::hashes::sha256::Hash as Sha256;
7775 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
7776 use core::time::Duration;
7777 use core::sync::atomic::Ordering;
7778 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
7779 use crate::ln::channelmanager::{inbound_payment, PaymentId, PaymentSendFailure, InterceptId};
7780 use crate::ln::functional_test_utils::*;
7781 use crate::ln::msgs;
7782 use crate::ln::msgs::ChannelMessageHandler;
7783 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
7784 use crate::util::errors::APIError;
7785 use crate::util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
7786 use crate::util::test_utils;
7787 use crate::util::config::ChannelConfig;
7788 use crate::chain::keysinterface::EntropySource;
7791 fn test_notify_limits() {
7792 // Check that a few cases which don't require the persistence of a new ChannelManager,
7793 // indeed, do not cause the persistence of a new ChannelManager.
7794 let chanmon_cfgs = create_chanmon_cfgs(3);
7795 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7796 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7797 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7799 // All nodes start with a persistable update pending as `create_network` connects each node
7800 // with all other nodes to make most tests simpler.
7801 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7802 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7803 assert!(nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7805 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1);
7807 // We check that the channel info nodes have doesn't change too early, even though we try
7808 // to connect messages with new values
7809 chan.0.contents.fee_base_msat *= 2;
7810 chan.1.contents.fee_base_msat *= 2;
7811 let node_a_chan_info = nodes[0].node.list_channels()[0].clone();
7812 let node_b_chan_info = nodes[1].node.list_channels()[0].clone();
7814 // The first two nodes (which opened a channel) should now require fresh persistence
7815 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7816 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7817 // ... but the last node should not.
7818 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7819 // After persisting the first two nodes they should no longer need fresh persistence.
7820 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7821 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7823 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
7824 // about the channel.
7825 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
7826 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
7827 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7829 // The nodes which are a party to the channel should also ignore messages from unrelated
7831 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7832 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7833 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7834 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7835 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7836 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7838 // At this point the channel info given by peers should still be the same.
7839 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7840 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7842 // An earlier version of handle_channel_update didn't check the directionality of the
7843 // update message and would always update the local fee info, even if our peer was
7844 // (spuriously) forwarding us our own channel_update.
7845 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
7846 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
7847 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
7849 // First deliver each peers' own message, checking that the node doesn't need to be
7850 // persisted and that its channel info remains the same.
7851 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
7852 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
7853 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7854 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7855 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7856 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7858 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
7859 // the channel info has updated.
7860 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
7861 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
7862 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7863 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7864 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
7865 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
7869 fn test_keysend_dup_hash_partial_mpp() {
7870 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
7872 let chanmon_cfgs = create_chanmon_cfgs(2);
7873 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7874 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7875 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7876 create_announced_chan_between_nodes(&nodes, 0, 1);
7878 // First, send a partial MPP payment.
7879 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
7880 let mut mpp_route = route.clone();
7881 mpp_route.paths.push(mpp_route.paths[0].clone());
7883 let payment_id = PaymentId([42; 32]);
7884 // Use the utility function send_payment_along_path to send the payment with MPP data which
7885 // indicates there are more HTLCs coming.
7886 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.
7887 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash, Some(payment_secret), payment_id, &mpp_route).unwrap();
7888 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[0], &route.payment_params, &our_payment_hash, &Some(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
7889 check_added_monitors!(nodes[0], 1);
7890 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7891 assert_eq!(events.len(), 1);
7892 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
7894 // Next, send a keysend payment with the same payment_hash and make sure it fails.
7895 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7896 check_added_monitors!(nodes[0], 1);
7897 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7898 assert_eq!(events.len(), 1);
7899 let ev = events.drain(..).next().unwrap();
7900 let payment_event = SendEvent::from_event(ev);
7901 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7902 check_added_monitors!(nodes[1], 0);
7903 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7904 expect_pending_htlcs_forwardable!(nodes[1]);
7905 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
7906 check_added_monitors!(nodes[1], 1);
7907 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7908 assert!(updates.update_add_htlcs.is_empty());
7909 assert!(updates.update_fulfill_htlcs.is_empty());
7910 assert_eq!(updates.update_fail_htlcs.len(), 1);
7911 assert!(updates.update_fail_malformed_htlcs.is_empty());
7912 assert!(updates.update_fee.is_none());
7913 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7914 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7915 expect_payment_failed!(nodes[0], our_payment_hash, true);
7917 // Send the second half of the original MPP payment.
7918 nodes[0].node.test_send_payment_along_path(&mpp_route.paths[1], &route.payment_params, &our_payment_hash, &Some(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
7919 check_added_monitors!(nodes[0], 1);
7920 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7921 assert_eq!(events.len(), 1);
7922 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
7924 // Claim the full MPP payment. Note that we can't use a test utility like
7925 // claim_funds_along_route because the ordering of the messages causes the second half of the
7926 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
7927 // lightning messages manually.
7928 nodes[1].node.claim_funds(payment_preimage);
7929 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
7930 check_added_monitors!(nodes[1], 2);
7932 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7933 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
7934 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
7935 check_added_monitors!(nodes[0], 1);
7936 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7937 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
7938 check_added_monitors!(nodes[1], 1);
7939 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7940 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
7941 check_added_monitors!(nodes[1], 1);
7942 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7943 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
7944 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
7945 check_added_monitors!(nodes[0], 1);
7946 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7947 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
7948 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7949 check_added_monitors!(nodes[0], 1);
7950 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
7951 check_added_monitors!(nodes[1], 1);
7952 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
7953 check_added_monitors!(nodes[1], 1);
7954 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7955 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
7956 check_added_monitors!(nodes[0], 1);
7958 // Note that successful MPP payments will generate a single PaymentSent event upon the first
7959 // path's success and a PaymentPathSuccessful event for each path's success.
7960 let events = nodes[0].node.get_and_clear_pending_events();
7961 assert_eq!(events.len(), 3);
7963 Event::PaymentSent { payment_id: ref id, payment_preimage: ref preimage, payment_hash: ref hash, .. } => {
7964 assert_eq!(Some(payment_id), *id);
7965 assert_eq!(payment_preimage, *preimage);
7966 assert_eq!(our_payment_hash, *hash);
7968 _ => panic!("Unexpected event"),
7971 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7972 assert_eq!(payment_id, *actual_payment_id);
7973 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7974 assert_eq!(route.paths[0], *path);
7976 _ => panic!("Unexpected event"),
7979 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7980 assert_eq!(payment_id, *actual_payment_id);
7981 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7982 assert_eq!(route.paths[0], *path);
7984 _ => panic!("Unexpected event"),
7989 fn test_keysend_dup_payment_hash() {
7990 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
7991 // outbound regular payment fails as expected.
7992 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
7993 // fails as expected.
7994 let chanmon_cfgs = create_chanmon_cfgs(2);
7995 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7996 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7997 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7998 create_announced_chan_between_nodes(&nodes, 0, 1);
7999 let scorer = test_utils::TestScorer::new();
8000 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
8002 // To start (1), send a regular payment but don't claim it.
8003 let expected_route = [&nodes[1]];
8004 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
8006 // Next, attempt a keysend payment and make sure it fails.
8007 let route_params = RouteParameters {
8008 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV),
8009 final_value_msat: 100_000,
8011 let route = find_route(
8012 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
8013 None, nodes[0].logger, &scorer, &random_seed_bytes
8015 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
8016 check_added_monitors!(nodes[0], 1);
8017 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8018 assert_eq!(events.len(), 1);
8019 let ev = events.drain(..).next().unwrap();
8020 let payment_event = SendEvent::from_event(ev);
8021 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8022 check_added_monitors!(nodes[1], 0);
8023 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8024 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
8025 // fails), the second will process the resulting failure and fail the HTLC backward
8026 expect_pending_htlcs_forwardable!(nodes[1]);
8027 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
8028 check_added_monitors!(nodes[1], 1);
8029 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8030 assert!(updates.update_add_htlcs.is_empty());
8031 assert!(updates.update_fulfill_htlcs.is_empty());
8032 assert_eq!(updates.update_fail_htlcs.len(), 1);
8033 assert!(updates.update_fail_malformed_htlcs.is_empty());
8034 assert!(updates.update_fee.is_none());
8035 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
8036 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
8037 expect_payment_failed!(nodes[0], payment_hash, true);
8039 // Finally, claim the original payment.
8040 claim_payment(&nodes[0], &expected_route, payment_preimage);
8042 // To start (2), send a keysend payment but don't claim it.
8043 let payment_preimage = PaymentPreimage([42; 32]);
8044 let route = find_route(
8045 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
8046 None, nodes[0].logger, &scorer, &random_seed_bytes
8048 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
8049 check_added_monitors!(nodes[0], 1);
8050 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8051 assert_eq!(events.len(), 1);
8052 let event = events.pop().unwrap();
8053 let path = vec![&nodes[1]];
8054 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
8056 // Next, attempt a regular payment and make sure it fails.
8057 let payment_secret = PaymentSecret([43; 32]);
8058 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
8059 check_added_monitors!(nodes[0], 1);
8060 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8061 assert_eq!(events.len(), 1);
8062 let ev = events.drain(..).next().unwrap();
8063 let payment_event = SendEvent::from_event(ev);
8064 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8065 check_added_monitors!(nodes[1], 0);
8066 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8067 expect_pending_htlcs_forwardable!(nodes[1]);
8068 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
8069 check_added_monitors!(nodes[1], 1);
8070 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8071 assert!(updates.update_add_htlcs.is_empty());
8072 assert!(updates.update_fulfill_htlcs.is_empty());
8073 assert_eq!(updates.update_fail_htlcs.len(), 1);
8074 assert!(updates.update_fail_malformed_htlcs.is_empty());
8075 assert!(updates.update_fee.is_none());
8076 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
8077 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
8078 expect_payment_failed!(nodes[0], payment_hash, true);
8080 // Finally, succeed the keysend payment.
8081 claim_payment(&nodes[0], &expected_route, payment_preimage);
8085 fn test_keysend_hash_mismatch() {
8086 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
8087 // preimage doesn't match the msg's payment hash.
8088 let chanmon_cfgs = create_chanmon_cfgs(2);
8089 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8090 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8091 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8093 let payer_pubkey = nodes[0].node.get_our_node_id();
8094 let payee_pubkey = nodes[1].node.get_our_node_id();
8096 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
8097 let route_params = RouteParameters {
8098 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
8099 final_value_msat: 10_000,
8101 let network_graph = nodes[0].network_graph.clone();
8102 let first_hops = nodes[0].node.list_usable_channels();
8103 let scorer = test_utils::TestScorer::new();
8104 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
8105 let route = find_route(
8106 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
8107 nodes[0].logger, &scorer, &random_seed_bytes
8110 let test_preimage = PaymentPreimage([42; 32]);
8111 let mismatch_payment_hash = PaymentHash([43; 32]);
8112 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash, None, PaymentId(mismatch_payment_hash.0), &route).unwrap();
8113 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash, &None, Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
8114 check_added_monitors!(nodes[0], 1);
8116 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
8117 assert_eq!(updates.update_add_htlcs.len(), 1);
8118 assert!(updates.update_fulfill_htlcs.is_empty());
8119 assert!(updates.update_fail_htlcs.is_empty());
8120 assert!(updates.update_fail_malformed_htlcs.is_empty());
8121 assert!(updates.update_fee.is_none());
8122 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8124 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Payment preimage didn't match payment hash".to_string(), 1);
8128 fn test_keysend_msg_with_secret_err() {
8129 // Test that we error as expected if we receive a keysend payment that includes a payment secret.
8130 let chanmon_cfgs = create_chanmon_cfgs(2);
8131 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8132 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8133 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8135 let payer_pubkey = nodes[0].node.get_our_node_id();
8136 let payee_pubkey = nodes[1].node.get_our_node_id();
8138 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
8139 let route_params = RouteParameters {
8140 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
8141 final_value_msat: 10_000,
8143 let network_graph = nodes[0].network_graph.clone();
8144 let first_hops = nodes[0].node.list_usable_channels();
8145 let scorer = test_utils::TestScorer::new();
8146 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
8147 let route = find_route(
8148 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
8149 nodes[0].logger, &scorer, &random_seed_bytes
8152 let test_preimage = PaymentPreimage([42; 32]);
8153 let test_secret = PaymentSecret([43; 32]);
8154 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
8155 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash, Some(test_secret), PaymentId(payment_hash.0), &route).unwrap();
8156 nodes[0].node.test_send_payment_internal(&route, payment_hash, &Some(test_secret), Some(test_preimage), PaymentId(payment_hash.0), None, session_privs).unwrap();
8157 check_added_monitors!(nodes[0], 1);
8159 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
8160 assert_eq!(updates.update_add_htlcs.len(), 1);
8161 assert!(updates.update_fulfill_htlcs.is_empty());
8162 assert!(updates.update_fail_htlcs.is_empty());
8163 assert!(updates.update_fail_malformed_htlcs.is_empty());
8164 assert!(updates.update_fee.is_none());
8165 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8167 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "We don't support MPP keysend payments".to_string(), 1);
8171 fn test_multi_hop_missing_secret() {
8172 let chanmon_cfgs = create_chanmon_cfgs(4);
8173 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8174 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8175 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8177 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
8178 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
8179 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
8180 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
8182 // Marshall an MPP route.
8183 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
8184 let path = route.paths[0].clone();
8185 route.paths.push(path);
8186 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8187 route.paths[0][0].short_channel_id = chan_1_id;
8188 route.paths[0][1].short_channel_id = chan_3_id;
8189 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8190 route.paths[1][0].short_channel_id = chan_2_id;
8191 route.paths[1][1].short_channel_id = chan_4_id;
8193 match nodes[0].node.send_payment(&route, payment_hash, &None, PaymentId(payment_hash.0)).unwrap_err() {
8194 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
8195 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err)) },
8196 _ => panic!("unexpected error")
8201 fn test_drop_disconnected_peers_when_removing_channels() {
8202 let chanmon_cfgs = create_chanmon_cfgs(2);
8203 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8204 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8205 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8207 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
8209 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
8210 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
8212 nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
8213 check_closed_broadcast!(nodes[0], true);
8214 check_added_monitors!(nodes[0], 1);
8215 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
8218 // Assert that nodes[1] is awaiting removal for nodes[0] once nodes[1] has been
8219 // disconnected and the channel between has been force closed.
8220 let nodes_0_per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
8221 // Assert that nodes[1] isn't removed before `timer_tick_occurred` has been executed.
8222 assert_eq!(nodes_0_per_peer_state.len(), 1);
8223 assert!(nodes_0_per_peer_state.get(&nodes[1].node.get_our_node_id()).is_some());
8226 nodes[0].node.timer_tick_occurred();
8229 // Assert that nodes[1] has now been removed.
8230 assert_eq!(nodes[0].node.per_peer_state.read().unwrap().len(), 0);
8235 fn bad_inbound_payment_hash() {
8236 // Add coverage for checking that a user-provided payment hash matches the payment secret.
8237 let chanmon_cfgs = create_chanmon_cfgs(2);
8238 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8239 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8240 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8242 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
8243 let payment_data = msgs::FinalOnionHopData {
8245 total_msat: 100_000,
8248 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
8249 // payment verification fails as expected.
8250 let mut bad_payment_hash = payment_hash.clone();
8251 bad_payment_hash.0[0] += 1;
8252 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) {
8253 Ok(_) => panic!("Unexpected ok"),
8255 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment".to_string(), "Failing HTLC with user-generated payment_hash".to_string(), 1);
8259 // Check that using the original payment hash succeeds.
8260 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());
8264 fn test_id_to_peer_coverage() {
8265 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
8266 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
8267 // the channel is successfully closed.
8268 let chanmon_cfgs = create_chanmon_cfgs(2);
8269 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8270 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8271 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8273 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
8274 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8275 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
8276 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8277 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
8279 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
8280 let channel_id = &tx.txid().into_inner();
8282 // Ensure that the `id_to_peer` map is empty until either party has received the
8283 // funding transaction, and have the real `channel_id`.
8284 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
8285 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8288 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
8290 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
8291 // as it has the funding transaction.
8292 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8293 assert_eq!(nodes_0_lock.len(), 1);
8294 assert!(nodes_0_lock.contains_key(channel_id));
8297 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8299 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8301 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8303 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8304 assert_eq!(nodes_0_lock.len(), 1);
8305 assert!(nodes_0_lock.contains_key(channel_id));
8309 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
8310 // as it has the funding transaction.
8311 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8312 assert_eq!(nodes_1_lock.len(), 1);
8313 assert!(nodes_1_lock.contains_key(channel_id));
8315 check_added_monitors!(nodes[1], 1);
8316 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8317 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
8318 check_added_monitors!(nodes[0], 1);
8319 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8320 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
8321 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
8323 nodes[0].node.close_channel(channel_id, &nodes[1].node.get_our_node_id()).unwrap();
8324 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()));
8325 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
8326 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &nodes_1_shutdown);
8328 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
8329 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
8331 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
8332 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
8333 // fee for the closing transaction has been negotiated and the parties has the other
8334 // party's signature for the fee negotiated closing transaction.)
8335 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8336 assert_eq!(nodes_0_lock.len(), 1);
8337 assert!(nodes_0_lock.contains_key(channel_id));
8341 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
8342 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
8343 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
8344 // kept in the `nodes[1]`'s `id_to_peer` map.
8345 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8346 assert_eq!(nodes_1_lock.len(), 1);
8347 assert!(nodes_1_lock.contains_key(channel_id));
8350 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()));
8352 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
8353 // therefore has all it needs to fully close the channel (both signatures for the
8354 // closing transaction).
8355 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
8356 // fully closed by `nodes[0]`.
8357 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
8359 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
8360 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
8361 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8362 assert_eq!(nodes_1_lock.len(), 1);
8363 assert!(nodes_1_lock.contains_key(channel_id));
8366 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
8368 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
8370 // Assert that the channel has now been removed from both parties `id_to_peer` map once
8371 // they both have everything required to fully close the channel.
8372 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8374 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
8376 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
8377 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
8380 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
8381 let expected_message = format!("Not connected to node: {}", expected_public_key);
8382 check_api_error_message(expected_message, res_err)
8385 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
8386 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
8387 check_api_error_message(expected_message, res_err)
8390 fn check_api_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
8392 Err(APIError::APIMisuseError { err }) => {
8393 assert_eq!(err, expected_err_message);
8395 Err(APIError::ChannelUnavailable { err }) => {
8396 assert_eq!(err, expected_err_message);
8398 Ok(_) => panic!("Unexpected Ok"),
8399 Err(_) => panic!("Unexpected Error"),
8404 fn test_api_calls_with_unkown_counterparty_node() {
8405 // Tests that our API functions that expects a `counterparty_node_id` as input, behaves as
8406 // expected if the `counterparty_node_id` is an unkown peer in the
8407 // `ChannelManager::per_peer_state` map.
8408 let chanmon_cfg = create_chanmon_cfgs(2);
8409 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
8410 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
8411 let nodes = create_network(2, &node_cfg, &node_chanmgr);
8414 let channel_id = [4; 32];
8415 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
8416 let intercept_id = InterceptId([0; 32]);
8418 // Test the API functions.
8419 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);
8421 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&channel_id, &unkown_public_key, 42), unkown_public_key);
8423 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
8425 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
8427 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
8429 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
8431 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
8435 fn test_connection_limiting() {
8436 // Test that we limit un-channel'd peers and un-funded channels properly.
8437 let chanmon_cfgs = create_chanmon_cfgs(2);
8438 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8439 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8440 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8442 // Note that create_network connects the nodes together for us
8444 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
8445 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8447 let mut funding_tx = None;
8448 for idx in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
8449 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
8450 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8453 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
8454 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
8455 funding_tx = Some(tx.clone());
8456 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx).unwrap();
8457 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8459 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8460 check_added_monitors!(nodes[1], 1);
8461 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8463 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
8464 check_added_monitors!(nodes[0], 1);
8466 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
8469 // A MAX_UNFUNDED_CHANS_PER_PEER + 1 channel will be summarily rejected
8470 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
8471 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
8472 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
8473 open_channel_msg.temporary_channel_id);
8475 // Further, because all of our channels with nodes[0] are inbound, and none of them funded,
8476 // it doesn't count as a "protected" peer, i.e. it counts towards the MAX_NO_CHANNEL_PEERS
8478 let mut peer_pks = Vec::with_capacity(super::MAX_NO_CHANNEL_PEERS);
8479 for _ in 1..super::MAX_NO_CHANNEL_PEERS {
8480 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
8481 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
8482 peer_pks.push(random_pk);
8483 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
8484 features: nodes[0].node.init_features(), remote_network_address: None }, true).unwrap();
8486 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
8487 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
8488 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
8489 features: nodes[0].node.init_features(), remote_network_address: None }, true).unwrap_err();
8491 // Also importantly, because nodes[0] isn't "protected", we will refuse a reconnection from
8492 // them if we have too many un-channel'd peers.
8493 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
8494 let chan_closed_events = nodes[1].node.get_and_clear_pending_events();
8495 assert_eq!(chan_closed_events.len(), super::MAX_UNFUNDED_CHANS_PER_PEER - 1);
8496 for ev in chan_closed_events {
8497 if let Event::ChannelClosed { .. } = ev { } else { panic!(); }
8499 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
8500 features: nodes[0].node.init_features(), remote_network_address: None }, true).unwrap();
8501 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
8502 features: nodes[0].node.init_features(), remote_network_address: None }, true).unwrap_err();
8504 // but of course if the connection is outbound its allowed...
8505 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
8506 features: nodes[0].node.init_features(), remote_network_address: None }, false).unwrap();
8507 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
8509 // Now nodes[0] is disconnected but still has a pending, un-funded channel lying around.
8510 // Even though we accept one more connection from new peers, we won't actually let them
8512 assert!(peer_pks.len() > super::MAX_UNFUNDED_CHANNEL_PEERS - 1);
8513 for i in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
8514 nodes[1].node.handle_open_channel(&peer_pks[i], &open_channel_msg);
8515 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, peer_pks[i]);
8516 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
8518 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
8519 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
8520 open_channel_msg.temporary_channel_id);
8522 // Of course, however, outbound channels are always allowed
8523 nodes[1].node.create_channel(last_random_pk, 100_000, 0, 42, None).unwrap();
8524 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, last_random_pk);
8526 // If we fund the first channel, nodes[0] has a live on-chain channel with us, it is now
8527 // "protected" and can connect again.
8528 mine_transaction(&nodes[1], funding_tx.as_ref().unwrap());
8529 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
8530 features: nodes[0].node.init_features(), remote_network_address: None }, true).unwrap();
8531 get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
8533 // Further, because the first channel was funded, we can open another channel with
8535 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
8536 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
8540 fn test_outbound_chans_unlimited() {
8541 // Test that we never refuse an outbound channel even if a peer is unfuned-channel-limited
8542 let chanmon_cfgs = create_chanmon_cfgs(2);
8543 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8544 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8545 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8547 // Note that create_network connects the nodes together for us
8549 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
8550 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8552 for _ in 0..super::MAX_UNFUNDED_CHANS_PER_PEER {
8553 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
8554 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8555 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
8558 // Once we have MAX_UNFUNDED_CHANS_PER_PEER unfunded channels, new inbound channels will be
8560 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
8561 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
8562 open_channel_msg.temporary_channel_id);
8564 // but we can still open an outbound channel.
8565 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
8566 get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
8568 // but even with such an outbound channel, additional inbound channels will still fail.
8569 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
8570 assert_eq!(get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id()).channel_id,
8571 open_channel_msg.temporary_channel_id);
8575 fn test_0conf_limiting() {
8576 // Tests that we properly limit inbound channels when we have the manual-channel-acceptance
8577 // flag set and (sometimes) accept channels as 0conf.
8578 let chanmon_cfgs = create_chanmon_cfgs(2);
8579 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8580 let mut settings = test_default_channel_config();
8581 settings.manually_accept_inbound_channels = true;
8582 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(settings)]);
8583 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8585 // Note that create_network connects the nodes together for us
8587 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
8588 let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8590 // First, get us up to MAX_UNFUNDED_CHANNEL_PEERS so we can test at the edge
8591 for _ in 0..super::MAX_UNFUNDED_CHANNEL_PEERS - 1 {
8592 let random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
8593 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
8594 nodes[1].node.peer_connected(&random_pk, &msgs::Init {
8595 features: nodes[0].node.init_features(), remote_network_address: None }, true).unwrap();
8597 nodes[1].node.handle_open_channel(&random_pk, &open_channel_msg);
8598 let events = nodes[1].node.get_and_clear_pending_events();
8600 Event::OpenChannelRequest { temporary_channel_id, .. } => {
8601 nodes[1].node.accept_inbound_channel(&temporary_channel_id, &random_pk, 23).unwrap();
8603 _ => panic!("Unexpected event"),
8605 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, random_pk);
8606 open_channel_msg.temporary_channel_id = nodes[0].keys_manager.get_secure_random_bytes();
8609 // If we try to accept a channel from another peer non-0conf it will fail.
8610 let last_random_pk = PublicKey::from_secret_key(&nodes[0].node.secp_ctx,
8611 &SecretKey::from_slice(&nodes[1].keys_manager.get_secure_random_bytes()).unwrap());
8612 nodes[1].node.peer_connected(&last_random_pk, &msgs::Init {
8613 features: nodes[0].node.init_features(), remote_network_address: None }, true).unwrap();
8614 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
8615 let events = nodes[1].node.get_and_clear_pending_events();
8617 Event::OpenChannelRequest { temporary_channel_id, .. } => {
8618 match nodes[1].node.accept_inbound_channel(&temporary_channel_id, &last_random_pk, 23) {
8619 Err(APIError::APIMisuseError { err }) =>
8620 assert_eq!(err, "Too many peers with unfunded channels, refusing to accept new ones"),
8624 _ => panic!("Unexpected event"),
8626 assert_eq!(get_err_msg(&nodes[1], &last_random_pk).channel_id,
8627 open_channel_msg.temporary_channel_id);
8629 // ...however if we accept the same channel 0conf it should work just fine.
8630 nodes[1].node.handle_open_channel(&last_random_pk, &open_channel_msg);
8631 let events = nodes[1].node.get_and_clear_pending_events();
8633 Event::OpenChannelRequest { temporary_channel_id, .. } => {
8634 nodes[1].node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &last_random_pk, 23).unwrap();
8636 _ => panic!("Unexpected event"),
8638 get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, last_random_pk);
8643 fn test_anchors_zero_fee_htlc_tx_fallback() {
8644 // Tests that if both nodes support anchors, but the remote node does not want to accept
8645 // anchor channels at the moment, an error it sent to the local node such that it can retry
8646 // the channel without the anchors feature.
8647 let chanmon_cfgs = create_chanmon_cfgs(2);
8648 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8649 let mut anchors_config = test_default_channel_config();
8650 anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
8651 anchors_config.manually_accept_inbound_channels = true;
8652 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config.clone()), Some(anchors_config.clone())]);
8653 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8655 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 0, None).unwrap();
8656 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8657 assert!(open_channel_msg.channel_type.as_ref().unwrap().supports_anchors_zero_fee_htlc_tx());
8659 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
8660 let events = nodes[1].node.get_and_clear_pending_events();
8662 Event::OpenChannelRequest { temporary_channel_id, .. } => {
8663 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
8665 _ => panic!("Unexpected event"),
8668 let error_msg = get_err_msg(&nodes[1], &nodes[0].node.get_our_node_id());
8669 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &error_msg);
8671 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8672 assert!(!open_channel_msg.channel_type.unwrap().supports_anchors_zero_fee_htlc_tx());
8674 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
8678 #[cfg(all(any(test, feature = "_test_utils"), feature = "_bench_unstable"))]
8680 use crate::chain::Listen;
8681 use crate::chain::chainmonitor::{ChainMonitor, Persist};
8682 use crate::chain::keysinterface::{EntropySource, KeysManager, InMemorySigner};
8683 use crate::ln::channelmanager::{self, BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId};
8684 use crate::ln::functional_test_utils::*;
8685 use crate::ln::msgs::{ChannelMessageHandler, Init};
8686 use crate::routing::gossip::NetworkGraph;
8687 use crate::routing::router::{PaymentParameters, get_route};
8688 use crate::util::test_utils;
8689 use crate::util::config::UserConfig;
8690 use crate::util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
8692 use bitcoin::hashes::Hash;
8693 use bitcoin::hashes::sha256::Hash as Sha256;
8694 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
8696 use crate::sync::{Arc, Mutex};
8700 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
8701 node: &'a ChannelManager<
8702 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
8703 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
8704 &'a test_utils::TestLogger, &'a P>,
8705 &'a test_utils::TestBroadcaster, &'a KeysManager, &'a KeysManager, &'a KeysManager,
8706 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
8707 &'a test_utils::TestLogger>,
8712 fn bench_sends(bench: &mut Bencher) {
8713 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
8716 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
8717 // Do a simple benchmark of sending a payment back and forth between two nodes.
8718 // Note that this is unrealistic as each payment send will require at least two fsync
8720 let network = bitcoin::Network::Testnet;
8722 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
8723 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
8724 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
8725 let scorer = Mutex::new(test_utils::TestScorer::new());
8726 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(network, &logger_a)), &scorer);
8728 let mut config: UserConfig = Default::default();
8729 config.channel_handshake_config.minimum_depth = 1;
8731 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
8732 let seed_a = [1u8; 32];
8733 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
8734 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 {
8736 best_block: BestBlock::from_network(network),
8738 let node_a_holder = NodeHolder { node: &node_a };
8740 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
8741 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
8742 let seed_b = [2u8; 32];
8743 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
8744 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 {
8746 best_block: BestBlock::from_network(network),
8748 let node_b_holder = NodeHolder { node: &node_b };
8750 node_a.peer_connected(&node_b.get_our_node_id(), &Init { features: node_b.init_features(), remote_network_address: None }, true).unwrap();
8751 node_b.peer_connected(&node_a.get_our_node_id(), &Init { features: node_a.init_features(), remote_network_address: None }, false).unwrap();
8752 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
8753 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()));
8754 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()));
8757 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
8758 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
8759 value: 8_000_000, script_pubkey: output_script,
8761 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
8762 } else { panic!(); }
8764 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()));
8765 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()));
8767 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
8770 header: BlockHeader { version: 0x20000000, prev_blockhash: BestBlock::from_network(network).block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
8773 Listen::block_connected(&node_a, &block, 1);
8774 Listen::block_connected(&node_b, &block, 1);
8776 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()));
8777 let msg_events = node_a.get_and_clear_pending_msg_events();
8778 assert_eq!(msg_events.len(), 2);
8779 match msg_events[0] {
8780 MessageSendEvent::SendChannelReady { ref msg, .. } => {
8781 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
8782 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
8786 match msg_events[1] {
8787 MessageSendEvent::SendChannelUpdate { .. } => {},
8791 let events_a = node_a.get_and_clear_pending_events();
8792 assert_eq!(events_a.len(), 1);
8794 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8795 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
8797 _ => panic!("Unexpected event"),
8800 let events_b = node_b.get_and_clear_pending_events();
8801 assert_eq!(events_b.len(), 1);
8803 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8804 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
8806 _ => panic!("Unexpected event"),
8809 let dummy_graph = NetworkGraph::new(network, &logger_a);
8811 let mut payment_count: u64 = 0;
8812 macro_rules! send_payment {
8813 ($node_a: expr, $node_b: expr) => {
8814 let usable_channels = $node_a.list_usable_channels();
8815 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id(), TEST_FINAL_CLTV)
8816 .with_features($node_b.invoice_features());
8817 let scorer = test_utils::TestScorer::new();
8818 let seed = [3u8; 32];
8819 let keys_manager = KeysManager::new(&seed, 42, 42);
8820 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8821 let route = get_route(&$node_a.get_our_node_id(), &payment_params, &dummy_graph.read_only(),
8822 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), 10_000, TEST_FINAL_CLTV, &logger_a, &scorer, &random_seed_bytes).unwrap();
8824 let mut payment_preimage = PaymentPreimage([0; 32]);
8825 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
8827 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
8828 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
8830 $node_a.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
8831 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
8832 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
8833 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
8834 let (raa, cs) = do_get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, &$node_a.get_our_node_id());
8835 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
8836 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
8837 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &get_event_msg!(NodeHolder { node: &$node_a }, MessageSendEvent::SendRevokeAndACK, $node_b.get_our_node_id()));
8839 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
8840 expect_payment_claimable!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
8841 $node_b.claim_funds(payment_preimage);
8842 expect_payment_claimed!(NodeHolder { node: &$node_b }, payment_hash, 10_000);
8844 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
8845 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
8846 assert_eq!(node_id, $node_a.get_our_node_id());
8847 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8848 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
8850 _ => panic!("Failed to generate claim event"),
8853 let (raa, cs) = do_get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, &$node_b.get_our_node_id());
8854 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
8855 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
8856 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &get_event_msg!(NodeHolder { node: &$node_b }, MessageSendEvent::SendRevokeAndACK, $node_a.get_our_node_id()));
8858 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
8863 send_payment!(node_a, node_b);
8864 send_payment!(node_b, node_a);