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::hashes::sha256d::Hash as Sha256dHash;
30 use bitcoin::hash_types::{BlockHash, Txid};
32 use bitcoin::secp256k1::{SecretKey,PublicKey};
33 use bitcoin::secp256k1::Secp256k1;
34 use bitcoin::secp256k1::ecdh::SharedSecret;
35 use bitcoin::{LockTime, secp256k1, Sequence};
38 use crate::chain::{Confirm, ChannelMonitorUpdateStatus, Watch, BestBlock};
39 use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator};
40 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};
41 use crate::chain::transaction::{OutPoint, TransactionData};
42 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
43 // construct one themselves.
44 use crate::ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
45 use crate::ln::channel::{Channel, ChannelError, ChannelUpdateStatus, UpdateFulfillCommitFetch};
46 use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
47 #[cfg(any(feature = "_test_utils", test))]
48 use crate::ln::features::InvoiceFeatures;
49 use crate::routing::gossip::NetworkGraph;
50 use crate::routing::router::{DefaultRouter, InFlightHtlcs, PaymentParameters, Route, RouteHop, RoutePath, Router};
51 use crate::routing::scoring::ProbabilisticScorer;
53 use crate::ln::onion_utils;
54 use crate::ln::onion_utils::HTLCFailReason;
55 use crate::ln::msgs::{ChannelMessageHandler, DecodeError, LightningError, MAX_VALUE_MSAT};
57 use crate::ln::outbound_payment;
58 use crate::ln::outbound_payment::{OutboundPayments, PendingOutboundPayment};
59 use crate::ln::wire::Encode;
60 use crate::chain::keysinterface::{EntropySource, KeysInterface, KeysManager, NodeSigner, Recipient, Sign, SignerProvider};
61 use crate::util::config::{UserConfig, ChannelConfig};
62 use crate::util::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
63 use crate::util::events;
64 use crate::util::wakers::{Future, Notifier};
65 use crate::util::scid_utils::fake_scid;
66 use crate::util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
67 use crate::util::logger::{Level, Logger};
68 use crate::util::errors::APIError;
71 use crate::prelude::*;
73 use core::cell::RefCell;
75 use crate::sync::{Arc, Mutex, MutexGuard, RwLock, RwLockReadGuard, FairRwLock};
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;
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 payment_params: Option<PaymentParameters>,
253 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
254 impl core::hash::Hash for HTLCSource {
255 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
257 HTLCSource::PreviousHopData(prev_hop_data) => {
259 prev_hop_data.hash(hasher);
261 HTLCSource::OutboundRoute { path, session_priv, payment_id, payment_secret, first_hop_htlc_msat, payment_params } => {
264 session_priv[..].hash(hasher);
265 payment_id.hash(hasher);
266 payment_secret.hash(hasher);
267 first_hop_htlc_msat.hash(hasher);
268 payment_params.hash(hasher);
273 #[cfg(not(feature = "grind_signatures"))]
276 pub fn dummy() -> Self {
277 HTLCSource::OutboundRoute {
279 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
280 first_hop_htlc_msat: 0,
281 payment_id: PaymentId([2; 32]),
282 payment_secret: None,
283 payment_params: None,
288 struct ReceiveError {
294 type ShutdownResult = (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash, PublicKey, [u8; 32])>);
296 /// Error type returned across the peer_state mutex boundary. When an Err is generated for a
297 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
298 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
299 /// peer_state lock. We then return the set of things that need to be done outside the lock in
300 /// this struct and call handle_error!() on it.
302 struct MsgHandleErrInternal {
303 err: msgs::LightningError,
304 chan_id: Option<([u8; 32], u128)>, // If Some a channel of ours has been closed
305 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
307 impl MsgHandleErrInternal {
309 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
311 err: LightningError {
313 action: msgs::ErrorAction::SendErrorMessage {
314 msg: msgs::ErrorMessage {
321 shutdown_finish: None,
325 fn ignore_no_close(err: String) -> Self {
327 err: LightningError {
329 action: msgs::ErrorAction::IgnoreError,
332 shutdown_finish: None,
336 fn from_no_close(err: msgs::LightningError) -> Self {
337 Self { err, chan_id: None, shutdown_finish: None }
340 fn from_finish_shutdown(err: String, channel_id: [u8; 32], user_channel_id: u128, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
342 err: LightningError {
344 action: msgs::ErrorAction::SendErrorMessage {
345 msg: msgs::ErrorMessage {
351 chan_id: Some((channel_id, user_channel_id)),
352 shutdown_finish: Some((shutdown_res, channel_update)),
356 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
359 ChannelError::Warn(msg) => LightningError {
361 action: msgs::ErrorAction::SendWarningMessage {
362 msg: msgs::WarningMessage {
366 log_level: Level::Warn,
369 ChannelError::Ignore(msg) => LightningError {
371 action: msgs::ErrorAction::IgnoreError,
373 ChannelError::Close(msg) => LightningError {
375 action: msgs::ErrorAction::SendErrorMessage {
376 msg: msgs::ErrorMessage {
384 shutdown_finish: None,
389 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
390 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
391 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
392 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
393 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
395 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
396 /// be sent in the order they appear in the return value, however sometimes the order needs to be
397 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
398 /// they were originally sent). In those cases, this enum is also returned.
399 #[derive(Clone, PartialEq)]
400 pub(super) enum RAACommitmentOrder {
401 /// Send the CommitmentUpdate messages first
403 /// Send the RevokeAndACK message first
407 /// Information about a payment which is currently being claimed.
408 struct ClaimingPayment {
410 payment_purpose: events::PaymentPurpose,
411 receiver_node_id: PublicKey,
413 impl_writeable_tlv_based!(ClaimingPayment, {
414 (0, amount_msat, required),
415 (2, payment_purpose, required),
416 (4, receiver_node_id, required),
419 /// Information about claimable or being-claimed payments
420 struct ClaimablePayments {
421 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
422 /// failed/claimed by the user.
424 /// Note that, no consistency guarantees are made about the channels given here actually
425 /// existing anymore by the time you go to read them!
427 /// When adding to the map, [`Self::pending_claiming_payments`] must also be checked to ensure
428 /// we don't get a duplicate payment.
429 claimable_htlcs: HashMap<PaymentHash, (events::PaymentPurpose, Vec<ClaimableHTLC>)>,
431 /// Map from payment hash to the payment data for HTLCs which we have begun claiming, but which
432 /// are waiting on a [`ChannelMonitorUpdate`] to complete in order to be surfaced to the user
433 /// as an [`events::Event::PaymentClaimed`].
434 pending_claiming_payments: HashMap<PaymentHash, ClaimingPayment>,
437 // Note this is only exposed in cfg(test):
438 pub(super) struct ChannelHolder {
439 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
440 /// for broadcast messages, where ordering isn't as strict).
441 pub(super) pending_msg_events: Vec<MessageSendEvent>,
444 /// Events which we process internally but cannot be procsesed immediately at the generation site
445 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
446 /// quite some time lag.
447 enum BackgroundEvent {
448 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
449 /// commitment transaction.
450 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
453 pub(crate) enum MonitorUpdateCompletionAction {
454 /// Indicates that a payment ultimately destined for us was claimed and we should emit an
455 /// [`events::Event::PaymentClaimed`] to the user if we haven't yet generated such an event for
456 /// this payment. Note that this is only best-effort. On restart it's possible such a duplicate
457 /// event can be generated.
458 PaymentClaimed { payment_hash: PaymentHash },
459 /// Indicates an [`events::Event`] should be surfaced to the user.
460 EmitEvent { event: events::Event },
463 /// State we hold per-peer.
464 pub(super) struct PeerState<Signer: Sign> {
465 /// `temporary_channel_id` or `channel_id` -> `channel`.
467 /// Holds all channels where the peer is the counterparty. Once a channel has been assigned a
468 /// `channel_id`, the `temporary_channel_id` key in the map is updated and is replaced by the
470 pub(super) channel_by_id: HashMap<[u8; 32], Channel<Signer>>,
471 /// The latest `InitFeatures` we heard from the peer.
472 latest_features: InitFeatures,
475 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
476 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
478 /// For users who don't want to bother doing their own payment preimage storage, we also store that
481 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
482 /// and instead encoding it in the payment secret.
483 struct PendingInboundPayment {
484 /// The payment secret that the sender must use for us to accept this payment
485 payment_secret: PaymentSecret,
486 /// Time at which this HTLC expires - blocks with a header time above this value will result in
487 /// this payment being removed.
489 /// Arbitrary identifier the user specifies (or not)
490 user_payment_id: u64,
491 // Other required attributes of the payment, optionally enforced:
492 payment_preimage: Option<PaymentPreimage>,
493 min_value_msat: Option<u64>,
496 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
497 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
498 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
499 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
500 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
501 /// that implements KeysInterface or Router for its keys manager and router, respectively, but this
502 /// type alias chooses the concrete types of KeysManager and DefaultRouter.
504 /// (C-not exported) as Arcs don't make sense in bindings
505 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
511 Arc<NetworkGraph<Arc<L>>>,
513 Arc<Mutex<ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>>
518 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
519 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
520 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
521 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
522 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
523 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
524 /// that implements KeysInterface or Router for its keys manager and router, respectively, but this
525 /// type alias chooses the concrete types of KeysManager and DefaultRouter.
527 /// (C-not exported) as Arcs don't make sense in bindings
528 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> = ChannelManager<&'a M, &'b T, &'c KeysManager, &'d F, &'e DefaultRouter<&'f NetworkGraph<&'g L>, &'g L, &'h Mutex<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>>, &'g L>;
530 /// Manager which keeps track of a number of channels and sends messages to the appropriate
531 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
533 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
534 /// to individual Channels.
536 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
537 /// all peers during write/read (though does not modify this instance, only the instance being
538 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
539 /// called funding_transaction_generated for outbound channels).
541 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
542 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
543 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
544 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
545 /// the serialization process). If the deserialized version is out-of-date compared to the
546 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
547 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
549 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
550 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
551 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
552 /// block_connected() to step towards your best block) upon deserialization before using the
555 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
556 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
557 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
558 /// offline for a full minute. In order to track this, you must call
559 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
561 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
562 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
563 /// essentially you should default to using a SimpleRefChannelManager, and use a
564 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
565 /// you're using lightning-net-tokio.
568 // The tree structure below illustrates the lock order requirements for the different locks of the
569 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
570 // and should then be taken in the order of the lowest to the highest level in the tree.
571 // Note that locks on different branches shall not be taken at the same time, as doing so will
572 // create a new lock order for those specific locks in the order they were taken.
576 // `total_consistency_lock`
578 // |__`forward_htlcs`
580 // | |__`pending_intercepted_htlcs`
582 // |__`pending_inbound_payments`
584 // | |__`claimable_payments`
586 // | |__`pending_outbound_payments` // This field's struct contains a map of pending outbounds
588 // | |__`channel_state`
590 // | |__`per_peer_state`
596 // | |__`short_to_chan_info`
598 // | |__`outbound_scid_aliases`
602 // | |__`pending_events`
604 // | |__`pending_background_events`
606 pub struct ChannelManager<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref>
608 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
609 T::Target: BroadcasterInterface,
610 K::Target: KeysInterface,
611 F::Target: FeeEstimator,
615 default_configuration: UserConfig,
616 genesis_hash: BlockHash,
617 fee_estimator: LowerBoundedFeeEstimator<F>,
623 /// See `ChannelManager` struct-level documentation for lock order requirements.
625 pub(super) best_block: RwLock<BestBlock>,
627 best_block: RwLock<BestBlock>,
628 secp_ctx: Secp256k1<secp256k1::All>,
630 /// See `ChannelManager` struct-level documentation for lock order requirements.
631 #[cfg(any(test, feature = "_test_utils"))]
632 pub(super) channel_state: Mutex<ChannelHolder>,
633 #[cfg(not(any(test, feature = "_test_utils")))]
634 channel_state: Mutex<ChannelHolder>,
636 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
637 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
638 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
639 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
641 /// See `ChannelManager` struct-level documentation for lock order requirements.
642 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
644 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
645 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
646 /// (if the channel has been force-closed), however we track them here to prevent duplicative
647 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
648 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
649 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
650 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
651 /// after reloading from disk while replaying blocks against ChannelMonitors.
653 /// See `PendingOutboundPayment` documentation for more info.
655 /// See `ChannelManager` struct-level documentation for lock order requirements.
656 pending_outbound_payments: OutboundPayments,
658 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
660 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
661 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
662 /// and via the classic SCID.
664 /// Note that no consistency guarantees are made about the existence of a channel with the
665 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
667 /// See `ChannelManager` struct-level documentation for lock order requirements.
669 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
671 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
672 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
673 /// until the user tells us what we should do with them.
675 /// See `ChannelManager` struct-level documentation for lock order requirements.
676 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
678 /// The sets of payments which are claimable or currently being claimed. See
679 /// [`ClaimablePayments`]' individual field docs for more info.
681 /// See `ChannelManager` struct-level documentation for lock order requirements.
682 claimable_payments: Mutex<ClaimablePayments>,
684 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
685 /// and some closed channels which reached a usable state prior to being closed. This is used
686 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
687 /// active channel list on load.
689 /// See `ChannelManager` struct-level documentation for lock order requirements.
690 outbound_scid_aliases: Mutex<HashSet<u64>>,
692 /// `channel_id` -> `counterparty_node_id`.
694 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
695 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
696 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
698 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
699 /// the corresponding channel for the event, as we only have access to the `channel_id` during
700 /// the handling of the events.
703 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
704 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
705 /// would break backwards compatability.
706 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
707 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
708 /// required to access the channel with the `counterparty_node_id`.
710 /// See `ChannelManager` struct-level documentation for lock order requirements.
711 id_to_peer: Mutex<HashMap<[u8; 32], PublicKey>>,
713 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
715 /// Outbound SCID aliases are added here once the channel is available for normal use, with
716 /// SCIDs being added once the funding transaction is confirmed at the channel's required
717 /// confirmation depth.
719 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
720 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
721 /// channel with the `channel_id` in our other maps.
723 /// See `ChannelManager` struct-level documentation for lock order requirements.
725 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
727 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
729 our_network_key: SecretKey,
730 our_network_pubkey: PublicKey,
732 inbound_payment_key: inbound_payment::ExpandedKey,
734 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
735 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
736 /// we encrypt the namespace identifier using these bytes.
738 /// [fake scids]: crate::util::scid_utils::fake_scid
739 fake_scid_rand_bytes: [u8; 32],
741 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
742 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
743 /// keeping additional state.
744 probing_cookie_secret: [u8; 32],
746 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
747 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
748 /// very far in the past, and can only ever be up to two hours in the future.
749 highest_seen_timestamp: AtomicUsize,
751 /// The bulk of our storage will eventually be here (message queues and the like). Currently
752 /// the `per_peer_state` stores our channels on a per-peer basis, as well as the peer's latest
755 /// If we are connected to a peer we always at least have an entry here, even if no channels
756 /// are currently open with that peer.
758 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
759 /// operate on the inner value freely. This opens up for parallel per-peer operation for
762 /// Note that the same thread must never acquire two inner `PeerState` locks at the same time.
764 /// See `ChannelManager` struct-level documentation for lock order requirements.
765 #[cfg(not(any(test, feature = "_test_utils")))]
766 per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<<K::Target as SignerProvider>::Signer>>>>,
767 #[cfg(any(test, feature = "_test_utils"))]
768 pub(super) per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<<K::Target as SignerProvider>::Signer>>>>,
770 /// See `ChannelManager` struct-level documentation for lock order requirements.
771 pending_events: Mutex<Vec<events::Event>>,
772 /// See `ChannelManager` struct-level documentation for lock order requirements.
773 pending_background_events: Mutex<Vec<BackgroundEvent>>,
774 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
775 /// Essentially just when we're serializing ourselves out.
776 /// Taken first everywhere where we are making changes before any other locks.
777 /// When acquiring this lock in read mode, rather than acquiring it directly, call
778 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
779 /// Notifier the lock contains sends out a notification when the lock is released.
780 total_consistency_lock: RwLock<()>,
782 persistence_notifier: Notifier,
789 /// Chain-related parameters used to construct a new `ChannelManager`.
791 /// Typically, the block-specific parameters are derived from the best block hash for the network,
792 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
793 /// are not needed when deserializing a previously constructed `ChannelManager`.
794 #[derive(Clone, Copy, PartialEq)]
795 pub struct ChainParameters {
796 /// The network for determining the `chain_hash` in Lightning messages.
797 pub network: Network,
799 /// The hash and height of the latest block successfully connected.
801 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
802 pub best_block: BestBlock,
805 #[derive(Copy, Clone, PartialEq)]
811 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
812 /// desirable to notify any listeners on `await_persistable_update_timeout`/
813 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
814 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
815 /// sending the aforementioned notification (since the lock being released indicates that the
816 /// updates are ready for persistence).
818 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
819 /// notify or not based on whether relevant changes have been made, providing a closure to
820 /// `optionally_notify` which returns a `NotifyOption`.
821 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
822 persistence_notifier: &'a Notifier,
824 // We hold onto this result so the lock doesn't get released immediately.
825 _read_guard: RwLockReadGuard<'a, ()>,
828 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
829 fn notify_on_drop(lock: &'a RwLock<()>, notifier: &'a Notifier) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
830 PersistenceNotifierGuard::optionally_notify(lock, notifier, || -> NotifyOption { NotifyOption::DoPersist })
833 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a Notifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
834 let read_guard = lock.read().unwrap();
836 PersistenceNotifierGuard {
837 persistence_notifier: notifier,
838 should_persist: persist_check,
839 _read_guard: read_guard,
844 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
846 if (self.should_persist)() == NotifyOption::DoPersist {
847 self.persistence_notifier.notify();
852 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
853 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
855 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
857 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
858 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
859 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
860 /// the maximum required amount in lnd as of March 2021.
861 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
863 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
864 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
866 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
868 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
869 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
870 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
871 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
872 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
873 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
874 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
875 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
876 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
877 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
878 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
879 // routing failure for any HTLC sender picking up an LDK node among the first hops.
880 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
882 /// Minimum CLTV difference between the current block height and received inbound payments.
883 /// Invoices generated for payment to us must set their `min_final_cltv_expiry` field to at least
885 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
886 // any payments to succeed. Further, we don't want payments to fail if a block was found while
887 // a payment was being routed, so we add an extra block to be safe.
888 pub const MIN_FINAL_CLTV_EXPIRY: u32 = HTLC_FAIL_BACK_BUFFER + 3;
890 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
891 // ie that if the next-hop peer fails the HTLC within
892 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
893 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
894 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
895 // LATENCY_GRACE_PERIOD_BLOCKS.
898 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;
900 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
901 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
904 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
906 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
907 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
909 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until we time-out the
910 /// idempotency of payments by [`PaymentId`]. See
911 /// [`OutboundPayments::remove_stale_resolved_payments`].
912 pub(crate) const IDEMPOTENCY_TIMEOUT_TICKS: u8 = 7;
914 /// Information needed for constructing an invoice route hint for this channel.
915 #[derive(Clone, Debug, PartialEq)]
916 pub struct CounterpartyForwardingInfo {
917 /// Base routing fee in millisatoshis.
918 pub fee_base_msat: u32,
919 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
920 pub fee_proportional_millionths: u32,
921 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
922 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
923 /// `cltv_expiry_delta` for more details.
924 pub cltv_expiry_delta: u16,
927 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
928 /// to better separate parameters.
929 #[derive(Clone, Debug, PartialEq)]
930 pub struct ChannelCounterparty {
931 /// The node_id of our counterparty
932 pub node_id: PublicKey,
933 /// The Features the channel counterparty provided upon last connection.
934 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
935 /// many routing-relevant features are present in the init context.
936 pub features: InitFeatures,
937 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
938 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
939 /// claiming at least this value on chain.
941 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
943 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
944 pub unspendable_punishment_reserve: u64,
945 /// Information on the fees and requirements that the counterparty requires when forwarding
946 /// payments to us through this channel.
947 pub forwarding_info: Option<CounterpartyForwardingInfo>,
948 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
949 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
950 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
951 pub outbound_htlc_minimum_msat: Option<u64>,
952 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
953 pub outbound_htlc_maximum_msat: Option<u64>,
956 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
957 #[derive(Clone, Debug, PartialEq)]
958 pub struct ChannelDetails {
959 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
960 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
961 /// Note that this means this value is *not* persistent - it can change once during the
962 /// lifetime of the channel.
963 pub channel_id: [u8; 32],
964 /// Parameters which apply to our counterparty. See individual fields for more information.
965 pub counterparty: ChannelCounterparty,
966 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
967 /// our counterparty already.
969 /// Note that, if this has been set, `channel_id` will be equivalent to
970 /// `funding_txo.unwrap().to_channel_id()`.
971 pub funding_txo: Option<OutPoint>,
972 /// The features which this channel operates with. See individual features for more info.
974 /// `None` until negotiation completes and the channel type is finalized.
975 pub channel_type: Option<ChannelTypeFeatures>,
976 /// The position of the funding transaction in the chain. None if the funding transaction has
977 /// not yet been confirmed and the channel fully opened.
979 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
980 /// payments instead of this. See [`get_inbound_payment_scid`].
982 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
983 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
985 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
986 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
987 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
988 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
989 /// [`confirmations_required`]: Self::confirmations_required
990 pub short_channel_id: Option<u64>,
991 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
992 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
993 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
996 /// This will be `None` as long as the channel is not available for routing outbound payments.
998 /// [`short_channel_id`]: Self::short_channel_id
999 /// [`confirmations_required`]: Self::confirmations_required
1000 pub outbound_scid_alias: Option<u64>,
1001 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1002 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1003 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1004 /// when they see a payment to be routed to us.
1006 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1007 /// previous values for inbound payment forwarding.
1009 /// [`short_channel_id`]: Self::short_channel_id
1010 pub inbound_scid_alias: Option<u64>,
1011 /// The value, in satoshis, of this channel as appears in the funding output
1012 pub channel_value_satoshis: u64,
1013 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1014 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1015 /// this value on chain.
1017 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1019 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1021 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1022 pub unspendable_punishment_reserve: Option<u64>,
1023 /// The `user_channel_id` passed in to create_channel, or a random value if the channel was
1024 /// inbound. This may be zero for inbound channels serialized with LDK versions prior to
1026 pub user_channel_id: u128,
1027 /// Our total balance. This is the amount we would get if we close the channel.
1028 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1029 /// amount is not likely to be recoverable on close.
1031 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1032 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1033 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1034 /// This does not consider any on-chain fees.
1036 /// See also [`ChannelDetails::outbound_capacity_msat`]
1037 pub balance_msat: u64,
1038 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1039 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1040 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1041 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1043 /// See also [`ChannelDetails::balance_msat`]
1045 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1046 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1047 /// should be able to spend nearly this amount.
1048 pub outbound_capacity_msat: u64,
1049 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1050 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1051 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1052 /// to use a limit as close as possible to the HTLC limit we can currently send.
1054 /// See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
1055 pub next_outbound_htlc_limit_msat: u64,
1056 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1057 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1058 /// available for inclusion in new inbound HTLCs).
1059 /// Note that there are some corner cases not fully handled here, so the actual available
1060 /// inbound capacity may be slightly higher than this.
1062 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1063 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1064 /// However, our counterparty should be able to spend nearly this amount.
1065 pub inbound_capacity_msat: u64,
1066 /// The number of required confirmations on the funding transaction before the funding will be
1067 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1068 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1069 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1070 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1072 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1074 /// [`is_outbound`]: ChannelDetails::is_outbound
1075 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1076 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1077 pub confirmations_required: Option<u32>,
1078 /// The current number of confirmations on the funding transaction.
1080 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1081 pub confirmations: Option<u32>,
1082 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1083 /// until we can claim our funds after we force-close the channel. During this time our
1084 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1085 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1086 /// time to claim our non-HTLC-encumbered funds.
1088 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1089 pub force_close_spend_delay: Option<u16>,
1090 /// True if the channel was initiated (and thus funded) by us.
1091 pub is_outbound: bool,
1092 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1093 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1094 /// required confirmation count has been reached (and we were connected to the peer at some
1095 /// point after the funding transaction received enough confirmations). The required
1096 /// confirmation count is provided in [`confirmations_required`].
1098 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1099 pub is_channel_ready: bool,
1100 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1101 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1103 /// This is a strict superset of `is_channel_ready`.
1104 pub is_usable: bool,
1105 /// True if this channel is (or will be) publicly-announced.
1106 pub is_public: bool,
1107 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1108 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1109 pub inbound_htlc_minimum_msat: Option<u64>,
1110 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1111 pub inbound_htlc_maximum_msat: Option<u64>,
1112 /// Set of configurable parameters that affect channel operation.
1114 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1115 pub config: Option<ChannelConfig>,
1118 impl ChannelDetails {
1119 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1120 /// This should be used for providing invoice hints or in any other context where our
1121 /// counterparty will forward a payment to us.
1123 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1124 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1125 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1126 self.inbound_scid_alias.or(self.short_channel_id)
1129 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1130 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1131 /// we're sending or forwarding a payment outbound over this channel.
1133 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1134 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1135 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1136 self.short_channel_id.or(self.outbound_scid_alias)
1140 /// Route hints used in constructing invoices for [phantom node payents].
1142 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
1144 pub struct PhantomRouteHints {
1145 /// The list of channels to be included in the invoice route hints.
1146 pub channels: Vec<ChannelDetails>,
1147 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1149 pub phantom_scid: u64,
1150 /// The pubkey of the real backing node that would ultimately receive the payment.
1151 pub real_node_pubkey: PublicKey,
1154 macro_rules! handle_error {
1155 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
1158 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish }) => {
1159 #[cfg(debug_assertions)]
1161 // In testing, ensure there are no deadlocks where the lock is already held upon
1162 // entering the macro.
1163 assert!($self.channel_state.try_lock().is_ok());
1164 assert!($self.pending_events.try_lock().is_ok());
1167 let mut msg_events = Vec::with_capacity(2);
1169 if let Some((shutdown_res, update_option)) = shutdown_finish {
1170 $self.finish_force_close_channel(shutdown_res);
1171 if let Some(update) = update_option {
1172 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1176 if let Some((channel_id, user_channel_id)) = chan_id {
1177 $self.pending_events.lock().unwrap().push(events::Event::ChannelClosed {
1178 channel_id, user_channel_id,
1179 reason: ClosureReason::ProcessingError { err: err.err.clone() }
1184 log_error!($self.logger, "{}", err.err);
1185 if let msgs::ErrorAction::IgnoreError = err.action {
1187 msg_events.push(events::MessageSendEvent::HandleError {
1188 node_id: $counterparty_node_id,
1189 action: err.action.clone()
1193 if !msg_events.is_empty() {
1194 $self.channel_state.lock().unwrap().pending_msg_events.append(&mut msg_events);
1197 // Return error in case higher-API need one
1204 macro_rules! update_maps_on_chan_removal {
1205 ($self: expr, $channel: expr) => {{
1206 $self.id_to_peer.lock().unwrap().remove(&$channel.channel_id());
1207 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1208 if let Some(short_id) = $channel.get_short_channel_id() {
1209 short_to_chan_info.remove(&short_id);
1211 // If the channel was never confirmed on-chain prior to its closure, remove the
1212 // outbound SCID alias we used for it from the collision-prevention set. While we
1213 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1214 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1215 // opening a million channels with us which are closed before we ever reach the funding
1217 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel.outbound_scid_alias());
1218 debug_assert!(alias_removed);
1220 short_to_chan_info.remove(&$channel.outbound_scid_alias());
1224 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1225 macro_rules! convert_chan_err {
1226 ($self: ident, $err: expr, $channel: expr, $channel_id: expr) => {
1228 ChannelError::Warn(msg) => {
1229 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), $channel_id.clone()))
1231 ChannelError::Ignore(msg) => {
1232 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
1234 ChannelError::Close(msg) => {
1235 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
1236 update_maps_on_chan_removal!($self, $channel);
1237 let shutdown_res = $channel.force_shutdown(true);
1238 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
1239 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
1245 macro_rules! break_chan_entry {
1246 ($self: ident, $res: expr, $entry: expr) => {
1250 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1252 $entry.remove_entry();
1260 macro_rules! try_chan_entry {
1261 ($self: ident, $res: expr, $entry: expr) => {
1265 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1267 $entry.remove_entry();
1275 macro_rules! remove_channel {
1276 ($self: expr, $entry: expr) => {
1278 let channel = $entry.remove_entry().1;
1279 update_maps_on_chan_removal!($self, channel);
1285 macro_rules! handle_monitor_update_res {
1286 ($self: ident, $err: expr, $chan: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $resend_channel_ready: expr, $failed_forwards: expr, $failed_fails: expr, $failed_finalized_fulfills: expr, $chan_id: expr) => {
1288 ChannelMonitorUpdateStatus::PermanentFailure => {
1289 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateStatus::PermanentFailure", log_bytes!($chan_id[..]));
1290 update_maps_on_chan_removal!($self, $chan);
1291 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
1292 // chain in a confused state! We need to move them into the ChannelMonitor which
1293 // will be responsible for failing backwards once things confirm on-chain.
1294 // It's ok that we drop $failed_forwards here - at this point we'd rather they
1295 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
1296 // us bother trying to claim it just to forward on to another peer. If we're
1297 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
1298 // given up the preimage yet, so might as well just wait until the payment is
1299 // retried, avoiding the on-chain fees.
1300 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure".to_owned(), *$chan_id, $chan.get_user_id(),
1301 $chan.force_shutdown(false), $self.get_channel_update_for_broadcast(&$chan).ok() ));
1304 ChannelMonitorUpdateStatus::InProgress => {
1305 log_info!($self.logger, "Disabling channel {} due to monitor update in progress. On restore will send {} and process {} forwards, {} fails, and {} fulfill finalizations",
1306 log_bytes!($chan_id[..]),
1307 if $resend_commitment && $resend_raa {
1308 match $action_type {
1309 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
1310 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
1312 } else if $resend_commitment { "commitment" }
1313 else if $resend_raa { "RAA" }
1315 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
1316 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len(),
1317 (&$failed_finalized_fulfills as &Vec<HTLCSource>).len());
1318 if !$resend_commitment {
1319 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
1322 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
1324 $chan.monitor_updating_paused($resend_raa, $resend_commitment, $resend_channel_ready, $failed_forwards, $failed_fails, $failed_finalized_fulfills);
1325 (Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$chan_id)), false)
1327 ChannelMonitorUpdateStatus::Completed => {
1332 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $resend_channel_ready: expr, $failed_forwards: expr, $failed_fails: expr, $failed_finalized_fulfills: expr) => { {
1333 let (res, drop) = handle_monitor_update_res!($self, $err, $entry.get_mut(), $action_type, $resend_raa, $resend_commitment, $resend_channel_ready, $failed_forwards, $failed_fails, $failed_finalized_fulfills, $entry.key());
1335 $entry.remove_entry();
1339 ($self: ident, $err: expr, $entry: expr, $action_type: path, $chan_id: expr, COMMITMENT_UPDATE_ONLY) => { {
1340 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst);
1341 handle_monitor_update_res!($self, $err, $entry, $action_type, false, true, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1343 ($self: ident, $err: expr, $entry: expr, $action_type: path, $chan_id: expr, NO_UPDATE) => {
1344 handle_monitor_update_res!($self, $err, $entry, $action_type, false, false, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1346 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_channel_ready: expr, OPTIONALLY_RESEND_FUNDING_LOCKED) => {
1347 handle_monitor_update_res!($self, $err, $entry, $action_type, false, false, $resend_channel_ready, Vec::new(), Vec::new(), Vec::new())
1349 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1350 handle_monitor_update_res!($self, $err, $entry, $action_type, $resend_raa, $resend_commitment, false, Vec::new(), Vec::new(), Vec::new())
1352 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
1353 handle_monitor_update_res!($self, $err, $entry, $action_type, $resend_raa, $resend_commitment, false, $failed_forwards, $failed_fails, Vec::new())
1357 macro_rules! send_channel_ready {
1358 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
1359 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1360 node_id: $channel.get_counterparty_node_id(),
1361 msg: $channel_ready_msg,
1363 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1364 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1365 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1366 let outbound_alias_insert = short_to_chan_info.insert($channel.outbound_scid_alias(), ($channel.get_counterparty_node_id(), $channel.channel_id()));
1367 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1368 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1369 if let Some(real_scid) = $channel.get_short_channel_id() {
1370 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.get_counterparty_node_id(), $channel.channel_id()));
1371 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1372 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1377 macro_rules! emit_channel_ready_event {
1378 ($self: expr, $channel: expr) => {
1379 if $channel.should_emit_channel_ready_event() {
1381 let mut pending_events = $self.pending_events.lock().unwrap();
1382 pending_events.push(events::Event::ChannelReady {
1383 channel_id: $channel.channel_id(),
1384 user_channel_id: $channel.get_user_id(),
1385 counterparty_node_id: $channel.get_counterparty_node_id(),
1386 channel_type: $channel.get_channel_type().clone(),
1389 $channel.set_channel_ready_event_emitted();
1394 impl<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref> ChannelManager<M, T, K, F, R, L>
1396 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
1397 T::Target: BroadcasterInterface,
1398 K::Target: KeysInterface,
1399 F::Target: FeeEstimator,
1403 /// Constructs a new ChannelManager to hold several channels and route between them.
1405 /// This is the main "logic hub" for all channel-related actions, and implements
1406 /// ChannelMessageHandler.
1408 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1410 /// Users need to notify the new ChannelManager when a new block is connected or
1411 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
1412 /// from after `params.latest_hash`.
1413 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, keys_manager: K, config: UserConfig, params: ChainParameters) -> Self {
1414 let mut secp_ctx = Secp256k1::new();
1415 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
1416 let inbound_pmt_key_material = keys_manager.get_inbound_payment_key_material();
1417 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
1419 default_configuration: config.clone(),
1420 genesis_hash: genesis_block(params.network).header.block_hash(),
1421 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
1426 best_block: RwLock::new(params.best_block),
1428 channel_state: Mutex::new(ChannelHolder{
1429 pending_msg_events: Vec::new(),
1431 outbound_scid_aliases: Mutex::new(HashSet::new()),
1432 pending_inbound_payments: Mutex::new(HashMap::new()),
1433 pending_outbound_payments: OutboundPayments::new(),
1434 forward_htlcs: Mutex::new(HashMap::new()),
1435 claimable_payments: Mutex::new(ClaimablePayments { claimable_htlcs: HashMap::new(), pending_claiming_payments: HashMap::new() }),
1436 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
1437 id_to_peer: Mutex::new(HashMap::new()),
1438 short_to_chan_info: FairRwLock::new(HashMap::new()),
1440 our_network_key: keys_manager.get_node_secret(Recipient::Node).unwrap(),
1441 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret(Recipient::Node).unwrap()),
1444 inbound_payment_key: expanded_inbound_key,
1445 fake_scid_rand_bytes: keys_manager.get_secure_random_bytes(),
1447 probing_cookie_secret: keys_manager.get_secure_random_bytes(),
1449 highest_seen_timestamp: AtomicUsize::new(0),
1451 per_peer_state: FairRwLock::new(HashMap::new()),
1453 pending_events: Mutex::new(Vec::new()),
1454 pending_background_events: Mutex::new(Vec::new()),
1455 total_consistency_lock: RwLock::new(()),
1456 persistence_notifier: Notifier::new(),
1464 /// Gets the current configuration applied to all new channels.
1465 pub fn get_current_default_configuration(&self) -> &UserConfig {
1466 &self.default_configuration
1469 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
1470 let height = self.best_block.read().unwrap().height();
1471 let mut outbound_scid_alias = 0;
1474 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
1475 outbound_scid_alias += 1;
1477 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
1479 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
1483 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"); }
1488 /// Creates a new outbound channel to the given remote node and with the given value.
1490 /// `user_channel_id` will be provided back as in
1491 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
1492 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
1493 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
1494 /// is simply copied to events and otherwise ignored.
1496 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
1497 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
1499 /// Note that we do not check if you are currently connected to the given peer. If no
1500 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
1501 /// the channel eventually being silently forgotten (dropped on reload).
1503 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
1504 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
1505 /// [`ChannelDetails::channel_id`] until after
1506 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
1507 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
1508 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
1510 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
1511 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
1512 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
1513 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> {
1514 if channel_value_satoshis < 1000 {
1515 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
1519 let per_peer_state = self.per_peer_state.read().unwrap();
1520 match per_peer_state.get(&their_network_key) {
1521 Some(peer_state) => {
1522 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
1523 let peer_state = peer_state.lock().unwrap();
1524 let their_features = &peer_state.latest_features;
1525 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
1526 match Channel::new_outbound(&self.fee_estimator, &self.keys_manager, their_network_key,
1527 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
1528 self.best_block.read().unwrap().height(), outbound_scid_alias)
1532 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
1537 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", their_network_key) }),
1540 let res = channel.get_open_channel(self.genesis_hash.clone());
1542 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1543 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
1544 debug_assert!(&self.total_consistency_lock.try_write().is_err());
1546 let temporary_channel_id = channel.channel_id();
1547 let mut channel_state = self.channel_state.lock().unwrap();
1548 let per_peer_state = self.per_peer_state.read().unwrap();
1549 if let Some(peer_state_mutex) = per_peer_state.get(&their_network_key){
1550 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
1551 let peer_state = &mut *peer_state_lock;
1552 match peer_state.channel_by_id.entry(temporary_channel_id) {
1553 hash_map::Entry::Occupied(_) => {
1555 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
1557 panic!("RNG is bad???");
1560 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
1562 } else { return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", their_network_key) }) }
1563 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
1564 node_id: their_network_key,
1567 Ok(temporary_channel_id)
1570 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<<K::Target as SignerProvider>::Signer>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
1571 let mut res = Vec::new();
1572 // Allocate our best estimate of the number of channels we have in the `res`
1573 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
1574 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
1575 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
1576 // unlikely as the `short_to_chan_info` map often contains 2 entries for
1577 // the same channel.
1578 res.reserve(self.short_to_chan_info.read().unwrap().len());
1580 let best_block_height = self.best_block.read().unwrap().height();
1581 let per_peer_state = self.per_peer_state.read().unwrap();
1582 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
1583 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
1584 let peer_state = &mut *peer_state_lock;
1585 for (channel_id, channel) in peer_state.channel_by_id.iter().filter(f) {
1586 let balance = channel.get_available_balances();
1587 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1588 channel.get_holder_counterparty_selected_channel_reserve_satoshis();
1589 res.push(ChannelDetails {
1590 channel_id: (*channel_id).clone(),
1591 counterparty: ChannelCounterparty {
1592 node_id: channel.get_counterparty_node_id(),
1593 features: peer_state.latest_features.clone(),
1594 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1595 forwarding_info: channel.counterparty_forwarding_info(),
1596 // Ensures that we have actually received the `htlc_minimum_msat` value
1597 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1598 // message (as they are always the first message from the counterparty).
1599 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1600 // default `0` value set by `Channel::new_outbound`.
1601 outbound_htlc_minimum_msat: if channel.have_received_message() {
1602 Some(channel.get_counterparty_htlc_minimum_msat()) } else { None },
1603 outbound_htlc_maximum_msat: channel.get_counterparty_htlc_maximum_msat(),
1605 funding_txo: channel.get_funding_txo(),
1606 // Note that accept_channel (or open_channel) is always the first message, so
1607 // `have_received_message` indicates that type negotiation has completed.
1608 channel_type: if channel.have_received_message() { Some(channel.get_channel_type().clone()) } else { None },
1609 short_channel_id: channel.get_short_channel_id(),
1610 outbound_scid_alias: if channel.is_usable() { Some(channel.outbound_scid_alias()) } else { None },
1611 inbound_scid_alias: channel.latest_inbound_scid_alias(),
1612 channel_value_satoshis: channel.get_value_satoshis(),
1613 unspendable_punishment_reserve: to_self_reserve_satoshis,
1614 balance_msat: balance.balance_msat,
1615 inbound_capacity_msat: balance.inbound_capacity_msat,
1616 outbound_capacity_msat: balance.outbound_capacity_msat,
1617 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1618 user_channel_id: channel.get_user_id(),
1619 confirmations_required: channel.minimum_depth(),
1620 confirmations: Some(channel.get_funding_tx_confirmations(best_block_height)),
1621 force_close_spend_delay: channel.get_counterparty_selected_contest_delay(),
1622 is_outbound: channel.is_outbound(),
1623 is_channel_ready: channel.is_usable(),
1624 is_usable: channel.is_live(),
1625 is_public: channel.should_announce(),
1626 inbound_htlc_minimum_msat: Some(channel.get_holder_htlc_minimum_msat()),
1627 inbound_htlc_maximum_msat: channel.get_holder_htlc_maximum_msat(),
1628 config: Some(channel.config()),
1636 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
1637 /// more information.
1638 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1639 self.list_channels_with_filter(|_| true)
1642 /// Gets the list of usable channels, in random order. Useful as an argument to [`find_route`]
1643 /// to ensure non-announced channels are used.
1645 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1646 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1649 /// [`find_route`]: crate::routing::router::find_route
1650 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1651 // Note we use is_live here instead of usable which leads to somewhat confused
1652 // internal/external nomenclature, but that's ok cause that's probably what the user
1653 // really wanted anyway.
1654 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1657 /// Helper function that issues the channel close events
1658 fn issue_channel_close_events(&self, channel: &Channel<<K::Target as SignerProvider>::Signer>, closure_reason: ClosureReason) {
1659 let mut pending_events_lock = self.pending_events.lock().unwrap();
1660 match channel.unbroadcasted_funding() {
1661 Some(transaction) => {
1662 pending_events_lock.push(events::Event::DiscardFunding { channel_id: channel.channel_id(), transaction })
1666 pending_events_lock.push(events::Event::ChannelClosed {
1667 channel_id: channel.channel_id(),
1668 user_channel_id: channel.get_user_id(),
1669 reason: closure_reason
1673 fn close_channel_internal(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>) -> Result<(), APIError> {
1674 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1676 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
1677 let result: Result<(), _> = loop {
1678 let mut channel_state_lock = self.channel_state.lock().unwrap();
1679 let channel_state = &mut *channel_state_lock;
1680 let per_peer_state = self.per_peer_state.read().unwrap();
1681 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
1682 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
1683 let peer_state = &mut *peer_state_lock;
1684 match peer_state.channel_by_id.entry(channel_id.clone()) {
1685 hash_map::Entry::Occupied(mut chan_entry) => {
1686 if *counterparty_node_id != chan_entry.get().get_counterparty_node_id(){
1687 return Err(APIError::APIMisuseError { err: "The passed counterparty_node_id doesn't match the channel's counterparty node_id".to_owned() });
1689 let (shutdown_msg, monitor_update, htlcs) = chan_entry.get_mut().get_shutdown(&self.keys_manager, &peer_state.latest_features, target_feerate_sats_per_1000_weight)?;
1690 failed_htlcs = htlcs;
1692 // Update the monitor with the shutdown script if necessary.
1693 if let Some(monitor_update) = monitor_update {
1694 let update_res = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update);
1695 let (result, is_permanent) =
1696 handle_monitor_update_res!(self, update_res, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
1698 remove_channel!(self, chan_entry);
1703 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1704 node_id: *counterparty_node_id,
1708 if chan_entry.get().is_shutdown() {
1709 let channel = remove_channel!(self, chan_entry);
1710 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
1711 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1715 self.issue_channel_close_events(&channel, ClosureReason::HolderForceClosed);
1719 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable { err: "No such channel".to_owned() })
1722 return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", counterparty_node_id) });
1726 for htlc_source in failed_htlcs.drain(..) {
1727 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
1728 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
1729 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
1732 let _ = handle_error!(self, result, *counterparty_node_id);
1736 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1737 /// will be accepted on the given channel, and after additional timeout/the closing of all
1738 /// pending HTLCs, the channel will be closed on chain.
1740 /// * If we are the channel initiator, we will pay between our [`Background`] and
1741 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1743 /// * If our counterparty is the channel initiator, we will require a channel closing
1744 /// transaction feerate of at least our [`Background`] feerate or the feerate which
1745 /// would appear on a force-closure transaction, whichever is lower. We will allow our
1746 /// counterparty to pay as much fee as they'd like, however.
1748 /// May generate a SendShutdown message event on success, which should be relayed.
1750 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1751 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1752 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1753 pub fn close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
1754 self.close_channel_internal(channel_id, counterparty_node_id, None)
1757 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1758 /// will be accepted on the given channel, and after additional timeout/the closing of all
1759 /// pending HTLCs, the channel will be closed on chain.
1761 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
1762 /// the channel being closed or not:
1763 /// * If we are the channel initiator, we will pay at least this feerate on the closing
1764 /// transaction. The upper-bound is set by
1765 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1766 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
1767 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
1768 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
1769 /// will appear on a force-closure transaction, whichever is lower).
1771 /// May generate a SendShutdown message event on success, which should be relayed.
1773 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1774 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1775 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1776 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> {
1777 self.close_channel_internal(channel_id, counterparty_node_id, Some(target_feerate_sats_per_1000_weight))
1781 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1782 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1783 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
1784 for htlc_source in failed_htlcs.drain(..) {
1785 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
1786 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
1787 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
1788 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
1790 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1791 // There isn't anything we can do if we get an update failure - we're already
1792 // force-closing. The monitor update on the required in-memory copy should broadcast
1793 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1794 // ignore the result here.
1795 let _ = self.chain_monitor.update_channel(funding_txo, monitor_update);
1799 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
1800 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
1801 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
1802 -> Result<PublicKey, APIError> {
1804 let per_peer_state = self.per_peer_state.read().unwrap();
1805 if let Some(peer_state_mutex) = per_peer_state.get(peer_node_id) {
1806 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
1807 let peer_state = &mut *peer_state_lock;
1808 if let hash_map::Entry::Occupied(chan) = peer_state.channel_by_id.entry(channel_id.clone()) {
1809 if chan.get().get_counterparty_node_id() != *peer_node_id {
1810 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1812 if let Some(peer_msg) = peer_msg {
1813 self.issue_channel_close_events(chan.get(),ClosureReason::CounterpartyForceClosed { peer_msg: peer_msg.to_string() });
1815 self.issue_channel_close_events(chan.get(),ClosureReason::HolderForceClosed);
1817 remove_channel!(self, chan)
1819 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1822 return Err(APIError::APIMisuseError{ err: format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", peer_node_id) });
1825 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
1826 self.finish_force_close_channel(chan.force_shutdown(broadcast));
1827 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
1828 let mut channel_state = self.channel_state.lock().unwrap();
1829 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1834 Ok(chan.get_counterparty_node_id())
1837 fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
1838 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1839 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
1840 Ok(counterparty_node_id) => {
1841 self.channel_state.lock().unwrap().pending_msg_events.push(
1842 events::MessageSendEvent::HandleError {
1843 node_id: counterparty_node_id,
1844 action: msgs::ErrorAction::SendErrorMessage {
1845 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
1855 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
1856 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
1857 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
1859 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
1860 -> Result<(), APIError> {
1861 self.force_close_sending_error(channel_id, counterparty_node_id, true)
1864 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
1865 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
1866 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
1868 /// You can always get the latest local transaction(s) to broadcast from
1869 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
1870 pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
1871 -> Result<(), APIError> {
1872 self.force_close_sending_error(channel_id, counterparty_node_id, false)
1875 /// Force close all channels, immediately broadcasting the latest local commitment transaction
1876 /// for each to the chain and rejecting new HTLCs on each.
1877 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
1878 for chan in self.list_channels() {
1879 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
1883 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
1884 /// local transaction(s).
1885 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
1886 for chan in self.list_channels() {
1887 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
1891 fn construct_recv_pending_htlc_info(&self, hop_data: msgs::OnionHopData, shared_secret: [u8; 32],
1892 payment_hash: PaymentHash, amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>) -> Result<PendingHTLCInfo, ReceiveError>
1894 // final_incorrect_cltv_expiry
1895 if hop_data.outgoing_cltv_value != cltv_expiry {
1896 return Err(ReceiveError {
1897 msg: "Upstream node set CLTV to the wrong value",
1899 err_data: cltv_expiry.to_be_bytes().to_vec()
1902 // final_expiry_too_soon
1903 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
1904 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
1905 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
1906 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
1907 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
1908 let current_height: u32 = self.best_block.read().unwrap().height();
1909 if (hop_data.outgoing_cltv_value as u64) <= current_height as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
1910 let mut err_data = Vec::with_capacity(12);
1911 err_data.extend_from_slice(&amt_msat.to_be_bytes());
1912 err_data.extend_from_slice(¤t_height.to_be_bytes());
1913 return Err(ReceiveError {
1914 err_code: 0x4000 | 15, err_data,
1915 msg: "The final CLTV expiry is too soon to handle",
1918 if hop_data.amt_to_forward > amt_msat {
1919 return Err(ReceiveError {
1921 err_data: amt_msat.to_be_bytes().to_vec(),
1922 msg: "Upstream node sent less than we were supposed to receive in payment",
1926 let routing = match hop_data.format {
1927 msgs::OnionHopDataFormat::NonFinalNode { .. } => {
1928 return Err(ReceiveError {
1929 err_code: 0x4000|22,
1930 err_data: Vec::new(),
1931 msg: "Got non final data with an HMAC of 0",
1934 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage } => {
1935 if payment_data.is_some() && keysend_preimage.is_some() {
1936 return Err(ReceiveError {
1937 err_code: 0x4000|22,
1938 err_data: Vec::new(),
1939 msg: "We don't support MPP keysend payments",
1941 } else if let Some(data) = payment_data {
1942 PendingHTLCRouting::Receive {
1944 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
1945 phantom_shared_secret,
1947 } else if let Some(payment_preimage) = keysend_preimage {
1948 // We need to check that the sender knows the keysend preimage before processing this
1949 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
1950 // could discover the final destination of X, by probing the adjacent nodes on the route
1951 // with a keysend payment of identical payment hash to X and observing the processing
1952 // time discrepancies due to a hash collision with X.
1953 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
1954 if hashed_preimage != payment_hash {
1955 return Err(ReceiveError {
1956 err_code: 0x4000|22,
1957 err_data: Vec::new(),
1958 msg: "Payment preimage didn't match payment hash",
1962 PendingHTLCRouting::ReceiveKeysend {
1964 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
1967 return Err(ReceiveError {
1968 err_code: 0x4000|0x2000|3,
1969 err_data: Vec::new(),
1970 msg: "We require payment_secrets",
1975 Ok(PendingHTLCInfo {
1978 incoming_shared_secret: shared_secret,
1979 incoming_amt_msat: Some(amt_msat),
1980 outgoing_amt_msat: amt_msat,
1981 outgoing_cltv_value: hop_data.outgoing_cltv_value,
1985 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> PendingHTLCStatus {
1986 macro_rules! return_malformed_err {
1987 ($msg: expr, $err_code: expr) => {
1989 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
1990 return PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
1991 channel_id: msg.channel_id,
1992 htlc_id: msg.htlc_id,
1993 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
1994 failure_code: $err_code,
2000 if let Err(_) = msg.onion_routing_packet.public_key {
2001 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2004 let shared_secret = SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key).secret_bytes();
2006 if msg.onion_routing_packet.version != 0 {
2007 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2008 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2009 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2010 //receiving node would have to brute force to figure out which version was put in the
2011 //packet by the node that send us the message, in the case of hashing the hop_data, the
2012 //node knows the HMAC matched, so they already know what is there...
2013 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2015 macro_rules! return_err {
2016 ($msg: expr, $err_code: expr, $data: expr) => {
2018 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2019 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2020 channel_id: msg.channel_id,
2021 htlc_id: msg.htlc_id,
2022 reason: HTLCFailReason::reason($err_code, $data.to_vec())
2023 .get_encrypted_failure_packet(&shared_secret, &None),
2029 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) {
2031 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2032 return_malformed_err!(err_msg, err_code);
2034 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2035 return_err!(err_msg, err_code, &[0; 0]);
2039 let pending_forward_info = match next_hop {
2040 onion_utils::Hop::Receive(next_hop_data) => {
2042 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash, msg.amount_msat, msg.cltv_expiry, None) {
2044 // Note that we could obviously respond immediately with an update_fulfill_htlc
2045 // message, however that would leak that we are the recipient of this payment, so
2046 // instead we stay symmetric with the forwarding case, only responding (after a
2047 // delay) once they've send us a commitment_signed!
2048 PendingHTLCStatus::Forward(info)
2050 Err(ReceiveError { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
2053 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
2054 let new_pubkey = msg.onion_routing_packet.public_key.unwrap();
2055 let outgoing_packet = msgs::OnionPacket {
2057 public_key: onion_utils::next_hop_packet_pubkey(&self.secp_ctx, new_pubkey, &shared_secret),
2058 hop_data: new_packet_bytes,
2059 hmac: next_hop_hmac.clone(),
2062 let short_channel_id = match next_hop_data.format {
2063 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
2064 msgs::OnionHopDataFormat::FinalNode { .. } => {
2065 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
2069 PendingHTLCStatus::Forward(PendingHTLCInfo {
2070 routing: PendingHTLCRouting::Forward {
2071 onion_packet: outgoing_packet,
2074 payment_hash: msg.payment_hash.clone(),
2075 incoming_shared_secret: shared_secret,
2076 incoming_amt_msat: Some(msg.amount_msat),
2077 outgoing_amt_msat: next_hop_data.amt_to_forward,
2078 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
2083 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref outgoing_amt_msat, ref outgoing_cltv_value, .. }) = &pending_forward_info {
2084 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
2085 // with a short_channel_id of 0. This is important as various things later assume
2086 // short_channel_id is non-0 in any ::Forward.
2087 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
2088 if let Some((err, mut code, chan_update)) = loop {
2089 let id_option = self.short_to_chan_info.read().unwrap().get(&short_channel_id).cloned();
2090 let forwarding_chan_info_opt = match id_option {
2091 None => { // unknown_next_peer
2092 // Note that this is likely a timing oracle for detecting whether an scid is a
2093 // phantom or an intercept.
2094 if (self.default_configuration.accept_intercept_htlcs &&
2095 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, *short_channel_id, &self.genesis_hash)) ||
2096 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, *short_channel_id, &self.genesis_hash)
2100 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2103 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
2105 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
2106 let per_peer_state = self.per_peer_state.read().unwrap();
2107 if let None = per_peer_state.get(&counterparty_node_id) {
2108 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2110 let peer_state_mutex = per_peer_state.get(&counterparty_node_id).unwrap();
2111 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2112 let peer_state = &mut *peer_state_lock;
2113 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id) {
2115 // Channel was removed. The short_to_chan_info and channel_by_id maps
2116 // have no consistency guarantees.
2117 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2121 if !chan.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
2122 // Note that the behavior here should be identical to the above block - we
2123 // should NOT reveal the existence or non-existence of a private channel if
2124 // we don't allow forwards outbound over them.
2125 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
2127 if chan.get_channel_type().supports_scid_privacy() && *short_channel_id != chan.outbound_scid_alias() {
2128 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
2129 // "refuse to forward unless the SCID alias was used", so we pretend
2130 // we don't have the channel here.
2131 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
2133 let chan_update_opt = self.get_channel_update_for_onion(*short_channel_id, chan).ok();
2135 // Note that we could technically not return an error yet here and just hope
2136 // that the connection is reestablished or monitor updated by the time we get
2137 // around to doing the actual forward, but better to fail early if we can and
2138 // hopefully an attacker trying to path-trace payments cannot make this occur
2139 // on a small/per-node/per-channel scale.
2140 if !chan.is_live() { // channel_disabled
2141 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, chan_update_opt));
2143 if *outgoing_amt_msat < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
2144 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
2146 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, *outgoing_amt_msat, *outgoing_cltv_value) {
2147 break Some((err, code, chan_update_opt));
2151 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 {
2152 // We really should set `incorrect_cltv_expiry` here but as we're not
2153 // forwarding over a real channel we can't generate a channel_update
2154 // for it. Instead we just return a generic temporary_node_failure.
2156 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
2163 let cur_height = self.best_block.read().unwrap().height() + 1;
2164 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
2165 // but we want to be robust wrt to counterparty packet sanitization (see
2166 // HTLC_FAIL_BACK_BUFFER rationale).
2167 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
2168 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
2170 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
2171 break Some(("CLTV expiry is too far in the future", 21, None));
2173 // If the HTLC expires ~now, don't bother trying to forward it to our
2174 // counterparty. They should fail it anyway, but we don't want to bother with
2175 // the round-trips or risk them deciding they definitely want the HTLC and
2176 // force-closing to ensure they get it if we're offline.
2177 // We previously had a much more aggressive check here which tried to ensure
2178 // our counterparty receives an HTLC which has *our* risk threshold met on it,
2179 // but there is no need to do that, and since we're a bit conservative with our
2180 // risk threshold it just results in failing to forward payments.
2181 if (*outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
2182 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
2188 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
2189 if let Some(chan_update) = chan_update {
2190 if code == 0x1000 | 11 || code == 0x1000 | 12 {
2191 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
2193 else if code == 0x1000 | 13 {
2194 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
2196 else if code == 0x1000 | 20 {
2197 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
2198 0u16.write(&mut res).expect("Writes cannot fail");
2200 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
2201 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
2202 chan_update.write(&mut res).expect("Writes cannot fail");
2203 } else if code & 0x1000 == 0x1000 {
2204 // If we're trying to return an error that requires a `channel_update` but
2205 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
2206 // generate an update), just use the generic "temporary_node_failure"
2210 return_err!(err, code, &res.0[..]);
2215 pending_forward_info
2218 /// Gets the current channel_update for the given channel. This first checks if the channel is
2219 /// public, and thus should be called whenever the result is going to be passed out in a
2220 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
2222 /// May be called with peer_state already locked!
2223 fn get_channel_update_for_broadcast(&self, chan: &Channel<<K::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2224 if !chan.should_announce() {
2225 return Err(LightningError {
2226 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
2227 action: msgs::ErrorAction::IgnoreError
2230 if chan.get_short_channel_id().is_none() {
2231 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
2233 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.channel_id()));
2234 self.get_channel_update_for_unicast(chan)
2237 /// Gets the current channel_update for the given channel. This does not check if the channel
2238 /// is public (only returning an Err if the channel does not yet have an assigned short_id),
2239 /// and thus MUST NOT be called unless the recipient of the resulting message has already
2240 /// provided evidence that they know about the existence of the channel.
2241 /// May be called with peer_state already locked!
2242 fn get_channel_update_for_unicast(&self, chan: &Channel<<K::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2243 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.channel_id()));
2244 let short_channel_id = match chan.get_short_channel_id().or(chan.latest_inbound_scid_alias()) {
2245 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
2249 self.get_channel_update_for_onion(short_channel_id, chan)
2251 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<<K::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2252 log_trace!(self.logger, "Generating channel update for channel {}", log_bytes!(chan.channel_id()));
2253 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
2255 let unsigned = msgs::UnsignedChannelUpdate {
2256 chain_hash: self.genesis_hash,
2258 timestamp: chan.get_update_time_counter(),
2259 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
2260 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
2261 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
2262 htlc_maximum_msat: chan.get_announced_htlc_max_msat(),
2263 fee_base_msat: chan.get_outbound_forwarding_fee_base_msat(),
2264 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
2265 excess_data: Vec::new(),
2268 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
2269 let sig = self.secp_ctx.sign_ecdsa(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
2271 Ok(msgs::ChannelUpdate {
2277 // Only public for testing, this should otherwise never be called direcly
2278 pub(crate) 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> {
2279 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
2280 let prng_seed = self.keys_manager.get_secure_random_bytes();
2281 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
2283 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
2284 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected"})?;
2285 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
2286 if onion_utils::route_size_insane(&onion_payloads) {
2287 return Err(APIError::InvalidRoute{err: "Route size too large considering onion data"});
2289 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
2291 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2293 let err: Result<(), _> = loop {
2294 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.first().unwrap().short_channel_id) {
2295 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
2296 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
2299 let mut channel_lock = self.channel_state.lock().unwrap();
2300 let channel_state = &mut *channel_lock;
2301 let per_peer_state = self.per_peer_state.read().unwrap();
2302 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
2303 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2304 let peer_state = &mut *peer_state_lock;
2305 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(id) {
2307 if !chan.get().is_live() {
2308 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
2310 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(
2311 htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
2313 session_priv: session_priv.clone(),
2314 first_hop_htlc_msat: htlc_msat,
2316 payment_secret: payment_secret.clone(),
2317 payment_params: payment_params.clone(),
2318 }, onion_packet, &self.logger),
2321 Some((update_add, commitment_signed, monitor_update)) => {
2322 let update_err = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update);
2323 let chan_id = chan.get().channel_id();
2325 handle_monitor_update_res!(self, update_err, chan,
2326 RAACommitmentOrder::CommitmentFirst, false, true))
2328 (ChannelMonitorUpdateStatus::PermanentFailure, Err(e)) => break Err(e),
2329 (ChannelMonitorUpdateStatus::Completed, Ok(())) => {},
2330 (ChannelMonitorUpdateStatus::InProgress, Err(_)) => {
2331 // Note that MonitorUpdateInProgress here indicates (per function
2332 // docs) that we will resend the commitment update once monitor
2333 // updating completes. Therefore, we must return an error
2334 // indicating that it is unsafe to retry the payment wholesale,
2335 // which we do in the send_payment check for
2336 // MonitorUpdateInProgress, below.
2337 return Err(APIError::MonitorUpdateInProgress);
2339 _ => unreachable!(),
2342 log_debug!(self.logger, "Sending payment along path resulted in a commitment_signed for channel {}", log_bytes!(chan_id));
2343 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2344 node_id: path.first().unwrap().pubkey,
2345 updates: msgs::CommitmentUpdate {
2346 update_add_htlcs: vec![update_add],
2347 update_fulfill_htlcs: Vec::new(),
2348 update_fail_htlcs: Vec::new(),
2349 update_fail_malformed_htlcs: Vec::new(),
2358 // The channel was likely removed after we fetched the id from the
2359 // `short_to_chan_info` map, but before we successfully locked the
2360 // `channel_by_id` map.
2361 // This can occur as no consistency guarantees exists between the two maps.
2362 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
2364 } else { return Err(APIError::InvalidRoute{err: "No peer matching the path's first hop found!" })}
2368 match handle_error!(self, err, path.first().unwrap().pubkey) {
2369 Ok(_) => unreachable!(),
2371 Err(APIError::ChannelUnavailable { err: e.err })
2376 /// Sends a payment along a given route.
2378 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
2379 /// fields for more info.
2381 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
2382 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
2383 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
2384 /// [`Event::PaymentSent`]) LDK will not stop you from sending a second payment with the same
2387 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
2388 /// tracking of payments, including state to indicate once a payment has completed. Because you
2389 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
2390 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
2391 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
2393 /// May generate SendHTLCs message(s) event on success, which should be relayed (e.g. via
2394 /// [`PeerManager::process_events`]).
2396 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
2397 /// each entry matching the corresponding-index entry in the route paths, see
2398 /// PaymentSendFailure for more info.
2400 /// In general, a path may raise:
2401 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
2402 /// node public key) is specified.
2403 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
2404 /// (including due to previous monitor update failure or new permanent monitor update
2406 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
2407 /// relevant updates.
2409 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
2410 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
2411 /// different route unless you intend to pay twice!
2413 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
2414 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
2415 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
2416 /// must not contain multiple paths as multi-path payments require a recipient-provided
2419 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
2420 /// bit set (either as required or as available). If multiple paths are present in the Route,
2421 /// we assume the invoice had the basic_mpp feature set.
2423 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2424 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
2425 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2426 let best_block_height = self.best_block.read().unwrap().height();
2427 self.pending_outbound_payments
2428 .send_payment_with_route(route, payment_hash, payment_secret, payment_id, &self.keys_manager, best_block_height,
2429 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2430 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2434 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> {
2435 let best_block_height = self.best_block.read().unwrap().height();
2436 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, payment_secret, keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.keys_manager, best_block_height,
2437 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2438 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2442 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> {
2443 let best_block_height = self.best_block.read().unwrap().height();
2444 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, payment_secret, payment_id, route, &self.keys_manager, best_block_height)
2448 /// Retries a payment along the given [`Route`].
2450 /// Errors returned are a superset of those returned from [`send_payment`], so see
2451 /// [`send_payment`] documentation for more details on errors. This method will also error if the
2452 /// retry amount puts the payment more than 10% over the payment's total amount, if the payment
2453 /// for the given `payment_id` cannot be found (likely due to timeout or success), or if
2454 /// further retries have been disabled with [`abandon_payment`].
2456 /// [`send_payment`]: [`ChannelManager::send_payment`]
2457 /// [`abandon_payment`]: [`ChannelManager::abandon_payment`]
2458 pub fn retry_payment(&self, route: &Route, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2459 let best_block_height = self.best_block.read().unwrap().height();
2460 self.pending_outbound_payments.retry_payment_with_route(route, payment_id, &self.keys_manager, best_block_height,
2461 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2462 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2465 /// Signals that no further retries for the given payment will occur.
2467 /// After this method returns, no future calls to [`retry_payment`] for the given `payment_id`
2468 /// are allowed. If no [`Event::PaymentFailed`] event had been generated before, one will be
2469 /// generated as soon as there are no remaining pending HTLCs for this payment.
2471 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
2472 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
2473 /// determine the ultimate status of a payment.
2475 /// If an [`Event::PaymentFailed`] event is generated and we restart without this
2476 /// [`ChannelManager`] having been persisted, the payment may still be in the pending state
2477 /// upon restart. This allows further calls to [`retry_payment`] (and requiring a second call
2478 /// to [`abandon_payment`] to mark the payment as failed again). Otherwise, future calls to
2479 /// [`retry_payment`] will fail with [`PaymentSendFailure::ParameterError`].
2481 /// [`abandon_payment`]: Self::abandon_payment
2482 /// [`retry_payment`]: Self::retry_payment
2483 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
2484 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2485 pub fn abandon_payment(&self, payment_id: PaymentId) {
2486 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2487 if let Some(payment_failed_ev) = self.pending_outbound_payments.abandon_payment(payment_id) {
2488 self.pending_events.lock().unwrap().push(payment_failed_ev);
2492 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
2493 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
2494 /// the preimage, it must be a cryptographically secure random value that no intermediate node
2495 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
2496 /// never reach the recipient.
2498 /// See [`send_payment`] documentation for more details on the return value of this function
2499 /// and idempotency guarantees provided by the [`PaymentId`] key.
2501 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
2502 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
2504 /// Note that `route` must have exactly one path.
2506 /// [`send_payment`]: Self::send_payment
2507 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
2508 let best_block_height = self.best_block.read().unwrap().height();
2509 self.pending_outbound_payments.send_spontaneous_payment(route, payment_preimage, payment_id, &self.keys_manager, best_block_height,
2510 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2511 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2514 /// Send a payment that is probing the given route for liquidity. We calculate the
2515 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
2516 /// us to easily discern them from real payments.
2517 pub fn send_probe(&self, hops: Vec<RouteHop>) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
2518 let best_block_height = self.best_block.read().unwrap().height();
2519 self.pending_outbound_payments.send_probe(hops, self.probing_cookie_secret, &self.keys_manager, best_block_height,
2520 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2521 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2524 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
2527 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
2528 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
2531 /// Handles the generation of a funding transaction, optionally (for tests) with a function
2532 /// which checks the correctness of the funding transaction given the associated channel.
2533 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<<K::Target as SignerProvider>::Signer>, &Transaction) -> Result<OutPoint, APIError>>(
2534 &self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
2535 ) -> Result<(), APIError> {
2538 let per_peer_state = self.per_peer_state.read().unwrap();
2539 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
2540 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2541 let peer_state = &mut *peer_state_lock;
2542 match peer_state.channel_by_id.remove(temporary_channel_id) {
2544 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
2546 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
2547 .map_err(|e| if let ChannelError::Close(msg) = e {
2548 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.get_user_id(), chan.force_shutdown(true), None)
2549 } else { unreachable!(); })
2552 None => { return Err(APIError::ChannelUnavailable { err: "No such channel".to_owned() }) },
2555 return Err(APIError::APIMisuseError { err: format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", counterparty_node_id) })
2558 match handle_error!(self, res, chan.get_counterparty_node_id()) {
2559 Ok(funding_msg) => {
2562 Err(_) => { return Err(APIError::ChannelUnavailable {
2563 err: "Error deriving keys or signing initial commitment transactions - either our RNG or our counterparty's RNG is broken or the Signer refused to sign".to_owned()
2568 let mut channel_state = self.channel_state.lock().unwrap();
2569 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
2570 node_id: chan.get_counterparty_node_id(),
2573 mem::drop(channel_state);
2574 let per_peer_state = self.per_peer_state.read().unwrap();
2575 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
2576 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2577 let peer_state = &mut *peer_state_lock;
2578 match peer_state.channel_by_id.entry(chan.channel_id()) {
2579 hash_map::Entry::Occupied(_) => {
2580 panic!("Generated duplicate funding txid?");
2582 hash_map::Entry::Vacant(e) => {
2583 let mut id_to_peer = self.id_to_peer.lock().unwrap();
2584 if id_to_peer.insert(chan.channel_id(), chan.get_counterparty_node_id()).is_some() {
2585 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
2590 } else { return Err(APIError::ChannelUnavailable { err: format!("Peer with counterparty_node_id {} disconnected and closed the channel", counterparty_node_id) }) }
2595 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> {
2596 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
2597 Ok(OutPoint { txid: tx.txid(), index: output_index })
2601 /// Call this upon creation of a funding transaction for the given channel.
2603 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
2604 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
2606 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
2607 /// across the p2p network.
2609 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
2610 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
2612 /// May panic if the output found in the funding transaction is duplicative with some other
2613 /// channel (note that this should be trivially prevented by using unique funding transaction
2614 /// keys per-channel).
2616 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
2617 /// counterparty's signature the funding transaction will automatically be broadcast via the
2618 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
2620 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
2621 /// not currently support replacing a funding transaction on an existing channel. Instead,
2622 /// create a new channel with a conflicting funding transaction.
2624 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
2625 /// the wallet software generating the funding transaction to apply anti-fee sniping as
2626 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
2627 /// for more details.
2629 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
2630 /// [`Event::ChannelClosed`]: crate::util::events::Event::ChannelClosed
2631 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
2632 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2634 for inp in funding_transaction.input.iter() {
2635 if inp.witness.is_empty() {
2636 return Err(APIError::APIMisuseError {
2637 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
2642 let height = self.best_block.read().unwrap().height();
2643 // Transactions are evaluated as final by network mempools at the next block. However, the modules
2644 // constituting our Lightning node might not have perfect sync about their blockchain views. Thus, if
2645 // the wallet module is in advance on the LDK view, allow one more block of headroom.
2646 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 {
2647 return Err(APIError::APIMisuseError {
2648 err: "Funding transaction absolute timelock is non-final".to_owned()
2652 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
2653 let mut output_index = None;
2654 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
2655 for (idx, outp) in tx.output.iter().enumerate() {
2656 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
2657 if output_index.is_some() {
2658 return Err(APIError::APIMisuseError {
2659 err: "Multiple outputs matched the expected script and value".to_owned()
2662 if idx > u16::max_value() as usize {
2663 return Err(APIError::APIMisuseError {
2664 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
2667 output_index = Some(idx as u16);
2670 if output_index.is_none() {
2671 return Err(APIError::APIMisuseError {
2672 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
2675 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
2679 /// Atomically updates the [`ChannelConfig`] for the given channels.
2681 /// Once the updates are applied, each eligible channel (advertised with a known short channel
2682 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
2683 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
2684 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
2686 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
2687 /// `counterparty_node_id` is provided.
2689 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
2690 /// below [`MIN_CLTV_EXPIRY_DELTA`].
2692 /// If an error is returned, none of the updates should be considered applied.
2694 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
2695 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
2696 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
2697 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
2698 /// [`ChannelUpdate`]: msgs::ChannelUpdate
2699 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
2700 /// [`APIMisuseError`]: APIError::APIMisuseError
2701 pub fn update_channel_config(
2702 &self, counterparty_node_id: &PublicKey, channel_ids: &[[u8; 32]], config: &ChannelConfig,
2703 ) -> Result<(), APIError> {
2704 if config.cltv_expiry_delta < MIN_CLTV_EXPIRY_DELTA {
2705 return Err(APIError::APIMisuseError {
2706 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
2710 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(
2711 &self.total_consistency_lock, &self.persistence_notifier,
2714 let mut channel_state_lock = self.channel_state.lock().unwrap();
2715 let channel_state = &mut *channel_state_lock;
2716 let per_peer_state = self.per_peer_state.read().unwrap();
2717 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
2718 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2719 let peer_state = &mut *peer_state_lock;
2720 for channel_id in channel_ids {
2721 if !peer_state.channel_by_id.contains_key(channel_id) {
2722 return Err(APIError::ChannelUnavailable {
2723 err: format!("Channel with ID {} was not found", log_bytes!(*channel_id)),
2727 for channel_id in channel_ids {
2728 let channel = peer_state.channel_by_id.get_mut(channel_id).unwrap();
2729 if !channel.update_config(config) {
2732 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
2733 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
2734 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
2735 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
2736 node_id: channel.get_counterparty_node_id(),
2742 return Err(APIError::APIMisuseError{ err: format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", counterparty_node_id) });
2748 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
2749 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
2751 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
2752 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
2754 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
2755 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
2756 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
2757 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
2758 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
2760 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
2761 /// you from forwarding more than you received.
2763 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
2766 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
2767 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
2768 // TODO: when we move to deciding the best outbound channel at forward time, only take
2769 // `next_node_id` and not `next_hop_channel_id`
2770 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> {
2771 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2773 let next_hop_scid = {
2774 let peer_state_lock = self.per_peer_state.read().unwrap();
2775 if let Some(peer_state_mutex) = peer_state_lock.get(&next_node_id) {
2776 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2777 let peer_state = &mut *peer_state_lock;
2778 match peer_state.channel_by_id.get(next_hop_channel_id) {
2780 if !chan.is_usable() {
2781 return Err(APIError::ChannelUnavailable {
2782 err: format!("Channel with id {} not fully established", log_bytes!(*next_hop_channel_id))
2785 chan.get_short_channel_id().unwrap_or(chan.outbound_scid_alias())
2787 None => return Err(APIError::ChannelUnavailable {
2788 err: format!("Channel with id {} not found", log_bytes!(*next_hop_channel_id))
2792 return Err(APIError::APIMisuseError{ err: format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", next_node_id) });
2796 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
2797 .ok_or_else(|| APIError::APIMisuseError {
2798 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
2801 let routing = match payment.forward_info.routing {
2802 PendingHTLCRouting::Forward { onion_packet, .. } => {
2803 PendingHTLCRouting::Forward { onion_packet, short_channel_id: next_hop_scid }
2805 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
2807 let pending_htlc_info = PendingHTLCInfo {
2808 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
2811 let mut per_source_pending_forward = [(
2812 payment.prev_short_channel_id,
2813 payment.prev_funding_outpoint,
2814 payment.prev_user_channel_id,
2815 vec![(pending_htlc_info, payment.prev_htlc_id)]
2817 self.forward_htlcs(&mut per_source_pending_forward);
2821 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
2822 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
2824 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
2827 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
2828 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
2829 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2831 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
2832 .ok_or_else(|| APIError::APIMisuseError {
2833 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
2836 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
2837 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2838 short_channel_id: payment.prev_short_channel_id,
2839 outpoint: payment.prev_funding_outpoint,
2840 htlc_id: payment.prev_htlc_id,
2841 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
2842 phantom_shared_secret: None,
2845 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
2846 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
2847 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
2848 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
2853 /// Processes HTLCs which are pending waiting on random forward delay.
2855 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
2856 /// Will likely generate further events.
2857 pub fn process_pending_htlc_forwards(&self) {
2858 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2860 let mut new_events = Vec::new();
2861 let mut failed_forwards = Vec::new();
2862 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
2864 let mut forward_htlcs = HashMap::new();
2865 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
2867 for (short_chan_id, mut pending_forwards) in forward_htlcs {
2868 if short_chan_id != 0 {
2869 macro_rules! forwarding_channel_not_found {
2871 for forward_info in pending_forwards.drain(..) {
2872 match forward_info {
2873 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
2874 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
2875 forward_info: PendingHTLCInfo {
2876 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
2877 outgoing_cltv_value, incoming_amt_msat: _
2880 macro_rules! failure_handler {
2881 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
2882 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2884 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2885 short_channel_id: prev_short_channel_id,
2886 outpoint: prev_funding_outpoint,
2887 htlc_id: prev_htlc_id,
2888 incoming_packet_shared_secret: incoming_shared_secret,
2889 phantom_shared_secret: $phantom_ss,
2892 let reason = if $next_hop_unknown {
2893 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
2895 HTLCDestination::FailedPayment{ payment_hash }
2898 failed_forwards.push((htlc_source, payment_hash,
2899 HTLCFailReason::reason($err_code, $err_data),
2905 macro_rules! fail_forward {
2906 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
2908 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
2912 macro_rules! failed_payment {
2913 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
2915 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
2919 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
2920 let phantom_secret_res = self.keys_manager.get_node_secret(Recipient::PhantomNode);
2921 if phantom_secret_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.genesis_hash) {
2922 let phantom_shared_secret = SharedSecret::new(&onion_packet.public_key.unwrap(), &phantom_secret_res.unwrap()).secret_bytes();
2923 let next_hop = match onion_utils::decode_next_payment_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
2925 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2926 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
2927 // In this scenario, the phantom would have sent us an
2928 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
2929 // if it came from us (the second-to-last hop) but contains the sha256
2931 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
2933 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2934 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
2938 onion_utils::Hop::Receive(hop_data) => {
2939 match self.construct_recv_pending_htlc_info(hop_data, incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value, Some(phantom_shared_secret)) {
2940 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
2941 Err(ReceiveError { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
2947 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
2950 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
2953 HTLCForwardInfo::FailHTLC { .. } => {
2954 // Channel went away before we could fail it. This implies
2955 // the channel is now on chain and our counterparty is
2956 // trying to broadcast the HTLC-Timeout, but that's their
2957 // problem, not ours.
2963 let (counterparty_node_id, forward_chan_id) = match self.short_to_chan_info.read().unwrap().get(&short_chan_id) {
2964 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
2966 forwarding_channel_not_found!();
2970 let per_peer_state = self.per_peer_state.read().unwrap();
2971 if let None = per_peer_state.get(&counterparty_node_id) {
2972 forwarding_channel_not_found!();
2975 let peer_state_mutex = per_peer_state.get(&counterparty_node_id).unwrap();
2976 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2977 let peer_state = &mut *peer_state_lock;
2978 match peer_state.channel_by_id.entry(forward_chan_id) {
2979 hash_map::Entry::Vacant(_) => {
2980 forwarding_channel_not_found!();
2983 hash_map::Entry::Occupied(mut chan) => {
2984 for forward_info in pending_forwards.drain(..) {
2985 match forward_info {
2986 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
2987 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id: _,
2988 forward_info: PendingHTLCInfo {
2989 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
2990 routing: PendingHTLCRouting::Forward { onion_packet, .. }, incoming_amt_msat: _,
2993 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);
2994 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2995 short_channel_id: prev_short_channel_id,
2996 outpoint: prev_funding_outpoint,
2997 htlc_id: prev_htlc_id,
2998 incoming_packet_shared_secret: incoming_shared_secret,
2999 // Phantom payments are only PendingHTLCRouting::Receive.
3000 phantom_shared_secret: None,
3002 if let Err(e) = chan.get_mut().queue_add_htlc(outgoing_amt_msat,
3003 payment_hash, outgoing_cltv_value, htlc_source.clone(),
3004 onion_packet, &self.logger)
3006 if let ChannelError::Ignore(msg) = e {
3007 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
3009 panic!("Stated return value requirements in send_htlc() were not met");
3011 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan.get());
3012 failed_forwards.push((htlc_source, payment_hash,
3013 HTLCFailReason::reason(failure_code, data),
3014 HTLCDestination::NextHopChannel { node_id: Some(chan.get().get_counterparty_node_id()), channel_id: forward_chan_id }
3019 HTLCForwardInfo::AddHTLC { .. } => {
3020 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
3022 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
3023 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
3024 if let Err(e) = chan.get_mut().queue_fail_htlc(
3025 htlc_id, err_packet, &self.logger
3027 if let ChannelError::Ignore(msg) = e {
3028 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
3030 panic!("Stated return value requirements in queue_fail_htlc() were not met");
3032 // fail-backs are best-effort, we probably already have one
3033 // pending, and if not that's OK, if not, the channel is on
3034 // the chain and sending the HTLC-Timeout is their problem.
3043 for forward_info in pending_forwards.drain(..) {
3044 match forward_info {
3045 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3046 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3047 forward_info: PendingHTLCInfo {
3048 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat, ..
3051 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret) = match routing {
3052 PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry, phantom_shared_secret } => {
3053 let _legacy_hop_data = Some(payment_data.clone());
3054 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data }, Some(payment_data), phantom_shared_secret)
3056 PendingHTLCRouting::ReceiveKeysend { payment_preimage, incoming_cltv_expiry } =>
3057 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage), None, None),
3059 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
3062 let claimable_htlc = ClaimableHTLC {
3063 prev_hop: HTLCPreviousHopData {
3064 short_channel_id: prev_short_channel_id,
3065 outpoint: prev_funding_outpoint,
3066 htlc_id: prev_htlc_id,
3067 incoming_packet_shared_secret: incoming_shared_secret,
3068 phantom_shared_secret,
3070 value: outgoing_amt_msat,
3072 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
3077 macro_rules! fail_htlc {
3078 ($htlc: expr, $payment_hash: expr) => {
3079 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
3080 htlc_msat_height_data.extend_from_slice(
3081 &self.best_block.read().unwrap().height().to_be_bytes(),
3083 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
3084 short_channel_id: $htlc.prev_hop.short_channel_id,
3085 outpoint: prev_funding_outpoint,
3086 htlc_id: $htlc.prev_hop.htlc_id,
3087 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
3088 phantom_shared_secret,
3090 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
3091 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
3095 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
3096 let mut receiver_node_id = self.our_network_pubkey;
3097 if phantom_shared_secret.is_some() {
3098 receiver_node_id = self.keys_manager.get_node_id(Recipient::PhantomNode)
3099 .expect("Failed to get node_id for phantom node recipient");
3102 macro_rules! check_total_value {
3103 ($payment_data: expr, $payment_preimage: expr) => {{
3104 let mut payment_claimable_generated = false;
3106 events::PaymentPurpose::InvoicePayment {
3107 payment_preimage: $payment_preimage,
3108 payment_secret: $payment_data.payment_secret,
3111 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3112 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
3113 fail_htlc!(claimable_htlc, payment_hash);
3116 let (_, htlcs) = claimable_payments.claimable_htlcs.entry(payment_hash)
3117 .or_insert_with(|| (purpose(), Vec::new()));
3118 if htlcs.len() == 1 {
3119 if let OnionPayload::Spontaneous(_) = htlcs[0].onion_payload {
3120 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));
3121 fail_htlc!(claimable_htlc, payment_hash);
3125 let mut total_value = claimable_htlc.value;
3126 for htlc in htlcs.iter() {
3127 total_value += htlc.value;
3128 match &htlc.onion_payload {
3129 OnionPayload::Invoice { .. } => {
3130 if htlc.total_msat != $payment_data.total_msat {
3131 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
3132 log_bytes!(payment_hash.0), $payment_data.total_msat, htlc.total_msat);
3133 total_value = msgs::MAX_VALUE_MSAT;
3135 if total_value >= msgs::MAX_VALUE_MSAT { break; }
3137 _ => unreachable!(),
3140 if total_value >= msgs::MAX_VALUE_MSAT || total_value > $payment_data.total_msat {
3141 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
3142 log_bytes!(payment_hash.0), total_value, $payment_data.total_msat);
3143 fail_htlc!(claimable_htlc, payment_hash);
3144 } else if total_value == $payment_data.total_msat {
3145 let prev_channel_id = prev_funding_outpoint.to_channel_id();
3146 htlcs.push(claimable_htlc);
3147 new_events.push(events::Event::PaymentClaimable {
3148 receiver_node_id: Some(receiver_node_id),
3151 amount_msat: total_value,
3152 via_channel_id: Some(prev_channel_id),
3153 via_user_channel_id: Some(prev_user_channel_id),
3155 payment_claimable_generated = true;
3157 // Nothing to do - we haven't reached the total
3158 // payment value yet, wait until we receive more
3160 htlcs.push(claimable_htlc);
3162 payment_claimable_generated
3166 // Check that the payment hash and secret are known. Note that we
3167 // MUST take care to handle the "unknown payment hash" and
3168 // "incorrect payment secret" cases here identically or we'd expose
3169 // that we are the ultimate recipient of the given payment hash.
3170 // Further, we must not expose whether we have any other HTLCs
3171 // associated with the same payment_hash pending or not.
3172 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
3173 match payment_secrets.entry(payment_hash) {
3174 hash_map::Entry::Vacant(_) => {
3175 match claimable_htlc.onion_payload {
3176 OnionPayload::Invoice { .. } => {
3177 let payment_data = payment_data.unwrap();
3178 let payment_preimage = match inbound_payment::verify(payment_hash, &payment_data, self.highest_seen_timestamp.load(Ordering::Acquire) as u64, &self.inbound_payment_key, &self.logger) {
3179 Ok(payment_preimage) => payment_preimage,
3181 fail_htlc!(claimable_htlc, payment_hash);
3185 check_total_value!(payment_data, payment_preimage);
3187 OnionPayload::Spontaneous(preimage) => {
3188 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3189 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
3190 fail_htlc!(claimable_htlc, payment_hash);
3193 match claimable_payments.claimable_htlcs.entry(payment_hash) {
3194 hash_map::Entry::Vacant(e) => {
3195 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
3196 e.insert((purpose.clone(), vec![claimable_htlc]));
3197 let prev_channel_id = prev_funding_outpoint.to_channel_id();
3198 new_events.push(events::Event::PaymentClaimable {
3199 receiver_node_id: Some(receiver_node_id),
3201 amount_msat: outgoing_amt_msat,
3203 via_channel_id: Some(prev_channel_id),
3204 via_user_channel_id: Some(prev_user_channel_id),
3207 hash_map::Entry::Occupied(_) => {
3208 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
3209 fail_htlc!(claimable_htlc, payment_hash);
3215 hash_map::Entry::Occupied(inbound_payment) => {
3216 if payment_data.is_none() {
3217 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));
3218 fail_htlc!(claimable_htlc, payment_hash);
3221 let payment_data = payment_data.unwrap();
3222 if inbound_payment.get().payment_secret != payment_data.payment_secret {
3223 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
3224 fail_htlc!(claimable_htlc, payment_hash);
3225 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
3226 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
3227 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
3228 fail_htlc!(claimable_htlc, payment_hash);
3230 let payment_claimable_generated = check_total_value!(payment_data, inbound_payment.get().payment_preimage);
3231 if payment_claimable_generated {
3232 inbound_payment.remove_entry();
3238 HTLCForwardInfo::FailHTLC { .. } => {
3239 panic!("Got pending fail of our own HTLC");
3247 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
3248 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
3250 self.forward_htlcs(&mut phantom_receives);
3252 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
3253 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
3254 // nice to do the work now if we can rather than while we're trying to get messages in the
3256 self.check_free_holding_cells();
3258 if new_events.is_empty() { return }
3259 let mut events = self.pending_events.lock().unwrap();
3260 events.append(&mut new_events);
3263 /// Free the background events, generally called from timer_tick_occurred.
3265 /// Exposed for testing to allow us to process events quickly without generating accidental
3266 /// BroadcastChannelUpdate events in timer_tick_occurred.
3268 /// Expects the caller to have a total_consistency_lock read lock.
3269 fn process_background_events(&self) -> bool {
3270 let mut background_events = Vec::new();
3271 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
3272 if background_events.is_empty() {
3276 for event in background_events.drain(..) {
3278 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
3279 // The channel has already been closed, so no use bothering to care about the
3280 // monitor updating completing.
3281 let _ = self.chain_monitor.update_channel(funding_txo, update);
3288 #[cfg(any(test, feature = "_test_utils"))]
3289 /// Process background events, for functional testing
3290 pub fn test_process_background_events(&self) {
3291 self.process_background_events();
3294 fn update_channel_fee(&self, chan_id: &[u8; 32], chan: &mut Channel<<K::Target as SignerProvider>::Signer>, new_feerate: u32) -> NotifyOption {
3295 if !chan.is_outbound() { return NotifyOption::SkipPersist; }
3296 // If the feerate has decreased by less than half, don't bother
3297 if new_feerate <= chan.get_feerate() && new_feerate * 2 > chan.get_feerate() {
3298 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
3299 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3300 return NotifyOption::SkipPersist;
3302 if !chan.is_live() {
3303 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).",
3304 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3305 return NotifyOption::SkipPersist;
3307 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
3308 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3310 chan.queue_update_fee(new_feerate, &self.logger);
3311 NotifyOption::DoPersist
3315 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
3316 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
3317 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
3318 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
3319 pub fn maybe_update_chan_fees(&self) {
3320 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3321 let mut should_persist = NotifyOption::SkipPersist;
3323 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3325 let per_peer_state = self.per_peer_state.read().unwrap();
3326 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
3327 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3328 let peer_state = &mut *peer_state_lock;
3329 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
3330 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
3331 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3339 /// Performs actions which should happen on startup and roughly once per minute thereafter.
3341 /// This currently includes:
3342 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
3343 /// * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
3344 /// than a minute, informing the network that they should no longer attempt to route over
3346 /// * Expiring a channel's previous `ChannelConfig` if necessary to only allow forwarding HTLCs
3347 /// with the current `ChannelConfig`.
3349 /// Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
3350 /// estimate fetches.
3351 pub fn timer_tick_occurred(&self) {
3352 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3353 let mut should_persist = NotifyOption::SkipPersist;
3354 if self.process_background_events() { should_persist = NotifyOption::DoPersist; }
3356 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3358 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
3359 let mut timed_out_mpp_htlcs = Vec::new();
3361 let mut channel_state_lock = self.channel_state.lock().unwrap();
3362 let channel_state = &mut *channel_state_lock;
3363 let pending_msg_events = &mut channel_state.pending_msg_events;
3364 let per_peer_state = self.per_peer_state.read().unwrap();
3365 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
3366 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3367 let peer_state = &mut *peer_state_lock;
3368 peer_state.channel_by_id.retain(|chan_id, chan| {
3369 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
3370 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3372 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
3373 let (needs_close, err) = convert_chan_err!(self, e, chan, chan_id);
3374 handle_errors.push((Err(err), *counterparty_node_id));
3375 if needs_close { return false; }
3378 match chan.channel_update_status() {
3379 ChannelUpdateStatus::Enabled if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged),
3380 ChannelUpdateStatus::Disabled if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged),
3381 ChannelUpdateStatus::DisabledStaged if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
3382 ChannelUpdateStatus::EnabledStaged if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
3383 ChannelUpdateStatus::DisabledStaged if !chan.is_live() => {
3384 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3385 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3389 should_persist = NotifyOption::DoPersist;
3390 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
3392 ChannelUpdateStatus::EnabledStaged if chan.is_live() => {
3393 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3394 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3398 should_persist = NotifyOption::DoPersist;
3399 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
3404 chan.maybe_expire_prev_config();
3411 self.claimable_payments.lock().unwrap().claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
3412 if htlcs.is_empty() {
3413 // This should be unreachable
3414 debug_assert!(false);
3417 if let OnionPayload::Invoice { .. } = htlcs[0].onion_payload {
3418 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
3419 // In this case we're not going to handle any timeouts of the parts here.
3420 if htlcs[0].total_msat == htlcs.iter().fold(0, |total, htlc| total + htlc.value) {
3422 } else if htlcs.into_iter().any(|htlc| {
3423 htlc.timer_ticks += 1;
3424 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
3426 timed_out_mpp_htlcs.extend(htlcs.drain(..).map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
3433 for htlc_source in timed_out_mpp_htlcs.drain(..) {
3434 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
3435 let reason = HTLCFailReason::from_failure_code(23);
3436 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
3437 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
3440 for (err, counterparty_node_id) in handle_errors.drain(..) {
3441 let _ = handle_error!(self, err, counterparty_node_id);
3444 self.pending_outbound_payments.remove_stale_resolved_payments(&self.pending_events);
3446 // Technically we don't need to do this here, but if we have holding cell entries in a
3447 // channel that need freeing, it's better to do that here and block a background task
3448 // than block the message queueing pipeline.
3449 if self.check_free_holding_cells() {
3450 should_persist = NotifyOption::DoPersist;
3457 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
3458 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
3459 /// along the path (including in our own channel on which we received it).
3461 /// Note that in some cases around unclean shutdown, it is possible the payment may have
3462 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
3463 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
3464 /// may have already been failed automatically by LDK if it was nearing its expiration time.
3466 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
3467 /// [`ChannelManager::claim_funds`]), you should still monitor for
3468 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
3469 /// startup during which time claims that were in-progress at shutdown may be replayed.
3470 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
3471 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3473 let removed_source = self.claimable_payments.lock().unwrap().claimable_htlcs.remove(payment_hash);
3474 if let Some((_, mut sources)) = removed_source {
3475 for htlc in sources.drain(..) {
3476 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
3477 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
3478 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
3479 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
3480 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
3481 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
3486 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3487 /// that we want to return and a channel.
3489 /// This is for failures on the channel on which the HTLC was *received*, not failures
3491 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<<K::Target as SignerProvider>::Signer>) -> (u16, Vec<u8>) {
3492 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
3493 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
3494 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
3495 // an inbound SCID alias before the real SCID.
3496 let scid_pref = if chan.should_announce() {
3497 chan.get_short_channel_id().or(chan.latest_inbound_scid_alias())
3499 chan.latest_inbound_scid_alias().or(chan.get_short_channel_id())
3501 if let Some(scid) = scid_pref {
3502 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
3504 (0x4000|10, Vec::new())
3509 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3510 /// that we want to return and a channel.
3511 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<<K::Target as SignerProvider>::Signer>) -> (u16, Vec<u8>) {
3512 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
3513 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
3514 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
3515 if desired_err_code == 0x1000 | 20 {
3516 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
3517 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
3518 0u16.write(&mut enc).expect("Writes cannot fail");
3520 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
3521 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
3522 upd.write(&mut enc).expect("Writes cannot fail");
3523 (desired_err_code, enc.0)
3525 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
3526 // which means we really shouldn't have gotten a payment to be forwarded over this
3527 // channel yet, or if we did it's from a route hint. Either way, returning an error of
3528 // PERM|no_such_channel should be fine.
3529 (0x4000|10, Vec::new())
3533 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
3534 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
3535 // be surfaced to the user.
3536 fn fail_holding_cell_htlcs(
3537 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32],
3538 counterparty_node_id: &PublicKey
3540 let (failure_code, onion_failure_data) = {
3541 let per_peer_state = self.per_peer_state.read().unwrap();
3542 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
3543 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3544 let peer_state = &mut *peer_state_lock;
3545 match peer_state.channel_by_id.entry(channel_id) {
3546 hash_map::Entry::Occupied(chan_entry) => {
3547 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan_entry.get())
3549 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
3551 } else { (0x4000|10, Vec::new()) }
3554 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
3555 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
3556 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
3557 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
3561 /// Fails an HTLC backwards to the sender of it to us.
3562 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
3563 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
3564 #[cfg(debug_assertions)]
3566 // Ensure that the `channel_state` and no peer state channel storage lock is not held
3567 // when calling this function.
3568 // This ensures that future code doesn't introduce a lock_order requirement for
3569 // `forward_htlcs` to be locked after the `channel_state` and `per_peer_state` locks,
3570 // which calling this function with the locks aquired would.
3571 assert!(self.channel_state.try_lock().is_ok());
3572 assert!(self.per_peer_state.try_write().is_ok());
3575 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
3576 //identify whether we sent it or not based on the (I presume) very different runtime
3577 //between the branches here. We should make this async and move it into the forward HTLCs
3580 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3581 // from block_connected which may run during initialization prior to the chain_monitor
3582 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
3584 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, ref payment_params, .. } => {
3585 self.pending_outbound_payments.fail_htlc(source, payment_hash, onion_error, path, session_priv, payment_id, payment_params, self.probing_cookie_secret, &self.secp_ctx, &self.pending_events, &self.logger);
3587 HTLCSource::PreviousHopData(HTLCPreviousHopData { ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret, ref phantom_shared_secret, ref outpoint }) => {
3588 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with {:?}", log_bytes!(payment_hash.0), onion_error);
3589 let err_packet = onion_error.get_encrypted_failure_packet(incoming_packet_shared_secret, phantom_shared_secret);
3591 let mut forward_event = None;
3592 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
3593 if forward_htlcs.is_empty() {
3594 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
3596 match forward_htlcs.entry(*short_channel_id) {
3597 hash_map::Entry::Occupied(mut entry) => {
3598 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet });
3600 hash_map::Entry::Vacant(entry) => {
3601 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }));
3604 mem::drop(forward_htlcs);
3605 let mut pending_events = self.pending_events.lock().unwrap();
3606 if let Some(time) = forward_event {
3607 pending_events.push(events::Event::PendingHTLCsForwardable {
3608 time_forwardable: time
3611 pending_events.push(events::Event::HTLCHandlingFailed {
3612 prev_channel_id: outpoint.to_channel_id(),
3613 failed_next_destination: destination,
3619 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
3620 /// [`MessageSendEvent`]s needed to claim the payment.
3622 /// Note that calling this method does *not* guarantee that the payment has been claimed. You
3623 /// *must* wait for an [`Event::PaymentClaimed`] event which upon a successful claim will be
3624 /// provided to your [`EventHandler`] when [`process_pending_events`] is next called.
3626 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
3627 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
3628 /// event matches your expectation. If you fail to do so and call this method, you may provide
3629 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
3631 /// [`Event::PaymentClaimable`]: crate::util::events::Event::PaymentClaimable
3632 /// [`Event::PaymentClaimed`]: crate::util::events::Event::PaymentClaimed
3633 /// [`process_pending_events`]: EventsProvider::process_pending_events
3634 /// [`create_inbound_payment`]: Self::create_inbound_payment
3635 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
3636 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
3637 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
3639 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3642 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3643 if let Some((payment_purpose, sources)) = claimable_payments.claimable_htlcs.remove(&payment_hash) {
3644 let mut receiver_node_id = self.our_network_pubkey;
3645 for htlc in sources.iter() {
3646 if htlc.prev_hop.phantom_shared_secret.is_some() {
3647 let phantom_pubkey = self.keys_manager.get_node_id(Recipient::PhantomNode)
3648 .expect("Failed to get node_id for phantom node recipient");
3649 receiver_node_id = phantom_pubkey;
3654 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
3655 ClaimingPayment { amount_msat: sources.iter().map(|source| source.value).sum(),
3656 payment_purpose, receiver_node_id,
3658 if dup_purpose.is_some() {
3659 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
3660 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
3661 log_bytes!(payment_hash.0));
3666 debug_assert!(!sources.is_empty());
3668 // If we are claiming an MPP payment, we check that all channels which contain a claimable
3669 // HTLC still exist. While this isn't guaranteed to remain true if a channel closes while
3670 // we're claiming (or even after we claim, before the commitment update dance completes),
3671 // it should be a relatively rare race, and we'd rather not claim HTLCs that require us to
3672 // go on-chain (and lose the on-chain fee to do so) than just reject the payment.
3674 // Note that we'll still always get our funds - as long as the generated
3675 // `ChannelMonitorUpdate` makes it out to the relevant monitor we can claim on-chain.
3677 // If we find an HTLC which we would need to claim but for which we do not have a
3678 // channel, we will fail all parts of the MPP payment. While we could wait and see if
3679 // the sender retries the already-failed path(s), it should be a pretty rare case where
3680 // we got all the HTLCs and then a channel closed while we were waiting for the user to
3681 // provide the preimage, so worrying too much about the optimal handling isn't worth
3683 let mut claimable_amt_msat = 0;
3684 let mut expected_amt_msat = None;
3685 let mut valid_mpp = true;
3686 let mut errs = Vec::new();
3687 let mut channel_state = Some(self.channel_state.lock().unwrap());
3688 let mut per_peer_state = Some(self.per_peer_state.read().unwrap());
3689 for htlc in sources.iter() {
3690 let (counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&htlc.prev_hop.short_channel_id) {
3691 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3698 if let None = per_peer_state.as_ref().unwrap().get(&counterparty_node_id) {
3703 let peer_state_mutex = per_peer_state.as_ref().unwrap().get(&counterparty_node_id).unwrap();
3704 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3705 let peer_state = &mut *peer_state_lock;
3707 if let None = peer_state.channel_by_id.get(&chan_id) {
3712 if expected_amt_msat.is_some() && expected_amt_msat != Some(htlc.total_msat) {
3713 log_error!(self.logger, "Somehow ended up with an MPP payment with different total amounts - this should not be reachable!");
3714 debug_assert!(false);
3719 expected_amt_msat = Some(htlc.total_msat);
3720 if let OnionPayload::Spontaneous(_) = &htlc.onion_payload {
3721 // We don't currently support MPP for spontaneous payments, so just check
3722 // that there's one payment here and move on.
3723 if sources.len() != 1 {
3724 log_error!(self.logger, "Somehow ended up with an MPP spontaneous payment - this should not be reachable!");
3725 debug_assert!(false);
3731 claimable_amt_msat += htlc.value;
3733 if sources.is_empty() || expected_amt_msat.is_none() {
3734 mem::drop(channel_state);
3735 mem::drop(per_peer_state);
3736 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
3737 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
3740 if claimable_amt_msat != expected_amt_msat.unwrap() {
3741 mem::drop(channel_state);
3742 mem::drop(per_peer_state);
3743 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
3744 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
3745 expected_amt_msat.unwrap(), claimable_amt_msat);
3749 for htlc in sources.drain(..) {
3750 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
3751 if per_peer_state.is_none() { per_peer_state = Some(self.per_peer_state.read().unwrap()); }
3752 if let Err((pk, err)) = self.claim_funds_from_hop(channel_state.take().unwrap(), per_peer_state.take().unwrap(),
3753 htlc.prev_hop, payment_preimage,
3754 |_| Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash }))
3756 if let msgs::ErrorAction::IgnoreError = err.err.action {
3757 // We got a temporary failure updating monitor, but will claim the
3758 // HTLC when the monitor updating is restored (or on chain).
3759 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
3760 } else { errs.push((pk, err)); }
3764 mem::drop(channel_state);
3765 mem::drop(per_peer_state);
3767 for htlc in sources.drain(..) {
3768 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
3769 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
3770 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
3771 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
3772 let receiver = HTLCDestination::FailedPayment { payment_hash };
3773 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
3775 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
3778 // Now we can handle any errors which were generated.
3779 for (counterparty_node_id, err) in errs.drain(..) {
3780 let res: Result<(), _> = Err(err);
3781 let _ = handle_error!(self, res, counterparty_node_id);
3785 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>) -> Option<MonitorUpdateCompletionAction>>(&self,
3786 mut channel_state_lock: MutexGuard<ChannelHolder>,
3787 per_peer_state_lock: RwLockReadGuard<HashMap<PublicKey, Mutex<PeerState<<K::Target as SignerProvider>::Signer>>>>,
3788 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
3789 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
3790 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
3792 let chan_id = prev_hop.outpoint.to_channel_id();
3793 let channel_state = &mut *channel_state_lock;
3795 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
3796 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
3800 let (found_channel, mut peer_state_opt) = if counterparty_node_id_opt.is_some() && per_peer_state_lock.get(&counterparty_node_id_opt.unwrap()).is_some() {
3801 let peer_mutex = per_peer_state_lock.get(&counterparty_node_id_opt.unwrap()).unwrap();
3802 let peer_state = peer_mutex.lock().unwrap();
3803 let found_channel = peer_state.channel_by_id.contains_key(&chan_id);
3804 (found_channel, Some(peer_state))
3805 } else { (false, None) };
3808 if let hash_map::Entry::Occupied(mut chan) = peer_state_opt.as_mut().unwrap().channel_by_id.entry(chan_id) {
3809 let counterparty_node_id = chan.get().get_counterparty_node_id();
3810 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
3811 Ok(msgs_monitor_option) => {
3812 if let UpdateFulfillCommitFetch::NewClaim { msgs, htlc_value_msat, monitor_update } = msgs_monitor_option {
3813 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3814 ChannelMonitorUpdateStatus::Completed => {},
3816 log_given_level!(self.logger, if e == ChannelMonitorUpdateStatus::PermanentFailure { Level::Error } else { Level::Debug },
3817 "Failed to update channel monitor with preimage {:?}: {:?}",
3818 payment_preimage, e);
3819 let err = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()).unwrap_err();
3820 mem::drop(channel_state_lock);
3821 mem::drop(peer_state_opt);
3822 mem::drop(per_peer_state_lock);
3823 self.handle_monitor_update_completion_actions(completion_action(Some(htlc_value_msat)));
3824 return Err((counterparty_node_id, err));
3827 if let Some((msg, commitment_signed)) = msgs {
3828 log_debug!(self.logger, "Claiming funds for HTLC with preimage {} resulted in a commitment_signed for channel {}",
3829 log_bytes!(payment_preimage.0), log_bytes!(chan.get().channel_id()));
3830 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3831 node_id: chan.get().get_counterparty_node_id(),
3832 updates: msgs::CommitmentUpdate {
3833 update_add_htlcs: Vec::new(),
3834 update_fulfill_htlcs: vec![msg],
3835 update_fail_htlcs: Vec::new(),
3836 update_fail_malformed_htlcs: Vec::new(),
3842 mem::drop(channel_state_lock);
3843 mem::drop(peer_state_opt);
3844 mem::drop(per_peer_state_lock);
3845 self.handle_monitor_update_completion_actions(completion_action(Some(htlc_value_msat)));
3851 Err((e, monitor_update)) => {
3852 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3853 ChannelMonitorUpdateStatus::Completed => {},
3855 // TODO: This needs to be handled somehow - if we receive a monitor update
3856 // with a preimage we *must* somehow manage to propagate it to the upstream
3857 // channel, or we must have an ability to receive the same update and try
3858 // again on restart.
3859 log_given_level!(self.logger, if e == ChannelMonitorUpdateStatus::PermanentFailure { Level::Error } else { Level::Info },
3860 "Failed to update channel monitor with preimage {:?} immediately prior to force-close: {:?}",
3861 payment_preimage, e);
3864 let (drop, res) = convert_chan_err!(self, e, chan.get_mut(), &chan_id);
3866 chan.remove_entry();
3868 mem::drop(channel_state_lock);
3869 mem::drop(peer_state_opt);
3870 mem::drop(per_peer_state_lock);
3871 self.handle_monitor_update_completion_actions(completion_action(None));
3872 Err((counterparty_node_id, res))
3876 // We've held the peer_state mutex since finding the channel and setting
3877 // found_channel to true, so the channel can't have been dropped.
3881 let preimage_update = ChannelMonitorUpdate {
3882 update_id: CLOSED_CHANNEL_UPDATE_ID,
3883 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
3887 // We update the ChannelMonitor on the backward link, after
3888 // receiving an `update_fulfill_htlc` from the forward link.
3889 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, preimage_update);
3890 if update_res != ChannelMonitorUpdateStatus::Completed {
3891 // TODO: This needs to be handled somehow - if we receive a monitor update
3892 // with a preimage we *must* somehow manage to propagate it to the upstream
3893 // channel, or we must have an ability to receive the same event and try
3894 // again on restart.
3895 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
3896 payment_preimage, update_res);
3898 mem::drop(channel_state_lock);
3899 mem::drop(peer_state_opt);
3900 mem::drop(per_peer_state_lock);
3901 // Note that we do process the completion action here. This totally could be a
3902 // duplicate claim, but we have no way of knowing without interrogating the
3903 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
3904 // generally always allowed to be duplicative (and it's specifically noted in
3905 // `PaymentForwarded`).
3906 self.handle_monitor_update_completion_actions(completion_action(None));
3911 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
3912 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
3915 fn claim_funds_internal(&self, channel_state_lock: MutexGuard<ChannelHolder>, source: HTLCSource, payment_preimage: PaymentPreimage, forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, next_channel_id: [u8; 32]) {
3917 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
3918 mem::drop(channel_state_lock);
3919 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage, session_priv, path, from_onchain, &self.pending_events, &self.logger);
3921 HTLCSource::PreviousHopData(hop_data) => {
3922 let prev_outpoint = hop_data.outpoint;
3923 let res = self.claim_funds_from_hop(channel_state_lock, self.per_peer_state.read().unwrap(), hop_data, payment_preimage,
3924 |htlc_claim_value_msat| {
3925 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
3926 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
3927 Some(claimed_htlc_value - forwarded_htlc_value)
3930 let prev_channel_id = Some(prev_outpoint.to_channel_id());
3931 let next_channel_id = Some(next_channel_id);
3933 Some(MonitorUpdateCompletionAction::EmitEvent { event: events::Event::PaymentForwarded {
3935 claim_from_onchain_tx: from_onchain,
3941 if let Err((pk, err)) = res {
3942 let result: Result<(), _> = Err(err);
3943 let _ = handle_error!(self, result, pk);
3949 /// Gets the node_id held by this ChannelManager
3950 pub fn get_our_node_id(&self) -> PublicKey {
3951 self.our_network_pubkey.clone()
3954 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
3955 for action in actions.into_iter() {
3957 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
3958 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
3959 if let Some(ClaimingPayment { amount_msat, payment_purpose: purpose, receiver_node_id }) = payment {
3960 self.pending_events.lock().unwrap().push(events::Event::PaymentClaimed {
3961 payment_hash, purpose, amount_msat, receiver_node_id: Some(receiver_node_id),
3965 MonitorUpdateCompletionAction::EmitEvent { event } => {
3966 self.pending_events.lock().unwrap().push(event);
3972 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
3973 /// update completion.
3974 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
3975 channel: &mut Channel<<K::Target as SignerProvider>::Signer>, raa: Option<msgs::RevokeAndACK>,
3976 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
3977 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
3978 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
3979 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
3980 let mut htlc_forwards = None;
3982 let counterparty_node_id = channel.get_counterparty_node_id();
3983 if !pending_forwards.is_empty() {
3984 htlc_forwards = Some((channel.get_short_channel_id().unwrap_or(channel.outbound_scid_alias()),
3985 channel.get_funding_txo().unwrap(), channel.get_user_id(), pending_forwards));
3988 if let Some(msg) = channel_ready {
3989 send_channel_ready!(self, pending_msg_events, channel, msg);
3991 if let Some(msg) = announcement_sigs {
3992 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
3993 node_id: counterparty_node_id,
3998 emit_channel_ready_event!(self, channel);
4000 macro_rules! handle_cs { () => {
4001 if let Some(update) = commitment_update {
4002 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4003 node_id: counterparty_node_id,
4008 macro_rules! handle_raa { () => {
4009 if let Some(revoke_and_ack) = raa {
4010 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
4011 node_id: counterparty_node_id,
4012 msg: revoke_and_ack,
4017 RAACommitmentOrder::CommitmentFirst => {
4021 RAACommitmentOrder::RevokeAndACKFirst => {
4027 if let Some(tx) = funding_broadcastable {
4028 log_info!(self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
4029 self.tx_broadcaster.broadcast_transaction(&tx);
4035 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
4036 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4039 let (mut pending_failures, finalized_claims, counterparty_node_id) = {
4040 let mut channel_lock = self.channel_state.lock().unwrap();
4041 let channel_state = &mut *channel_lock;
4042 let counterparty_node_id = match counterparty_node_id {
4043 Some(cp_id) => cp_id.clone(),
4045 // TODO: Once we can rely on the counterparty_node_id from the
4046 // monitor event, this and the id_to_peer map should be removed.
4047 let id_to_peer = self.id_to_peer.lock().unwrap();
4048 match id_to_peer.get(&funding_txo.to_channel_id()) {
4049 Some(cp_id) => cp_id.clone(),
4054 let per_peer_state = self.per_peer_state.read().unwrap();
4055 let mut peer_state_lock;
4057 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
4058 peer_state_lock = peer_state_mutex.lock().unwrap();
4059 let peer_state = &mut *peer_state_lock;
4060 match peer_state.channel_by_id.entry(funding_txo.to_channel_id()){
4061 hash_map::Entry::Occupied(chan) => chan,
4062 hash_map::Entry::Vacant(_) => return,
4066 if !channel.get().is_awaiting_monitor_update() || channel.get().get_latest_monitor_update_id() != highest_applied_update_id {
4070 let updates = channel.get_mut().monitor_updating_restored(&self.logger, self.get_our_node_id(), self.genesis_hash, self.best_block.read().unwrap().height());
4071 let channel_update = if updates.channel_ready.is_some() && channel.get().is_usable() {
4072 // We only send a channel_update in the case where we are just now sending a
4073 // channel_ready and the channel is in a usable state. We may re-send a
4074 // channel_update later through the announcement_signatures process for public
4075 // channels, but there's no reason not to just inform our counterparty of our fees
4077 if let Ok(msg) = self.get_channel_update_for_unicast(channel.get()) {
4078 Some(events::MessageSendEvent::SendChannelUpdate {
4079 node_id: channel.get().get_counterparty_node_id(),
4084 htlc_forwards = self.handle_channel_resumption(&mut channel_state.pending_msg_events, channel.get_mut(), updates.raa, updates.commitment_update, updates.order, updates.accepted_htlcs, updates.funding_broadcastable, updates.channel_ready, updates.announcement_sigs);
4085 if let Some(upd) = channel_update {
4086 channel_state.pending_msg_events.push(upd);
4089 (updates.failed_htlcs, updates.finalized_claimed_htlcs, counterparty_node_id)
4091 if let Some(forwards) = htlc_forwards {
4092 self.forward_htlcs(&mut [forwards][..]);
4094 self.finalize_claims(finalized_claims);
4095 for failure in pending_failures.drain(..) {
4096 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id: funding_txo.to_channel_id() };
4097 self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
4101 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
4103 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
4104 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
4107 /// The `user_channel_id` parameter will be provided back in
4108 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4109 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4111 /// Note that this method will return an error and reject the channel, if it requires support
4112 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
4113 /// used to accept such channels.
4115 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4116 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4117 pub fn accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
4118 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
4121 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
4122 /// it as confirmed immediately.
4124 /// The `user_channel_id` parameter will be provided back in
4125 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4126 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4128 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
4129 /// and (if the counterparty agrees), enables forwarding of payments immediately.
4131 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
4132 /// transaction and blindly assumes that it will eventually confirm.
4134 /// If it does not confirm before we decide to close the channel, or if the funding transaction
4135 /// does not pay to the correct script the correct amount, *you will lose funds*.
4137 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4138 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4139 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> {
4140 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
4143 fn do_accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
4144 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4146 let mut channel_state_lock = self.channel_state.lock().unwrap();
4147 let channel_state = &mut *channel_state_lock;
4148 let per_peer_state = self.per_peer_state.read().unwrap();
4149 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4150 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4151 let peer_state = &mut *peer_state_lock;
4152 match peer_state.channel_by_id.entry(temporary_channel_id.clone()) {
4153 hash_map::Entry::Occupied(mut channel) => {
4154 if !channel.get().inbound_is_awaiting_accept() {
4155 return Err(APIError::APIMisuseError { err: "The channel isn't currently awaiting to be accepted.".to_owned() });
4157 if *counterparty_node_id != channel.get().get_counterparty_node_id() {
4158 return Err(APIError::APIMisuseError { err: "The passed counterparty_node_id doesn't match the channel's counterparty node_id".to_owned() });
4161 channel.get_mut().set_0conf();
4162 } else if channel.get().get_channel_type().requires_zero_conf() {
4163 let send_msg_err_event = events::MessageSendEvent::HandleError {
4164 node_id: channel.get().get_counterparty_node_id(),
4165 action: msgs::ErrorAction::SendErrorMessage{
4166 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
4169 channel_state.pending_msg_events.push(send_msg_err_event);
4170 let _ = remove_channel!(self, channel);
4171 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
4174 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4175 node_id: channel.get().get_counterparty_node_id(),
4176 msg: channel.get_mut().accept_inbound_channel(user_channel_id),
4179 hash_map::Entry::Vacant(_) => {
4180 return Err(APIError::ChannelUnavailable { err: "Can't accept a channel that doesn't exist".to_owned() });
4184 return Err(APIError::APIMisuseError { err: format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", counterparty_node_id) });
4189 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
4190 if msg.chain_hash != self.genesis_hash {
4191 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
4194 if !self.default_configuration.accept_inbound_channels {
4195 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4198 let mut random_bytes = [0u8; 16];
4199 random_bytes.copy_from_slice(&self.keys_manager.get_secure_random_bytes()[..16]);
4200 let user_channel_id = u128::from_be_bytes(random_bytes);
4202 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
4203 let mut channel = match Channel::new_from_req(&self.fee_estimator, &self.keys_manager,
4204 counterparty_node_id.clone(), &their_features, msg, user_channel_id, &self.default_configuration,
4205 self.best_block.read().unwrap().height(), &self.logger, outbound_scid_alias)
4208 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4209 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
4213 let mut channel_state_lock = self.channel_state.lock().unwrap();
4214 let channel_state = &mut *channel_state_lock;
4215 let per_peer_state = self.per_peer_state.read().unwrap();
4216 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4217 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4218 let peer_state = &mut *peer_state_lock;
4219 match peer_state.channel_by_id.entry(channel.channel_id()) {
4220 hash_map::Entry::Occupied(_) => {
4221 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4222 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision for the same peer!".to_owned(), msg.temporary_channel_id.clone()))
4224 hash_map::Entry::Vacant(entry) => {
4225 if !self.default_configuration.manually_accept_inbound_channels {
4226 if channel.get_channel_type().requires_zero_conf() {
4227 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4229 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4230 node_id: counterparty_node_id.clone(),
4231 msg: channel.accept_inbound_channel(user_channel_id),
4234 let mut pending_events = self.pending_events.lock().unwrap();
4235 pending_events.push(
4236 events::Event::OpenChannelRequest {
4237 temporary_channel_id: msg.temporary_channel_id.clone(),
4238 counterparty_node_id: counterparty_node_id.clone(),
4239 funding_satoshis: msg.funding_satoshis,
4240 push_msat: msg.push_msat,
4241 channel_type: channel.get_channel_type().clone(),
4246 entry.insert(channel);
4250 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id.clone()))
4255 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
4256 let (value, output_script, user_id) = {
4257 let per_peer_state = self.per_peer_state.read().unwrap();
4258 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4259 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4260 let peer_state = &mut *peer_state_lock;
4261 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
4262 hash_map::Entry::Occupied(mut chan) => {
4263 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4264 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
4266 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &their_features), chan);
4267 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
4269 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
4272 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id))
4275 let mut pending_events = self.pending_events.lock().unwrap();
4276 pending_events.push(events::Event::FundingGenerationReady {
4277 temporary_channel_id: msg.temporary_channel_id,
4278 counterparty_node_id: *counterparty_node_id,
4279 channel_value_satoshis: value,
4281 user_channel_id: user_id,
4286 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
4287 let mut channel_state_lock = self.channel_state.lock().unwrap();
4288 let channel_state = &mut *channel_state_lock;
4289 let per_peer_state = self.per_peer_state.read().unwrap();
4290 let ((funding_msg, monitor, mut channel_ready), mut chan) = {
4291 let best_block = *self.best_block.read().unwrap();
4292 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4293 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4294 let peer_state = &mut *peer_state_lock;
4295 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
4296 hash_map::Entry::Occupied(mut chan) => {
4297 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4298 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
4300 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.keys_manager, &self.logger), chan), chan.remove())
4302 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
4305 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id))
4308 // Because we have exclusive ownership of the channel here we can release the peer_state
4309 // lock before watch_channel
4310 match self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
4311 ChannelMonitorUpdateStatus::Completed => {},
4312 ChannelMonitorUpdateStatus::PermanentFailure => {
4313 // Note that we reply with the new channel_id in error messages if we gave up on the
4314 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
4315 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
4316 // any messages referencing a previously-closed channel anyway.
4317 // We do not propagate the monitor update to the user as it would be for a monitor
4318 // that we didn't manage to store (and that we don't care about - we don't respond
4319 // with the funding_signed so the channel can never go on chain).
4320 let (_monitor_update, failed_htlcs) = chan.force_shutdown(false);
4321 assert!(failed_htlcs.is_empty());
4322 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
4324 ChannelMonitorUpdateStatus::InProgress => {
4325 // There's no problem signing a counterparty's funding transaction if our monitor
4326 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
4327 // accepted payment from yet. We do, however, need to wait to send our channel_ready
4328 // until we have persisted our monitor.
4329 chan.monitor_updating_paused(false, false, channel_ready.is_some(), Vec::new(), Vec::new(), Vec::new());
4330 channel_ready = None; // Don't send the channel_ready now
4333 // It's safe to unwrap as we've held the `per_peer_state` read lock since checking that the
4334 // peer exists, despite the inner PeerState potentially having no channels after removing
4335 // the channel above.
4336 let peer_state_mutex = per_peer_state.get(counterparty_node_id).unwrap();
4337 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4338 let peer_state = &mut *peer_state_lock;
4339 match peer_state.channel_by_id.entry(funding_msg.channel_id) {
4340 hash_map::Entry::Occupied(_) => {
4341 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
4343 hash_map::Entry::Vacant(e) => {
4344 let mut id_to_peer = self.id_to_peer.lock().unwrap();
4345 match id_to_peer.entry(chan.channel_id()) {
4346 hash_map::Entry::Occupied(_) => {
4347 return Err(MsgHandleErrInternal::send_err_msg_no_close(
4348 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
4349 funding_msg.channel_id))
4351 hash_map::Entry::Vacant(i_e) => {
4352 i_e.insert(chan.get_counterparty_node_id());
4355 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
4356 node_id: counterparty_node_id.clone(),
4359 if let Some(msg) = channel_ready {
4360 send_channel_ready!(self, channel_state.pending_msg_events, chan, msg);
4368 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
4370 let best_block = *self.best_block.read().unwrap();
4371 let mut channel_lock = self.channel_state.lock().unwrap();
4372 let channel_state = &mut *channel_lock;
4373 let per_peer_state = self.per_peer_state.read().unwrap();
4374 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4375 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4376 let peer_state = &mut *peer_state_lock;
4377 match peer_state.channel_by_id.entry(msg.channel_id) {
4378 hash_map::Entry::Occupied(mut chan) => {
4379 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4380 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4382 let (monitor, funding_tx, channel_ready) = match chan.get_mut().funding_signed(&msg, best_block, &self.keys_manager, &self.logger) {
4383 Ok(update) => update,
4384 Err(e) => try_chan_entry!(self, Err(e), chan),
4386 match self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
4387 ChannelMonitorUpdateStatus::Completed => {},
4389 let mut res = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::RevokeAndACKFirst, channel_ready.is_some(), OPTIONALLY_RESEND_FUNDING_LOCKED);
4390 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
4391 // We weren't able to watch the channel to begin with, so no updates should be made on
4392 // it. Previously, full_stack_target found an (unreachable) panic when the
4393 // monitor update contained within `shutdown_finish` was applied.
4394 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
4395 shutdown_finish.0.take();
4401 if let Some(msg) = channel_ready {
4402 send_channel_ready!(self, channel_state.pending_msg_events, chan.get(), msg);
4406 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4409 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4412 log_info!(self.logger, "Broadcasting funding transaction with txid {}", funding_tx.txid());
4413 self.tx_broadcaster.broadcast_transaction(&funding_tx);
4417 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
4418 let mut channel_state_lock = self.channel_state.lock().unwrap();
4419 let channel_state = &mut *channel_state_lock;
4420 let per_peer_state = self.per_peer_state.read().unwrap();
4421 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4422 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4423 let peer_state = &mut *peer_state_lock;
4424 match peer_state.channel_by_id.entry(msg.channel_id) {
4425 hash_map::Entry::Occupied(mut chan) => {
4426 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4427 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4429 let announcement_sigs_opt = try_chan_entry!(self, chan.get_mut().channel_ready(&msg, self.get_our_node_id(),
4430 self.genesis_hash.clone(), &self.best_block.read().unwrap(), &self.logger), chan);
4431 if let Some(announcement_sigs) = announcement_sigs_opt {
4432 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(chan.get().channel_id()));
4433 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4434 node_id: counterparty_node_id.clone(),
4435 msg: announcement_sigs,
4437 } else if chan.get().is_usable() {
4438 // If we're sending an announcement_signatures, we'll send the (public)
4439 // channel_update after sending a channel_announcement when we receive our
4440 // counterparty's announcement_signatures. Thus, we only bother to send a
4441 // channel_update here if the channel is not public, i.e. we're not sending an
4442 // announcement_signatures.
4443 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", log_bytes!(chan.get().channel_id()));
4444 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
4445 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4446 node_id: counterparty_node_id.clone(),
4452 emit_channel_ready_event!(self, chan.get_mut());
4456 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4459 Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4463 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
4464 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
4465 let result: Result<(), _> = loop {
4466 let mut channel_state_lock = self.channel_state.lock().unwrap();
4467 let channel_state = &mut *channel_state_lock;
4468 let per_peer_state = self.per_peer_state.read().unwrap();
4469 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4470 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4471 let peer_state = &mut *peer_state_lock;
4472 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
4473 hash_map::Entry::Occupied(mut chan_entry) => {
4474 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
4475 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4478 if !chan_entry.get().received_shutdown() {
4479 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
4480 log_bytes!(msg.channel_id),
4481 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
4484 let (shutdown, monitor_update, htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&self.keys_manager, &their_features, &msg), chan_entry);
4485 dropped_htlcs = htlcs;
4487 // Update the monitor with the shutdown script if necessary.
4488 if let Some(monitor_update) = monitor_update {
4489 let update_res = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update);
4490 let (result, is_permanent) =
4491 handle_monitor_update_res!(self, update_res, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
4493 remove_channel!(self, chan_entry);
4498 if let Some(msg) = shutdown {
4499 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
4500 node_id: *counterparty_node_id,
4507 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4510 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4513 for htlc_source in dropped_htlcs.drain(..) {
4514 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
4515 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
4516 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
4519 let _ = handle_error!(self, result, *counterparty_node_id);
4523 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
4524 let (tx, chan_option) = {
4525 let mut channel_state_lock = self.channel_state.lock().unwrap();
4526 let channel_state = &mut *channel_state_lock;
4527 let per_peer_state = self.per_peer_state.read().unwrap();
4528 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4529 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4530 let peer_state = &mut *peer_state_lock;
4531 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
4532 hash_map::Entry::Occupied(mut chan_entry) => {
4533 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
4534 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4536 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), chan_entry);
4537 if let Some(msg) = closing_signed {
4538 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
4539 node_id: counterparty_node_id.clone(),
4544 // We're done with this channel, we've got a signed closing transaction and
4545 // will send the closing_signed back to the remote peer upon return. This
4546 // also implies there are no pending HTLCs left on the channel, so we can
4547 // fully delete it from tracking (the channel monitor is still around to
4548 // watch for old state broadcasts)!
4549 (tx, Some(remove_channel!(self, chan_entry)))
4550 } else { (tx, None) }
4552 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4555 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4558 if let Some(broadcast_tx) = tx {
4559 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
4560 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
4562 if let Some(chan) = chan_option {
4563 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4564 let mut channel_state = self.channel_state.lock().unwrap();
4565 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4569 self.issue_channel_close_events(&chan, ClosureReason::CooperativeClosure);
4574 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
4575 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
4576 //determine the state of the payment based on our response/if we forward anything/the time
4577 //we take to respond. We should take care to avoid allowing such an attack.
4579 //TODO: There exists a further attack where a node may garble the onion data, forward it to
4580 //us repeatedly garbled in different ways, and compare our error messages, which are
4581 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
4582 //but we should prevent it anyway.
4584 let pending_forward_info = self.decode_update_add_htlc_onion(msg);
4585 let per_peer_state = self.per_peer_state.read().unwrap();
4586 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4587 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4588 let peer_state = &mut *peer_state_lock;
4589 match peer_state.channel_by_id.entry(msg.channel_id) {
4590 hash_map::Entry::Occupied(mut chan) => {
4591 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4592 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4595 let create_pending_htlc_status = |chan: &Channel<<K::Target as SignerProvider>::Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
4596 // If the update_add is completely bogus, the call will Err and we will close,
4597 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
4598 // want to reject the new HTLC and fail it backwards instead of forwarding.
4599 match pending_forward_info {
4600 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
4601 let reason = if (error_code & 0x1000) != 0 {
4602 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
4603 HTLCFailReason::reason(real_code, error_data)
4605 HTLCFailReason::from_failure_code(error_code)
4606 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
4607 let msg = msgs::UpdateFailHTLC {
4608 channel_id: msg.channel_id,
4609 htlc_id: msg.htlc_id,
4612 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
4614 _ => pending_forward_info
4617 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), chan);
4619 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4622 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4627 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
4628 let channel_lock = self.channel_state.lock().unwrap();
4629 let (htlc_source, forwarded_htlc_value) = {
4630 let per_peer_state = self.per_peer_state.read().unwrap();
4631 if let None = per_peer_state.get(counterparty_node_id) {
4632 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id));
4634 let peer_state_mutex = per_peer_state.get(counterparty_node_id).unwrap();
4635 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4636 let peer_state = &mut *peer_state_lock;
4637 match peer_state.channel_by_id.entry(msg.channel_id) {
4638 hash_map::Entry::Occupied(mut chan) => {
4639 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4640 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4642 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), chan)
4644 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4647 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, msg.channel_id);
4651 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
4652 let per_peer_state = self.per_peer_state.read().unwrap();
4653 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4654 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4655 let peer_state = &mut *peer_state_lock;
4656 match peer_state.channel_by_id.entry(msg.channel_id) {
4657 hash_map::Entry::Occupied(mut chan) => {
4658 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4659 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4661 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan);
4663 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4666 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id));
4671 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
4672 let per_peer_state = self.per_peer_state.read().unwrap();
4673 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4674 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4675 let peer_state = &mut *peer_state_lock;
4676 match peer_state.channel_by_id.entry(msg.channel_id) {
4677 hash_map::Entry::Occupied(mut chan) => {
4678 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4679 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4681 if (msg.failure_code & 0x8000) == 0 {
4682 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
4683 try_chan_entry!(self, Err(chan_err), chan);
4685 try_chan_entry!(self, chan.get_mut().update_fail_malformed_htlc(&msg, HTLCFailReason::reason(msg.failure_code, msg.sha256_of_onion.to_vec())), chan);
4688 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4691 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4695 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
4696 let mut channel_state_lock = self.channel_state.lock().unwrap();
4697 let channel_state = &mut *channel_state_lock;
4698 let per_peer_state = self.per_peer_state.read().unwrap();
4699 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4700 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4701 let peer_state = &mut *peer_state_lock;
4702 match peer_state.channel_by_id.entry(msg.channel_id) {
4703 hash_map::Entry::Occupied(mut chan) => {
4704 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4705 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4707 let (revoke_and_ack, commitment_signed, monitor_update) =
4708 match chan.get_mut().commitment_signed(&msg, &self.logger) {
4709 Err((None, e)) => try_chan_entry!(self, Err(e), chan),
4710 Err((Some(update), e)) => {
4711 assert!(chan.get().is_awaiting_monitor_update());
4712 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), update);
4713 try_chan_entry!(self, Err(e), chan);
4718 let update_res = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update);
4719 if let Err(e) = handle_monitor_update_res!(self, update_res, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some()) {
4723 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
4724 node_id: counterparty_node_id.clone(),
4725 msg: revoke_and_ack,
4727 if let Some(msg) = commitment_signed {
4728 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4729 node_id: counterparty_node_id.clone(),
4730 updates: msgs::CommitmentUpdate {
4731 update_add_htlcs: Vec::new(),
4732 update_fulfill_htlcs: Vec::new(),
4733 update_fail_htlcs: Vec::new(),
4734 update_fail_malformed_htlcs: Vec::new(),
4736 commitment_signed: msg,
4742 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4745 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4750 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
4751 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
4752 let mut forward_event = None;
4753 let mut new_intercept_events = Vec::new();
4754 let mut failed_intercept_forwards = Vec::new();
4755 if !pending_forwards.is_empty() {
4756 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
4757 let scid = match forward_info.routing {
4758 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
4759 PendingHTLCRouting::Receive { .. } => 0,
4760 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
4762 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
4763 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
4765 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
4766 let forward_htlcs_empty = forward_htlcs.is_empty();
4767 match forward_htlcs.entry(scid) {
4768 hash_map::Entry::Occupied(mut entry) => {
4769 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4770 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
4772 hash_map::Entry::Vacant(entry) => {
4773 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
4774 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.genesis_hash)
4776 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).into_inner());
4777 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
4778 match pending_intercepts.entry(intercept_id) {
4779 hash_map::Entry::Vacant(entry) => {
4780 new_intercept_events.push(events::Event::HTLCIntercepted {
4781 requested_next_hop_scid: scid,
4782 payment_hash: forward_info.payment_hash,
4783 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
4784 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
4787 entry.insert(PendingAddHTLCInfo {
4788 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
4790 hash_map::Entry::Occupied(_) => {
4791 log_info!(self.logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
4792 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4793 short_channel_id: prev_short_channel_id,
4794 outpoint: prev_funding_outpoint,
4795 htlc_id: prev_htlc_id,
4796 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
4797 phantom_shared_secret: None,
4800 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
4801 HTLCFailReason::from_failure_code(0x4000 | 10),
4802 HTLCDestination::InvalidForward { requested_forward_scid: scid },
4807 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
4808 // payments are being processed.
4809 if forward_htlcs_empty {
4810 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
4812 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4813 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
4820 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
4821 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4824 if !new_intercept_events.is_empty() {
4825 let mut events = self.pending_events.lock().unwrap();
4826 events.append(&mut new_intercept_events);
4829 match forward_event {
4831 let mut pending_events = self.pending_events.lock().unwrap();
4832 pending_events.push(events::Event::PendingHTLCsForwardable {
4833 time_forwardable: time
4841 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
4842 let mut htlcs_to_fail = Vec::new();
4844 let mut channel_state_lock = self.channel_state.lock().unwrap();
4845 let channel_state = &mut *channel_state_lock;
4846 let per_peer_state = self.per_peer_state.read().unwrap();
4847 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4848 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4849 let peer_state = &mut *peer_state_lock;
4850 match peer_state.channel_by_id.entry(msg.channel_id) {
4851 hash_map::Entry::Occupied(mut chan) => {
4852 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4853 break Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4855 let was_paused_for_mon_update = chan.get().is_awaiting_monitor_update();
4856 let raa_updates = break_chan_entry!(self,
4857 chan.get_mut().revoke_and_ack(&msg, &self.logger), chan);
4858 htlcs_to_fail = raa_updates.holding_cell_failed_htlcs;
4859 let update_res = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), raa_updates.monitor_update);
4860 if was_paused_for_mon_update {
4861 assert!(update_res != ChannelMonitorUpdateStatus::Completed);
4862 assert!(raa_updates.commitment_update.is_none());
4863 assert!(raa_updates.accepted_htlcs.is_empty());
4864 assert!(raa_updates.failed_htlcs.is_empty());
4865 assert!(raa_updates.finalized_claimed_htlcs.is_empty());
4866 break Err(MsgHandleErrInternal::ignore_no_close("Existing pending monitor update prevented responses to RAA".to_owned()));
4868 if update_res != ChannelMonitorUpdateStatus::Completed {
4869 if let Err(e) = handle_monitor_update_res!(self, update_res, chan,
4870 RAACommitmentOrder::CommitmentFirst, false,
4871 raa_updates.commitment_update.is_some(), false,
4872 raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
4873 raa_updates.finalized_claimed_htlcs) {
4875 } else { unreachable!(); }
4877 if let Some(updates) = raa_updates.commitment_update {
4878 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4879 node_id: counterparty_node_id.clone(),
4883 break Ok((raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
4884 raa_updates.finalized_claimed_htlcs,
4885 chan.get().get_short_channel_id()
4886 .unwrap_or(chan.get().outbound_scid_alias()),
4887 chan.get().get_funding_txo().unwrap(),
4888 chan.get().get_user_id()))
4890 hash_map::Entry::Vacant(_) => break Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4893 break Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4896 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
4898 Ok((pending_forwards, mut pending_failures, finalized_claim_htlcs,
4899 short_channel_id, channel_outpoint, user_channel_id)) =>
4901 for failure in pending_failures.drain(..) {
4902 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: channel_outpoint.to_channel_id() };
4903 self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
4905 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, user_channel_id, pending_forwards)]);
4906 self.finalize_claims(finalized_claim_htlcs);
4913 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
4914 let per_peer_state = self.per_peer_state.read().unwrap();
4915 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4916 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4917 let peer_state = &mut *peer_state_lock;
4918 match peer_state.channel_by_id.entry(msg.channel_id) {
4919 hash_map::Entry::Occupied(mut chan) => {
4920 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4921 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4923 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg, &self.logger), chan);
4925 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4928 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id));
4933 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
4934 let mut channel_state_lock = self.channel_state.lock().unwrap();
4935 let channel_state = &mut *channel_state_lock;
4936 let per_peer_state = self.per_peer_state.read().unwrap();
4937 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
4938 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4939 let peer_state = &mut *peer_state_lock;
4940 match peer_state.channel_by_id.entry(msg.channel_id) {
4941 hash_map::Entry::Occupied(mut chan) => {
4942 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4943 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4945 if !chan.get().is_usable() {
4946 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
4949 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
4950 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(
4951 self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height(), msg), chan),
4952 // Note that announcement_signatures fails if the channel cannot be announced,
4953 // so get_channel_update_for_broadcast will never fail by the time we get here.
4954 update_msg: self.get_channel_update_for_broadcast(chan.get()).unwrap(),
4957 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4960 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id));
4965 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
4966 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
4967 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
4968 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
4970 // It's not a local channel
4971 return Ok(NotifyOption::SkipPersist)
4974 let per_peer_state = self.per_peer_state.read().unwrap();
4975 if let Some(peer_state_mutex) = per_peer_state.get(&chan_counterparty_node_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(chan_id) {
4979 hash_map::Entry::Occupied(mut chan) => {
4980 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4981 if chan.get().should_announce() {
4982 // If the announcement is about a channel of ours which is public, some
4983 // other peer may simply be forwarding all its gossip to us. Don't provide
4984 // a scary-looking error message and return Ok instead.
4985 return Ok(NotifyOption::SkipPersist);
4987 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));
4989 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().get_counterparty_node_id().serialize()[..];
4990 let msg_from_node_one = msg.contents.flags & 1 == 0;
4991 if were_node_one == msg_from_node_one {
4992 return Ok(NotifyOption::SkipPersist);
4994 log_debug!(self.logger, "Received channel_update for channel {}.", log_bytes!(chan_id));
4995 try_chan_entry!(self, chan.get_mut().channel_update(&msg), chan);
4998 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersist)
5001 return Ok(NotifyOption::SkipPersist)
5003 Ok(NotifyOption::DoPersist)
5006 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
5008 let need_lnd_workaround = {
5009 let mut channel_state_lock = self.channel_state.lock().unwrap();
5010 let channel_state = &mut *channel_state_lock;
5011 let per_peer_state = self.per_peer_state.read().unwrap();
5013 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
5014 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5015 let peer_state = &mut *peer_state_lock;
5016 match peer_state.channel_by_id.entry(msg.channel_id) {
5017 hash_map::Entry::Occupied(mut chan) => {
5018 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5019 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5021 // Currently, we expect all holding cell update_adds to be dropped on peer
5022 // disconnect, so Channel's reestablish will never hand us any holding cell
5023 // freed HTLCs to fail backwards. If in the future we no longer drop pending
5024 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
5025 let responses = try_chan_entry!(self, chan.get_mut().channel_reestablish(
5026 msg, &self.logger, self.our_network_pubkey.clone(), self.genesis_hash,
5027 &*self.best_block.read().unwrap()), chan);
5028 let mut channel_update = None;
5029 if let Some(msg) = responses.shutdown_msg {
5030 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5031 node_id: counterparty_node_id.clone(),
5034 } else if chan.get().is_usable() {
5035 // If the channel is in a usable state (ie the channel is not being shut
5036 // down), send a unicast channel_update to our counterparty to make sure
5037 // they have the latest channel parameters.
5038 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
5039 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
5040 node_id: chan.get().get_counterparty_node_id(),
5045 let need_lnd_workaround = chan.get_mut().workaround_lnd_bug_4006.take();
5046 htlc_forwards = self.handle_channel_resumption(
5047 &mut channel_state.pending_msg_events, chan.get_mut(), responses.raa, responses.commitment_update, responses.order,
5048 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
5049 if let Some(upd) = channel_update {
5050 channel_state.pending_msg_events.push(upd);
5054 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5057 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer with a node_id matching the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id));
5061 if let Some(forwards) = htlc_forwards {
5062 self.forward_htlcs(&mut [forwards][..]);
5065 if let Some(channel_ready_msg) = need_lnd_workaround {
5066 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
5071 /// Process pending events from the `chain::Watch`, returning whether any events were processed.
5072 fn process_pending_monitor_events(&self) -> bool {
5073 let mut failed_channels = Vec::new();
5074 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
5075 let has_pending_monitor_events = !pending_monitor_events.is_empty();
5076 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
5077 for monitor_event in monitor_events.drain(..) {
5078 match monitor_event {
5079 MonitorEvent::HTLCEvent(htlc_update) => {
5080 if let Some(preimage) = htlc_update.payment_preimage {
5081 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
5082 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, funding_outpoint.to_channel_id());
5084 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
5085 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
5086 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
5087 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
5090 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
5091 MonitorEvent::UpdateFailed(funding_outpoint) => {
5092 let mut channel_lock = self.channel_state.lock().unwrap();
5093 let channel_state = &mut *channel_lock;
5094 let counterparty_node_id_opt = match counterparty_node_id {
5095 Some(cp_id) => Some(cp_id),
5097 // TODO: Once we can rely on the counterparty_node_id from the
5098 // monitor event, this and the id_to_peer map should be removed.
5099 let id_to_peer = self.id_to_peer.lock().unwrap();
5100 id_to_peer.get(&funding_outpoint.to_channel_id()).cloned()
5103 if let Some(counterparty_node_id) = counterparty_node_id_opt {
5104 let per_peer_state = self.per_peer_state.read().unwrap();
5105 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
5106 let pending_msg_events = &mut channel_state.pending_msg_events;
5107 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5108 let peer_state = &mut *peer_state_lock;
5109 if let hash_map::Entry::Occupied(chan_entry) = peer_state.channel_by_id.entry(funding_outpoint.to_channel_id()) {
5110 let mut chan = remove_channel!(self, chan_entry);
5111 failed_channels.push(chan.force_shutdown(false));
5112 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5113 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5117 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
5118 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
5120 ClosureReason::CommitmentTxConfirmed
5122 self.issue_channel_close_events(&chan, reason);
5123 pending_msg_events.push(events::MessageSendEvent::HandleError {
5124 node_id: chan.get_counterparty_node_id(),
5125 action: msgs::ErrorAction::SendErrorMessage {
5126 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
5133 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
5134 self.channel_monitor_updated(&funding_txo, monitor_update_id, counterparty_node_id.as_ref());
5140 for failure in failed_channels.drain(..) {
5141 self.finish_force_close_channel(failure);
5144 has_pending_monitor_events
5147 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
5148 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
5149 /// update events as a separate process method here.
5151 pub fn process_monitor_events(&self) {
5152 self.process_pending_monitor_events();
5155 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
5156 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
5157 /// update was applied.
5158 fn check_free_holding_cells(&self) -> bool {
5159 let mut has_monitor_update = false;
5160 let mut failed_htlcs = Vec::new();
5161 let mut handle_errors = Vec::new();
5163 let mut channel_state_lock = self.channel_state.lock().unwrap();
5164 let channel_state = &mut *channel_state_lock;
5165 let pending_msg_events = &mut channel_state.pending_msg_events;
5166 let per_peer_state = self.per_peer_state.read().unwrap();
5168 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5169 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5170 let peer_state = &mut *peer_state_lock;
5171 peer_state.channel_by_id.retain(|channel_id, chan| {
5172 match chan.maybe_free_holding_cell_htlcs(&self.logger) {
5173 Ok((commitment_opt, holding_cell_failed_htlcs)) => {
5174 if !holding_cell_failed_htlcs.is_empty() {
5176 holding_cell_failed_htlcs,
5178 chan.get_counterparty_node_id()
5181 if let Some((commitment_update, monitor_update)) = commitment_opt {
5182 match self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
5183 ChannelMonitorUpdateStatus::Completed => {
5184 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5185 node_id: chan.get_counterparty_node_id(),
5186 updates: commitment_update,
5190 has_monitor_update = true;
5191 let (res, close_channel) = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, channel_id, COMMITMENT_UPDATE_ONLY);
5192 handle_errors.push((chan.get_counterparty_node_id(), res));
5193 if close_channel { return false; }
5200 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
5201 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5202 // ChannelClosed event is generated by handle_error for us
5210 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
5211 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
5212 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
5215 for (counterparty_node_id, err) in handle_errors.drain(..) {
5216 let _ = handle_error!(self, err, counterparty_node_id);
5222 /// Check whether any channels have finished removing all pending updates after a shutdown
5223 /// exchange and can now send a closing_signed.
5224 /// Returns whether any closing_signed messages were generated.
5225 fn maybe_generate_initial_closing_signed(&self) -> bool {
5226 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
5227 let mut has_update = false;
5229 let mut channel_state_lock = self.channel_state.lock().unwrap();
5230 let channel_state = &mut *channel_state_lock;
5231 let pending_msg_events = &mut channel_state.pending_msg_events;
5232 let per_peer_state = self.per_peer_state.read().unwrap();
5234 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5235 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5236 let peer_state = &mut *peer_state_lock;
5237 peer_state.channel_by_id.retain(|channel_id, chan| {
5238 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
5239 Ok((msg_opt, tx_opt)) => {
5240 if let Some(msg) = msg_opt {
5242 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5243 node_id: chan.get_counterparty_node_id(), msg,
5246 if let Some(tx) = tx_opt {
5247 // We're done with this channel. We got a closing_signed and sent back
5248 // a closing_signed with a closing transaction to broadcast.
5249 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5250 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5255 self.issue_channel_close_events(chan, ClosureReason::CooperativeClosure);
5257 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
5258 self.tx_broadcaster.broadcast_transaction(&tx);
5259 update_maps_on_chan_removal!(self, chan);
5265 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
5266 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5274 for (counterparty_node_id, err) in handle_errors.drain(..) {
5275 let _ = handle_error!(self, err, counterparty_node_id);
5281 /// Handle a list of channel failures during a block_connected or block_disconnected call,
5282 /// pushing the channel monitor update (if any) to the background events queue and removing the
5284 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
5285 for mut failure in failed_channels.drain(..) {
5286 // Either a commitment transactions has been confirmed on-chain or
5287 // Channel::block_disconnected detected that the funding transaction has been
5288 // reorganized out of the main chain.
5289 // We cannot broadcast our latest local state via monitor update (as
5290 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
5291 // so we track the update internally and handle it when the user next calls
5292 // timer_tick_occurred, guaranteeing we're running normally.
5293 if let Some((funding_txo, update)) = failure.0.take() {
5294 assert_eq!(update.updates.len(), 1);
5295 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
5296 assert!(should_broadcast);
5297 } else { unreachable!(); }
5298 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
5300 self.finish_force_close_channel(failure);
5304 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> {
5305 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
5307 if min_value_msat.is_some() && min_value_msat.unwrap() > MAX_VALUE_MSAT {
5308 return Err(APIError::APIMisuseError { err: format!("min_value_msat of {} greater than total 21 million bitcoin supply", min_value_msat.unwrap()) });
5311 let payment_secret = PaymentSecret(self.keys_manager.get_secure_random_bytes());
5313 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5314 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5315 match payment_secrets.entry(payment_hash) {
5316 hash_map::Entry::Vacant(e) => {
5317 e.insert(PendingInboundPayment {
5318 payment_secret, min_value_msat, payment_preimage,
5319 user_payment_id: 0, // For compatibility with version 0.0.103 and earlier
5320 // We assume that highest_seen_timestamp is pretty close to the current time -
5321 // it's updated when we receive a new block with the maximum time we've seen in
5322 // a header. It should never be more than two hours in the future.
5323 // Thus, we add two hours here as a buffer to ensure we absolutely
5324 // never fail a payment too early.
5325 // Note that we assume that received blocks have reasonably up-to-date
5327 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
5330 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
5335 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
5338 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
5339 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
5341 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
5342 /// will have the [`PaymentClaimable::payment_preimage`] field filled in. That should then be
5343 /// passed directly to [`claim_funds`].
5345 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
5347 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5348 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5352 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5353 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5355 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5357 /// [`claim_funds`]: Self::claim_funds
5358 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
5359 /// [`PaymentClaimable::payment_preimage`]: events::Event::PaymentClaimable::payment_preimage
5360 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5361 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), ()> {
5362 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs, &self.keys_manager, self.highest_seen_timestamp.load(Ordering::Acquire) as u64)
5365 /// Legacy version of [`create_inbound_payment`]. Use this method if you wish to share
5366 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5368 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5371 /// This method is deprecated and will be removed soon.
5373 /// [`create_inbound_payment`]: Self::create_inbound_payment
5375 pub fn create_inbound_payment_legacy(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), APIError> {
5376 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
5377 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
5378 let payment_secret = self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs)?;
5379 Ok((payment_hash, payment_secret))
5382 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
5383 /// stored external to LDK.
5385 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
5386 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
5387 /// the `min_value_msat` provided here, if one is provided.
5389 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
5390 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
5393 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
5394 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
5395 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
5396 /// sender "proof-of-payment" unless they have paid the required amount.
5398 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
5399 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
5400 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
5401 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
5402 /// invoices when no timeout is set.
5404 /// Note that we use block header time to time-out pending inbound payments (with some margin
5405 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
5406 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
5407 /// If you need exact expiry semantics, you should enforce them upon receipt of
5408 /// [`PaymentClaimable`].
5410 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
5411 /// set to at least [`MIN_FINAL_CLTV_EXPIRY`].
5413 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5414 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5418 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5419 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5421 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5423 /// [`create_inbound_payment`]: Self::create_inbound_payment
5424 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
5425 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<PaymentSecret, ()> {
5426 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash, invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64)
5429 /// Legacy version of [`create_inbound_payment_for_hash`]. Use this method if you wish to share
5430 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5432 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5435 /// This method is deprecated and will be removed soon.
5437 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5439 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> {
5440 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
5443 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
5444 /// previously returned from [`create_inbound_payment`].
5446 /// [`create_inbound_payment`]: Self::create_inbound_payment
5447 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
5448 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
5451 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
5452 /// are used when constructing the phantom invoice's route hints.
5454 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5455 pub fn get_phantom_scid(&self) -> u64 {
5456 let best_block_height = self.best_block.read().unwrap().height();
5457 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
5459 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
5460 // Ensure the generated scid doesn't conflict with a real channel.
5461 match short_to_chan_info.get(&scid_candidate) {
5462 Some(_) => continue,
5463 None => return scid_candidate
5468 /// Gets route hints for use in receiving [phantom node payments].
5470 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5471 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
5473 channels: self.list_usable_channels(),
5474 phantom_scid: self.get_phantom_scid(),
5475 real_node_pubkey: self.get_our_node_id(),
5479 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
5480 /// used when constructing the route hints for HTLCs intended to be intercepted. See
5481 /// [`ChannelManager::forward_intercepted_htlc`].
5483 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
5484 /// times to get a unique scid.
5485 pub fn get_intercept_scid(&self) -> u64 {
5486 let best_block_height = self.best_block.read().unwrap().height();
5487 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
5489 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
5490 // Ensure the generated scid doesn't conflict with a real channel.
5491 if short_to_chan_info.contains_key(&scid_candidate) { continue }
5492 return scid_candidate
5496 /// Gets inflight HTLC information by processing pending outbound payments that are in
5497 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
5498 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
5499 let mut inflight_htlcs = InFlightHtlcs::new();
5501 let per_peer_state = self.per_peer_state.read().unwrap();
5502 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5503 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5504 let peer_state = &mut *peer_state_lock;
5505 for chan in peer_state.channel_by_id.values() {
5506 for (htlc_source, _) in chan.inflight_htlc_sources() {
5507 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
5508 inflight_htlcs.process_path(path, self.get_our_node_id());
5517 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
5518 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
5519 let events = core::cell::RefCell::new(Vec::new());
5520 let event_handler = |event: events::Event| events.borrow_mut().push(event);
5521 self.process_pending_events(&event_handler);
5526 pub fn pop_pending_event(&self) -> Option<events::Event> {
5527 let mut events = self.pending_events.lock().unwrap();
5528 if events.is_empty() { None } else { Some(events.remove(0)) }
5532 pub fn has_pending_payments(&self) -> bool {
5533 self.pending_outbound_payments.has_pending_payments()
5537 pub fn clear_pending_payments(&self) {
5538 self.pending_outbound_payments.clear_pending_payments()
5541 /// Processes any events asynchronously in the order they were generated since the last call
5542 /// using the given event handler.
5544 /// See the trait-level documentation of [`EventsProvider`] for requirements.
5545 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
5548 // We'll acquire our total consistency lock until the returned future completes so that
5549 // we can be sure no other persists happen while processing events.
5550 let _read_guard = self.total_consistency_lock.read().unwrap();
5552 let mut result = NotifyOption::SkipPersist;
5554 // TODO: This behavior should be documented. It's unintuitive that we query
5555 // ChannelMonitors when clearing other events.
5556 if self.process_pending_monitor_events() {
5557 result = NotifyOption::DoPersist;
5560 let pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5561 if !pending_events.is_empty() {
5562 result = NotifyOption::DoPersist;
5565 for event in pending_events {
5566 handler(event).await;
5569 if result == NotifyOption::DoPersist {
5570 self.persistence_notifier.notify();
5575 impl<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<M, T, K, F, R, L>
5577 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
5578 T::Target: BroadcasterInterface,
5579 K::Target: KeysInterface,
5580 F::Target: FeeEstimator,
5584 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
5585 let events = RefCell::new(Vec::new());
5586 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5587 let mut result = NotifyOption::SkipPersist;
5589 // TODO: This behavior should be documented. It's unintuitive that we query
5590 // ChannelMonitors when clearing other events.
5591 if self.process_pending_monitor_events() {
5592 result = NotifyOption::DoPersist;
5595 if self.check_free_holding_cells() {
5596 result = NotifyOption::DoPersist;
5598 if self.maybe_generate_initial_closing_signed() {
5599 result = NotifyOption::DoPersist;
5602 let mut pending_events = Vec::new();
5603 let mut channel_state = self.channel_state.lock().unwrap();
5604 mem::swap(&mut pending_events, &mut channel_state.pending_msg_events);
5606 if !pending_events.is_empty() {
5607 events.replace(pending_events);
5616 impl<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref> EventsProvider for ChannelManager<M, T, K, F, R, L>
5618 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
5619 T::Target: BroadcasterInterface,
5620 K::Target: KeysInterface,
5621 F::Target: FeeEstimator,
5625 /// Processes events that must be periodically handled.
5627 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
5628 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
5629 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
5630 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5631 let mut result = NotifyOption::SkipPersist;
5633 // TODO: This behavior should be documented. It's unintuitive that we query
5634 // ChannelMonitors when clearing other events.
5635 if self.process_pending_monitor_events() {
5636 result = NotifyOption::DoPersist;
5639 let pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5640 if !pending_events.is_empty() {
5641 result = NotifyOption::DoPersist;
5644 for event in pending_events {
5645 handler.handle_event(event);
5653 impl<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref> chain::Listen for ChannelManager<M, T, K, F, R, L>
5655 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
5656 T::Target: BroadcasterInterface,
5657 K::Target: KeysInterface,
5658 F::Target: FeeEstimator,
5662 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5664 let best_block = self.best_block.read().unwrap();
5665 assert_eq!(best_block.block_hash(), header.prev_blockhash,
5666 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
5667 assert_eq!(best_block.height(), height - 1,
5668 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
5671 self.transactions_confirmed(header, txdata, height);
5672 self.best_block_updated(header, height);
5675 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
5676 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5677 let new_height = height - 1;
5679 let mut best_block = self.best_block.write().unwrap();
5680 assert_eq!(best_block.block_hash(), header.block_hash(),
5681 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
5682 assert_eq!(best_block.height(), height,
5683 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
5684 *best_block = BestBlock::new(header.prev_blockhash, new_height)
5687 self.do_chain_event(Some(new_height), |channel| channel.best_block_updated(new_height, header.time, self.genesis_hash.clone(), self.get_our_node_id(), &self.logger));
5691 impl<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref> chain::Confirm for ChannelManager<M, T, K, F, R, L>
5693 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
5694 T::Target: BroadcasterInterface,
5695 K::Target: KeysInterface,
5696 F::Target: FeeEstimator,
5700 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5701 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5702 // during initialization prior to the chain_monitor being fully configured in some cases.
5703 // See the docs for `ChannelManagerReadArgs` for more.
5705 let block_hash = header.block_hash();
5706 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
5708 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5709 self.do_chain_event(Some(height), |channel| channel.transactions_confirmed(&block_hash, height, txdata, self.genesis_hash.clone(), self.get_our_node_id(), &self.logger)
5710 .map(|(a, b)| (a, Vec::new(), b)));
5712 let last_best_block_height = self.best_block.read().unwrap().height();
5713 if height < last_best_block_height {
5714 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
5715 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.get_our_node_id(), &self.logger));
5719 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
5720 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5721 // during initialization prior to the chain_monitor being fully configured in some cases.
5722 // See the docs for `ChannelManagerReadArgs` for more.
5724 let block_hash = header.block_hash();
5725 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
5727 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5729 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
5731 self.do_chain_event(Some(height), |channel| channel.best_block_updated(height, header.time, self.genesis_hash.clone(), self.get_our_node_id(), &self.logger));
5733 macro_rules! max_time {
5734 ($timestamp: expr) => {
5736 // Update $timestamp to be the max of its current value and the block
5737 // timestamp. This should keep us close to the current time without relying on
5738 // having an explicit local time source.
5739 // Just in case we end up in a race, we loop until we either successfully
5740 // update $timestamp or decide we don't need to.
5741 let old_serial = $timestamp.load(Ordering::Acquire);
5742 if old_serial >= header.time as usize { break; }
5743 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
5749 max_time!(self.highest_seen_timestamp);
5750 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5751 payment_secrets.retain(|_, inbound_payment| {
5752 inbound_payment.expiry_time > header.time as u64
5756 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
5757 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
5758 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
5759 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5760 let peer_state = &mut *peer_state_lock;
5761 for chan in peer_state.channel_by_id.values() {
5762 if let (Some(funding_txo), block_hash) = (chan.get_funding_txo(), chan.get_funding_tx_confirmed_in()) {
5763 res.push((funding_txo.txid, block_hash));
5770 fn transaction_unconfirmed(&self, txid: &Txid) {
5771 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5772 self.do_chain_event(None, |channel| {
5773 if let Some(funding_txo) = channel.get_funding_txo() {
5774 if funding_txo.txid == *txid {
5775 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
5776 } else { Ok((None, Vec::new(), None)) }
5777 } else { Ok((None, Vec::new(), None)) }
5782 impl<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref> ChannelManager<M, T, K, F, R, L>
5784 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
5785 T::Target: BroadcasterInterface,
5786 K::Target: KeysInterface,
5787 F::Target: FeeEstimator,
5791 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
5792 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
5794 fn do_chain_event<FN: Fn(&mut Channel<<K::Target as SignerProvider>::Signer>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
5795 (&self, height_opt: Option<u32>, f: FN) {
5796 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5797 // during initialization prior to the chain_monitor being fully configured in some cases.
5798 // See the docs for `ChannelManagerReadArgs` for more.
5800 let mut failed_channels = Vec::new();
5801 let mut timed_out_htlcs = Vec::new();
5803 let mut channel_lock = self.channel_state.lock().unwrap();
5804 let channel_state = &mut *channel_lock;
5805 let pending_msg_events = &mut channel_state.pending_msg_events;
5806 let per_peer_state = self.per_peer_state.read().unwrap();
5807 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5808 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5809 let peer_state = &mut *peer_state_lock;
5810 peer_state.channel_by_id.retain(|_, channel| {
5811 let res = f(channel);
5812 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
5813 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
5814 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
5815 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
5816 HTLCDestination::NextHopChannel { node_id: Some(channel.get_counterparty_node_id()), channel_id: channel.channel_id() }));
5818 if let Some(channel_ready) = channel_ready_opt {
5819 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
5820 if channel.is_usable() {
5821 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", log_bytes!(channel.channel_id()));
5822 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
5823 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
5824 node_id: channel.get_counterparty_node_id(),
5829 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", log_bytes!(channel.channel_id()));
5833 emit_channel_ready_event!(self, channel);
5835 if let Some(announcement_sigs) = announcement_sigs {
5836 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(channel.channel_id()));
5837 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5838 node_id: channel.get_counterparty_node_id(),
5839 msg: announcement_sigs,
5841 if let Some(height) = height_opt {
5842 if let Some(announcement) = channel.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash, height) {
5843 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5845 // Note that announcement_signatures fails if the channel cannot be announced,
5846 // so get_channel_update_for_broadcast will never fail by the time we get here.
5847 update_msg: self.get_channel_update_for_broadcast(channel).unwrap(),
5852 if channel.is_our_channel_ready() {
5853 if let Some(real_scid) = channel.get_short_channel_id() {
5854 // If we sent a 0conf channel_ready, and now have an SCID, we add it
5855 // to the short_to_chan_info map here. Note that we check whether we
5856 // can relay using the real SCID at relay-time (i.e.
5857 // enforce option_scid_alias then), and if the funding tx is ever
5858 // un-confirmed we force-close the channel, ensuring short_to_chan_info
5859 // is always consistent.
5860 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
5861 let scid_insert = short_to_chan_info.insert(real_scid, (channel.get_counterparty_node_id(), channel.channel_id()));
5862 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.get_counterparty_node_id(), channel.channel_id()),
5863 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
5864 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
5867 } else if let Err(reason) = res {
5868 update_maps_on_chan_removal!(self, channel);
5869 // It looks like our counterparty went on-chain or funding transaction was
5870 // reorged out of the main chain. Close the channel.
5871 failed_channels.push(channel.force_shutdown(true));
5872 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
5873 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5877 let reason_message = format!("{}", reason);
5878 self.issue_channel_close_events(channel, reason);
5879 pending_msg_events.push(events::MessageSendEvent::HandleError {
5880 node_id: channel.get_counterparty_node_id(),
5881 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
5882 channel_id: channel.channel_id(),
5883 data: reason_message,
5893 if let Some(height) = height_opt {
5894 self.claimable_payments.lock().unwrap().claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
5895 htlcs.retain(|htlc| {
5896 // If height is approaching the number of blocks we think it takes us to get
5897 // our commitment transaction confirmed before the HTLC expires, plus the
5898 // number of blocks we generally consider it to take to do a commitment update,
5899 // just give up on it and fail the HTLC.
5900 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
5901 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5902 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
5904 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
5905 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
5906 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
5910 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
5913 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
5914 intercepted_htlcs.retain(|_, htlc| {
5915 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
5916 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
5917 short_channel_id: htlc.prev_short_channel_id,
5918 htlc_id: htlc.prev_htlc_id,
5919 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
5920 phantom_shared_secret: None,
5921 outpoint: htlc.prev_funding_outpoint,
5924 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
5925 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
5926 _ => unreachable!(),
5928 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
5929 HTLCFailReason::from_failure_code(0x2000 | 2),
5930 HTLCDestination::InvalidForward { requested_forward_scid }));
5931 log_trace!(self.logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
5937 self.handle_init_event_channel_failures(failed_channels);
5939 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
5940 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
5944 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
5945 /// indicating whether persistence is necessary. Only one listener on
5946 /// [`await_persistable_update`], [`await_persistable_update_timeout`], or a future returned by
5947 /// [`get_persistable_update_future`] is guaranteed to be woken up.
5949 /// Note that this method is not available with the `no-std` feature.
5951 /// [`await_persistable_update`]: Self::await_persistable_update
5952 /// [`await_persistable_update_timeout`]: Self::await_persistable_update_timeout
5953 /// [`get_persistable_update_future`]: Self::get_persistable_update_future
5954 #[cfg(any(test, feature = "std"))]
5955 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
5956 self.persistence_notifier.wait_timeout(max_wait)
5959 /// Blocks until ChannelManager needs to be persisted. Only one listener on
5960 /// [`await_persistable_update`], `await_persistable_update_timeout`, or a future returned by
5961 /// [`get_persistable_update_future`] is guaranteed to be woken up.
5963 /// [`await_persistable_update`]: Self::await_persistable_update
5964 /// [`get_persistable_update_future`]: Self::get_persistable_update_future
5965 pub fn await_persistable_update(&self) {
5966 self.persistence_notifier.wait()
5969 /// Gets a [`Future`] that completes when a persistable update is available. Note that
5970 /// callbacks registered on the [`Future`] MUST NOT call back into this [`ChannelManager`] and
5971 /// should instead register actions to be taken later.
5972 pub fn get_persistable_update_future(&self) -> Future {
5973 self.persistence_notifier.get_future()
5976 #[cfg(any(test, feature = "_test_utils"))]
5977 pub fn get_persistence_condvar_value(&self) -> bool {
5978 self.persistence_notifier.notify_pending()
5981 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
5982 /// [`chain::Confirm`] interfaces.
5983 pub fn current_best_block(&self) -> BestBlock {
5984 self.best_block.read().unwrap().clone()
5988 impl<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref>
5989 ChannelMessageHandler for ChannelManager<M, T, K, F, R, L>
5991 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
5992 T::Target: BroadcasterInterface,
5993 K::Target: KeysInterface,
5994 F::Target: FeeEstimator,
5998 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
5999 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6000 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
6003 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
6004 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6005 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
6008 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
6009 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6010 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
6013 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
6014 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6015 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
6018 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
6019 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6020 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
6023 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) {
6024 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6025 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, their_features, msg), *counterparty_node_id);
6028 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
6029 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6030 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
6033 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
6034 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6035 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
6038 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
6039 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6040 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
6043 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
6044 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6045 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
6048 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
6049 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6050 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
6053 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
6054 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6055 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
6058 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
6059 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6060 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
6063 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
6064 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6065 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
6068 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
6069 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6070 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
6073 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
6074 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
6075 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
6078 NotifyOption::SkipPersist
6083 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
6084 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6085 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
6088 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
6089 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6090 let mut failed_channels = Vec::new();
6091 let mut no_channels_remain = true;
6092 let mut channel_state = self.channel_state.lock().unwrap();
6093 let mut per_peer_state = self.per_peer_state.write().unwrap();
6095 let pending_msg_events = &mut channel_state.pending_msg_events;
6096 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates. We believe we {} make future connections to this peer.",
6097 log_pubkey!(counterparty_node_id), if no_connection_possible { "cannot" } else { "can" });
6098 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
6099 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6100 let peer_state = &mut *peer_state_lock;
6101 peer_state.channel_by_id.retain(|_, chan| {
6102 if chan.get_counterparty_node_id() == *counterparty_node_id {
6103 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
6104 if chan.is_shutdown() {
6105 update_maps_on_chan_removal!(self, chan);
6106 self.issue_channel_close_events(chan, ClosureReason::DisconnectedPeer);
6109 no_channels_remain = false;
6115 pending_msg_events.retain(|msg| {
6117 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != counterparty_node_id,
6118 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != counterparty_node_id,
6119 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != counterparty_node_id,
6120 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != counterparty_node_id,
6121 &events::MessageSendEvent::SendChannelReady { ref node_id, .. } => node_id != counterparty_node_id,
6122 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != counterparty_node_id,
6123 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != counterparty_node_id,
6124 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != counterparty_node_id,
6125 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != counterparty_node_id,
6126 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != counterparty_node_id,
6127 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != counterparty_node_id,
6128 &events::MessageSendEvent::SendChannelAnnouncement { ref node_id, .. } => node_id != counterparty_node_id,
6129 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
6130 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
6131 &events::MessageSendEvent::SendChannelUpdate { ref node_id, .. } => node_id != counterparty_node_id,
6132 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != counterparty_node_id,
6133 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
6134 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
6135 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
6136 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
6139 mem::drop(channel_state);
6141 if no_channels_remain {
6142 per_peer_state.remove(counterparty_node_id);
6144 mem::drop(per_peer_state);
6146 for failure in failed_channels.drain(..) {
6147 self.finish_force_close_channel(failure);
6151 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) -> Result<(), ()> {
6152 if !init_msg.features.supports_static_remote_key() {
6153 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(counterparty_node_id));
6157 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
6159 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6162 let mut peer_state_lock = self.per_peer_state.write().unwrap();
6163 match peer_state_lock.entry(counterparty_node_id.clone()) {
6164 hash_map::Entry::Vacant(e) => {
6165 e.insert(Mutex::new(PeerState {
6166 channel_by_id: HashMap::new(),
6167 latest_features: init_msg.features.clone(),
6170 hash_map::Entry::Occupied(e) => {
6171 e.get().lock().unwrap().latest_features = init_msg.features.clone();
6176 let mut channel_state_lock = self.channel_state.lock().unwrap();
6177 let channel_state = &mut *channel_state_lock;
6178 let pending_msg_events = &mut channel_state.pending_msg_events;
6179 let per_peer_state = self.per_peer_state.read().unwrap();
6181 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6182 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6183 let peer_state = &mut *peer_state_lock;
6184 peer_state.channel_by_id.retain(|_, chan| {
6185 let retain = if chan.get_counterparty_node_id() == *counterparty_node_id {
6186 if !chan.have_received_message() {
6187 // If we created this (outbound) channel while we were disconnected from the
6188 // peer we probably failed to send the open_channel message, which is now
6189 // lost. We can't have had anything pending related to this channel, so we just
6193 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
6194 node_id: chan.get_counterparty_node_id(),
6195 msg: chan.get_channel_reestablish(&self.logger),
6200 if retain && chan.get_counterparty_node_id() != *counterparty_node_id {
6201 if let Some(msg) = chan.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height()) {
6202 if let Ok(update_msg) = self.get_channel_update_for_broadcast(chan) {
6203 pending_msg_events.push(events::MessageSendEvent::SendChannelAnnouncement {
6204 node_id: *counterparty_node_id,
6213 //TODO: Also re-broadcast announcement_signatures
6217 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
6218 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6220 if msg.channel_id == [0; 32] {
6221 for chan in self.list_channels() {
6222 if chan.counterparty.node_id == *counterparty_node_id {
6223 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6224 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data), true);
6229 // First check if we can advance the channel type and try again.
6230 let mut channel_state = self.channel_state.lock().unwrap();
6231 let per_peer_state = self.per_peer_state.read().unwrap();
6232 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
6233 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6234 let peer_state = &mut *peer_state_lock;
6235 if let Some(chan) = peer_state.channel_by_id.get_mut(&msg.channel_id) {
6236 if chan.get_counterparty_node_id() != *counterparty_node_id {
6239 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash) {
6240 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
6241 node_id: *counterparty_node_id,
6250 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6251 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
6255 fn provided_node_features(&self) -> NodeFeatures {
6256 provided_node_features()
6259 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
6260 provided_init_features()
6264 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
6265 /// [`ChannelManager`].
6266 pub fn provided_node_features() -> NodeFeatures {
6267 provided_init_features().to_context()
6270 /// Fetches the set of [`InvoiceFeatures`] flags which are provided by or required by
6271 /// [`ChannelManager`].
6273 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
6274 /// or not. Thus, this method is not public.
6275 #[cfg(any(feature = "_test_utils", test))]
6276 pub fn provided_invoice_features() -> InvoiceFeatures {
6277 provided_init_features().to_context()
6280 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
6281 /// [`ChannelManager`].
6282 pub fn provided_channel_features() -> ChannelFeatures {
6283 provided_init_features().to_context()
6286 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
6287 /// [`ChannelManager`].
6288 pub fn provided_init_features() -> InitFeatures {
6289 // Note that if new features are added here which other peers may (eventually) require, we
6290 // should also add the corresponding (optional) bit to the ChannelMessageHandler impl for
6291 // ErroringMessageHandler.
6292 let mut features = InitFeatures::empty();
6293 features.set_data_loss_protect_optional();
6294 features.set_upfront_shutdown_script_optional();
6295 features.set_variable_length_onion_required();
6296 features.set_static_remote_key_required();
6297 features.set_payment_secret_required();
6298 features.set_basic_mpp_optional();
6299 features.set_wumbo_optional();
6300 features.set_shutdown_any_segwit_optional();
6301 features.set_channel_type_optional();
6302 features.set_scid_privacy_optional();
6303 features.set_zero_conf_optional();
6307 const SERIALIZATION_VERSION: u8 = 1;
6308 const MIN_SERIALIZATION_VERSION: u8 = 1;
6310 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
6311 (2, fee_base_msat, required),
6312 (4, fee_proportional_millionths, required),
6313 (6, cltv_expiry_delta, required),
6316 impl_writeable_tlv_based!(ChannelCounterparty, {
6317 (2, node_id, required),
6318 (4, features, required),
6319 (6, unspendable_punishment_reserve, required),
6320 (8, forwarding_info, option),
6321 (9, outbound_htlc_minimum_msat, option),
6322 (11, outbound_htlc_maximum_msat, option),
6325 impl Writeable for ChannelDetails {
6326 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6327 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
6328 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
6329 let user_channel_id_low = self.user_channel_id as u64;
6330 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
6331 write_tlv_fields!(writer, {
6332 (1, self.inbound_scid_alias, option),
6333 (2, self.channel_id, required),
6334 (3, self.channel_type, option),
6335 (4, self.counterparty, required),
6336 (5, self.outbound_scid_alias, option),
6337 (6, self.funding_txo, option),
6338 (7, self.config, option),
6339 (8, self.short_channel_id, option),
6340 (9, self.confirmations, option),
6341 (10, self.channel_value_satoshis, required),
6342 (12, self.unspendable_punishment_reserve, option),
6343 (14, user_channel_id_low, required),
6344 (16, self.balance_msat, required),
6345 (18, self.outbound_capacity_msat, required),
6346 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6347 // filled in, so we can safely unwrap it here.
6348 (19, self.next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6349 (20, self.inbound_capacity_msat, required),
6350 (22, self.confirmations_required, option),
6351 (24, self.force_close_spend_delay, option),
6352 (26, self.is_outbound, required),
6353 (28, self.is_channel_ready, required),
6354 (30, self.is_usable, required),
6355 (32, self.is_public, required),
6356 (33, self.inbound_htlc_minimum_msat, option),
6357 (35, self.inbound_htlc_maximum_msat, option),
6358 (37, user_channel_id_high_opt, option),
6364 impl Readable for ChannelDetails {
6365 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6366 init_and_read_tlv_fields!(reader, {
6367 (1, inbound_scid_alias, option),
6368 (2, channel_id, required),
6369 (3, channel_type, option),
6370 (4, counterparty, required),
6371 (5, outbound_scid_alias, option),
6372 (6, funding_txo, option),
6373 (7, config, option),
6374 (8, short_channel_id, option),
6375 (9, confirmations, option),
6376 (10, channel_value_satoshis, required),
6377 (12, unspendable_punishment_reserve, option),
6378 (14, user_channel_id_low, required),
6379 (16, balance_msat, required),
6380 (18, outbound_capacity_msat, required),
6381 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6382 // filled in, so we can safely unwrap it here.
6383 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6384 (20, inbound_capacity_msat, required),
6385 (22, confirmations_required, option),
6386 (24, force_close_spend_delay, option),
6387 (26, is_outbound, required),
6388 (28, is_channel_ready, required),
6389 (30, is_usable, required),
6390 (32, is_public, required),
6391 (33, inbound_htlc_minimum_msat, option),
6392 (35, inbound_htlc_maximum_msat, option),
6393 (37, user_channel_id_high_opt, option),
6396 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
6397 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
6398 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
6399 let user_channel_id = user_channel_id_low as u128 +
6400 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
6404 channel_id: channel_id.0.unwrap(),
6406 counterparty: counterparty.0.unwrap(),
6407 outbound_scid_alias,
6411 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
6412 unspendable_punishment_reserve,
6414 balance_msat: balance_msat.0.unwrap(),
6415 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
6416 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
6417 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
6418 confirmations_required,
6420 force_close_spend_delay,
6421 is_outbound: is_outbound.0.unwrap(),
6422 is_channel_ready: is_channel_ready.0.unwrap(),
6423 is_usable: is_usable.0.unwrap(),
6424 is_public: is_public.0.unwrap(),
6425 inbound_htlc_minimum_msat,
6426 inbound_htlc_maximum_msat,
6431 impl_writeable_tlv_based!(PhantomRouteHints, {
6432 (2, channels, vec_type),
6433 (4, phantom_scid, required),
6434 (6, real_node_pubkey, required),
6437 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
6439 (0, onion_packet, required),
6440 (2, short_channel_id, required),
6443 (0, payment_data, required),
6444 (1, phantom_shared_secret, option),
6445 (2, incoming_cltv_expiry, required),
6447 (2, ReceiveKeysend) => {
6448 (0, payment_preimage, required),
6449 (2, incoming_cltv_expiry, required),
6453 impl_writeable_tlv_based!(PendingHTLCInfo, {
6454 (0, routing, required),
6455 (2, incoming_shared_secret, required),
6456 (4, payment_hash, required),
6457 (6, outgoing_amt_msat, required),
6458 (8, outgoing_cltv_value, required),
6459 (9, incoming_amt_msat, option),
6463 impl Writeable for HTLCFailureMsg {
6464 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6466 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
6468 channel_id.write(writer)?;
6469 htlc_id.write(writer)?;
6470 reason.write(writer)?;
6472 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6473 channel_id, htlc_id, sha256_of_onion, failure_code
6476 channel_id.write(writer)?;
6477 htlc_id.write(writer)?;
6478 sha256_of_onion.write(writer)?;
6479 failure_code.write(writer)?;
6486 impl Readable for HTLCFailureMsg {
6487 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6488 let id: u8 = Readable::read(reader)?;
6491 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
6492 channel_id: Readable::read(reader)?,
6493 htlc_id: Readable::read(reader)?,
6494 reason: Readable::read(reader)?,
6498 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6499 channel_id: Readable::read(reader)?,
6500 htlc_id: Readable::read(reader)?,
6501 sha256_of_onion: Readable::read(reader)?,
6502 failure_code: Readable::read(reader)?,
6505 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
6506 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
6507 // messages contained in the variants.
6508 // In version 0.0.101, support for reading the variants with these types was added, and
6509 // we should migrate to writing these variants when UpdateFailHTLC or
6510 // UpdateFailMalformedHTLC get TLV fields.
6512 let length: BigSize = Readable::read(reader)?;
6513 let mut s = FixedLengthReader::new(reader, length.0);
6514 let res = Readable::read(&mut s)?;
6515 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6516 Ok(HTLCFailureMsg::Relay(res))
6519 let length: BigSize = Readable::read(reader)?;
6520 let mut s = FixedLengthReader::new(reader, length.0);
6521 let res = Readable::read(&mut s)?;
6522 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6523 Ok(HTLCFailureMsg::Malformed(res))
6525 _ => Err(DecodeError::UnknownRequiredFeature),
6530 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
6535 impl_writeable_tlv_based!(HTLCPreviousHopData, {
6536 (0, short_channel_id, required),
6537 (1, phantom_shared_secret, option),
6538 (2, outpoint, required),
6539 (4, htlc_id, required),
6540 (6, incoming_packet_shared_secret, required)
6543 impl Writeable for ClaimableHTLC {
6544 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6545 let (payment_data, keysend_preimage) = match &self.onion_payload {
6546 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
6547 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
6549 write_tlv_fields!(writer, {
6550 (0, self.prev_hop, required),
6551 (1, self.total_msat, required),
6552 (2, self.value, required),
6553 (4, payment_data, option),
6554 (6, self.cltv_expiry, required),
6555 (8, keysend_preimage, option),
6561 impl Readable for ClaimableHTLC {
6562 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6563 let mut prev_hop = crate::util::ser::OptionDeserWrapper(None);
6565 let mut payment_data: Option<msgs::FinalOnionHopData> = None;
6566 let mut cltv_expiry = 0;
6567 let mut total_msat = None;
6568 let mut keysend_preimage: Option<PaymentPreimage> = None;
6569 read_tlv_fields!(reader, {
6570 (0, prev_hop, required),
6571 (1, total_msat, option),
6572 (2, value, required),
6573 (4, payment_data, option),
6574 (6, cltv_expiry, required),
6575 (8, keysend_preimage, option)
6577 let onion_payload = match keysend_preimage {
6579 if payment_data.is_some() {
6580 return Err(DecodeError::InvalidValue)
6582 if total_msat.is_none() {
6583 total_msat = Some(value);
6585 OnionPayload::Spontaneous(p)
6588 if total_msat.is_none() {
6589 if payment_data.is_none() {
6590 return Err(DecodeError::InvalidValue)
6592 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
6594 OnionPayload::Invoice { _legacy_hop_data: payment_data }
6598 prev_hop: prev_hop.0.unwrap(),
6601 total_msat: total_msat.unwrap(),
6608 impl Readable for HTLCSource {
6609 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6610 let id: u8 = Readable::read(reader)?;
6613 let mut session_priv: crate::util::ser::OptionDeserWrapper<SecretKey> = crate::util::ser::OptionDeserWrapper(None);
6614 let mut first_hop_htlc_msat: u64 = 0;
6615 let mut path = Some(Vec::new());
6616 let mut payment_id = None;
6617 let mut payment_secret = None;
6618 let mut payment_params = None;
6619 read_tlv_fields!(reader, {
6620 (0, session_priv, required),
6621 (1, payment_id, option),
6622 (2, first_hop_htlc_msat, required),
6623 (3, payment_secret, option),
6624 (4, path, vec_type),
6625 (5, payment_params, option),
6627 if payment_id.is_none() {
6628 // For backwards compat, if there was no payment_id written, use the session_priv bytes
6630 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
6632 Ok(HTLCSource::OutboundRoute {
6633 session_priv: session_priv.0.unwrap(),
6634 first_hop_htlc_msat,
6635 path: path.unwrap(),
6636 payment_id: payment_id.unwrap(),
6641 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
6642 _ => Err(DecodeError::UnknownRequiredFeature),
6647 impl Writeable for HTLCSource {
6648 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
6650 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id, payment_secret, payment_params } => {
6652 let payment_id_opt = Some(payment_id);
6653 write_tlv_fields!(writer, {
6654 (0, session_priv, required),
6655 (1, payment_id_opt, option),
6656 (2, first_hop_htlc_msat, required),
6657 (3, payment_secret, option),
6658 (4, *path, vec_type),
6659 (5, payment_params, option),
6662 HTLCSource::PreviousHopData(ref field) => {
6664 field.write(writer)?;
6671 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
6672 (0, forward_info, required),
6673 (1, prev_user_channel_id, (default_value, 0)),
6674 (2, prev_short_channel_id, required),
6675 (4, prev_htlc_id, required),
6676 (6, prev_funding_outpoint, required),
6679 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
6681 (0, htlc_id, required),
6682 (2, err_packet, required),
6687 impl_writeable_tlv_based!(PendingInboundPayment, {
6688 (0, payment_secret, required),
6689 (2, expiry_time, required),
6690 (4, user_payment_id, required),
6691 (6, payment_preimage, required),
6692 (8, min_value_msat, required),
6695 impl<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref> Writeable for ChannelManager<M, T, K, F, R, L>
6697 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
6698 T::Target: BroadcasterInterface,
6699 K::Target: KeysInterface,
6700 F::Target: FeeEstimator,
6704 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6705 let _consistency_lock = self.total_consistency_lock.write().unwrap();
6707 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
6709 self.genesis_hash.write(writer)?;
6711 let best_block = self.best_block.read().unwrap();
6712 best_block.height().write(writer)?;
6713 best_block.block_hash().write(writer)?;
6717 let per_peer_state = self.per_peer_state.read().unwrap();
6718 let mut unfunded_channels = 0;
6719 let mut number_of_channels = 0;
6720 for (_, peer_state_mutex) in per_peer_state.iter() {
6721 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6722 let peer_state = &mut *peer_state_lock;
6723 number_of_channels += peer_state.channel_by_id.len();
6724 for (_, channel) in peer_state.channel_by_id.iter() {
6725 if !channel.is_funding_initiated() {
6726 unfunded_channels += 1;
6731 ((number_of_channels - unfunded_channels) as u64).write(writer)?;
6733 for (_, peer_state_mutex) in per_peer_state.iter() {
6734 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6735 let peer_state = &mut *peer_state_lock;
6736 for (_, channel) in peer_state.channel_by_id.iter() {
6737 if channel.is_funding_initiated() {
6738 channel.write(writer)?;
6745 let forward_htlcs = self.forward_htlcs.lock().unwrap();
6746 (forward_htlcs.len() as u64).write(writer)?;
6747 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
6748 short_channel_id.write(writer)?;
6749 (pending_forwards.len() as u64).write(writer)?;
6750 for forward in pending_forwards {
6751 forward.write(writer)?;
6756 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
6757 let claimable_payments = self.claimable_payments.lock().unwrap();
6758 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
6760 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
6761 (claimable_payments.claimable_htlcs.len() as u64).write(writer)?;
6762 for (payment_hash, (purpose, previous_hops)) in claimable_payments.claimable_htlcs.iter() {
6763 payment_hash.write(writer)?;
6764 (previous_hops.len() as u64).write(writer)?;
6765 for htlc in previous_hops.iter() {
6766 htlc.write(writer)?;
6768 htlc_purposes.push(purpose);
6771 let per_peer_state = self.per_peer_state.write().unwrap();
6772 (per_peer_state.len() as u64).write(writer)?;
6773 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
6774 peer_pubkey.write(writer)?;
6775 let peer_state = peer_state_mutex.lock().unwrap();
6776 peer_state.latest_features.write(writer)?;
6779 let events = self.pending_events.lock().unwrap();
6780 (events.len() as u64).write(writer)?;
6781 for event in events.iter() {
6782 event.write(writer)?;
6785 let background_events = self.pending_background_events.lock().unwrap();
6786 (background_events.len() as u64).write(writer)?;
6787 for event in background_events.iter() {
6789 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
6791 funding_txo.write(writer)?;
6792 monitor_update.write(writer)?;
6797 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
6798 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
6799 // likely to be identical.
6800 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
6801 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
6803 (pending_inbound_payments.len() as u64).write(writer)?;
6804 for (hash, pending_payment) in pending_inbound_payments.iter() {
6805 hash.write(writer)?;
6806 pending_payment.write(writer)?;
6809 // For backwards compat, write the session privs and their total length.
6810 let mut num_pending_outbounds_compat: u64 = 0;
6811 for (_, outbound) in pending_outbound_payments.iter() {
6812 if !outbound.is_fulfilled() && !outbound.abandoned() {
6813 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
6816 num_pending_outbounds_compat.write(writer)?;
6817 for (_, outbound) in pending_outbound_payments.iter() {
6819 PendingOutboundPayment::Legacy { session_privs } |
6820 PendingOutboundPayment::Retryable { session_privs, .. } => {
6821 for session_priv in session_privs.iter() {
6822 session_priv.write(writer)?;
6825 PendingOutboundPayment::Fulfilled { .. } => {},
6826 PendingOutboundPayment::Abandoned { .. } => {},
6830 // Encode without retry info for 0.0.101 compatibility.
6831 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
6832 for (id, outbound) in pending_outbound_payments.iter() {
6834 PendingOutboundPayment::Legacy { session_privs } |
6835 PendingOutboundPayment::Retryable { session_privs, .. } => {
6836 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
6842 let mut pending_intercepted_htlcs = None;
6843 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
6844 if our_pending_intercepts.len() != 0 {
6845 pending_intercepted_htlcs = Some(our_pending_intercepts);
6848 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
6849 if pending_claiming_payments.as_ref().unwrap().is_empty() {
6850 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
6851 // map. Thus, if there are no entries we skip writing a TLV for it.
6852 pending_claiming_payments = None;
6854 debug_assert!(false, "While we have code to serialize pending_claiming_payments, the map should always be empty until a later PR");
6857 write_tlv_fields!(writer, {
6858 (1, pending_outbound_payments_no_retry, required),
6859 (2, pending_intercepted_htlcs, option),
6860 (3, pending_outbound_payments, required),
6861 (4, pending_claiming_payments, option),
6862 (5, self.our_network_pubkey, required),
6863 (7, self.fake_scid_rand_bytes, required),
6864 (9, htlc_purposes, vec_type),
6865 (11, self.probing_cookie_secret, required),
6872 /// Arguments for the creation of a ChannelManager that are not deserialized.
6874 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
6876 /// 1) Deserialize all stored [`ChannelMonitor`]s.
6877 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
6878 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
6879 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
6880 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
6881 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
6882 /// same way you would handle a [`chain::Filter`] call using
6883 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
6884 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
6885 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
6886 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
6887 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
6888 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
6890 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
6891 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
6893 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
6894 /// call any other methods on the newly-deserialized [`ChannelManager`].
6896 /// Note that because some channels may be closed during deserialization, it is critical that you
6897 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
6898 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
6899 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
6900 /// not force-close the same channels but consider them live), you may end up revoking a state for
6901 /// which you've already broadcasted the transaction.
6903 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
6904 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref>
6906 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
6907 T::Target: BroadcasterInterface,
6908 K::Target: KeysInterface,
6909 F::Target: FeeEstimator,
6913 /// The keys provider which will give us relevant keys. Some keys will be loaded during
6914 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
6916 pub keys_manager: K,
6918 /// The fee_estimator for use in the ChannelManager in the future.
6920 /// No calls to the FeeEstimator will be made during deserialization.
6921 pub fee_estimator: F,
6922 /// The chain::Watch for use in the ChannelManager in the future.
6924 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
6925 /// you have deserialized ChannelMonitors separately and will add them to your
6926 /// chain::Watch after deserializing this ChannelManager.
6927 pub chain_monitor: M,
6929 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
6930 /// used to broadcast the latest local commitment transactions of channels which must be
6931 /// force-closed during deserialization.
6932 pub tx_broadcaster: T,
6933 /// The router which will be used in the ChannelManager in the future for finding routes
6934 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
6936 /// No calls to the router will be made during deserialization.
6938 /// The Logger for use in the ChannelManager and which may be used to log information during
6939 /// deserialization.
6941 /// Default settings used for new channels. Any existing channels will continue to use the
6942 /// runtime settings which were stored when the ChannelManager was serialized.
6943 pub default_config: UserConfig,
6945 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
6946 /// value.get_funding_txo() should be the key).
6948 /// If a monitor is inconsistent with the channel state during deserialization the channel will
6949 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
6950 /// is true for missing channels as well. If there is a monitor missing for which we find
6951 /// channel data Err(DecodeError::InvalidValue) will be returned.
6953 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
6956 /// (C-not exported) because we have no HashMap bindings
6957 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<K::Target as SignerProvider>::Signer>>,
6960 impl<'a, M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref>
6961 ChannelManagerReadArgs<'a, M, T, K, F, R, L>
6963 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
6964 T::Target: BroadcasterInterface,
6965 K::Target: KeysInterface,
6966 F::Target: FeeEstimator,
6970 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
6971 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
6972 /// populate a HashMap directly from C.
6973 pub fn new(keys_manager: K, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, default_config: UserConfig,
6974 mut channel_monitors: Vec<&'a mut ChannelMonitor<<K::Target as SignerProvider>::Signer>>) -> Self {
6976 keys_manager, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
6977 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
6982 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
6983 // SipmleArcChannelManager type:
6984 impl<'a, M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref>
6985 ReadableArgs<ChannelManagerReadArgs<'a, M, T, K, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, K, F, R, L>>)
6987 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
6988 T::Target: BroadcasterInterface,
6989 K::Target: KeysInterface,
6990 F::Target: FeeEstimator,
6994 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, K, F, R, L>) -> Result<Self, DecodeError> {
6995 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, K, F, R, L>)>::read(reader, args)?;
6996 Ok((blockhash, Arc::new(chan_manager)))
7000 impl<'a, M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref>
7001 ReadableArgs<ChannelManagerReadArgs<'a, M, T, K, F, R, L>> for (BlockHash, ChannelManager<M, T, K, F, R, L>)
7003 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
7004 T::Target: BroadcasterInterface,
7005 K::Target: KeysInterface,
7006 F::Target: FeeEstimator,
7010 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, K, F, R, L>) -> Result<Self, DecodeError> {
7011 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
7013 let genesis_hash: BlockHash = Readable::read(reader)?;
7014 let best_block_height: u32 = Readable::read(reader)?;
7015 let best_block_hash: BlockHash = Readable::read(reader)?;
7017 let mut failed_htlcs = Vec::new();
7019 let channel_count: u64 = Readable::read(reader)?;
7020 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
7021 let mut peer_channels: HashMap<PublicKey, HashMap<[u8; 32], Channel<<K::Target as SignerProvider>::Signer>>> = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7022 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7023 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7024 let mut channel_closures = Vec::new();
7025 for _ in 0..channel_count {
7026 let mut channel: Channel<<K::Target as SignerProvider>::Signer> = Channel::read(reader, (&args.keys_manager, best_block_height))?;
7027 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
7028 funding_txo_set.insert(funding_txo.clone());
7029 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
7030 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
7031 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
7032 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
7033 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
7034 // If the channel is ahead of the monitor, return InvalidValue:
7035 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
7036 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
7037 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
7038 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
7039 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
7040 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
7041 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");
7042 return Err(DecodeError::InvalidValue);
7043 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
7044 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
7045 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
7046 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
7047 // But if the channel is behind of the monitor, close the channel:
7048 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
7049 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
7050 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
7051 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
7052 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
7053 failed_htlcs.append(&mut new_failed_htlcs);
7054 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
7055 channel_closures.push(events::Event::ChannelClosed {
7056 channel_id: channel.channel_id(),
7057 user_channel_id: channel.get_user_id(),
7058 reason: ClosureReason::OutdatedChannelManager
7060 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
7061 let mut found_htlc = false;
7062 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
7063 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
7066 // If we have some HTLCs in the channel which are not present in the newer
7067 // ChannelMonitor, they have been removed and should be failed back to
7068 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
7069 // were actually claimed we'd have generated and ensured the previous-hop
7070 // claim update ChannelMonitor updates were persisted prior to persising
7071 // the ChannelMonitor update for the forward leg, so attempting to fail the
7072 // backwards leg of the HTLC will simply be rejected.
7073 log_info!(args.logger,
7074 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
7075 log_bytes!(channel.channel_id()), log_bytes!(payment_hash.0));
7076 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.get_counterparty_node_id(), channel.channel_id()));
7080 log_info!(args.logger, "Successfully loaded channel {}", log_bytes!(channel.channel_id()));
7081 if let Some(short_channel_id) = channel.get_short_channel_id() {
7082 short_to_chan_info.insert(short_channel_id, (channel.get_counterparty_node_id(), channel.channel_id()));
7084 if channel.is_funding_initiated() {
7085 id_to_peer.insert(channel.channel_id(), channel.get_counterparty_node_id());
7087 match peer_channels.entry(channel.get_counterparty_node_id()) {
7088 hash_map::Entry::Occupied(mut entry) => {
7089 let by_id_map = entry.get_mut();
7090 by_id_map.insert(channel.channel_id(), channel);
7092 hash_map::Entry::Vacant(entry) => {
7093 let mut by_id_map = HashMap::new();
7094 by_id_map.insert(channel.channel_id(), channel);
7095 entry.insert(by_id_map);
7099 } else if channel.is_awaiting_initial_mon_persist() {
7100 // If we were persisted and shut down while the initial ChannelMonitor persistence
7101 // was in-progress, we never broadcasted the funding transaction and can still
7102 // safely discard the channel.
7103 let _ = channel.force_shutdown(false);
7104 channel_closures.push(events::Event::ChannelClosed {
7105 channel_id: channel.channel_id(),
7106 user_channel_id: channel.get_user_id(),
7107 reason: ClosureReason::DisconnectedPeer,
7110 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.channel_id()));
7111 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
7112 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
7113 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
7114 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");
7115 return Err(DecodeError::InvalidValue);
7119 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
7120 if !funding_txo_set.contains(funding_txo) {
7121 log_info!(args.logger, "Broadcasting latest holder commitment transaction for closed channel {}", log_bytes!(funding_txo.to_channel_id()));
7122 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
7126 const MAX_ALLOC_SIZE: usize = 1024 * 64;
7127 let forward_htlcs_count: u64 = Readable::read(reader)?;
7128 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
7129 for _ in 0..forward_htlcs_count {
7130 let short_channel_id = Readable::read(reader)?;
7131 let pending_forwards_count: u64 = Readable::read(reader)?;
7132 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
7133 for _ in 0..pending_forwards_count {
7134 pending_forwards.push(Readable::read(reader)?);
7136 forward_htlcs.insert(short_channel_id, pending_forwards);
7139 let claimable_htlcs_count: u64 = Readable::read(reader)?;
7140 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
7141 for _ in 0..claimable_htlcs_count {
7142 let payment_hash = Readable::read(reader)?;
7143 let previous_hops_len: u64 = Readable::read(reader)?;
7144 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
7145 for _ in 0..previous_hops_len {
7146 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
7148 claimable_htlcs_list.push((payment_hash, previous_hops));
7151 let peer_count: u64 = Readable::read(reader)?;
7152 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<<K::Target as SignerProvider>::Signer>>)>()));
7153 for _ in 0..peer_count {
7154 let peer_pubkey = Readable::read(reader)?;
7155 let peer_state = PeerState {
7156 channel_by_id: peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new()),
7157 latest_features: Readable::read(reader)?,
7159 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
7162 let event_count: u64 = Readable::read(reader)?;
7163 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>()));
7164 for _ in 0..event_count {
7165 match MaybeReadable::read(reader)? {
7166 Some(event) => pending_events_read.push(event),
7171 let background_event_count: u64 = Readable::read(reader)?;
7172 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>()));
7173 for _ in 0..background_event_count {
7174 match <u8 as Readable>::read(reader)? {
7175 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
7176 _ => return Err(DecodeError::InvalidValue),
7180 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
7181 let highest_seen_timestamp: u32 = Readable::read(reader)?;
7183 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
7184 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
7185 for _ in 0..pending_inbound_payment_count {
7186 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
7187 return Err(DecodeError::InvalidValue);
7191 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
7192 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
7193 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
7194 for _ in 0..pending_outbound_payments_count_compat {
7195 let session_priv = Readable::read(reader)?;
7196 let payment = PendingOutboundPayment::Legacy {
7197 session_privs: [session_priv].iter().cloned().collect()
7199 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
7200 return Err(DecodeError::InvalidValue)
7204 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
7205 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
7206 let mut pending_outbound_payments = None;
7207 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
7208 let mut received_network_pubkey: Option<PublicKey> = None;
7209 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
7210 let mut probing_cookie_secret: Option<[u8; 32]> = None;
7211 let mut claimable_htlc_purposes = None;
7212 let mut pending_claiming_payments = Some(HashMap::new());
7213 read_tlv_fields!(reader, {
7214 (1, pending_outbound_payments_no_retry, option),
7215 (2, pending_intercepted_htlcs, option),
7216 (3, pending_outbound_payments, option),
7217 (4, pending_claiming_payments, option),
7218 (5, received_network_pubkey, option),
7219 (7, fake_scid_rand_bytes, option),
7220 (9, claimable_htlc_purposes, vec_type),
7221 (11, probing_cookie_secret, option),
7223 if fake_scid_rand_bytes.is_none() {
7224 fake_scid_rand_bytes = Some(args.keys_manager.get_secure_random_bytes());
7227 if probing_cookie_secret.is_none() {
7228 probing_cookie_secret = Some(args.keys_manager.get_secure_random_bytes());
7231 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
7232 pending_outbound_payments = Some(pending_outbound_payments_compat);
7233 } else if pending_outbound_payments.is_none() {
7234 let mut outbounds = HashMap::new();
7235 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
7236 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
7238 pending_outbound_payments = Some(outbounds);
7240 // If we're tracking pending payments, ensure we haven't lost any by looking at the
7241 // ChannelMonitor data for any channels for which we do not have authorative state
7242 // (i.e. those for which we just force-closed above or we otherwise don't have a
7243 // corresponding `Channel` at all).
7244 // This avoids several edge-cases where we would otherwise "forget" about pending
7245 // payments which are still in-flight via their on-chain state.
7246 // We only rebuild the pending payments map if we were most recently serialized by
7248 for (_, monitor) in args.channel_monitors.iter() {
7249 if id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id()).is_none() {
7250 for (htlc_source, htlc) in monitor.get_pending_outbound_htlcs() {
7251 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, payment_secret, .. } = htlc_source {
7252 if path.is_empty() {
7253 log_error!(args.logger, "Got an empty path for a pending payment");
7254 return Err(DecodeError::InvalidValue);
7256 let path_amt = path.last().unwrap().fee_msat;
7257 let mut session_priv_bytes = [0; 32];
7258 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
7259 match pending_outbound_payments.as_mut().unwrap().entry(payment_id) {
7260 hash_map::Entry::Occupied(mut entry) => {
7261 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
7262 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
7263 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), log_bytes!(htlc.payment_hash.0));
7265 hash_map::Entry::Vacant(entry) => {
7266 let path_fee = path.get_path_fees();
7267 entry.insert(PendingOutboundPayment::Retryable {
7268 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
7269 payment_hash: htlc.payment_hash,
7271 pending_amt_msat: path_amt,
7272 pending_fee_msat: Some(path_fee),
7273 total_msat: path_amt,
7274 starting_block_height: best_block_height,
7276 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
7277 path_amt, log_bytes!(htlc.payment_hash.0), log_bytes!(session_priv_bytes));
7282 for (htlc_source, htlc) in monitor.get_all_current_outbound_htlcs() {
7283 if let HTLCSource::PreviousHopData(prev_hop_data) = htlc_source {
7284 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
7285 info.prev_funding_outpoint == prev_hop_data.outpoint &&
7286 info.prev_htlc_id == prev_hop_data.htlc_id
7288 // The ChannelMonitor is now responsible for this HTLC's
7289 // failure/success and will let us know what its outcome is. If we
7290 // still have an entry for this HTLC in `forward_htlcs` or
7291 // `pending_intercepted_htlcs`, we were apparently not persisted after
7292 // the monitor was when forwarding the payment.
7293 forward_htlcs.retain(|_, forwards| {
7294 forwards.retain(|forward| {
7295 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
7296 if pending_forward_matches_htlc(&htlc_info) {
7297 log_info!(args.logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
7298 log_bytes!(htlc.payment_hash.0), log_bytes!(monitor.get_funding_txo().0.to_channel_id()));
7303 !forwards.is_empty()
7305 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
7306 if pending_forward_matches_htlc(&htlc_info) {
7307 log_info!(args.logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
7308 log_bytes!(htlc.payment_hash.0), log_bytes!(monitor.get_funding_txo().0.to_channel_id()));
7309 pending_events_read.retain(|event| {
7310 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
7311 intercepted_id != ev_id
7323 if !forward_htlcs.is_empty() {
7324 // If we have pending HTLCs to forward, assume we either dropped a
7325 // `PendingHTLCsForwardable` or the user received it but never processed it as they
7326 // shut down before the timer hit. Either way, set the time_forwardable to a small
7327 // constant as enough time has likely passed that we should simply handle the forwards
7328 // now, or at least after the user gets a chance to reconnect to our peers.
7329 pending_events_read.push(events::Event::PendingHTLCsForwardable {
7330 time_forwardable: Duration::from_secs(2),
7334 let inbound_pmt_key_material = args.keys_manager.get_inbound_payment_key_material();
7335 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
7337 let mut claimable_htlcs = HashMap::with_capacity(claimable_htlcs_list.len());
7338 if let Some(mut purposes) = claimable_htlc_purposes {
7339 if purposes.len() != claimable_htlcs_list.len() {
7340 return Err(DecodeError::InvalidValue);
7342 for (purpose, (payment_hash, previous_hops)) in purposes.drain(..).zip(claimable_htlcs_list.drain(..)) {
7343 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7346 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
7347 // include a `_legacy_hop_data` in the `OnionPayload`.
7348 for (payment_hash, previous_hops) in claimable_htlcs_list.drain(..) {
7349 if previous_hops.is_empty() {
7350 return Err(DecodeError::InvalidValue);
7352 let purpose = match &previous_hops[0].onion_payload {
7353 OnionPayload::Invoice { _legacy_hop_data } => {
7354 if let Some(hop_data) = _legacy_hop_data {
7355 events::PaymentPurpose::InvoicePayment {
7356 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
7357 Some(inbound_payment) => inbound_payment.payment_preimage,
7358 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
7359 Ok(payment_preimage) => payment_preimage,
7361 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));
7362 return Err(DecodeError::InvalidValue);
7366 payment_secret: hop_data.payment_secret,
7368 } else { return Err(DecodeError::InvalidValue); }
7370 OnionPayload::Spontaneous(payment_preimage) =>
7371 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
7373 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7377 let mut secp_ctx = Secp256k1::new();
7378 secp_ctx.seeded_randomize(&args.keys_manager.get_secure_random_bytes());
7380 if !channel_closures.is_empty() {
7381 pending_events_read.append(&mut channel_closures);
7384 let our_network_key = match args.keys_manager.get_node_secret(Recipient::Node) {
7386 Err(()) => return Err(DecodeError::InvalidValue)
7388 let our_network_pubkey = PublicKey::from_secret_key(&secp_ctx, &our_network_key);
7389 if let Some(network_pubkey) = received_network_pubkey {
7390 if network_pubkey != our_network_pubkey {
7391 log_error!(args.logger, "Key that was generated does not match the existing key.");
7392 return Err(DecodeError::InvalidValue);
7396 let mut outbound_scid_aliases = HashSet::new();
7397 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
7398 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7399 let peer_state = &mut *peer_state_lock;
7400 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
7401 if chan.outbound_scid_alias() == 0 {
7402 let mut outbound_scid_alias;
7404 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
7405 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.keys_manager);
7406 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
7408 chan.set_outbound_scid_alias(outbound_scid_alias);
7409 } else if !outbound_scid_aliases.insert(chan.outbound_scid_alias()) {
7410 // Note that in rare cases its possible to hit this while reading an older
7411 // channel if we just happened to pick a colliding outbound alias above.
7412 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7413 return Err(DecodeError::InvalidValue);
7415 if chan.is_usable() {
7416 if short_to_chan_info.insert(chan.outbound_scid_alias(), (chan.get_counterparty_node_id(), *chan_id)).is_some() {
7417 // Note that in rare cases its possible to hit this while reading an older
7418 // channel if we just happened to pick a colliding outbound alias above.
7419 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7420 return Err(DecodeError::InvalidValue);
7426 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
7428 for (_, monitor) in args.channel_monitors.iter() {
7429 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
7430 if let Some((payment_purpose, claimable_htlcs)) = claimable_htlcs.remove(&payment_hash) {
7431 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", log_bytes!(payment_hash.0));
7432 let mut claimable_amt_msat = 0;
7433 let mut receiver_node_id = Some(our_network_pubkey);
7434 let phantom_shared_secret = claimable_htlcs[0].prev_hop.phantom_shared_secret;
7435 if phantom_shared_secret.is_some() {
7436 let phantom_pubkey = args.keys_manager.get_node_id(Recipient::PhantomNode)
7437 .expect("Failed to get node_id for phantom node recipient");
7438 receiver_node_id = Some(phantom_pubkey)
7440 for claimable_htlc in claimable_htlcs {
7441 claimable_amt_msat += claimable_htlc.value;
7443 // Add a holding-cell claim of the payment to the Channel, which should be
7444 // applied ~immediately on peer reconnection. Because it won't generate a
7445 // new commitment transaction we can just provide the payment preimage to
7446 // the corresponding ChannelMonitor and nothing else.
7448 // We do so directly instead of via the normal ChannelMonitor update
7449 // procedure as the ChainMonitor hasn't yet been initialized, implying
7450 // we're not allowed to call it directly yet. Further, we do the update
7451 // without incrementing the ChannelMonitor update ID as there isn't any
7453 // If we were to generate a new ChannelMonitor update ID here and then
7454 // crash before the user finishes block connect we'd end up force-closing
7455 // this channel as well. On the flip side, there's no harm in restarting
7456 // without the new monitor persisted - we'll end up right back here on
7458 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
7459 if let Some(peer_node_id) = id_to_peer.get(&previous_channel_id){
7460 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
7461 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7462 let peer_state = &mut *peer_state_lock;
7463 if let Some(channel) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
7464 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
7467 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
7468 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
7471 pending_events_read.push(events::Event::PaymentClaimed {
7474 purpose: payment_purpose,
7475 amount_msat: claimable_amt_msat,
7481 let channel_manager = ChannelManager {
7483 fee_estimator: bounded_fee_estimator,
7484 chain_monitor: args.chain_monitor,
7485 tx_broadcaster: args.tx_broadcaster,
7486 router: args.router,
7488 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
7490 channel_state: Mutex::new(ChannelHolder {
7491 pending_msg_events: Vec::new(),
7493 inbound_payment_key: expanded_inbound_key,
7494 pending_inbound_payments: Mutex::new(pending_inbound_payments),
7495 pending_outbound_payments: OutboundPayments { pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()) },
7496 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
7498 forward_htlcs: Mutex::new(forward_htlcs),
7499 claimable_payments: Mutex::new(ClaimablePayments { claimable_htlcs, pending_claiming_payments: pending_claiming_payments.unwrap() }),
7500 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
7501 id_to_peer: Mutex::new(id_to_peer),
7502 short_to_chan_info: FairRwLock::new(short_to_chan_info),
7503 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
7505 probing_cookie_secret: probing_cookie_secret.unwrap(),
7511 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
7513 per_peer_state: FairRwLock::new(per_peer_state),
7515 pending_events: Mutex::new(pending_events_read),
7516 pending_background_events: Mutex::new(pending_background_events_read),
7517 total_consistency_lock: RwLock::new(()),
7518 persistence_notifier: Notifier::new(),
7520 keys_manager: args.keys_manager,
7521 logger: args.logger,
7522 default_configuration: args.default_config,
7525 for htlc_source in failed_htlcs.drain(..) {
7526 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
7527 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
7528 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
7529 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
7532 //TODO: Broadcast channel update for closed channels, but only after we've made a
7533 //connection or two.
7535 Ok((best_block_hash.clone(), channel_manager))
7541 use bitcoin::hashes::Hash;
7542 use bitcoin::hashes::sha256::Hash as Sha256;
7543 use core::time::Duration;
7544 use core::sync::atomic::Ordering;
7545 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
7546 use crate::ln::channelmanager::{self, inbound_payment, PaymentId, PaymentSendFailure};
7547 use crate::ln::functional_test_utils::*;
7548 use crate::ln::msgs;
7549 use crate::ln::msgs::ChannelMessageHandler;
7550 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
7551 use crate::util::errors::APIError;
7552 use crate::util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
7553 use crate::util::test_utils;
7554 use crate::chain::keysinterface::{EntropySource, KeysInterface};
7557 fn test_notify_limits() {
7558 // Check that a few cases which don't require the persistence of a new ChannelManager,
7559 // indeed, do not cause the persistence of a new ChannelManager.
7560 let chanmon_cfgs = create_chanmon_cfgs(3);
7561 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7562 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7563 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7565 // All nodes start with a persistable update pending as `create_network` connects each node
7566 // with all other nodes to make most tests simpler.
7567 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7568 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7569 assert!(nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7571 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7573 // We check that the channel info nodes have doesn't change too early, even though we try
7574 // to connect messages with new values
7575 chan.0.contents.fee_base_msat *= 2;
7576 chan.1.contents.fee_base_msat *= 2;
7577 let node_a_chan_info = nodes[0].node.list_channels()[0].clone();
7578 let node_b_chan_info = nodes[1].node.list_channels()[0].clone();
7580 // The first two nodes (which opened a channel) should now require fresh persistence
7581 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7582 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7583 // ... but the last node should not.
7584 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7585 // After persisting the first two nodes they should no longer need fresh persistence.
7586 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7587 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7589 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
7590 // about the channel.
7591 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
7592 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
7593 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7595 // The nodes which are a party to the channel should also ignore messages from unrelated
7597 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7598 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7599 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7600 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7601 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7602 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7604 // At this point the channel info given by peers should still be the same.
7605 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7606 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7608 // An earlier version of handle_channel_update didn't check the directionality of the
7609 // update message and would always update the local fee info, even if our peer was
7610 // (spuriously) forwarding us our own channel_update.
7611 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
7612 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
7613 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
7615 // First deliver each peers' own message, checking that the node doesn't need to be
7616 // persisted and that its channel info remains the same.
7617 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
7618 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
7619 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7620 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7621 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7622 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7624 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
7625 // the channel info has updated.
7626 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
7627 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
7628 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7629 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7630 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
7631 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
7635 fn test_keysend_dup_hash_partial_mpp() {
7636 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
7638 let chanmon_cfgs = create_chanmon_cfgs(2);
7639 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7640 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7641 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7642 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7644 // First, send a partial MPP payment.
7645 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
7646 let mut mpp_route = route.clone();
7647 mpp_route.paths.push(mpp_route.paths[0].clone());
7649 let payment_id = PaymentId([42; 32]);
7650 // Use the utility function send_payment_along_path to send the payment with MPP data which
7651 // indicates there are more HTLCs coming.
7652 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.
7653 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash, Some(payment_secret), payment_id, &mpp_route).unwrap();
7654 nodes[0].node.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();
7655 check_added_monitors!(nodes[0], 1);
7656 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7657 assert_eq!(events.len(), 1);
7658 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
7660 // Next, send a keysend payment with the same payment_hash and make sure it fails.
7661 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7662 check_added_monitors!(nodes[0], 1);
7663 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7664 assert_eq!(events.len(), 1);
7665 let ev = events.drain(..).next().unwrap();
7666 let payment_event = SendEvent::from_event(ev);
7667 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7668 check_added_monitors!(nodes[1], 0);
7669 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7670 expect_pending_htlcs_forwardable!(nodes[1]);
7671 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
7672 check_added_monitors!(nodes[1], 1);
7673 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7674 assert!(updates.update_add_htlcs.is_empty());
7675 assert!(updates.update_fulfill_htlcs.is_empty());
7676 assert_eq!(updates.update_fail_htlcs.len(), 1);
7677 assert!(updates.update_fail_malformed_htlcs.is_empty());
7678 assert!(updates.update_fee.is_none());
7679 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7680 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7681 expect_payment_failed!(nodes[0], our_payment_hash, true);
7683 // Send the second half of the original MPP payment.
7684 nodes[0].node.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();
7685 check_added_monitors!(nodes[0], 1);
7686 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7687 assert_eq!(events.len(), 1);
7688 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
7690 // Claim the full MPP payment. Note that we can't use a test utility like
7691 // claim_funds_along_route because the ordering of the messages causes the second half of the
7692 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
7693 // lightning messages manually.
7694 nodes[1].node.claim_funds(payment_preimage);
7695 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
7696 check_added_monitors!(nodes[1], 2);
7698 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7699 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
7700 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
7701 check_added_monitors!(nodes[0], 1);
7702 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7703 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
7704 check_added_monitors!(nodes[1], 1);
7705 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7706 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
7707 check_added_monitors!(nodes[1], 1);
7708 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7709 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
7710 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
7711 check_added_monitors!(nodes[0], 1);
7712 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7713 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
7714 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7715 check_added_monitors!(nodes[0], 1);
7716 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
7717 check_added_monitors!(nodes[1], 1);
7718 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
7719 check_added_monitors!(nodes[1], 1);
7720 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7721 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
7722 check_added_monitors!(nodes[0], 1);
7724 // Note that successful MPP payments will generate a single PaymentSent event upon the first
7725 // path's success and a PaymentPathSuccessful event for each path's success.
7726 let events = nodes[0].node.get_and_clear_pending_events();
7727 assert_eq!(events.len(), 3);
7729 Event::PaymentSent { payment_id: ref id, payment_preimage: ref preimage, payment_hash: ref hash, .. } => {
7730 assert_eq!(Some(payment_id), *id);
7731 assert_eq!(payment_preimage, *preimage);
7732 assert_eq!(our_payment_hash, *hash);
7734 _ => panic!("Unexpected event"),
7737 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7738 assert_eq!(payment_id, *actual_payment_id);
7739 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7740 assert_eq!(route.paths[0], *path);
7742 _ => panic!("Unexpected event"),
7745 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7746 assert_eq!(payment_id, *actual_payment_id);
7747 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7748 assert_eq!(route.paths[0], *path);
7750 _ => panic!("Unexpected event"),
7755 fn test_keysend_dup_payment_hash() {
7756 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
7757 // outbound regular payment fails as expected.
7758 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
7759 // fails as expected.
7760 let chanmon_cfgs = create_chanmon_cfgs(2);
7761 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7762 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7763 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7764 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7765 let scorer = test_utils::TestScorer::with_penalty(0);
7766 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7768 // To start (1), send a regular payment but don't claim it.
7769 let expected_route = [&nodes[1]];
7770 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
7772 // Next, attempt a keysend payment and make sure it fails.
7773 let route_params = RouteParameters {
7774 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id()),
7775 final_value_msat: 100_000,
7776 final_cltv_expiry_delta: TEST_FINAL_CLTV,
7778 let route = find_route(
7779 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
7780 None, nodes[0].logger, &scorer, &random_seed_bytes
7782 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7783 check_added_monitors!(nodes[0], 1);
7784 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7785 assert_eq!(events.len(), 1);
7786 let ev = events.drain(..).next().unwrap();
7787 let payment_event = SendEvent::from_event(ev);
7788 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7789 check_added_monitors!(nodes[1], 0);
7790 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7791 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
7792 // fails), the second will process the resulting failure and fail the HTLC backward
7793 expect_pending_htlcs_forwardable!(nodes[1]);
7794 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
7795 check_added_monitors!(nodes[1], 1);
7796 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7797 assert!(updates.update_add_htlcs.is_empty());
7798 assert!(updates.update_fulfill_htlcs.is_empty());
7799 assert_eq!(updates.update_fail_htlcs.len(), 1);
7800 assert!(updates.update_fail_malformed_htlcs.is_empty());
7801 assert!(updates.update_fee.is_none());
7802 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7803 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7804 expect_payment_failed!(nodes[0], payment_hash, true);
7806 // Finally, claim the original payment.
7807 claim_payment(&nodes[0], &expected_route, payment_preimage);
7809 // To start (2), send a keysend payment but don't claim it.
7810 let payment_preimage = PaymentPreimage([42; 32]);
7811 let route = find_route(
7812 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
7813 None, nodes[0].logger, &scorer, &random_seed_bytes
7815 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7816 check_added_monitors!(nodes[0], 1);
7817 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7818 assert_eq!(events.len(), 1);
7819 let event = events.pop().unwrap();
7820 let path = vec![&nodes[1]];
7821 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
7823 // Next, attempt a regular payment and make sure it fails.
7824 let payment_secret = PaymentSecret([43; 32]);
7825 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
7826 check_added_monitors!(nodes[0], 1);
7827 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7828 assert_eq!(events.len(), 1);
7829 let ev = events.drain(..).next().unwrap();
7830 let payment_event = SendEvent::from_event(ev);
7831 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7832 check_added_monitors!(nodes[1], 0);
7833 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7834 expect_pending_htlcs_forwardable!(nodes[1]);
7835 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
7836 check_added_monitors!(nodes[1], 1);
7837 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7838 assert!(updates.update_add_htlcs.is_empty());
7839 assert!(updates.update_fulfill_htlcs.is_empty());
7840 assert_eq!(updates.update_fail_htlcs.len(), 1);
7841 assert!(updates.update_fail_malformed_htlcs.is_empty());
7842 assert!(updates.update_fee.is_none());
7843 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7844 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7845 expect_payment_failed!(nodes[0], payment_hash, true);
7847 // Finally, succeed the keysend payment.
7848 claim_payment(&nodes[0], &expected_route, payment_preimage);
7852 fn test_keysend_hash_mismatch() {
7853 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
7854 // preimage doesn't match the msg's payment hash.
7855 let chanmon_cfgs = create_chanmon_cfgs(2);
7856 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7857 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7858 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7860 let payer_pubkey = nodes[0].node.get_our_node_id();
7861 let payee_pubkey = nodes[1].node.get_our_node_id();
7862 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7863 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7865 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], channelmanager::provided_init_features(), channelmanager::provided_init_features());
7866 let route_params = RouteParameters {
7867 payment_params: PaymentParameters::for_keysend(payee_pubkey),
7868 final_value_msat: 10_000,
7869 final_cltv_expiry_delta: 40,
7871 let network_graph = nodes[0].network_graph.clone();
7872 let first_hops = nodes[0].node.list_usable_channels();
7873 let scorer = test_utils::TestScorer::with_penalty(0);
7874 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7875 let route = find_route(
7876 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
7877 nodes[0].logger, &scorer, &random_seed_bytes
7880 let test_preimage = PaymentPreimage([42; 32]);
7881 let mismatch_payment_hash = PaymentHash([43; 32]);
7882 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash, None, PaymentId(mismatch_payment_hash.0), &route).unwrap();
7883 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash, &None, Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
7884 check_added_monitors!(nodes[0], 1);
7886 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7887 assert_eq!(updates.update_add_htlcs.len(), 1);
7888 assert!(updates.update_fulfill_htlcs.is_empty());
7889 assert!(updates.update_fail_htlcs.is_empty());
7890 assert!(updates.update_fail_malformed_htlcs.is_empty());
7891 assert!(updates.update_fee.is_none());
7892 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7894 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Payment preimage didn't match payment hash".to_string(), 1);
7898 fn test_keysend_msg_with_secret_err() {
7899 // Test that we error as expected if we receive a keysend payment that includes a payment secret.
7900 let chanmon_cfgs = create_chanmon_cfgs(2);
7901 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7902 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7903 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7905 let payer_pubkey = nodes[0].node.get_our_node_id();
7906 let payee_pubkey = nodes[1].node.get_our_node_id();
7907 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7908 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7910 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], channelmanager::provided_init_features(), channelmanager::provided_init_features());
7911 let route_params = RouteParameters {
7912 payment_params: PaymentParameters::for_keysend(payee_pubkey),
7913 final_value_msat: 10_000,
7914 final_cltv_expiry_delta: 40,
7916 let network_graph = nodes[0].network_graph.clone();
7917 let first_hops = nodes[0].node.list_usable_channels();
7918 let scorer = test_utils::TestScorer::with_penalty(0);
7919 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7920 let route = find_route(
7921 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
7922 nodes[0].logger, &scorer, &random_seed_bytes
7925 let test_preimage = PaymentPreimage([42; 32]);
7926 let test_secret = PaymentSecret([43; 32]);
7927 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
7928 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash, Some(test_secret), PaymentId(payment_hash.0), &route).unwrap();
7929 nodes[0].node.test_send_payment_internal(&route, payment_hash, &Some(test_secret), Some(test_preimage), PaymentId(payment_hash.0), None, session_privs).unwrap();
7930 check_added_monitors!(nodes[0], 1);
7932 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7933 assert_eq!(updates.update_add_htlcs.len(), 1);
7934 assert!(updates.update_fulfill_htlcs.is_empty());
7935 assert!(updates.update_fail_htlcs.is_empty());
7936 assert!(updates.update_fail_malformed_htlcs.is_empty());
7937 assert!(updates.update_fee.is_none());
7938 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7940 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "We don't support MPP keysend payments".to_string(), 1);
7944 fn test_multi_hop_missing_secret() {
7945 let chanmon_cfgs = create_chanmon_cfgs(4);
7946 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7947 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7948 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7950 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
7951 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
7952 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
7953 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
7955 // Marshall an MPP route.
7956 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
7957 let path = route.paths[0].clone();
7958 route.paths.push(path);
7959 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
7960 route.paths[0][0].short_channel_id = chan_1_id;
7961 route.paths[0][1].short_channel_id = chan_3_id;
7962 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
7963 route.paths[1][0].short_channel_id = chan_2_id;
7964 route.paths[1][1].short_channel_id = chan_4_id;
7966 match nodes[0].node.send_payment(&route, payment_hash, &None, PaymentId(payment_hash.0)).unwrap_err() {
7967 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
7968 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err)) },
7969 _ => panic!("unexpected error")
7974 fn bad_inbound_payment_hash() {
7975 // Add coverage for checking that a user-provided payment hash matches the payment secret.
7976 let chanmon_cfgs = create_chanmon_cfgs(2);
7977 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7978 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7979 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7981 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
7982 let payment_data = msgs::FinalOnionHopData {
7984 total_msat: 100_000,
7987 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
7988 // payment verification fails as expected.
7989 let mut bad_payment_hash = payment_hash.clone();
7990 bad_payment_hash.0[0] += 1;
7991 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) {
7992 Ok(_) => panic!("Unexpected ok"),
7994 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment".to_string(), "Failing HTLC with user-generated payment_hash".to_string(), 1);
7998 // Check that using the original payment hash succeeds.
7999 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());
8003 fn test_id_to_peer_coverage() {
8004 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
8005 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
8006 // the channel is successfully closed.
8007 let chanmon_cfgs = create_chanmon_cfgs(2);
8008 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8009 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8010 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8012 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
8013 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8014 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
8015 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8016 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
8018 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
8019 let channel_id = &tx.txid().into_inner();
8021 // Ensure that the `id_to_peer` map is empty until either party has received the
8022 // funding transaction, and have the real `channel_id`.
8023 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
8024 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8027 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
8029 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
8030 // as it has the funding transaction.
8031 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8032 assert_eq!(nodes_0_lock.len(), 1);
8033 assert!(nodes_0_lock.contains_key(channel_id));
8035 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8038 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8040 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8042 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8043 assert_eq!(nodes_0_lock.len(), 1);
8044 assert!(nodes_0_lock.contains_key(channel_id));
8046 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
8047 // as it has the funding transaction.
8048 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8049 assert_eq!(nodes_1_lock.len(), 1);
8050 assert!(nodes_1_lock.contains_key(channel_id));
8052 check_added_monitors!(nodes[1], 1);
8053 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8054 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
8055 check_added_monitors!(nodes[0], 1);
8056 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8057 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
8058 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
8060 nodes[0].node.close_channel(channel_id, &nodes[1].node.get_our_node_id()).unwrap();
8061 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &channelmanager::provided_init_features(), &get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id()));
8062 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
8063 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &nodes_1_shutdown);
8065 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
8066 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
8068 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
8069 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
8070 // fee for the closing transaction has been negotiated and the parties has the other
8071 // party's signature for the fee negotiated closing transaction.)
8072 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8073 assert_eq!(nodes_0_lock.len(), 1);
8074 assert!(nodes_0_lock.contains_key(channel_id));
8076 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
8077 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
8078 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
8079 // kept in the `nodes[1]`'s `id_to_peer` map.
8080 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8081 assert_eq!(nodes_1_lock.len(), 1);
8082 assert!(nodes_1_lock.contains_key(channel_id));
8085 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()));
8087 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
8088 // therefore has all it needs to fully close the channel (both signatures for the
8089 // closing transaction).
8090 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
8091 // fully closed by `nodes[0]`.
8092 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
8094 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
8095 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
8096 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8097 assert_eq!(nodes_1_lock.len(), 1);
8098 assert!(nodes_1_lock.contains_key(channel_id));
8101 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
8103 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
8105 // Assert that the channel has now been removed from both parties `id_to_peer` map once
8106 // they both have everything required to fully close the channel.
8107 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8109 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
8111 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
8112 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
8116 #[cfg(all(any(test, feature = "_test_utils"), feature = "_bench_unstable"))]
8118 use crate::chain::Listen;
8119 use crate::chain::chainmonitor::{ChainMonitor, Persist};
8120 use crate::chain::keysinterface::{EntropySource, KeysManager, KeysInterface, InMemorySigner};
8121 use crate::ln::channelmanager::{self, BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId};
8122 use crate::ln::functional_test_utils::*;
8123 use crate::ln::msgs::{ChannelMessageHandler, Init};
8124 use crate::routing::gossip::NetworkGraph;
8125 use crate::routing::router::{PaymentParameters, get_route};
8126 use crate::util::test_utils;
8127 use crate::util::config::UserConfig;
8128 use crate::util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
8130 use bitcoin::hashes::Hash;
8131 use bitcoin::hashes::sha256::Hash as Sha256;
8132 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
8134 use crate::sync::{Arc, Mutex};
8138 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
8139 node: &'a ChannelManager<
8140 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
8141 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
8142 &'a test_utils::TestLogger, &'a P>,
8143 &'a test_utils::TestBroadcaster, &'a KeysManager,
8144 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
8145 &'a test_utils::TestLogger>,
8150 fn bench_sends(bench: &mut Bencher) {
8151 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
8154 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
8155 // Do a simple benchmark of sending a payment back and forth between two nodes.
8156 // Note that this is unrealistic as each payment send will require at least two fsync
8158 let network = bitcoin::Network::Testnet;
8159 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
8161 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
8162 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
8163 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
8164 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(genesis_hash, &logger_a)));
8166 let mut config: UserConfig = Default::default();
8167 config.channel_handshake_config.minimum_depth = 1;
8169 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
8170 let seed_a = [1u8; 32];
8171 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
8172 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &router, &logger_a, &keys_manager_a, config.clone(), ChainParameters {
8174 best_block: BestBlock::from_genesis(network),
8176 let node_a_holder = NodeHolder { node: &node_a };
8178 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
8179 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
8180 let seed_b = [2u8; 32];
8181 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
8182 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &router, &logger_b, &keys_manager_b, config.clone(), ChainParameters {
8184 best_block: BestBlock::from_genesis(network),
8186 let node_b_holder = NodeHolder { node: &node_b };
8188 node_a.peer_connected(&node_b.get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8189 node_b.peer_connected(&node_a.get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8190 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
8191 node_b.handle_open_channel(&node_a.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(node_a_holder, MessageSendEvent::SendOpenChannel, node_b.get_our_node_id()));
8192 node_a.handle_accept_channel(&node_b.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(node_b_holder, MessageSendEvent::SendAcceptChannel, node_a.get_our_node_id()));
8195 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
8196 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
8197 value: 8_000_000, script_pubkey: output_script,
8199 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
8200 } else { panic!(); }
8202 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()));
8203 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()));
8205 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
8208 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
8211 Listen::block_connected(&node_a, &block, 1);
8212 Listen::block_connected(&node_b, &block, 1);
8214 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()));
8215 let msg_events = node_a.get_and_clear_pending_msg_events();
8216 assert_eq!(msg_events.len(), 2);
8217 match msg_events[0] {
8218 MessageSendEvent::SendChannelReady { ref msg, .. } => {
8219 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
8220 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
8224 match msg_events[1] {
8225 MessageSendEvent::SendChannelUpdate { .. } => {},
8229 let events_a = node_a.get_and_clear_pending_events();
8230 assert_eq!(events_a.len(), 1);
8232 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8233 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
8235 _ => panic!("Unexpected event"),
8238 let events_b = node_b.get_and_clear_pending_events();
8239 assert_eq!(events_b.len(), 1);
8241 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8242 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
8244 _ => panic!("Unexpected event"),
8247 let dummy_graph = NetworkGraph::new(genesis_hash, &logger_a);
8249 let mut payment_count: u64 = 0;
8250 macro_rules! send_payment {
8251 ($node_a: expr, $node_b: expr) => {
8252 let usable_channels = $node_a.list_usable_channels();
8253 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id())
8254 .with_features(channelmanager::provided_invoice_features());
8255 let scorer = test_utils::TestScorer::with_penalty(0);
8256 let seed = [3u8; 32];
8257 let keys_manager = KeysManager::new(&seed, 42, 42);
8258 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8259 let route = get_route(&$node_a.get_our_node_id(), &payment_params, &dummy_graph.read_only(),
8260 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), 10_000, TEST_FINAL_CLTV, &logger_a, &scorer, &random_seed_bytes).unwrap();
8262 let mut payment_preimage = PaymentPreimage([0; 32]);
8263 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
8265 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
8266 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200).unwrap();
8268 $node_a.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
8269 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
8270 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
8271 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
8272 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
8273 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
8274 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
8275 $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()));
8277 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
8278 expect_payment_claimable!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
8279 $node_b.claim_funds(payment_preimage);
8280 expect_payment_claimed!(NodeHolder { node: &$node_b }, payment_hash, 10_000);
8282 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
8283 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
8284 assert_eq!(node_id, $node_a.get_our_node_id());
8285 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8286 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
8288 _ => panic!("Failed to generate claim event"),
8291 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
8292 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
8293 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
8294 $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()));
8296 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
8301 send_payment!(node_a, node_b);
8302 send_payment!(node_b, node_a);