1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! The top-level channel management and payment tracking stuff lives here.
12 //! The ChannelManager is the main chunk of logic implementing the lightning protocol and is
13 //! responsible for tracking which channels are open, HTLCs are in flight and reestablishing those
14 //! upon reconnect to the relevant peer(s).
16 //! It does not manage routing logic (see [`find_route`] for that) nor does it manage constructing
17 //! on-chain transactions (it only monitors the chain to watch for any force-closes that might
18 //! imply it needs to fail HTLCs/payments/channels it manages).
20 //! [`find_route`]: crate::routing::router::find_route
22 use bitcoin::blockdata::block::BlockHeader;
23 use bitcoin::blockdata::transaction::Transaction;
24 use bitcoin::blockdata::constants::genesis_block;
25 use bitcoin::network::constants::Network;
27 use bitcoin::hashes::Hash;
28 use bitcoin::hashes::sha256::Hash as Sha256;
29 use bitcoin::hash_types::{BlockHash, Txid};
31 use bitcoin::secp256k1::{SecretKey,PublicKey};
32 use bitcoin::secp256k1::Secp256k1;
33 use bitcoin::{LockTime, secp256k1, Sequence};
36 use crate::chain::{Confirm, ChannelMonitorUpdateStatus, Watch, BestBlock};
37 use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator};
38 use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
39 use crate::chain::transaction::{OutPoint, TransactionData};
40 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
41 // construct one themselves.
42 use crate::ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
43 use crate::ln::channel::{Channel, ChannelError, ChannelUpdateStatus, UpdateFulfillCommitFetch};
44 use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
45 #[cfg(any(feature = "_test_utils", test))]
46 use crate::ln::features::InvoiceFeatures;
47 use crate::routing::gossip::NetworkGraph;
48 use crate::routing::router::{DefaultRouter, InFlightHtlcs, PaymentParameters, Route, RouteHop, RoutePath, Router};
49 use crate::routing::scoring::ProbabilisticScorer;
51 use crate::ln::onion_utils;
52 use crate::ln::onion_utils::HTLCFailReason;
53 use crate::ln::msgs::{ChannelMessageHandler, DecodeError, LightningError, MAX_VALUE_MSAT};
55 use crate::ln::outbound_payment;
56 use crate::ln::outbound_payment::{OutboundPayments, PendingOutboundPayment};
57 use crate::ln::wire::Encode;
58 use crate::chain::keysinterface::{EntropySource, KeysManager, NodeSigner, Recipient, SignerProvider, ChannelSigner};
59 use crate::util::config::{UserConfig, ChannelConfig};
60 use crate::util::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
61 use crate::util::events;
62 use crate::util::wakers::{Future, Notifier};
63 use crate::util::scid_utils::fake_scid;
64 use crate::util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
65 use crate::util::logger::{Level, Logger};
66 use crate::util::errors::APIError;
69 use crate::prelude::*;
71 use core::cell::RefCell;
73 use crate::sync::{Arc, Mutex, RwLock, RwLockReadGuard, FairRwLock};
74 use core::sync::atomic::{AtomicUsize, Ordering};
75 use core::time::Duration;
78 // Re-export this for use in the public API.
79 pub use crate::ln::outbound_payment::PaymentSendFailure;
81 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
83 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
84 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
85 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
87 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
88 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
89 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
90 // before we forward it.
92 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
93 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
94 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
95 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
96 // our payment, which we can use to decode errors or inform the user that the payment was sent.
98 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
99 pub(super) enum PendingHTLCRouting {
101 onion_packet: msgs::OnionPacket,
102 /// The SCID from the onion that we should forward to. This could be a real SCID or a fake one
103 /// generated using `get_fake_scid` from the scid_utils::fake_scid module.
104 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
107 payment_data: msgs::FinalOnionHopData,
108 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
109 phantom_shared_secret: Option<[u8; 32]>,
112 payment_preimage: PaymentPreimage,
113 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
117 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
118 pub(super) struct PendingHTLCInfo {
119 pub(super) routing: PendingHTLCRouting,
120 pub(super) incoming_shared_secret: [u8; 32],
121 payment_hash: PaymentHash,
122 pub(super) incoming_amt_msat: Option<u64>, // Added in 0.0.113
123 pub(super) outgoing_amt_msat: u64,
124 pub(super) outgoing_cltv_value: u32,
127 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
128 pub(super) enum HTLCFailureMsg {
129 Relay(msgs::UpdateFailHTLC),
130 Malformed(msgs::UpdateFailMalformedHTLC),
133 /// Stores whether we can't forward an HTLC or relevant forwarding info
134 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
135 pub(super) enum PendingHTLCStatus {
136 Forward(PendingHTLCInfo),
137 Fail(HTLCFailureMsg),
140 pub(super) struct PendingAddHTLCInfo {
141 pub(super) forward_info: PendingHTLCInfo,
143 // These fields are produced in `forward_htlcs()` and consumed in
144 // `process_pending_htlc_forwards()` for constructing the
145 // `HTLCSource::PreviousHopData` for failed and forwarded
148 // Note that this may be an outbound SCID alias for the associated channel.
149 prev_short_channel_id: u64,
151 prev_funding_outpoint: OutPoint,
152 prev_user_channel_id: u128,
155 pub(super) enum HTLCForwardInfo {
156 AddHTLC(PendingAddHTLCInfo),
159 err_packet: msgs::OnionErrorPacket,
163 /// Tracks the inbound corresponding to an outbound HTLC
164 #[derive(Clone, Hash, PartialEq, Eq)]
165 pub(crate) struct HTLCPreviousHopData {
166 // Note that this may be an outbound SCID alias for the associated channel.
167 short_channel_id: u64,
169 incoming_packet_shared_secret: [u8; 32],
170 phantom_shared_secret: Option<[u8; 32]>,
172 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
173 // channel with a preimage provided by the forward channel.
178 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
180 /// This is only here for backwards-compatibility in serialization, in the future it can be
181 /// removed, breaking clients running 0.0.106 and earlier.
182 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
184 /// Contains the payer-provided preimage.
185 Spontaneous(PaymentPreimage),
188 /// HTLCs that are to us and can be failed/claimed by the user
189 struct ClaimableHTLC {
190 prev_hop: HTLCPreviousHopData,
192 /// The amount (in msats) of this MPP part
194 onion_payload: OnionPayload,
196 /// The sum total of all MPP parts
200 /// A payment identifier used to uniquely identify a payment to LDK.
201 /// (C-not exported) as we just use [u8; 32] directly
202 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
203 pub struct PaymentId(pub [u8; 32]);
205 impl Writeable for PaymentId {
206 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
211 impl Readable for PaymentId {
212 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
213 let buf: [u8; 32] = Readable::read(r)?;
218 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
219 /// (C-not exported) as we just use [u8; 32] directly
220 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
221 pub struct InterceptId(pub [u8; 32]);
223 impl Writeable for InterceptId {
224 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
229 impl Readable for InterceptId {
230 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
231 let buf: [u8; 32] = Readable::read(r)?;
235 /// Tracks the inbound corresponding to an outbound HTLC
236 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
237 #[derive(Clone, PartialEq, Eq)]
238 pub(crate) enum HTLCSource {
239 PreviousHopData(HTLCPreviousHopData),
242 session_priv: SecretKey,
243 /// Technically we can recalculate this from the route, but we cache it here to avoid
244 /// doing a double-pass on route when we get a failure back
245 first_hop_htlc_msat: u64,
246 payment_id: PaymentId,
247 payment_secret: Option<PaymentSecret>,
248 payment_params: Option<PaymentParameters>,
251 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
252 impl core::hash::Hash for HTLCSource {
253 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
255 HTLCSource::PreviousHopData(prev_hop_data) => {
257 prev_hop_data.hash(hasher);
259 HTLCSource::OutboundRoute { path, session_priv, payment_id, payment_secret, first_hop_htlc_msat, payment_params } => {
262 session_priv[..].hash(hasher);
263 payment_id.hash(hasher);
264 payment_secret.hash(hasher);
265 first_hop_htlc_msat.hash(hasher);
266 payment_params.hash(hasher);
271 #[cfg(not(feature = "grind_signatures"))]
274 pub fn dummy() -> Self {
275 HTLCSource::OutboundRoute {
277 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
278 first_hop_htlc_msat: 0,
279 payment_id: PaymentId([2; 32]),
280 payment_secret: None,
281 payment_params: None,
286 struct ReceiveError {
292 type ShutdownResult = (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash, PublicKey, [u8; 32])>);
294 /// Error type returned across the peer_state mutex boundary. When an Err is generated for a
295 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
296 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
297 /// peer_state lock. We then return the set of things that need to be done outside the lock in
298 /// this struct and call handle_error!() on it.
300 struct MsgHandleErrInternal {
301 err: msgs::LightningError,
302 chan_id: Option<([u8; 32], u128)>, // If Some a channel of ours has been closed
303 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
305 impl MsgHandleErrInternal {
307 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
309 err: LightningError {
311 action: msgs::ErrorAction::SendErrorMessage {
312 msg: msgs::ErrorMessage {
319 shutdown_finish: None,
323 fn ignore_no_close(err: String) -> Self {
325 err: LightningError {
327 action: msgs::ErrorAction::IgnoreError,
330 shutdown_finish: None,
334 fn from_no_close(err: msgs::LightningError) -> Self {
335 Self { err, chan_id: None, shutdown_finish: None }
338 fn from_finish_shutdown(err: String, channel_id: [u8; 32], user_channel_id: u128, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
340 err: LightningError {
342 action: msgs::ErrorAction::SendErrorMessage {
343 msg: msgs::ErrorMessage {
349 chan_id: Some((channel_id, user_channel_id)),
350 shutdown_finish: Some((shutdown_res, channel_update)),
354 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
357 ChannelError::Warn(msg) => LightningError {
359 action: msgs::ErrorAction::SendWarningMessage {
360 msg: msgs::WarningMessage {
364 log_level: Level::Warn,
367 ChannelError::Ignore(msg) => LightningError {
369 action: msgs::ErrorAction::IgnoreError,
371 ChannelError::Close(msg) => LightningError {
373 action: msgs::ErrorAction::SendErrorMessage {
374 msg: msgs::ErrorMessage {
382 shutdown_finish: None,
387 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
388 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
389 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
390 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
391 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
393 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
394 /// be sent in the order they appear in the return value, however sometimes the order needs to be
395 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
396 /// they were originally sent). In those cases, this enum is also returned.
397 #[derive(Clone, PartialEq)]
398 pub(super) enum RAACommitmentOrder {
399 /// Send the CommitmentUpdate messages first
401 /// Send the RevokeAndACK message first
405 /// Information about a payment which is currently being claimed.
406 struct ClaimingPayment {
408 payment_purpose: events::PaymentPurpose,
409 receiver_node_id: PublicKey,
411 impl_writeable_tlv_based!(ClaimingPayment, {
412 (0, amount_msat, required),
413 (2, payment_purpose, required),
414 (4, receiver_node_id, required),
417 /// Information about claimable or being-claimed payments
418 struct ClaimablePayments {
419 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
420 /// failed/claimed by the user.
422 /// Note that, no consistency guarantees are made about the channels given here actually
423 /// existing anymore by the time you go to read them!
425 /// When adding to the map, [`Self::pending_claiming_payments`] must also be checked to ensure
426 /// we don't get a duplicate payment.
427 claimable_htlcs: HashMap<PaymentHash, (events::PaymentPurpose, Vec<ClaimableHTLC>)>,
429 /// Map from payment hash to the payment data for HTLCs which we have begun claiming, but which
430 /// are waiting on a [`ChannelMonitorUpdate`] to complete in order to be surfaced to the user
431 /// as an [`events::Event::PaymentClaimed`].
432 pending_claiming_payments: HashMap<PaymentHash, ClaimingPayment>,
435 /// Events which we process internally but cannot be procsesed immediately at the generation site
436 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
437 /// quite some time lag.
438 enum BackgroundEvent {
439 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
440 /// commitment transaction.
441 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
444 pub(crate) enum MonitorUpdateCompletionAction {
445 /// Indicates that a payment ultimately destined for us was claimed and we should emit an
446 /// [`events::Event::PaymentClaimed`] to the user if we haven't yet generated such an event for
447 /// this payment. Note that this is only best-effort. On restart it's possible such a duplicate
448 /// event can be generated.
449 PaymentClaimed { payment_hash: PaymentHash },
450 /// Indicates an [`events::Event`] should be surfaced to the user.
451 EmitEvent { event: events::Event },
454 /// State we hold per-peer.
455 pub(super) struct PeerState<Signer: ChannelSigner> {
456 /// `temporary_channel_id` or `channel_id` -> `channel`.
458 /// Holds all channels where the peer is the counterparty. Once a channel has been assigned a
459 /// `channel_id`, the `temporary_channel_id` key in the map is updated and is replaced by the
461 pub(super) channel_by_id: HashMap<[u8; 32], Channel<Signer>>,
462 /// The latest `InitFeatures` we heard from the peer.
463 latest_features: InitFeatures,
464 /// Messages to send to the peer - pushed to in the same lock that they are generated in (except
465 /// for broadcast messages, where ordering isn't as strict).
466 pub(super) pending_msg_events: Vec<MessageSendEvent>,
469 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
470 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
472 /// For users who don't want to bother doing their own payment preimage storage, we also store that
475 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
476 /// and instead encoding it in the payment secret.
477 struct PendingInboundPayment {
478 /// The payment secret that the sender must use for us to accept this payment
479 payment_secret: PaymentSecret,
480 /// Time at which this HTLC expires - blocks with a header time above this value will result in
481 /// this payment being removed.
483 /// Arbitrary identifier the user specifies (or not)
484 user_payment_id: u64,
485 // Other required attributes of the payment, optionally enforced:
486 payment_preimage: Option<PaymentPreimage>,
487 min_value_msat: Option<u64>,
490 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
491 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
492 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
493 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
494 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
495 /// that implements KeysInterface or Router for its keys manager and router, respectively, but this
496 /// type alias chooses the concrete types of KeysManager and DefaultRouter.
498 /// (C-not exported) as Arcs don't make sense in bindings
499 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
507 Arc<NetworkGraph<Arc<L>>>,
509 Arc<Mutex<ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>>
514 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
515 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
516 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
517 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
518 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
519 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
520 /// that implements KeysInterface or Router for its keys manager and router, respectively, but this
521 /// type alias chooses the concrete types of KeysManager and DefaultRouter.
523 /// (C-not exported) as Arcs don't make sense in bindings
524 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> = ChannelManager<&'a M, &'b T, &'c KeysManager, &'c KeysManager, &'c KeysManager, &'d F, &'e DefaultRouter<&'f NetworkGraph<&'g L>, &'g L, &'h Mutex<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>>, &'g L>;
526 /// Manager which keeps track of a number of channels and sends messages to the appropriate
527 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
529 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
530 /// to individual Channels.
532 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
533 /// all peers during write/read (though does not modify this instance, only the instance being
534 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
535 /// called funding_transaction_generated for outbound channels).
537 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
538 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
539 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
540 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
541 /// the serialization process). If the deserialized version is out-of-date compared to the
542 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
543 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
545 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
546 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
547 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
548 /// block_connected() to step towards your best block) upon deserialization before using the
551 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
552 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
553 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
554 /// offline for a full minute. In order to track this, you must call
555 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
557 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
558 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
559 /// essentially you should default to using a SimpleRefChannelManager, and use a
560 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
561 /// you're using lightning-net-tokio.
564 // The tree structure below illustrates the lock order requirements for the different locks of the
565 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
566 // and should then be taken in the order of the lowest to the highest level in the tree.
567 // Note that locks on different branches shall not be taken at the same time, as doing so will
568 // create a new lock order for those specific locks in the order they were taken.
572 // `total_consistency_lock`
574 // |__`forward_htlcs`
576 // | |__`pending_intercepted_htlcs`
578 // |__`per_peer_state`
580 // | |__`pending_inbound_payments`
582 // | |__`claimable_payments`
584 // | |__`pending_outbound_payments` // This field's struct contains a map of pending outbounds
590 // | |__`short_to_chan_info`
592 // | |__`outbound_scid_aliases`
596 // | |__`pending_events`
598 // | |__`pending_background_events`
600 pub struct ChannelManager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
602 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
603 T::Target: BroadcasterInterface,
604 ES::Target: EntropySource,
605 NS::Target: NodeSigner,
606 SP::Target: SignerProvider,
607 F::Target: FeeEstimator,
611 default_configuration: UserConfig,
612 genesis_hash: BlockHash,
613 fee_estimator: LowerBoundedFeeEstimator<F>,
619 /// See `ChannelManager` struct-level documentation for lock order requirements.
621 pub(super) best_block: RwLock<BestBlock>,
623 best_block: RwLock<BestBlock>,
624 secp_ctx: Secp256k1<secp256k1::All>,
626 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
627 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
628 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
629 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
631 /// See `ChannelManager` struct-level documentation for lock order requirements.
632 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
634 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
635 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
636 /// (if the channel has been force-closed), however we track them here to prevent duplicative
637 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
638 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
639 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
640 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
641 /// after reloading from disk while replaying blocks against ChannelMonitors.
643 /// See `PendingOutboundPayment` documentation for more info.
645 /// See `ChannelManager` struct-level documentation for lock order requirements.
646 pending_outbound_payments: OutboundPayments,
648 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
650 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
651 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
652 /// and via the classic SCID.
654 /// Note that no consistency guarantees are made about the existence of a channel with the
655 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
657 /// See `ChannelManager` struct-level documentation for lock order requirements.
659 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
661 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
662 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
663 /// until the user tells us what we should do with them.
665 /// See `ChannelManager` struct-level documentation for lock order requirements.
666 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
668 /// The sets of payments which are claimable or currently being claimed. See
669 /// [`ClaimablePayments`]' individual field docs for more info.
671 /// See `ChannelManager` struct-level documentation for lock order requirements.
672 claimable_payments: Mutex<ClaimablePayments>,
674 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
675 /// and some closed channels which reached a usable state prior to being closed. This is used
676 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
677 /// active channel list on load.
679 /// See `ChannelManager` struct-level documentation for lock order requirements.
680 outbound_scid_aliases: Mutex<HashSet<u64>>,
682 /// `channel_id` -> `counterparty_node_id`.
684 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
685 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
686 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
688 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
689 /// the corresponding channel for the event, as we only have access to the `channel_id` during
690 /// the handling of the events.
692 /// Note that no consistency guarantees are made about the existence of a peer with the
693 /// `counterparty_node_id` in our other maps.
696 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
697 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
698 /// would break backwards compatability.
699 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
700 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
701 /// required to access the channel with the `counterparty_node_id`.
703 /// See `ChannelManager` struct-level documentation for lock order requirements.
704 id_to_peer: Mutex<HashMap<[u8; 32], PublicKey>>,
706 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
708 /// Outbound SCID aliases are added here once the channel is available for normal use, with
709 /// SCIDs being added once the funding transaction is confirmed at the channel's required
710 /// confirmation depth.
712 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
713 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
714 /// channel with the `channel_id` in our other maps.
716 /// See `ChannelManager` struct-level documentation for lock order requirements.
718 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
720 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
722 our_network_pubkey: PublicKey,
724 inbound_payment_key: inbound_payment::ExpandedKey,
726 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
727 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
728 /// we encrypt the namespace identifier using these bytes.
730 /// [fake scids]: crate::util::scid_utils::fake_scid
731 fake_scid_rand_bytes: [u8; 32],
733 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
734 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
735 /// keeping additional state.
736 probing_cookie_secret: [u8; 32],
738 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
739 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
740 /// very far in the past, and can only ever be up to two hours in the future.
741 highest_seen_timestamp: AtomicUsize,
743 /// The bulk of our storage will eventually be here (message queues and the like). Currently
744 /// the `per_peer_state` stores our channels on a per-peer basis, as well as the peer's latest
747 /// If we are connected to a peer we always at least have an entry here, even if no channels
748 /// are currently open with that peer.
750 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
751 /// operate on the inner value freely. This opens up for parallel per-peer operation for
754 /// Note that the same thread must never acquire two inner `PeerState` locks at the same time.
756 /// See `ChannelManager` struct-level documentation for lock order requirements.
757 #[cfg(not(any(test, feature = "_test_utils")))]
758 per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>>>,
759 #[cfg(any(test, feature = "_test_utils"))]
760 pub(super) per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>>>,
762 /// See `ChannelManager` struct-level documentation for lock order requirements.
763 pending_events: Mutex<Vec<events::Event>>,
764 /// See `ChannelManager` struct-level documentation for lock order requirements.
765 pending_background_events: Mutex<Vec<BackgroundEvent>>,
766 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
767 /// Essentially just when we're serializing ourselves out.
768 /// Taken first everywhere where we are making changes before any other locks.
769 /// When acquiring this lock in read mode, rather than acquiring it directly, call
770 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
771 /// Notifier the lock contains sends out a notification when the lock is released.
772 total_consistency_lock: RwLock<()>,
774 persistence_notifier: Notifier,
783 /// Chain-related parameters used to construct a new `ChannelManager`.
785 /// Typically, the block-specific parameters are derived from the best block hash for the network,
786 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
787 /// are not needed when deserializing a previously constructed `ChannelManager`.
788 #[derive(Clone, Copy, PartialEq)]
789 pub struct ChainParameters {
790 /// The network for determining the `chain_hash` in Lightning messages.
791 pub network: Network,
793 /// The hash and height of the latest block successfully connected.
795 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
796 pub best_block: BestBlock,
799 #[derive(Copy, Clone, PartialEq)]
805 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
806 /// desirable to notify any listeners on `await_persistable_update_timeout`/
807 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
808 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
809 /// sending the aforementioned notification (since the lock being released indicates that the
810 /// updates are ready for persistence).
812 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
813 /// notify or not based on whether relevant changes have been made, providing a closure to
814 /// `optionally_notify` which returns a `NotifyOption`.
815 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
816 persistence_notifier: &'a Notifier,
818 // We hold onto this result so the lock doesn't get released immediately.
819 _read_guard: RwLockReadGuard<'a, ()>,
822 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
823 fn notify_on_drop(lock: &'a RwLock<()>, notifier: &'a Notifier) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
824 PersistenceNotifierGuard::optionally_notify(lock, notifier, || -> NotifyOption { NotifyOption::DoPersist })
827 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a Notifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
828 let read_guard = lock.read().unwrap();
830 PersistenceNotifierGuard {
831 persistence_notifier: notifier,
832 should_persist: persist_check,
833 _read_guard: read_guard,
838 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
840 if (self.should_persist)() == NotifyOption::DoPersist {
841 self.persistence_notifier.notify();
846 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
847 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
849 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
851 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
852 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
853 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
854 /// the maximum required amount in lnd as of March 2021.
855 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
857 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
858 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
860 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
862 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
863 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
864 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
865 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
866 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
867 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
868 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
869 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
870 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
871 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
872 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
873 // routing failure for any HTLC sender picking up an LDK node among the first hops.
874 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
876 /// Minimum CLTV difference between the current block height and received inbound payments.
877 /// Invoices generated for payment to us must set their `min_final_cltv_expiry_delta` field to at least
879 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
880 // any payments to succeed. Further, we don't want payments to fail if a block was found while
881 // a payment was being routed, so we add an extra block to be safe.
882 pub const MIN_FINAL_CLTV_EXPIRY_DELTA: u16 = HTLC_FAIL_BACK_BUFFER as u16 + 3;
884 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
885 // ie that if the next-hop peer fails the HTLC within
886 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
887 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
888 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
889 // LATENCY_GRACE_PERIOD_BLOCKS.
892 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;
894 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
895 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
898 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
900 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
901 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
903 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until we time-out the
904 /// idempotency of payments by [`PaymentId`]. See
905 /// [`OutboundPayments::remove_stale_resolved_payments`].
906 pub(crate) const IDEMPOTENCY_TIMEOUT_TICKS: u8 = 7;
908 /// Information needed for constructing an invoice route hint for this channel.
909 #[derive(Clone, Debug, PartialEq)]
910 pub struct CounterpartyForwardingInfo {
911 /// Base routing fee in millisatoshis.
912 pub fee_base_msat: u32,
913 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
914 pub fee_proportional_millionths: u32,
915 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
916 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
917 /// `cltv_expiry_delta` for more details.
918 pub cltv_expiry_delta: u16,
921 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
922 /// to better separate parameters.
923 #[derive(Clone, Debug, PartialEq)]
924 pub struct ChannelCounterparty {
925 /// The node_id of our counterparty
926 pub node_id: PublicKey,
927 /// The Features the channel counterparty provided upon last connection.
928 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
929 /// many routing-relevant features are present in the init context.
930 pub features: InitFeatures,
931 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
932 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
933 /// claiming at least this value on chain.
935 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
937 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
938 pub unspendable_punishment_reserve: u64,
939 /// Information on the fees and requirements that the counterparty requires when forwarding
940 /// payments to us through this channel.
941 pub forwarding_info: Option<CounterpartyForwardingInfo>,
942 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
943 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
944 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
945 pub outbound_htlc_minimum_msat: Option<u64>,
946 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
947 pub outbound_htlc_maximum_msat: Option<u64>,
950 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
951 #[derive(Clone, Debug, PartialEq)]
952 pub struct ChannelDetails {
953 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
954 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
955 /// Note that this means this value is *not* persistent - it can change once during the
956 /// lifetime of the channel.
957 pub channel_id: [u8; 32],
958 /// Parameters which apply to our counterparty. See individual fields for more information.
959 pub counterparty: ChannelCounterparty,
960 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
961 /// our counterparty already.
963 /// Note that, if this has been set, `channel_id` will be equivalent to
964 /// `funding_txo.unwrap().to_channel_id()`.
965 pub funding_txo: Option<OutPoint>,
966 /// The features which this channel operates with. See individual features for more info.
968 /// `None` until negotiation completes and the channel type is finalized.
969 pub channel_type: Option<ChannelTypeFeatures>,
970 /// The position of the funding transaction in the chain. None if the funding transaction has
971 /// not yet been confirmed and the channel fully opened.
973 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
974 /// payments instead of this. See [`get_inbound_payment_scid`].
976 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
977 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
979 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
980 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
981 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
982 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
983 /// [`confirmations_required`]: Self::confirmations_required
984 pub short_channel_id: Option<u64>,
985 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
986 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
987 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
990 /// This will be `None` as long as the channel is not available for routing outbound payments.
992 /// [`short_channel_id`]: Self::short_channel_id
993 /// [`confirmations_required`]: Self::confirmations_required
994 pub outbound_scid_alias: Option<u64>,
995 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
996 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
997 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
998 /// when they see a payment to be routed to us.
1000 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1001 /// previous values for inbound payment forwarding.
1003 /// [`short_channel_id`]: Self::short_channel_id
1004 pub inbound_scid_alias: Option<u64>,
1005 /// The value, in satoshis, of this channel as appears in the funding output
1006 pub channel_value_satoshis: u64,
1007 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1008 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1009 /// this value on chain.
1011 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1013 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1015 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1016 pub unspendable_punishment_reserve: Option<u64>,
1017 /// The `user_channel_id` passed in to create_channel, or a random value if the channel was
1018 /// inbound. This may be zero for inbound channels serialized with LDK versions prior to
1020 pub user_channel_id: u128,
1021 /// Our total balance. This is the amount we would get if we close the channel.
1022 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1023 /// amount is not likely to be recoverable on close.
1025 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1026 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1027 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1028 /// This does not consider any on-chain fees.
1030 /// See also [`ChannelDetails::outbound_capacity_msat`]
1031 pub balance_msat: u64,
1032 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1033 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1034 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1035 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1037 /// See also [`ChannelDetails::balance_msat`]
1039 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1040 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1041 /// should be able to spend nearly this amount.
1042 pub outbound_capacity_msat: u64,
1043 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1044 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1045 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1046 /// to use a limit as close as possible to the HTLC limit we can currently send.
1048 /// See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
1049 pub next_outbound_htlc_limit_msat: u64,
1050 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1051 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1052 /// available for inclusion in new inbound HTLCs).
1053 /// Note that there are some corner cases not fully handled here, so the actual available
1054 /// inbound capacity may be slightly higher than this.
1056 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1057 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1058 /// However, our counterparty should be able to spend nearly this amount.
1059 pub inbound_capacity_msat: u64,
1060 /// The number of required confirmations on the funding transaction before the funding will be
1061 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1062 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1063 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1064 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1066 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1068 /// [`is_outbound`]: ChannelDetails::is_outbound
1069 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1070 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1071 pub confirmations_required: Option<u32>,
1072 /// The current number of confirmations on the funding transaction.
1074 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1075 pub confirmations: Option<u32>,
1076 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1077 /// until we can claim our funds after we force-close the channel. During this time our
1078 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1079 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1080 /// time to claim our non-HTLC-encumbered funds.
1082 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1083 pub force_close_spend_delay: Option<u16>,
1084 /// True if the channel was initiated (and thus funded) by us.
1085 pub is_outbound: bool,
1086 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1087 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1088 /// required confirmation count has been reached (and we were connected to the peer at some
1089 /// point after the funding transaction received enough confirmations). The required
1090 /// confirmation count is provided in [`confirmations_required`].
1092 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1093 pub is_channel_ready: bool,
1094 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1095 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1097 /// This is a strict superset of `is_channel_ready`.
1098 pub is_usable: bool,
1099 /// True if this channel is (or will be) publicly-announced.
1100 pub is_public: bool,
1101 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1102 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1103 pub inbound_htlc_minimum_msat: Option<u64>,
1104 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1105 pub inbound_htlc_maximum_msat: Option<u64>,
1106 /// Set of configurable parameters that affect channel operation.
1108 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1109 pub config: Option<ChannelConfig>,
1112 impl ChannelDetails {
1113 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1114 /// This should be used for providing invoice hints or in any other context where our
1115 /// counterparty will forward a payment to us.
1117 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1118 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1119 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1120 self.inbound_scid_alias.or(self.short_channel_id)
1123 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1124 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1125 /// we're sending or forwarding a payment outbound over this channel.
1127 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1128 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1129 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1130 self.short_channel_id.or(self.outbound_scid_alias)
1134 /// Route hints used in constructing invoices for [phantom node payents].
1136 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
1138 pub struct PhantomRouteHints {
1139 /// The list of channels to be included in the invoice route hints.
1140 pub channels: Vec<ChannelDetails>,
1141 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1143 pub phantom_scid: u64,
1144 /// The pubkey of the real backing node that would ultimately receive the payment.
1145 pub real_node_pubkey: PublicKey,
1148 macro_rules! handle_error {
1149 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
1152 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish }) => {
1153 #[cfg(any(feature = "_test_utils", test))]
1155 // In testing, ensure there are no deadlocks where the lock is already held upon
1156 // entering the macro.
1157 debug_assert!($self.pending_events.try_lock().is_ok());
1158 debug_assert!($self.per_peer_state.try_write().is_ok());
1161 let mut msg_events = Vec::with_capacity(2);
1163 if let Some((shutdown_res, update_option)) = shutdown_finish {
1164 $self.finish_force_close_channel(shutdown_res);
1165 if let Some(update) = update_option {
1166 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1170 if let Some((channel_id, user_channel_id)) = chan_id {
1171 $self.pending_events.lock().unwrap().push(events::Event::ChannelClosed {
1172 channel_id, user_channel_id,
1173 reason: ClosureReason::ProcessingError { err: err.err.clone() }
1178 log_error!($self.logger, "{}", err.err);
1179 if let msgs::ErrorAction::IgnoreError = err.action {
1181 msg_events.push(events::MessageSendEvent::HandleError {
1182 node_id: $counterparty_node_id,
1183 action: err.action.clone()
1187 if !msg_events.is_empty() {
1188 let per_peer_state = $self.per_peer_state.read().unwrap();
1189 if let Some(peer_state_mutex) = per_peer_state.get(&$counterparty_node_id) {
1190 let mut peer_state = peer_state_mutex.lock().unwrap();
1191 peer_state.pending_msg_events.append(&mut msg_events);
1193 #[cfg(any(feature = "_test_utils", test))]
1195 if let None = per_peer_state.get(&$counterparty_node_id) {
1196 // This shouldn't occour in tests unless an unkown counterparty_node_id
1197 // has been passed to our message handling functions.
1198 let expected_error_str = format!("Can't find a peer matching the passed counterparty node_id {}", $counterparty_node_id);
1200 msgs::ErrorAction::SendErrorMessage {
1201 msg: msgs::ErrorMessage { ref channel_id, ref data }
1204 assert_eq!(*data, expected_error_str);
1205 if let Some((err_channel_id, _user_channel_id)) = chan_id {
1206 debug_assert_eq!(*channel_id, err_channel_id);
1209 _ => debug_assert!(false, "Unexpected event"),
1215 // Return error in case higher-API need one
1222 macro_rules! update_maps_on_chan_removal {
1223 ($self: expr, $channel: expr) => {{
1224 $self.id_to_peer.lock().unwrap().remove(&$channel.channel_id());
1225 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1226 if let Some(short_id) = $channel.get_short_channel_id() {
1227 short_to_chan_info.remove(&short_id);
1229 // If the channel was never confirmed on-chain prior to its closure, remove the
1230 // outbound SCID alias we used for it from the collision-prevention set. While we
1231 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1232 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1233 // opening a million channels with us which are closed before we ever reach the funding
1235 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel.outbound_scid_alias());
1236 debug_assert!(alias_removed);
1238 short_to_chan_info.remove(&$channel.outbound_scid_alias());
1242 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1243 macro_rules! convert_chan_err {
1244 ($self: ident, $err: expr, $channel: expr, $channel_id: expr) => {
1246 ChannelError::Warn(msg) => {
1247 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), $channel_id.clone()))
1249 ChannelError::Ignore(msg) => {
1250 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
1252 ChannelError::Close(msg) => {
1253 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
1254 update_maps_on_chan_removal!($self, $channel);
1255 let shutdown_res = $channel.force_shutdown(true);
1256 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
1257 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
1263 macro_rules! break_chan_entry {
1264 ($self: ident, $res: expr, $entry: expr) => {
1268 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1270 $entry.remove_entry();
1278 macro_rules! try_chan_entry {
1279 ($self: ident, $res: expr, $entry: expr) => {
1283 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1285 $entry.remove_entry();
1293 macro_rules! remove_channel {
1294 ($self: expr, $entry: expr) => {
1296 let channel = $entry.remove_entry().1;
1297 update_maps_on_chan_removal!($self, channel);
1303 macro_rules! handle_monitor_update_res {
1304 ($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) => {
1306 ChannelMonitorUpdateStatus::PermanentFailure => {
1307 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateStatus::PermanentFailure", log_bytes!($chan_id[..]));
1308 update_maps_on_chan_removal!($self, $chan);
1309 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
1310 // chain in a confused state! We need to move them into the ChannelMonitor which
1311 // will be responsible for failing backwards once things confirm on-chain.
1312 // It's ok that we drop $failed_forwards here - at this point we'd rather they
1313 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
1314 // us bother trying to claim it just to forward on to another peer. If we're
1315 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
1316 // given up the preimage yet, so might as well just wait until the payment is
1317 // retried, avoiding the on-chain fees.
1318 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure".to_owned(), *$chan_id, $chan.get_user_id(),
1319 $chan.force_shutdown(false), $self.get_channel_update_for_broadcast(&$chan).ok() ));
1322 ChannelMonitorUpdateStatus::InProgress => {
1323 log_info!($self.logger, "Disabling channel {} due to monitor update in progress. On restore will send {} and process {} forwards, {} fails, and {} fulfill finalizations",
1324 log_bytes!($chan_id[..]),
1325 if $resend_commitment && $resend_raa {
1326 match $action_type {
1327 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
1328 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
1330 } else if $resend_commitment { "commitment" }
1331 else if $resend_raa { "RAA" }
1333 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
1334 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len(),
1335 (&$failed_finalized_fulfills as &Vec<HTLCSource>).len());
1336 if !$resend_commitment {
1337 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
1340 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
1342 $chan.monitor_updating_paused($resend_raa, $resend_commitment, $resend_channel_ready, $failed_forwards, $failed_fails, $failed_finalized_fulfills);
1343 (Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$chan_id)), false)
1345 ChannelMonitorUpdateStatus::Completed => {
1350 ($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) => { {
1351 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());
1353 $entry.remove_entry();
1357 ($self: ident, $err: expr, $entry: expr, $action_type: path, $chan_id: expr, COMMITMENT_UPDATE_ONLY) => { {
1358 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst);
1359 handle_monitor_update_res!($self, $err, $entry, $action_type, false, true, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1361 ($self: ident, $err: expr, $entry: expr, $action_type: path, $chan_id: expr, NO_UPDATE) => {
1362 handle_monitor_update_res!($self, $err, $entry, $action_type, false, false, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1364 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_channel_ready: expr, OPTIONALLY_RESEND_FUNDING_LOCKED) => {
1365 handle_monitor_update_res!($self, $err, $entry, $action_type, false, false, $resend_channel_ready, Vec::new(), Vec::new(), Vec::new())
1367 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1368 handle_monitor_update_res!($self, $err, $entry, $action_type, $resend_raa, $resend_commitment, false, Vec::new(), Vec::new(), Vec::new())
1370 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
1371 handle_monitor_update_res!($self, $err, $entry, $action_type, $resend_raa, $resend_commitment, false, $failed_forwards, $failed_fails, Vec::new())
1375 macro_rules! send_channel_ready {
1376 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
1377 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1378 node_id: $channel.get_counterparty_node_id(),
1379 msg: $channel_ready_msg,
1381 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1382 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1383 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1384 let outbound_alias_insert = short_to_chan_info.insert($channel.outbound_scid_alias(), ($channel.get_counterparty_node_id(), $channel.channel_id()));
1385 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1386 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1387 if let Some(real_scid) = $channel.get_short_channel_id() {
1388 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.get_counterparty_node_id(), $channel.channel_id()));
1389 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1390 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1395 macro_rules! emit_channel_ready_event {
1396 ($self: expr, $channel: expr) => {
1397 if $channel.should_emit_channel_ready_event() {
1399 let mut pending_events = $self.pending_events.lock().unwrap();
1400 pending_events.push(events::Event::ChannelReady {
1401 channel_id: $channel.channel_id(),
1402 user_channel_id: $channel.get_user_id(),
1403 counterparty_node_id: $channel.get_counterparty_node_id(),
1404 channel_type: $channel.get_channel_type().clone(),
1407 $channel.set_channel_ready_event_emitted();
1412 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> ChannelManager<M, T, ES, NS, SP, F, R, L>
1414 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
1415 T::Target: BroadcasterInterface,
1416 ES::Target: EntropySource,
1417 NS::Target: NodeSigner,
1418 SP::Target: SignerProvider,
1419 F::Target: FeeEstimator,
1423 /// Constructs a new ChannelManager to hold several channels and route between them.
1425 /// This is the main "logic hub" for all channel-related actions, and implements
1426 /// ChannelMessageHandler.
1428 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1430 /// Users need to notify the new ChannelManager when a new block is connected or
1431 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
1432 /// from after `params.latest_hash`.
1433 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, entropy_source: ES, node_signer: NS, signer_provider: SP, config: UserConfig, params: ChainParameters) -> Self {
1434 let mut secp_ctx = Secp256k1::new();
1435 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
1436 let inbound_pmt_key_material = node_signer.get_inbound_payment_key_material();
1437 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
1439 default_configuration: config.clone(),
1440 genesis_hash: genesis_block(params.network).header.block_hash(),
1441 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
1446 best_block: RwLock::new(params.best_block),
1448 outbound_scid_aliases: Mutex::new(HashSet::new()),
1449 pending_inbound_payments: Mutex::new(HashMap::new()),
1450 pending_outbound_payments: OutboundPayments::new(),
1451 forward_htlcs: Mutex::new(HashMap::new()),
1452 claimable_payments: Mutex::new(ClaimablePayments { claimable_htlcs: HashMap::new(), pending_claiming_payments: HashMap::new() }),
1453 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
1454 id_to_peer: Mutex::new(HashMap::new()),
1455 short_to_chan_info: FairRwLock::new(HashMap::new()),
1457 our_network_pubkey: node_signer.get_node_id(Recipient::Node).unwrap(),
1460 inbound_payment_key: expanded_inbound_key,
1461 fake_scid_rand_bytes: entropy_source.get_secure_random_bytes(),
1463 probing_cookie_secret: entropy_source.get_secure_random_bytes(),
1465 highest_seen_timestamp: AtomicUsize::new(0),
1467 per_peer_state: FairRwLock::new(HashMap::new()),
1469 pending_events: Mutex::new(Vec::new()),
1470 pending_background_events: Mutex::new(Vec::new()),
1471 total_consistency_lock: RwLock::new(()),
1472 persistence_notifier: Notifier::new(),
1482 /// Gets the current configuration applied to all new channels.
1483 pub fn get_current_default_configuration(&self) -> &UserConfig {
1484 &self.default_configuration
1487 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
1488 let height = self.best_block.read().unwrap().height();
1489 let mut outbound_scid_alias = 0;
1492 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
1493 outbound_scid_alias += 1;
1495 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
1497 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
1501 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"); }
1506 /// Creates a new outbound channel to the given remote node and with the given value.
1508 /// `user_channel_id` will be provided back as in
1509 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
1510 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
1511 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
1512 /// is simply copied to events and otherwise ignored.
1514 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
1515 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
1517 /// Note that we do not check if you are currently connected to the given peer. If no
1518 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
1519 /// the channel eventually being silently forgotten (dropped on reload).
1521 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
1522 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
1523 /// [`ChannelDetails::channel_id`] until after
1524 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
1525 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
1526 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
1528 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
1529 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
1530 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
1531 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> {
1532 if channel_value_satoshis < 1000 {
1533 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
1536 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1537 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
1538 debug_assert!(&self.total_consistency_lock.try_write().is_err());
1540 let per_peer_state = self.per_peer_state.read().unwrap();
1542 let peer_state_mutex_opt = per_peer_state.get(&their_network_key);
1543 if let None = peer_state_mutex_opt {
1544 return Err(APIError::APIMisuseError { err: format!("Not connected to node: {}", their_network_key) });
1547 let mut peer_state = peer_state_mutex_opt.unwrap().lock().unwrap();
1549 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
1550 let their_features = &peer_state.latest_features;
1551 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
1552 match Channel::new_outbound(&self.fee_estimator, &self.entropy_source, &self.signer_provider, their_network_key,
1553 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
1554 self.best_block.read().unwrap().height(), outbound_scid_alias)
1558 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
1563 let res = channel.get_open_channel(self.genesis_hash.clone());
1565 let temporary_channel_id = channel.channel_id();
1566 match peer_state.channel_by_id.entry(temporary_channel_id) {
1567 hash_map::Entry::Occupied(_) => {
1569 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
1571 panic!("RNG is bad???");
1574 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
1577 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
1578 node_id: their_network_key,
1581 Ok(temporary_channel_id)
1584 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<<SP::Target as SignerProvider>::Signer>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
1585 let mut res = Vec::new();
1586 // Allocate our best estimate of the number of channels we have in the `res`
1587 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
1588 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
1589 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
1590 // unlikely as the `short_to_chan_info` map often contains 2 entries for
1591 // the same channel.
1592 res.reserve(self.short_to_chan_info.read().unwrap().len());
1594 let best_block_height = self.best_block.read().unwrap().height();
1595 let per_peer_state = self.per_peer_state.read().unwrap();
1596 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
1597 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
1598 let peer_state = &mut *peer_state_lock;
1599 for (channel_id, channel) in peer_state.channel_by_id.iter().filter(f) {
1600 let balance = channel.get_available_balances();
1601 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1602 channel.get_holder_counterparty_selected_channel_reserve_satoshis();
1603 res.push(ChannelDetails {
1604 channel_id: (*channel_id).clone(),
1605 counterparty: ChannelCounterparty {
1606 node_id: channel.get_counterparty_node_id(),
1607 features: peer_state.latest_features.clone(),
1608 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1609 forwarding_info: channel.counterparty_forwarding_info(),
1610 // Ensures that we have actually received the `htlc_minimum_msat` value
1611 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1612 // message (as they are always the first message from the counterparty).
1613 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1614 // default `0` value set by `Channel::new_outbound`.
1615 outbound_htlc_minimum_msat: if channel.have_received_message() {
1616 Some(channel.get_counterparty_htlc_minimum_msat()) } else { None },
1617 outbound_htlc_maximum_msat: channel.get_counterparty_htlc_maximum_msat(),
1619 funding_txo: channel.get_funding_txo(),
1620 // Note that accept_channel (or open_channel) is always the first message, so
1621 // `have_received_message` indicates that type negotiation has completed.
1622 channel_type: if channel.have_received_message() { Some(channel.get_channel_type().clone()) } else { None },
1623 short_channel_id: channel.get_short_channel_id(),
1624 outbound_scid_alias: if channel.is_usable() { Some(channel.outbound_scid_alias()) } else { None },
1625 inbound_scid_alias: channel.latest_inbound_scid_alias(),
1626 channel_value_satoshis: channel.get_value_satoshis(),
1627 unspendable_punishment_reserve: to_self_reserve_satoshis,
1628 balance_msat: balance.balance_msat,
1629 inbound_capacity_msat: balance.inbound_capacity_msat,
1630 outbound_capacity_msat: balance.outbound_capacity_msat,
1631 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1632 user_channel_id: channel.get_user_id(),
1633 confirmations_required: channel.minimum_depth(),
1634 confirmations: Some(channel.get_funding_tx_confirmations(best_block_height)),
1635 force_close_spend_delay: channel.get_counterparty_selected_contest_delay(),
1636 is_outbound: channel.is_outbound(),
1637 is_channel_ready: channel.is_usable(),
1638 is_usable: channel.is_live(),
1639 is_public: channel.should_announce(),
1640 inbound_htlc_minimum_msat: Some(channel.get_holder_htlc_minimum_msat()),
1641 inbound_htlc_maximum_msat: channel.get_holder_htlc_maximum_msat(),
1642 config: Some(channel.config()),
1650 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
1651 /// more information.
1652 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1653 self.list_channels_with_filter(|_| true)
1656 /// Gets the list of usable channels, in random order. Useful as an argument to [`find_route`]
1657 /// to ensure non-announced channels are used.
1659 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1660 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1663 /// [`find_route`]: crate::routing::router::find_route
1664 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1665 // Note we use is_live here instead of usable which leads to somewhat confused
1666 // internal/external nomenclature, but that's ok cause that's probably what the user
1667 // really wanted anyway.
1668 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1671 /// Helper function that issues the channel close events
1672 fn issue_channel_close_events(&self, channel: &Channel<<SP::Target as SignerProvider>::Signer>, closure_reason: ClosureReason) {
1673 let mut pending_events_lock = self.pending_events.lock().unwrap();
1674 match channel.unbroadcasted_funding() {
1675 Some(transaction) => {
1676 pending_events_lock.push(events::Event::DiscardFunding { channel_id: channel.channel_id(), transaction })
1680 pending_events_lock.push(events::Event::ChannelClosed {
1681 channel_id: channel.channel_id(),
1682 user_channel_id: channel.get_user_id(),
1683 reason: closure_reason
1687 fn close_channel_internal(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>) -> Result<(), APIError> {
1688 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1690 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
1691 let result: Result<(), _> = loop {
1692 let per_peer_state = self.per_peer_state.read().unwrap();
1694 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
1695 if let None = peer_state_mutex_opt {
1696 return Err(APIError::APIMisuseError { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) });
1699 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
1700 let peer_state = &mut *peer_state_lock;
1701 match peer_state.channel_by_id.entry(channel_id.clone()) {
1702 hash_map::Entry::Occupied(mut chan_entry) => {
1703 let (shutdown_msg, monitor_update, htlcs) = chan_entry.get_mut().get_shutdown(&self.signer_provider, &peer_state.latest_features, target_feerate_sats_per_1000_weight)?;
1704 failed_htlcs = htlcs;
1706 // Update the monitor with the shutdown script if necessary.
1707 if let Some(monitor_update) = monitor_update {
1708 let update_res = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), &monitor_update);
1709 let (result, is_permanent) =
1710 handle_monitor_update_res!(self, update_res, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
1712 remove_channel!(self, chan_entry);
1717 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1718 node_id: *counterparty_node_id,
1722 if chan_entry.get().is_shutdown() {
1723 let channel = remove_channel!(self, chan_entry);
1724 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
1725 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1729 self.issue_channel_close_events(&channel, ClosureReason::HolderForceClosed);
1733 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*channel_id), counterparty_node_id) })
1737 for htlc_source in failed_htlcs.drain(..) {
1738 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
1739 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
1740 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
1743 let _ = handle_error!(self, result, *counterparty_node_id);
1747 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1748 /// will be accepted on the given channel, and after additional timeout/the closing of all
1749 /// pending HTLCs, the channel will be closed on chain.
1751 /// * If we are the channel initiator, we will pay between our [`Background`] and
1752 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1754 /// * If our counterparty is the channel initiator, we will require a channel closing
1755 /// transaction feerate of at least our [`Background`] feerate or the feerate which
1756 /// would appear on a force-closure transaction, whichever is lower. We will allow our
1757 /// counterparty to pay as much fee as they'd like, however.
1759 /// May generate a SendShutdown message event on success, which should be relayed.
1761 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1762 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1763 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1764 pub fn close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
1765 self.close_channel_internal(channel_id, counterparty_node_id, None)
1768 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1769 /// will be accepted on the given channel, and after additional timeout/the closing of all
1770 /// pending HTLCs, the channel will be closed on chain.
1772 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
1773 /// the channel being closed or not:
1774 /// * If we are the channel initiator, we will pay at least this feerate on the closing
1775 /// transaction. The upper-bound is set by
1776 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1777 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
1778 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
1779 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
1780 /// will appear on a force-closure transaction, whichever is lower).
1782 /// May generate a SendShutdown message event on success, which should be relayed.
1784 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1785 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1786 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1787 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> {
1788 self.close_channel_internal(channel_id, counterparty_node_id, Some(target_feerate_sats_per_1000_weight))
1792 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1793 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1794 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
1795 for htlc_source in failed_htlcs.drain(..) {
1796 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
1797 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
1798 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
1799 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
1801 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1802 // There isn't anything we can do if we get an update failure - we're already
1803 // force-closing. The monitor update on the required in-memory copy should broadcast
1804 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1805 // ignore the result here.
1806 let _ = self.chain_monitor.update_channel(funding_txo, &monitor_update);
1810 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
1811 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
1812 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
1813 -> Result<PublicKey, APIError> {
1814 let per_peer_state = self.per_peer_state.read().unwrap();
1815 let peer_state_mutex_opt = per_peer_state.get(peer_node_id);
1817 if let None = peer_state_mutex_opt {
1818 return Err(APIError::APIMisuseError{ err: format!("Can't find a peer matching the passed counterparty node_id {}", peer_node_id) });
1820 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
1821 let peer_state = &mut *peer_state_lock;
1822 if let hash_map::Entry::Occupied(chan) = peer_state.channel_by_id.entry(channel_id.clone()) {
1823 if let Some(peer_msg) = peer_msg {
1824 self.issue_channel_close_events(chan.get(),ClosureReason::CounterpartyForceClosed { peer_msg: peer_msg.to_string() });
1826 self.issue_channel_close_events(chan.get(),ClosureReason::HolderForceClosed);
1828 remove_channel!(self, chan)
1830 return Err(APIError::ChannelUnavailable{ err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*channel_id), peer_node_id) });
1833 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
1834 self.finish_force_close_channel(chan.force_shutdown(broadcast));
1835 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
1836 let mut peer_state = peer_state_mutex_opt.unwrap().lock().unwrap();
1837 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1842 Ok(chan.get_counterparty_node_id())
1845 fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
1846 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1847 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
1848 Ok(counterparty_node_id) => {
1849 let per_peer_state = self.per_peer_state.read().unwrap();
1850 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
1851 let mut peer_state = peer_state_mutex.lock().unwrap();
1852 peer_state.pending_msg_events.push(
1853 events::MessageSendEvent::HandleError {
1854 node_id: counterparty_node_id,
1855 action: msgs::ErrorAction::SendErrorMessage {
1856 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
1867 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
1868 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
1869 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
1871 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
1872 -> Result<(), APIError> {
1873 self.force_close_sending_error(channel_id, counterparty_node_id, true)
1876 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
1877 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
1878 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
1880 /// You can always get the latest local transaction(s) to broadcast from
1881 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
1882 pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
1883 -> Result<(), APIError> {
1884 self.force_close_sending_error(channel_id, counterparty_node_id, false)
1887 /// Force close all channels, immediately broadcasting the latest local commitment transaction
1888 /// for each to the chain and rejecting new HTLCs on each.
1889 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
1890 for chan in self.list_channels() {
1891 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
1895 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
1896 /// local transaction(s).
1897 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
1898 for chan in self.list_channels() {
1899 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
1903 fn construct_recv_pending_htlc_info(&self, hop_data: msgs::OnionHopData, shared_secret: [u8; 32],
1904 payment_hash: PaymentHash, amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>) -> Result<PendingHTLCInfo, ReceiveError>
1906 // final_incorrect_cltv_expiry
1907 if hop_data.outgoing_cltv_value != cltv_expiry {
1908 return Err(ReceiveError {
1909 msg: "Upstream node set CLTV to the wrong value",
1911 err_data: cltv_expiry.to_be_bytes().to_vec()
1914 // final_expiry_too_soon
1915 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
1916 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
1918 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
1919 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
1920 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
1921 let current_height: u32 = self.best_block.read().unwrap().height();
1922 if (hop_data.outgoing_cltv_value as u64) <= current_height as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
1923 let mut err_data = Vec::with_capacity(12);
1924 err_data.extend_from_slice(&amt_msat.to_be_bytes());
1925 err_data.extend_from_slice(¤t_height.to_be_bytes());
1926 return Err(ReceiveError {
1927 err_code: 0x4000 | 15, err_data,
1928 msg: "The final CLTV expiry is too soon to handle",
1931 if hop_data.amt_to_forward > amt_msat {
1932 return Err(ReceiveError {
1934 err_data: amt_msat.to_be_bytes().to_vec(),
1935 msg: "Upstream node sent less than we were supposed to receive in payment",
1939 let routing = match hop_data.format {
1940 msgs::OnionHopDataFormat::NonFinalNode { .. } => {
1941 return Err(ReceiveError {
1942 err_code: 0x4000|22,
1943 err_data: Vec::new(),
1944 msg: "Got non final data with an HMAC of 0",
1947 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage } => {
1948 if payment_data.is_some() && keysend_preimage.is_some() {
1949 return Err(ReceiveError {
1950 err_code: 0x4000|22,
1951 err_data: Vec::new(),
1952 msg: "We don't support MPP keysend payments",
1954 } else if let Some(data) = payment_data {
1955 PendingHTLCRouting::Receive {
1957 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
1958 phantom_shared_secret,
1960 } else if let Some(payment_preimage) = keysend_preimage {
1961 // We need to check that the sender knows the keysend preimage before processing this
1962 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
1963 // could discover the final destination of X, by probing the adjacent nodes on the route
1964 // with a keysend payment of identical payment hash to X and observing the processing
1965 // time discrepancies due to a hash collision with X.
1966 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
1967 if hashed_preimage != payment_hash {
1968 return Err(ReceiveError {
1969 err_code: 0x4000|22,
1970 err_data: Vec::new(),
1971 msg: "Payment preimage didn't match payment hash",
1975 PendingHTLCRouting::ReceiveKeysend {
1977 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
1980 return Err(ReceiveError {
1981 err_code: 0x4000|0x2000|3,
1982 err_data: Vec::new(),
1983 msg: "We require payment_secrets",
1988 Ok(PendingHTLCInfo {
1991 incoming_shared_secret: shared_secret,
1992 incoming_amt_msat: Some(amt_msat),
1993 outgoing_amt_msat: amt_msat,
1994 outgoing_cltv_value: hop_data.outgoing_cltv_value,
1998 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> PendingHTLCStatus {
1999 macro_rules! return_malformed_err {
2000 ($msg: expr, $err_code: expr) => {
2002 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2003 return PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
2004 channel_id: msg.channel_id,
2005 htlc_id: msg.htlc_id,
2006 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
2007 failure_code: $err_code,
2013 if let Err(_) = msg.onion_routing_packet.public_key {
2014 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2017 let shared_secret = self.node_signer.ecdh(
2018 Recipient::Node, &msg.onion_routing_packet.public_key.unwrap(), None
2019 ).unwrap().secret_bytes();
2021 if msg.onion_routing_packet.version != 0 {
2022 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2023 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2024 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2025 //receiving node would have to brute force to figure out which version was put in the
2026 //packet by the node that send us the message, in the case of hashing the hop_data, the
2027 //node knows the HMAC matched, so they already know what is there...
2028 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2030 macro_rules! return_err {
2031 ($msg: expr, $err_code: expr, $data: expr) => {
2033 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2034 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2035 channel_id: msg.channel_id,
2036 htlc_id: msg.htlc_id,
2037 reason: HTLCFailReason::reason($err_code, $data.to_vec())
2038 .get_encrypted_failure_packet(&shared_secret, &None),
2044 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) {
2046 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2047 return_malformed_err!(err_msg, err_code);
2049 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2050 return_err!(err_msg, err_code, &[0; 0]);
2054 let pending_forward_info = match next_hop {
2055 onion_utils::Hop::Receive(next_hop_data) => {
2057 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash, msg.amount_msat, msg.cltv_expiry, None) {
2059 // Note that we could obviously respond immediately with an update_fulfill_htlc
2060 // message, however that would leak that we are the recipient of this payment, so
2061 // instead we stay symmetric with the forwarding case, only responding (after a
2062 // delay) once they've send us a commitment_signed!
2063 PendingHTLCStatus::Forward(info)
2065 Err(ReceiveError { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
2068 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
2069 let new_pubkey = msg.onion_routing_packet.public_key.unwrap();
2070 let outgoing_packet = msgs::OnionPacket {
2072 public_key: onion_utils::next_hop_packet_pubkey(&self.secp_ctx, new_pubkey, &shared_secret),
2073 hop_data: new_packet_bytes,
2074 hmac: next_hop_hmac.clone(),
2077 let short_channel_id = match next_hop_data.format {
2078 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
2079 msgs::OnionHopDataFormat::FinalNode { .. } => {
2080 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
2084 PendingHTLCStatus::Forward(PendingHTLCInfo {
2085 routing: PendingHTLCRouting::Forward {
2086 onion_packet: outgoing_packet,
2089 payment_hash: msg.payment_hash.clone(),
2090 incoming_shared_secret: shared_secret,
2091 incoming_amt_msat: Some(msg.amount_msat),
2092 outgoing_amt_msat: next_hop_data.amt_to_forward,
2093 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
2098 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref outgoing_amt_msat, ref outgoing_cltv_value, .. }) = &pending_forward_info {
2099 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
2100 // with a short_channel_id of 0. This is important as various things later assume
2101 // short_channel_id is non-0 in any ::Forward.
2102 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
2103 if let Some((err, mut code, chan_update)) = loop {
2104 let id_option = self.short_to_chan_info.read().unwrap().get(short_channel_id).cloned();
2105 let forwarding_chan_info_opt = match id_option {
2106 None => { // unknown_next_peer
2107 // Note that this is likely a timing oracle for detecting whether an scid is a
2108 // phantom or an intercept.
2109 if (self.default_configuration.accept_intercept_htlcs &&
2110 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, *short_channel_id, &self.genesis_hash)) ||
2111 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, *short_channel_id, &self.genesis_hash)
2115 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2118 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
2120 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
2121 let per_peer_state = self.per_peer_state.read().unwrap();
2122 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
2123 if let None = peer_state_mutex_opt {
2124 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2126 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
2127 let peer_state = &mut *peer_state_lock;
2128 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id) {
2130 // Channel was removed. The short_to_chan_info and channel_by_id maps
2131 // have no consistency guarantees.
2132 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2136 if !chan.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
2137 // Note that the behavior here should be identical to the above block - we
2138 // should NOT reveal the existence or non-existence of a private channel if
2139 // we don't allow forwards outbound over them.
2140 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
2142 if chan.get_channel_type().supports_scid_privacy() && *short_channel_id != chan.outbound_scid_alias() {
2143 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
2144 // "refuse to forward unless the SCID alias was used", so we pretend
2145 // we don't have the channel here.
2146 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
2148 let chan_update_opt = self.get_channel_update_for_onion(*short_channel_id, chan).ok();
2150 // Note that we could technically not return an error yet here and just hope
2151 // that the connection is reestablished or monitor updated by the time we get
2152 // around to doing the actual forward, but better to fail early if we can and
2153 // hopefully an attacker trying to path-trace payments cannot make this occur
2154 // on a small/per-node/per-channel scale.
2155 if !chan.is_live() { // channel_disabled
2156 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, chan_update_opt));
2158 if *outgoing_amt_msat < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
2159 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
2161 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, *outgoing_amt_msat, *outgoing_cltv_value) {
2162 break Some((err, code, chan_update_opt));
2166 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 {
2167 // We really should set `incorrect_cltv_expiry` here but as we're not
2168 // forwarding over a real channel we can't generate a channel_update
2169 // for it. Instead we just return a generic temporary_node_failure.
2171 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
2178 let cur_height = self.best_block.read().unwrap().height() + 1;
2179 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
2180 // but we want to be robust wrt to counterparty packet sanitization (see
2181 // HTLC_FAIL_BACK_BUFFER rationale).
2182 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
2183 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
2185 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
2186 break Some(("CLTV expiry is too far in the future", 21, None));
2188 // If the HTLC expires ~now, don't bother trying to forward it to our
2189 // counterparty. They should fail it anyway, but we don't want to bother with
2190 // the round-trips or risk them deciding they definitely want the HTLC and
2191 // force-closing to ensure they get it if we're offline.
2192 // We previously had a much more aggressive check here which tried to ensure
2193 // our counterparty receives an HTLC which has *our* risk threshold met on it,
2194 // but there is no need to do that, and since we're a bit conservative with our
2195 // risk threshold it just results in failing to forward payments.
2196 if (*outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
2197 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
2203 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
2204 if let Some(chan_update) = chan_update {
2205 if code == 0x1000 | 11 || code == 0x1000 | 12 {
2206 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
2208 else if code == 0x1000 | 13 {
2209 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
2211 else if code == 0x1000 | 20 {
2212 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
2213 0u16.write(&mut res).expect("Writes cannot fail");
2215 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
2216 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
2217 chan_update.write(&mut res).expect("Writes cannot fail");
2218 } else if code & 0x1000 == 0x1000 {
2219 // If we're trying to return an error that requires a `channel_update` but
2220 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
2221 // generate an update), just use the generic "temporary_node_failure"
2225 return_err!(err, code, &res.0[..]);
2230 pending_forward_info
2233 /// Gets the current channel_update for the given channel. This first checks if the channel is
2234 /// public, and thus should be called whenever the result is going to be passed out in a
2235 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
2237 /// May be called with peer_state already locked!
2238 fn get_channel_update_for_broadcast(&self, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2239 if !chan.should_announce() {
2240 return Err(LightningError {
2241 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
2242 action: msgs::ErrorAction::IgnoreError
2245 if chan.get_short_channel_id().is_none() {
2246 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
2248 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.channel_id()));
2249 self.get_channel_update_for_unicast(chan)
2252 /// Gets the current channel_update for the given channel. This does not check if the channel
2253 /// is public (only returning an Err if the channel does not yet have an assigned short_id),
2254 /// and thus MUST NOT be called unless the recipient of the resulting message has already
2255 /// provided evidence that they know about the existence of the channel.
2256 /// May be called with peer_state already locked!
2257 fn get_channel_update_for_unicast(&self, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2258 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.channel_id()));
2259 let short_channel_id = match chan.get_short_channel_id().or(chan.latest_inbound_scid_alias()) {
2260 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
2264 self.get_channel_update_for_onion(short_channel_id, chan)
2266 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2267 log_trace!(self.logger, "Generating channel update for channel {}", log_bytes!(chan.channel_id()));
2268 let were_node_one = self.our_network_pubkey.serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
2270 let unsigned = msgs::UnsignedChannelUpdate {
2271 chain_hash: self.genesis_hash,
2273 timestamp: chan.get_update_time_counter(),
2274 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
2275 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
2276 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
2277 htlc_maximum_msat: chan.get_announced_htlc_max_msat(),
2278 fee_base_msat: chan.get_outbound_forwarding_fee_base_msat(),
2279 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
2280 excess_data: Vec::new(),
2282 // Panic on failure to signal LDK should be restarted to retry signing the `ChannelUpdate`.
2283 // If we returned an error and the `node_signer` cannot provide a signature for whatever
2284 // reason`, we wouldn't be able to receive inbound payments through the corresponding
2286 let sig = self.node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelUpdate(&unsigned)).unwrap();
2288 Ok(msgs::ChannelUpdate {
2294 // Only public for testing, this should otherwise never be called direcly
2295 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> {
2296 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
2297 let prng_seed = self.entropy_source.get_secure_random_bytes();
2298 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
2300 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
2301 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected"})?;
2302 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
2303 if onion_utils::route_size_insane(&onion_payloads) {
2304 return Err(APIError::InvalidRoute{err: "Route size too large considering onion data"});
2306 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
2308 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2310 let err: Result<(), _> = loop {
2311 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.first().unwrap().short_channel_id) {
2312 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
2313 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
2316 let per_peer_state = self.per_peer_state.read().unwrap();
2317 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
2318 if let None = peer_state_mutex_opt {
2319 return Err(APIError::InvalidRoute{err: "No peer matching the path's first hop found!" });
2321 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
2322 let peer_state = &mut *peer_state_lock;
2323 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(id) {
2325 if !chan.get().is_live() {
2326 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
2328 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(
2329 htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
2331 session_priv: session_priv.clone(),
2332 first_hop_htlc_msat: htlc_msat,
2334 payment_secret: payment_secret.clone(),
2335 payment_params: payment_params.clone(),
2336 }, onion_packet, &self.logger),
2339 Some((update_add, commitment_signed, monitor_update)) => {
2340 let update_err = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), &monitor_update);
2341 let chan_id = chan.get().channel_id();
2343 handle_monitor_update_res!(self, update_err, chan,
2344 RAACommitmentOrder::CommitmentFirst, false, true))
2346 (ChannelMonitorUpdateStatus::PermanentFailure, Err(e)) => break Err(e),
2347 (ChannelMonitorUpdateStatus::Completed, Ok(())) => {},
2348 (ChannelMonitorUpdateStatus::InProgress, Err(_)) => {
2349 // Note that MonitorUpdateInProgress here indicates (per function
2350 // docs) that we will resend the commitment update once monitor
2351 // updating completes. Therefore, we must return an error
2352 // indicating that it is unsafe to retry the payment wholesale,
2353 // which we do in the send_payment check for
2354 // MonitorUpdateInProgress, below.
2355 return Err(APIError::MonitorUpdateInProgress);
2357 _ => unreachable!(),
2360 log_debug!(self.logger, "Sending payment along path resulted in a commitment_signed for channel {}", log_bytes!(chan_id));
2361 peer_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2362 node_id: path.first().unwrap().pubkey,
2363 updates: msgs::CommitmentUpdate {
2364 update_add_htlcs: vec![update_add],
2365 update_fulfill_htlcs: Vec::new(),
2366 update_fail_htlcs: Vec::new(),
2367 update_fail_malformed_htlcs: Vec::new(),
2376 // The channel was likely removed after we fetched the id from the
2377 // `short_to_chan_info` map, but before we successfully locked the
2378 // `channel_by_id` map.
2379 // This can occur as no consistency guarantees exists between the two maps.
2380 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
2385 match handle_error!(self, err, path.first().unwrap().pubkey) {
2386 Ok(_) => unreachable!(),
2388 Err(APIError::ChannelUnavailable { err: e.err })
2393 /// Sends a payment along a given route.
2395 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
2396 /// fields for more info.
2398 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
2399 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
2400 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
2401 /// [`Event::PaymentSent`]) LDK will not stop you from sending a second payment with the same
2404 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
2405 /// tracking of payments, including state to indicate once a payment has completed. Because you
2406 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
2407 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
2408 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
2410 /// May generate SendHTLCs message(s) event on success, which should be relayed (e.g. via
2411 /// [`PeerManager::process_events`]).
2413 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
2414 /// each entry matching the corresponding-index entry in the route paths, see
2415 /// PaymentSendFailure for more info.
2417 /// In general, a path may raise:
2418 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
2419 /// node public key) is specified.
2420 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
2421 /// (including due to previous monitor update failure or new permanent monitor update
2423 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
2424 /// relevant updates.
2426 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
2427 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
2428 /// different route unless you intend to pay twice!
2430 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
2431 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
2432 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
2433 /// must not contain multiple paths as multi-path payments require a recipient-provided
2436 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
2437 /// bit set (either as required or as available). If multiple paths are present in the Route,
2438 /// we assume the invoice had the basic_mpp feature set.
2440 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2441 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
2442 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2443 let best_block_height = self.best_block.read().unwrap().height();
2444 self.pending_outbound_payments
2445 .send_payment_with_route(route, payment_hash, payment_secret, payment_id, &self.entropy_source, &self.node_signer, best_block_height,
2446 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2447 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2451 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> {
2452 let best_block_height = self.best_block.read().unwrap().height();
2453 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, payment_secret, keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.node_signer, best_block_height,
2454 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2455 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2459 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> {
2460 let best_block_height = self.best_block.read().unwrap().height();
2461 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, payment_secret, payment_id, route, &self.entropy_source, best_block_height)
2465 /// Retries a payment along the given [`Route`].
2467 /// Errors returned are a superset of those returned from [`send_payment`], so see
2468 /// [`send_payment`] documentation for more details on errors. This method will also error if the
2469 /// retry amount puts the payment more than 10% over the payment's total amount, if the payment
2470 /// for the given `payment_id` cannot be found (likely due to timeout or success), or if
2471 /// further retries have been disabled with [`abandon_payment`].
2473 /// [`send_payment`]: [`ChannelManager::send_payment`]
2474 /// [`abandon_payment`]: [`ChannelManager::abandon_payment`]
2475 pub fn retry_payment(&self, route: &Route, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2476 let best_block_height = self.best_block.read().unwrap().height();
2477 self.pending_outbound_payments.retry_payment_with_route(route, payment_id, &self.entropy_source, &self.node_signer, best_block_height,
2478 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2479 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2482 /// Signals that no further retries for the given payment will occur.
2484 /// After this method returns, no future calls to [`retry_payment`] for the given `payment_id`
2485 /// are allowed. If no [`Event::PaymentFailed`] event had been generated before, one will be
2486 /// generated as soon as there are no remaining pending HTLCs for this payment.
2488 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
2489 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
2490 /// determine the ultimate status of a payment.
2492 /// If an [`Event::PaymentFailed`] event is generated and we restart without this
2493 /// [`ChannelManager`] having been persisted, the payment may still be in the pending state
2494 /// upon restart. This allows further calls to [`retry_payment`] (and requiring a second call
2495 /// to [`abandon_payment`] to mark the payment as failed again). Otherwise, future calls to
2496 /// [`retry_payment`] will fail with [`PaymentSendFailure::ParameterError`].
2498 /// [`abandon_payment`]: Self::abandon_payment
2499 /// [`retry_payment`]: Self::retry_payment
2500 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
2501 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2502 pub fn abandon_payment(&self, payment_id: PaymentId) {
2503 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2504 if let Some(payment_failed_ev) = self.pending_outbound_payments.abandon_payment(payment_id) {
2505 self.pending_events.lock().unwrap().push(payment_failed_ev);
2509 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
2510 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
2511 /// the preimage, it must be a cryptographically secure random value that no intermediate node
2512 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
2513 /// never reach the recipient.
2515 /// See [`send_payment`] documentation for more details on the return value of this function
2516 /// and idempotency guarantees provided by the [`PaymentId`] key.
2518 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
2519 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
2521 /// Note that `route` must have exactly one path.
2523 /// [`send_payment`]: Self::send_payment
2524 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
2525 let best_block_height = self.best_block.read().unwrap().height();
2526 self.pending_outbound_payments.send_spontaneous_payment(route, payment_preimage, payment_id, &self.entropy_source, &self.node_signer, best_block_height,
2527 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2528 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2531 /// Send a payment that is probing the given route for liquidity. We calculate the
2532 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
2533 /// us to easily discern them from real payments.
2534 pub fn send_probe(&self, hops: Vec<RouteHop>) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
2535 let best_block_height = self.best_block.read().unwrap().height();
2536 self.pending_outbound_payments.send_probe(hops, self.probing_cookie_secret, &self.entropy_source, &self.node_signer, best_block_height,
2537 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2538 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2541 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
2544 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
2545 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
2548 /// Handles the generation of a funding transaction, optionally (for tests) with a function
2549 /// which checks the correctness of the funding transaction given the associated channel.
2550 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<<SP::Target as SignerProvider>::Signer>, &Transaction) -> Result<OutPoint, APIError>>(
2551 &self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
2552 ) -> Result<(), APIError> {
2553 let per_peer_state = self.per_peer_state.read().unwrap();
2554 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
2555 if let None = peer_state_mutex_opt {
2556 return Err(APIError::ChannelUnavailable { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })
2559 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
2560 let peer_state = &mut *peer_state_lock;
2563 match peer_state.channel_by_id.remove(temporary_channel_id) {
2565 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
2567 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
2568 .map_err(|e| if let ChannelError::Close(msg) = e {
2569 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.get_user_id(), chan.force_shutdown(true), None)
2570 } else { unreachable!(); })
2573 None => { return Err(APIError::ChannelUnavailable { err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*temporary_channel_id), counterparty_node_id) }) },
2576 match handle_error!(self, res, chan.get_counterparty_node_id()) {
2577 Ok(funding_msg) => {
2580 Err(_) => { return Err(APIError::ChannelUnavailable {
2581 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()
2586 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
2587 node_id: chan.get_counterparty_node_id(),
2590 match peer_state.channel_by_id.entry(chan.channel_id()) {
2591 hash_map::Entry::Occupied(_) => {
2592 panic!("Generated duplicate funding txid?");
2594 hash_map::Entry::Vacant(e) => {
2595 let mut id_to_peer = self.id_to_peer.lock().unwrap();
2596 if id_to_peer.insert(chan.channel_id(), chan.get_counterparty_node_id()).is_some() {
2597 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
2606 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> {
2607 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
2608 Ok(OutPoint { txid: tx.txid(), index: output_index })
2612 /// Call this upon creation of a funding transaction for the given channel.
2614 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
2615 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
2617 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
2618 /// across the p2p network.
2620 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
2621 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
2623 /// May panic if the output found in the funding transaction is duplicative with some other
2624 /// channel (note that this should be trivially prevented by using unique funding transaction
2625 /// keys per-channel).
2627 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
2628 /// counterparty's signature the funding transaction will automatically be broadcast via the
2629 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
2631 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
2632 /// not currently support replacing a funding transaction on an existing channel. Instead,
2633 /// create a new channel with a conflicting funding transaction.
2635 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
2636 /// the wallet software generating the funding transaction to apply anti-fee sniping as
2637 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
2638 /// for more details.
2640 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
2641 /// [`Event::ChannelClosed`]: crate::util::events::Event::ChannelClosed
2642 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
2643 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2645 for inp in funding_transaction.input.iter() {
2646 if inp.witness.is_empty() {
2647 return Err(APIError::APIMisuseError {
2648 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
2653 let height = self.best_block.read().unwrap().height();
2654 // Transactions are evaluated as final by network mempools at the next block. However, the modules
2655 // constituting our Lightning node might not have perfect sync about their blockchain views. Thus, if
2656 // the wallet module is in advance on the LDK view, allow one more block of headroom.
2657 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 {
2658 return Err(APIError::APIMisuseError {
2659 err: "Funding transaction absolute timelock is non-final".to_owned()
2663 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
2664 let mut output_index = None;
2665 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
2666 for (idx, outp) in tx.output.iter().enumerate() {
2667 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
2668 if output_index.is_some() {
2669 return Err(APIError::APIMisuseError {
2670 err: "Multiple outputs matched the expected script and value".to_owned()
2673 if idx > u16::max_value() as usize {
2674 return Err(APIError::APIMisuseError {
2675 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
2678 output_index = Some(idx as u16);
2681 if output_index.is_none() {
2682 return Err(APIError::APIMisuseError {
2683 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
2686 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
2690 /// Atomically updates the [`ChannelConfig`] for the given channels.
2692 /// Once the updates are applied, each eligible channel (advertised with a known short channel
2693 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
2694 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
2695 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
2697 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
2698 /// `counterparty_node_id` is provided.
2700 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
2701 /// below [`MIN_CLTV_EXPIRY_DELTA`].
2703 /// If an error is returned, none of the updates should be considered applied.
2705 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
2706 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
2707 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
2708 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
2709 /// [`ChannelUpdate`]: msgs::ChannelUpdate
2710 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
2711 /// [`APIMisuseError`]: APIError::APIMisuseError
2712 pub fn update_channel_config(
2713 &self, counterparty_node_id: &PublicKey, channel_ids: &[[u8; 32]], config: &ChannelConfig,
2714 ) -> Result<(), APIError> {
2715 if config.cltv_expiry_delta < MIN_CLTV_EXPIRY_DELTA {
2716 return Err(APIError::APIMisuseError {
2717 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
2721 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(
2722 &self.total_consistency_lock, &self.persistence_notifier,
2724 let per_peer_state = self.per_peer_state.read().unwrap();
2725 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
2726 if let None = peer_state_mutex_opt {
2727 return Err(APIError::APIMisuseError{ err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) });
2729 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
2730 let peer_state = &mut *peer_state_lock;
2731 for channel_id in channel_ids {
2732 if !peer_state.channel_by_id.contains_key(channel_id) {
2733 return Err(APIError::ChannelUnavailable {
2734 err: format!("Channel with ID {} was not found for the passed counterparty_node_id {}", log_bytes!(*channel_id), counterparty_node_id),
2738 for channel_id in channel_ids {
2739 let channel = peer_state.channel_by_id.get_mut(channel_id).unwrap();
2740 if !channel.update_config(config) {
2743 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
2744 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
2745 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
2746 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
2747 node_id: channel.get_counterparty_node_id(),
2755 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
2756 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
2758 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
2759 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
2761 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
2762 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
2763 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
2764 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
2765 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
2767 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
2768 /// you from forwarding more than you received.
2770 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
2773 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
2774 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
2775 // TODO: when we move to deciding the best outbound channel at forward time, only take
2776 // `next_node_id` and not `next_hop_channel_id`
2777 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> {
2778 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2780 let next_hop_scid = {
2781 let peer_state_lock = self.per_peer_state.read().unwrap();
2782 if let Some(peer_state_mutex) = peer_state_lock.get(&next_node_id) {
2783 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2784 let peer_state = &mut *peer_state_lock;
2785 match peer_state.channel_by_id.get(next_hop_channel_id) {
2787 if !chan.is_usable() {
2788 return Err(APIError::ChannelUnavailable {
2789 err: format!("Channel with id {} not fully established", log_bytes!(*next_hop_channel_id))
2792 chan.get_short_channel_id().unwrap_or(chan.outbound_scid_alias())
2794 None => return Err(APIError::ChannelUnavailable {
2795 err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*next_hop_channel_id), next_node_id)
2799 return Err(APIError::APIMisuseError{ err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) });
2803 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
2804 .ok_or_else(|| APIError::APIMisuseError {
2805 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
2808 let routing = match payment.forward_info.routing {
2809 PendingHTLCRouting::Forward { onion_packet, .. } => {
2810 PendingHTLCRouting::Forward { onion_packet, short_channel_id: next_hop_scid }
2812 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
2814 let pending_htlc_info = PendingHTLCInfo {
2815 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
2818 let mut per_source_pending_forward = [(
2819 payment.prev_short_channel_id,
2820 payment.prev_funding_outpoint,
2821 payment.prev_user_channel_id,
2822 vec![(pending_htlc_info, payment.prev_htlc_id)]
2824 self.forward_htlcs(&mut per_source_pending_forward);
2828 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
2829 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
2831 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
2834 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
2835 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
2836 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2838 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
2839 .ok_or_else(|| APIError::APIMisuseError {
2840 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
2843 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
2844 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2845 short_channel_id: payment.prev_short_channel_id,
2846 outpoint: payment.prev_funding_outpoint,
2847 htlc_id: payment.prev_htlc_id,
2848 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
2849 phantom_shared_secret: None,
2852 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
2853 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
2854 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
2855 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
2860 /// Processes HTLCs which are pending waiting on random forward delay.
2862 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
2863 /// Will likely generate further events.
2864 pub fn process_pending_htlc_forwards(&self) {
2865 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2867 let mut new_events = Vec::new();
2868 let mut failed_forwards = Vec::new();
2869 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
2871 let mut forward_htlcs = HashMap::new();
2872 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
2874 for (short_chan_id, mut pending_forwards) in forward_htlcs {
2875 if short_chan_id != 0 {
2876 macro_rules! forwarding_channel_not_found {
2878 for forward_info in pending_forwards.drain(..) {
2879 match forward_info {
2880 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
2881 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
2882 forward_info: PendingHTLCInfo {
2883 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
2884 outgoing_cltv_value, incoming_amt_msat: _
2887 macro_rules! failure_handler {
2888 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
2889 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2891 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2892 short_channel_id: prev_short_channel_id,
2893 outpoint: prev_funding_outpoint,
2894 htlc_id: prev_htlc_id,
2895 incoming_packet_shared_secret: incoming_shared_secret,
2896 phantom_shared_secret: $phantom_ss,
2899 let reason = if $next_hop_unknown {
2900 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
2902 HTLCDestination::FailedPayment{ payment_hash }
2905 failed_forwards.push((htlc_source, payment_hash,
2906 HTLCFailReason::reason($err_code, $err_data),
2912 macro_rules! fail_forward {
2913 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
2915 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
2919 macro_rules! failed_payment {
2920 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
2922 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
2926 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
2927 let phantom_pubkey_res = self.node_signer.get_node_id(Recipient::PhantomNode);
2928 if phantom_pubkey_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.genesis_hash) {
2929 let phantom_shared_secret = self.node_signer.ecdh(Recipient::PhantomNode, &onion_packet.public_key.unwrap(), None).unwrap().secret_bytes();
2930 let next_hop = match onion_utils::decode_next_payment_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
2932 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2933 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
2934 // In this scenario, the phantom would have sent us an
2935 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
2936 // if it came from us (the second-to-last hop) but contains the sha256
2938 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
2940 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2941 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
2945 onion_utils::Hop::Receive(hop_data) => {
2946 match self.construct_recv_pending_htlc_info(hop_data, incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value, Some(phantom_shared_secret)) {
2947 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
2948 Err(ReceiveError { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
2954 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
2957 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
2960 HTLCForwardInfo::FailHTLC { .. } => {
2961 // Channel went away before we could fail it. This implies
2962 // the channel is now on chain and our counterparty is
2963 // trying to broadcast the HTLC-Timeout, but that's their
2964 // problem, not ours.
2970 let (counterparty_node_id, forward_chan_id) = match self.short_to_chan_info.read().unwrap().get(&short_chan_id) {
2971 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
2973 forwarding_channel_not_found!();
2977 let per_peer_state = self.per_peer_state.read().unwrap();
2978 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
2979 if let None = peer_state_mutex_opt {
2980 forwarding_channel_not_found!();
2983 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
2984 let peer_state = &mut *peer_state_lock;
2985 match peer_state.channel_by_id.entry(forward_chan_id) {
2986 hash_map::Entry::Vacant(_) => {
2987 forwarding_channel_not_found!();
2990 hash_map::Entry::Occupied(mut chan) => {
2991 for forward_info in pending_forwards.drain(..) {
2992 match forward_info {
2993 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
2994 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id: _,
2995 forward_info: PendingHTLCInfo {
2996 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
2997 routing: PendingHTLCRouting::Forward { onion_packet, .. }, incoming_amt_msat: _,
3000 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);
3001 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3002 short_channel_id: prev_short_channel_id,
3003 outpoint: prev_funding_outpoint,
3004 htlc_id: prev_htlc_id,
3005 incoming_packet_shared_secret: incoming_shared_secret,
3006 // Phantom payments are only PendingHTLCRouting::Receive.
3007 phantom_shared_secret: None,
3009 if let Err(e) = chan.get_mut().queue_add_htlc(outgoing_amt_msat,
3010 payment_hash, outgoing_cltv_value, htlc_source.clone(),
3011 onion_packet, &self.logger)
3013 if let ChannelError::Ignore(msg) = e {
3014 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
3016 panic!("Stated return value requirements in send_htlc() were not met");
3018 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan.get());
3019 failed_forwards.push((htlc_source, payment_hash,
3020 HTLCFailReason::reason(failure_code, data),
3021 HTLCDestination::NextHopChannel { node_id: Some(chan.get().get_counterparty_node_id()), channel_id: forward_chan_id }
3026 HTLCForwardInfo::AddHTLC { .. } => {
3027 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
3029 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
3030 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
3031 if let Err(e) = chan.get_mut().queue_fail_htlc(
3032 htlc_id, err_packet, &self.logger
3034 if let ChannelError::Ignore(msg) = e {
3035 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
3037 panic!("Stated return value requirements in queue_fail_htlc() were not met");
3039 // fail-backs are best-effort, we probably already have one
3040 // pending, and if not that's OK, if not, the channel is on
3041 // the chain and sending the HTLC-Timeout is their problem.
3050 for forward_info in pending_forwards.drain(..) {
3051 match forward_info {
3052 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3053 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3054 forward_info: PendingHTLCInfo {
3055 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat, ..
3058 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret) = match routing {
3059 PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry, phantom_shared_secret } => {
3060 let _legacy_hop_data = Some(payment_data.clone());
3061 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data }, Some(payment_data), phantom_shared_secret)
3063 PendingHTLCRouting::ReceiveKeysend { payment_preimage, incoming_cltv_expiry } =>
3064 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage), None, None),
3066 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
3069 let claimable_htlc = ClaimableHTLC {
3070 prev_hop: HTLCPreviousHopData {
3071 short_channel_id: prev_short_channel_id,
3072 outpoint: prev_funding_outpoint,
3073 htlc_id: prev_htlc_id,
3074 incoming_packet_shared_secret: incoming_shared_secret,
3075 phantom_shared_secret,
3077 value: outgoing_amt_msat,
3079 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
3084 macro_rules! fail_htlc {
3085 ($htlc: expr, $payment_hash: expr) => {
3086 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
3087 htlc_msat_height_data.extend_from_slice(
3088 &self.best_block.read().unwrap().height().to_be_bytes(),
3090 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
3091 short_channel_id: $htlc.prev_hop.short_channel_id,
3092 outpoint: prev_funding_outpoint,
3093 htlc_id: $htlc.prev_hop.htlc_id,
3094 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
3095 phantom_shared_secret,
3097 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
3098 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
3102 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
3103 let mut receiver_node_id = self.our_network_pubkey;
3104 if phantom_shared_secret.is_some() {
3105 receiver_node_id = self.node_signer.get_node_id(Recipient::PhantomNode)
3106 .expect("Failed to get node_id for phantom node recipient");
3109 macro_rules! check_total_value {
3110 ($payment_data: expr, $payment_preimage: expr) => {{
3111 let mut payment_claimable_generated = false;
3113 events::PaymentPurpose::InvoicePayment {
3114 payment_preimage: $payment_preimage,
3115 payment_secret: $payment_data.payment_secret,
3118 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3119 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
3120 fail_htlc!(claimable_htlc, payment_hash);
3123 let (_, htlcs) = claimable_payments.claimable_htlcs.entry(payment_hash)
3124 .or_insert_with(|| (purpose(), Vec::new()));
3125 if htlcs.len() == 1 {
3126 if let OnionPayload::Spontaneous(_) = htlcs[0].onion_payload {
3127 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));
3128 fail_htlc!(claimable_htlc, payment_hash);
3132 let mut total_value = claimable_htlc.value;
3133 for htlc in htlcs.iter() {
3134 total_value += htlc.value;
3135 match &htlc.onion_payload {
3136 OnionPayload::Invoice { .. } => {
3137 if htlc.total_msat != $payment_data.total_msat {
3138 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
3139 log_bytes!(payment_hash.0), $payment_data.total_msat, htlc.total_msat);
3140 total_value = msgs::MAX_VALUE_MSAT;
3142 if total_value >= msgs::MAX_VALUE_MSAT { break; }
3144 _ => unreachable!(),
3147 if total_value >= msgs::MAX_VALUE_MSAT || total_value > $payment_data.total_msat {
3148 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
3149 log_bytes!(payment_hash.0), total_value, $payment_data.total_msat);
3150 fail_htlc!(claimable_htlc, payment_hash);
3151 } else if total_value == $payment_data.total_msat {
3152 let prev_channel_id = prev_funding_outpoint.to_channel_id();
3153 htlcs.push(claimable_htlc);
3154 new_events.push(events::Event::PaymentClaimable {
3155 receiver_node_id: Some(receiver_node_id),
3158 amount_msat: total_value,
3159 via_channel_id: Some(prev_channel_id),
3160 via_user_channel_id: Some(prev_user_channel_id),
3162 payment_claimable_generated = true;
3164 // Nothing to do - we haven't reached the total
3165 // payment value yet, wait until we receive more
3167 htlcs.push(claimable_htlc);
3169 payment_claimable_generated
3173 // Check that the payment hash and secret are known. Note that we
3174 // MUST take care to handle the "unknown payment hash" and
3175 // "incorrect payment secret" cases here identically or we'd expose
3176 // that we are the ultimate recipient of the given payment hash.
3177 // Further, we must not expose whether we have any other HTLCs
3178 // associated with the same payment_hash pending or not.
3179 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
3180 match payment_secrets.entry(payment_hash) {
3181 hash_map::Entry::Vacant(_) => {
3182 match claimable_htlc.onion_payload {
3183 OnionPayload::Invoice { .. } => {
3184 let payment_data = payment_data.unwrap();
3185 let (payment_preimage, min_final_cltv_expiry_delta) = match inbound_payment::verify(payment_hash, &payment_data, self.highest_seen_timestamp.load(Ordering::Acquire) as u64, &self.inbound_payment_key, &self.logger) {
3186 Ok(result) => result,
3188 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as payment verification failed", log_bytes!(payment_hash.0));
3189 fail_htlc!(claimable_htlc, payment_hash);
3193 if let Some(min_final_cltv_expiry_delta) = min_final_cltv_expiry_delta {
3194 let expected_min_expiry_height = (self.current_best_block().height() + min_final_cltv_expiry_delta as u32) as u64;
3195 if (cltv_expiry as u64) < expected_min_expiry_height {
3196 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as its CLTV expiry was too soon (had {}, earliest expected {})",
3197 log_bytes!(payment_hash.0), cltv_expiry, expected_min_expiry_height);
3198 fail_htlc!(claimable_htlc, payment_hash);
3202 check_total_value!(payment_data, payment_preimage);
3204 OnionPayload::Spontaneous(preimage) => {
3205 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3206 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
3207 fail_htlc!(claimable_htlc, payment_hash);
3210 match claimable_payments.claimable_htlcs.entry(payment_hash) {
3211 hash_map::Entry::Vacant(e) => {
3212 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
3213 e.insert((purpose.clone(), vec![claimable_htlc]));
3214 let prev_channel_id = prev_funding_outpoint.to_channel_id();
3215 new_events.push(events::Event::PaymentClaimable {
3216 receiver_node_id: Some(receiver_node_id),
3218 amount_msat: outgoing_amt_msat,
3220 via_channel_id: Some(prev_channel_id),
3221 via_user_channel_id: Some(prev_user_channel_id),
3224 hash_map::Entry::Occupied(_) => {
3225 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
3226 fail_htlc!(claimable_htlc, payment_hash);
3232 hash_map::Entry::Occupied(inbound_payment) => {
3233 if payment_data.is_none() {
3234 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));
3235 fail_htlc!(claimable_htlc, payment_hash);
3238 let payment_data = payment_data.unwrap();
3239 if inbound_payment.get().payment_secret != payment_data.payment_secret {
3240 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
3241 fail_htlc!(claimable_htlc, payment_hash);
3242 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
3243 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
3244 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
3245 fail_htlc!(claimable_htlc, payment_hash);
3247 let payment_claimable_generated = check_total_value!(payment_data, inbound_payment.get().payment_preimage);
3248 if payment_claimable_generated {
3249 inbound_payment.remove_entry();
3255 HTLCForwardInfo::FailHTLC { .. } => {
3256 panic!("Got pending fail of our own HTLC");
3264 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
3265 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
3267 self.forward_htlcs(&mut phantom_receives);
3269 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
3270 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
3271 // nice to do the work now if we can rather than while we're trying to get messages in the
3273 self.check_free_holding_cells();
3275 if new_events.is_empty() { return }
3276 let mut events = self.pending_events.lock().unwrap();
3277 events.append(&mut new_events);
3280 /// Free the background events, generally called from timer_tick_occurred.
3282 /// Exposed for testing to allow us to process events quickly without generating accidental
3283 /// BroadcastChannelUpdate events in timer_tick_occurred.
3285 /// Expects the caller to have a total_consistency_lock read lock.
3286 fn process_background_events(&self) -> bool {
3287 let mut background_events = Vec::new();
3288 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
3289 if background_events.is_empty() {
3293 for event in background_events.drain(..) {
3295 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
3296 // The channel has already been closed, so no use bothering to care about the
3297 // monitor updating completing.
3298 let _ = self.chain_monitor.update_channel(funding_txo, &update);
3305 #[cfg(any(test, feature = "_test_utils"))]
3306 /// Process background events, for functional testing
3307 pub fn test_process_background_events(&self) {
3308 self.process_background_events();
3311 fn update_channel_fee(&self, chan_id: &[u8; 32], chan: &mut Channel<<SP::Target as SignerProvider>::Signer>, new_feerate: u32) -> NotifyOption {
3312 if !chan.is_outbound() { return NotifyOption::SkipPersist; }
3313 // If the feerate has decreased by less than half, don't bother
3314 if new_feerate <= chan.get_feerate() && new_feerate * 2 > chan.get_feerate() {
3315 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
3316 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3317 return NotifyOption::SkipPersist;
3319 if !chan.is_live() {
3320 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).",
3321 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3322 return NotifyOption::SkipPersist;
3324 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
3325 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3327 chan.queue_update_fee(new_feerate, &self.logger);
3328 NotifyOption::DoPersist
3332 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
3333 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
3334 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
3335 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
3336 pub fn maybe_update_chan_fees(&self) {
3337 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3338 let mut should_persist = NotifyOption::SkipPersist;
3340 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3342 let per_peer_state = self.per_peer_state.read().unwrap();
3343 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
3344 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3345 let peer_state = &mut *peer_state_lock;
3346 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
3347 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
3348 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3356 /// Performs actions which should happen on startup and roughly once per minute thereafter.
3358 /// This currently includes:
3359 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
3360 /// * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
3361 /// than a minute, informing the network that they should no longer attempt to route over
3363 /// * Expiring a channel's previous `ChannelConfig` if necessary to only allow forwarding HTLCs
3364 /// with the current `ChannelConfig`.
3366 /// Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
3367 /// estimate fetches.
3368 pub fn timer_tick_occurred(&self) {
3369 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3370 let mut should_persist = NotifyOption::SkipPersist;
3371 if self.process_background_events() { should_persist = NotifyOption::DoPersist; }
3373 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3375 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
3376 let mut timed_out_mpp_htlcs = Vec::new();
3378 let per_peer_state = self.per_peer_state.read().unwrap();
3379 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
3380 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3381 let peer_state = &mut *peer_state_lock;
3382 let pending_msg_events = &mut peer_state.pending_msg_events;
3383 peer_state.channel_by_id.retain(|chan_id, chan| {
3384 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
3385 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3387 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
3388 let (needs_close, err) = convert_chan_err!(self, e, chan, chan_id);
3389 handle_errors.push((Err(err), *counterparty_node_id));
3390 if needs_close { return false; }
3393 match chan.channel_update_status() {
3394 ChannelUpdateStatus::Enabled if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged),
3395 ChannelUpdateStatus::Disabled if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged),
3396 ChannelUpdateStatus::DisabledStaged if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
3397 ChannelUpdateStatus::EnabledStaged if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
3398 ChannelUpdateStatus::DisabledStaged if !chan.is_live() => {
3399 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3400 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3404 should_persist = NotifyOption::DoPersist;
3405 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
3407 ChannelUpdateStatus::EnabledStaged if chan.is_live() => {
3408 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3409 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3413 should_persist = NotifyOption::DoPersist;
3414 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
3419 chan.maybe_expire_prev_config();
3426 self.claimable_payments.lock().unwrap().claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
3427 if htlcs.is_empty() {
3428 // This should be unreachable
3429 debug_assert!(false);
3432 if let OnionPayload::Invoice { .. } = htlcs[0].onion_payload {
3433 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
3434 // In this case we're not going to handle any timeouts of the parts here.
3435 if htlcs[0].total_msat == htlcs.iter().fold(0, |total, htlc| total + htlc.value) {
3437 } else if htlcs.into_iter().any(|htlc| {
3438 htlc.timer_ticks += 1;
3439 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
3441 timed_out_mpp_htlcs.extend(htlcs.drain(..).map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
3448 for htlc_source in timed_out_mpp_htlcs.drain(..) {
3449 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
3450 let reason = HTLCFailReason::from_failure_code(23);
3451 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
3452 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
3455 for (err, counterparty_node_id) in handle_errors.drain(..) {
3456 let _ = handle_error!(self, err, counterparty_node_id);
3459 self.pending_outbound_payments.remove_stale_resolved_payments(&self.pending_events);
3461 // Technically we don't need to do this here, but if we have holding cell entries in a
3462 // channel that need freeing, it's better to do that here and block a background task
3463 // than block the message queueing pipeline.
3464 if self.check_free_holding_cells() {
3465 should_persist = NotifyOption::DoPersist;
3472 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
3473 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
3474 /// along the path (including in our own channel on which we received it).
3476 /// Note that in some cases around unclean shutdown, it is possible the payment may have
3477 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
3478 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
3479 /// may have already been failed automatically by LDK if it was nearing its expiration time.
3481 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
3482 /// [`ChannelManager::claim_funds`]), you should still monitor for
3483 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
3484 /// startup during which time claims that were in-progress at shutdown may be replayed.
3485 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
3486 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3488 let removed_source = self.claimable_payments.lock().unwrap().claimable_htlcs.remove(payment_hash);
3489 if let Some((_, mut sources)) = removed_source {
3490 for htlc in sources.drain(..) {
3491 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
3492 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
3493 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
3494 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
3495 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
3496 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
3501 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3502 /// that we want to return and a channel.
3504 /// This is for failures on the channel on which the HTLC was *received*, not failures
3506 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> (u16, Vec<u8>) {
3507 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
3508 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
3509 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
3510 // an inbound SCID alias before the real SCID.
3511 let scid_pref = if chan.should_announce() {
3512 chan.get_short_channel_id().or(chan.latest_inbound_scid_alias())
3514 chan.latest_inbound_scid_alias().or(chan.get_short_channel_id())
3516 if let Some(scid) = scid_pref {
3517 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
3519 (0x4000|10, Vec::new())
3524 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3525 /// that we want to return and a channel.
3526 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> (u16, Vec<u8>) {
3527 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
3528 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
3529 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
3530 if desired_err_code == 0x1000 | 20 {
3531 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
3532 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
3533 0u16.write(&mut enc).expect("Writes cannot fail");
3535 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
3536 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
3537 upd.write(&mut enc).expect("Writes cannot fail");
3538 (desired_err_code, enc.0)
3540 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
3541 // which means we really shouldn't have gotten a payment to be forwarded over this
3542 // channel yet, or if we did it's from a route hint. Either way, returning an error of
3543 // PERM|no_such_channel should be fine.
3544 (0x4000|10, Vec::new())
3548 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
3549 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
3550 // be surfaced to the user.
3551 fn fail_holding_cell_htlcs(
3552 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32],
3553 counterparty_node_id: &PublicKey
3555 let (failure_code, onion_failure_data) = {
3556 let per_peer_state = self.per_peer_state.read().unwrap();
3557 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
3558 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3559 let peer_state = &mut *peer_state_lock;
3560 match peer_state.channel_by_id.entry(channel_id) {
3561 hash_map::Entry::Occupied(chan_entry) => {
3562 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan_entry.get())
3564 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
3566 } else { (0x4000|10, Vec::new()) }
3569 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
3570 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
3571 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
3572 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
3576 /// Fails an HTLC backwards to the sender of it to us.
3577 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
3578 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
3579 #[cfg(any(feature = "_test_utils", test))]
3581 // Ensure that no peer state channel storage lock is not held when calling this
3583 // This ensures that future code doesn't introduce a lock_order requirement for
3584 // `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
3585 // this function with any `per_peer_state` peer lock aquired would.
3586 let per_peer_state = self.per_peer_state.read().unwrap();
3587 for (_, peer) in per_peer_state.iter() {
3588 debug_assert!(peer.try_lock().is_ok());
3592 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
3593 //identify whether we sent it or not based on the (I presume) very different runtime
3594 //between the branches here. We should make this async and move it into the forward HTLCs
3597 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3598 // from block_connected which may run during initialization prior to the chain_monitor
3599 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
3601 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, ref payment_params, .. } => {
3602 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);
3604 HTLCSource::PreviousHopData(HTLCPreviousHopData { ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret, ref phantom_shared_secret, ref outpoint }) => {
3605 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with {:?}", log_bytes!(payment_hash.0), onion_error);
3606 let err_packet = onion_error.get_encrypted_failure_packet(incoming_packet_shared_secret, phantom_shared_secret);
3608 let mut forward_event = None;
3609 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
3610 if forward_htlcs.is_empty() {
3611 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
3613 match forward_htlcs.entry(*short_channel_id) {
3614 hash_map::Entry::Occupied(mut entry) => {
3615 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet });
3617 hash_map::Entry::Vacant(entry) => {
3618 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }));
3621 mem::drop(forward_htlcs);
3622 let mut pending_events = self.pending_events.lock().unwrap();
3623 if let Some(time) = forward_event {
3624 pending_events.push(events::Event::PendingHTLCsForwardable {
3625 time_forwardable: time
3628 pending_events.push(events::Event::HTLCHandlingFailed {
3629 prev_channel_id: outpoint.to_channel_id(),
3630 failed_next_destination: destination,
3636 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
3637 /// [`MessageSendEvent`]s needed to claim the payment.
3639 /// Note that calling this method does *not* guarantee that the payment has been claimed. You
3640 /// *must* wait for an [`Event::PaymentClaimed`] event which upon a successful claim will be
3641 /// provided to your [`EventHandler`] when [`process_pending_events`] is next called.
3643 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
3644 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
3645 /// event matches your expectation. If you fail to do so and call this method, you may provide
3646 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
3648 /// [`Event::PaymentClaimable`]: crate::util::events::Event::PaymentClaimable
3649 /// [`Event::PaymentClaimed`]: crate::util::events::Event::PaymentClaimed
3650 /// [`process_pending_events`]: EventsProvider::process_pending_events
3651 /// [`create_inbound_payment`]: Self::create_inbound_payment
3652 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
3653 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
3654 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
3656 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3659 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3660 if let Some((payment_purpose, sources)) = claimable_payments.claimable_htlcs.remove(&payment_hash) {
3661 let mut receiver_node_id = self.our_network_pubkey;
3662 for htlc in sources.iter() {
3663 if htlc.prev_hop.phantom_shared_secret.is_some() {
3664 let phantom_pubkey = self.node_signer.get_node_id(Recipient::PhantomNode)
3665 .expect("Failed to get node_id for phantom node recipient");
3666 receiver_node_id = phantom_pubkey;
3671 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
3672 ClaimingPayment { amount_msat: sources.iter().map(|source| source.value).sum(),
3673 payment_purpose, receiver_node_id,
3675 if dup_purpose.is_some() {
3676 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
3677 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
3678 log_bytes!(payment_hash.0));
3683 debug_assert!(!sources.is_empty());
3685 // If we are claiming an MPP payment, we check that all channels which contain a claimable
3686 // HTLC still exist. While this isn't guaranteed to remain true if a channel closes while
3687 // we're claiming (or even after we claim, before the commitment update dance completes),
3688 // it should be a relatively rare race, and we'd rather not claim HTLCs that require us to
3689 // go on-chain (and lose the on-chain fee to do so) than just reject the payment.
3691 // Note that we'll still always get our funds - as long as the generated
3692 // `ChannelMonitorUpdate` makes it out to the relevant monitor we can claim on-chain.
3694 // If we find an HTLC which we would need to claim but for which we do not have a
3695 // channel, we will fail all parts of the MPP payment. While we could wait and see if
3696 // the sender retries the already-failed path(s), it should be a pretty rare case where
3697 // we got all the HTLCs and then a channel closed while we were waiting for the user to
3698 // provide the preimage, so worrying too much about the optimal handling isn't worth
3700 let mut claimable_amt_msat = 0;
3701 let mut expected_amt_msat = None;
3702 let mut valid_mpp = true;
3703 let mut errs = Vec::new();
3704 let mut per_peer_state = Some(self.per_peer_state.read().unwrap());
3705 for htlc in sources.iter() {
3706 let (counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&htlc.prev_hop.short_channel_id) {
3707 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3714 if let None = per_peer_state.as_ref().unwrap().get(&counterparty_node_id) {
3719 let peer_state_mutex = per_peer_state.as_ref().unwrap().get(&counterparty_node_id).unwrap();
3720 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3721 let peer_state = &mut *peer_state_lock;
3723 if let None = peer_state.channel_by_id.get(&chan_id) {
3728 if expected_amt_msat.is_some() && expected_amt_msat != Some(htlc.total_msat) {
3729 log_error!(self.logger, "Somehow ended up with an MPP payment with different total amounts - this should not be reachable!");
3730 debug_assert!(false);
3735 expected_amt_msat = Some(htlc.total_msat);
3736 if let OnionPayload::Spontaneous(_) = &htlc.onion_payload {
3737 // We don't currently support MPP for spontaneous payments, so just check
3738 // that there's one payment here and move on.
3739 if sources.len() != 1 {
3740 log_error!(self.logger, "Somehow ended up with an MPP spontaneous payment - this should not be reachable!");
3741 debug_assert!(false);
3747 claimable_amt_msat += htlc.value;
3749 if sources.is_empty() || expected_amt_msat.is_none() {
3750 mem::drop(per_peer_state);
3751 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
3752 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
3755 if claimable_amt_msat != expected_amt_msat.unwrap() {
3756 mem::drop(per_peer_state);
3757 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
3758 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
3759 expected_amt_msat.unwrap(), claimable_amt_msat);
3763 for htlc in sources.drain(..) {
3764 if per_peer_state.is_none() { per_peer_state = Some(self.per_peer_state.read().unwrap()); }
3765 if let Err((pk, err)) = self.claim_funds_from_hop(per_peer_state.take().unwrap(),
3766 htlc.prev_hop, payment_preimage,
3767 |_| Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash }))
3769 if let msgs::ErrorAction::IgnoreError = err.err.action {
3770 // We got a temporary failure updating monitor, but will claim the
3771 // HTLC when the monitor updating is restored (or on chain).
3772 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
3773 } else { errs.push((pk, err)); }
3777 mem::drop(per_peer_state);
3779 for htlc in sources.drain(..) {
3780 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
3781 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
3782 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
3783 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
3784 let receiver = HTLCDestination::FailedPayment { payment_hash };
3785 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
3787 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
3790 // Now we can handle any errors which were generated.
3791 for (counterparty_node_id, err) in errs.drain(..) {
3792 let res: Result<(), _> = Err(err);
3793 let _ = handle_error!(self, res, counterparty_node_id);
3797 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>) -> Option<MonitorUpdateCompletionAction>>(&self,
3798 per_peer_state_lock: RwLockReadGuard<HashMap<PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>>>,
3799 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
3800 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
3801 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
3803 let chan_id = prev_hop.outpoint.to_channel_id();
3805 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
3806 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
3810 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() {
3811 let peer_mutex = per_peer_state_lock.get(&counterparty_node_id_opt.unwrap()).unwrap();
3812 let peer_state = peer_mutex.lock().unwrap();
3813 let found_channel = peer_state.channel_by_id.contains_key(&chan_id);
3814 (found_channel, Some(peer_state))
3815 } else { (false, None) };
3818 let peer_state = &mut *peer_state_opt.as_mut().unwrap();
3819 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(chan_id) {
3820 let counterparty_node_id = chan.get().get_counterparty_node_id();
3821 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
3822 Ok(msgs_monitor_option) => {
3823 if let UpdateFulfillCommitFetch::NewClaim { msgs, htlc_value_msat, monitor_update } = msgs_monitor_option {
3824 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), &monitor_update) {
3825 ChannelMonitorUpdateStatus::Completed => {},
3827 log_given_level!(self.logger, if e == ChannelMonitorUpdateStatus::PermanentFailure { Level::Error } else { Level::Debug },
3828 "Failed to update channel monitor with preimage {:?}: {:?}",
3829 payment_preimage, e);
3830 let err = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()).unwrap_err();
3831 mem::drop(peer_state_opt);
3832 mem::drop(per_peer_state_lock);
3833 self.handle_monitor_update_completion_actions(completion_action(Some(htlc_value_msat)));
3834 return Err((counterparty_node_id, err));
3837 if let Some((msg, commitment_signed)) = msgs {
3838 log_debug!(self.logger, "Claiming funds for HTLC with preimage {} resulted in a commitment_signed for channel {}",
3839 log_bytes!(payment_preimage.0), log_bytes!(chan.get().channel_id()));
3840 peer_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3841 node_id: counterparty_node_id,
3842 updates: msgs::CommitmentUpdate {
3843 update_add_htlcs: Vec::new(),
3844 update_fulfill_htlcs: vec![msg],
3845 update_fail_htlcs: Vec::new(),
3846 update_fail_malformed_htlcs: Vec::new(),
3852 mem::drop(peer_state_opt);
3853 mem::drop(per_peer_state_lock);
3854 self.handle_monitor_update_completion_actions(completion_action(Some(htlc_value_msat)));
3860 Err((e, monitor_update)) => {
3861 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), &monitor_update) {
3862 ChannelMonitorUpdateStatus::Completed => {},
3864 // TODO: This needs to be handled somehow - if we receive a monitor update
3865 // with a preimage we *must* somehow manage to propagate it to the upstream
3866 // channel, or we must have an ability to receive the same update and try
3867 // again on restart.
3868 log_given_level!(self.logger, if e == ChannelMonitorUpdateStatus::PermanentFailure { Level::Error } else { Level::Info },
3869 "Failed to update channel monitor with preimage {:?} immediately prior to force-close: {:?}",
3870 payment_preimage, e);
3873 let (drop, res) = convert_chan_err!(self, e, chan.get_mut(), &chan_id);
3875 chan.remove_entry();
3877 mem::drop(peer_state_opt);
3878 mem::drop(per_peer_state_lock);
3879 self.handle_monitor_update_completion_actions(completion_action(None));
3880 Err((counterparty_node_id, res))
3884 // We've held the peer_state mutex since finding the channel and setting
3885 // found_channel to true, so the channel can't have been dropped.
3889 let preimage_update = ChannelMonitorUpdate {
3890 update_id: CLOSED_CHANNEL_UPDATE_ID,
3891 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
3895 // We update the ChannelMonitor on the backward link, after
3896 // receiving an `update_fulfill_htlc` from the forward link.
3897 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, &preimage_update);
3898 if update_res != ChannelMonitorUpdateStatus::Completed {
3899 // TODO: This needs to be handled somehow - if we receive a monitor update
3900 // with a preimage we *must* somehow manage to propagate it to the upstream
3901 // channel, or we must have an ability to receive the same event and try
3902 // again on restart.
3903 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
3904 payment_preimage, update_res);
3906 mem::drop(peer_state_opt);
3907 mem::drop(per_peer_state_lock);
3908 // Note that we do process the completion action here. This totally could be a
3909 // duplicate claim, but we have no way of knowing without interrogating the
3910 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
3911 // generally always allowed to be duplicative (and it's specifically noted in
3912 // `PaymentForwarded`).
3913 self.handle_monitor_update_completion_actions(completion_action(None));
3918 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
3919 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
3922 fn claim_funds_internal(&self, source: HTLCSource, payment_preimage: PaymentPreimage, forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, next_channel_id: [u8; 32]) {
3924 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
3925 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage, session_priv, path, from_onchain, &self.pending_events, &self.logger);
3927 HTLCSource::PreviousHopData(hop_data) => {
3928 let prev_outpoint = hop_data.outpoint;
3929 let res = self.claim_funds_from_hop(self.per_peer_state.read().unwrap(), hop_data, payment_preimage,
3930 |htlc_claim_value_msat| {
3931 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
3932 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
3933 Some(claimed_htlc_value - forwarded_htlc_value)
3936 let prev_channel_id = Some(prev_outpoint.to_channel_id());
3937 let next_channel_id = Some(next_channel_id);
3939 Some(MonitorUpdateCompletionAction::EmitEvent { event: events::Event::PaymentForwarded {
3941 claim_from_onchain_tx: from_onchain,
3947 if let Err((pk, err)) = res {
3948 let result: Result<(), _> = Err(err);
3949 let _ = handle_error!(self, result, pk);
3955 /// Gets the node_id held by this ChannelManager
3956 pub fn get_our_node_id(&self) -> PublicKey {
3957 self.our_network_pubkey.clone()
3960 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
3961 for action in actions.into_iter() {
3963 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
3964 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
3965 if let Some(ClaimingPayment { amount_msat, payment_purpose: purpose, receiver_node_id }) = payment {
3966 self.pending_events.lock().unwrap().push(events::Event::PaymentClaimed {
3967 payment_hash, purpose, amount_msat, receiver_node_id: Some(receiver_node_id),
3971 MonitorUpdateCompletionAction::EmitEvent { event } => {
3972 self.pending_events.lock().unwrap().push(event);
3978 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
3979 /// update completion.
3980 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
3981 channel: &mut Channel<<SP::Target as SignerProvider>::Signer>, raa: Option<msgs::RevokeAndACK>,
3982 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
3983 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
3984 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
3985 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
3986 let mut htlc_forwards = None;
3988 let counterparty_node_id = channel.get_counterparty_node_id();
3989 if !pending_forwards.is_empty() {
3990 htlc_forwards = Some((channel.get_short_channel_id().unwrap_or(channel.outbound_scid_alias()),
3991 channel.get_funding_txo().unwrap(), channel.get_user_id(), pending_forwards));
3994 if let Some(msg) = channel_ready {
3995 send_channel_ready!(self, pending_msg_events, channel, msg);
3997 if let Some(msg) = announcement_sigs {
3998 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
3999 node_id: counterparty_node_id,
4004 emit_channel_ready_event!(self, channel);
4006 macro_rules! handle_cs { () => {
4007 if let Some(update) = commitment_update {
4008 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4009 node_id: counterparty_node_id,
4014 macro_rules! handle_raa { () => {
4015 if let Some(revoke_and_ack) = raa {
4016 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
4017 node_id: counterparty_node_id,
4018 msg: revoke_and_ack,
4023 RAACommitmentOrder::CommitmentFirst => {
4027 RAACommitmentOrder::RevokeAndACKFirst => {
4033 if let Some(tx) = funding_broadcastable {
4034 log_info!(self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
4035 self.tx_broadcaster.broadcast_transaction(&tx);
4041 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
4042 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4045 let (mut pending_failures, finalized_claims, counterparty_node_id) = {
4046 let counterparty_node_id = match counterparty_node_id {
4047 Some(cp_id) => cp_id.clone(),
4049 // TODO: Once we can rely on the counterparty_node_id from the
4050 // monitor event, this and the id_to_peer map should be removed.
4051 let id_to_peer = self.id_to_peer.lock().unwrap();
4052 match id_to_peer.get(&funding_txo.to_channel_id()) {
4053 Some(cp_id) => cp_id.clone(),
4058 let per_peer_state = self.per_peer_state.read().unwrap();
4059 let mut peer_state_lock;
4060 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
4061 if let None = peer_state_mutex_opt { return }
4062 peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4063 let peer_state = &mut *peer_state_lock;
4065 match peer_state.channel_by_id.entry(funding_txo.to_channel_id()){
4066 hash_map::Entry::Occupied(chan) => chan,
4067 hash_map::Entry::Vacant(_) => return,
4070 if !channel.get().is_awaiting_monitor_update() || channel.get().get_latest_monitor_update_id() != highest_applied_update_id {
4074 let updates = channel.get_mut().monitor_updating_restored(&self.logger, &self.node_signer, self.genesis_hash, &self.default_configuration, self.best_block.read().unwrap().height());
4075 let channel_update = if updates.channel_ready.is_some() && channel.get().is_usable() {
4076 // We only send a channel_update in the case where we are just now sending a
4077 // channel_ready and the channel is in a usable state. We may re-send a
4078 // channel_update later through the announcement_signatures process for public
4079 // channels, but there's no reason not to just inform our counterparty of our fees
4081 if let Ok(msg) = self.get_channel_update_for_unicast(channel.get()) {
4082 Some(events::MessageSendEvent::SendChannelUpdate {
4083 node_id: channel.get().get_counterparty_node_id(),
4088 htlc_forwards = self.handle_channel_resumption(&mut peer_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);
4089 if let Some(upd) = channel_update {
4090 peer_state.pending_msg_events.push(upd);
4093 (updates.failed_htlcs, updates.finalized_claimed_htlcs, counterparty_node_id)
4095 if let Some(forwards) = htlc_forwards {
4096 self.forward_htlcs(&mut [forwards][..]);
4098 self.finalize_claims(finalized_claims);
4099 for failure in pending_failures.drain(..) {
4100 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id: funding_txo.to_channel_id() };
4101 self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
4105 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
4107 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
4108 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
4111 /// The `user_channel_id` parameter will be provided back in
4112 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4113 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4115 /// Note that this method will return an error and reject the channel, if it requires support
4116 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
4117 /// used to accept such channels.
4119 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4120 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4121 pub fn accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
4122 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
4125 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
4126 /// it as confirmed immediately.
4128 /// The `user_channel_id` parameter will be provided back in
4129 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4130 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4132 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
4133 /// and (if the counterparty agrees), enables forwarding of payments immediately.
4135 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
4136 /// transaction and blindly assumes that it will eventually confirm.
4138 /// If it does not confirm before we decide to close the channel, or if the funding transaction
4139 /// does not pay to the correct script the correct amount, *you will lose funds*.
4141 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4142 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4143 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> {
4144 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
4147 fn do_accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
4148 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4150 let per_peer_state = self.per_peer_state.read().unwrap();
4151 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4152 if let None = peer_state_mutex_opt {
4153 return Err(APIError::APIMisuseError { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) });
4155 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4156 let peer_state = &mut *peer_state_lock;
4157 match peer_state.channel_by_id.entry(temporary_channel_id.clone()) {
4158 hash_map::Entry::Occupied(mut channel) => {
4159 if !channel.get().inbound_is_awaiting_accept() {
4160 return Err(APIError::APIMisuseError { err: "The channel isn't currently awaiting to be accepted.".to_owned() });
4163 channel.get_mut().set_0conf();
4164 } else if channel.get().get_channel_type().requires_zero_conf() {
4165 let send_msg_err_event = events::MessageSendEvent::HandleError {
4166 node_id: channel.get().get_counterparty_node_id(),
4167 action: msgs::ErrorAction::SendErrorMessage{
4168 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
4171 peer_state.pending_msg_events.push(send_msg_err_event);
4172 let _ = remove_channel!(self, channel);
4173 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
4176 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4177 node_id: channel.get().get_counterparty_node_id(),
4178 msg: channel.get_mut().accept_inbound_channel(user_channel_id),
4181 hash_map::Entry::Vacant(_) => {
4182 return Err(APIError::ChannelUnavailable { err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*temporary_channel_id), counterparty_node_id) });
4188 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
4189 if msg.chain_hash != self.genesis_hash {
4190 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
4193 if !self.default_configuration.accept_inbound_channels {
4194 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4197 let mut random_bytes = [0u8; 16];
4198 random_bytes.copy_from_slice(&self.entropy_source.get_secure_random_bytes()[..16]);
4199 let user_channel_id = u128::from_be_bytes(random_bytes);
4201 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
4202 let per_peer_state = self.per_peer_state.read().unwrap();
4203 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4204 if let None = peer_state_mutex_opt {
4205 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.temporary_channel_id.clone()))
4207 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4208 let peer_state = &mut *peer_state_lock;
4209 let mut channel = match Channel::new_from_req(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
4210 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id, &self.default_configuration,
4211 self.best_block.read().unwrap().height(), &self.logger, outbound_scid_alias)
4214 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4215 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
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 peer_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);
4252 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
4253 let (value, output_script, user_id) = {
4254 let per_peer_state = self.per_peer_state.read().unwrap();
4255 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4256 if let None = peer_state_mutex_opt {
4257 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.temporary_channel_id))
4259 let mut peer_state_lock = peer_state_mutex_opt.unwrap().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 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &peer_state.latest_features), chan);
4264 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
4266 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id))
4269 let mut pending_events = self.pending_events.lock().unwrap();
4270 pending_events.push(events::Event::FundingGenerationReady {
4271 temporary_channel_id: msg.temporary_channel_id,
4272 counterparty_node_id: *counterparty_node_id,
4273 channel_value_satoshis: value,
4275 user_channel_id: user_id,
4280 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
4281 let per_peer_state = self.per_peer_state.read().unwrap();
4282 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4283 if let None = peer_state_mutex_opt {
4284 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.temporary_channel_id))
4286 let ((funding_msg, monitor, mut channel_ready), mut chan) = {
4287 let best_block = *self.best_block.read().unwrap();
4288 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4289 let peer_state = &mut *peer_state_lock;
4290 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
4291 hash_map::Entry::Occupied(mut chan) => {
4292 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.signer_provider, &self.logger), chan), chan.remove())
4294 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id))
4297 // Because we have exclusive ownership of the channel here we can release the peer_state
4298 // lock before watch_channel
4299 match self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
4300 ChannelMonitorUpdateStatus::Completed => {},
4301 ChannelMonitorUpdateStatus::PermanentFailure => {
4302 // Note that we reply with the new channel_id in error messages if we gave up on the
4303 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
4304 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
4305 // any messages referencing a previously-closed channel anyway.
4306 // We do not propagate the monitor update to the user as it would be for a monitor
4307 // that we didn't manage to store (and that we don't care about - we don't respond
4308 // with the funding_signed so the channel can never go on chain).
4309 let (_monitor_update, failed_htlcs) = chan.force_shutdown(false);
4310 assert!(failed_htlcs.is_empty());
4311 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
4313 ChannelMonitorUpdateStatus::InProgress => {
4314 // There's no problem signing a counterparty's funding transaction if our monitor
4315 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
4316 // accepted payment from yet. We do, however, need to wait to send our channel_ready
4317 // until we have persisted our monitor.
4318 chan.monitor_updating_paused(false, false, channel_ready.is_some(), Vec::new(), Vec::new(), Vec::new());
4319 channel_ready = None; // Don't send the channel_ready now
4322 // It's safe to unwrap as we've held the `per_peer_state` read lock since checking that the
4323 // peer exists, despite the inner PeerState potentially having no channels after removing
4324 // the channel above.
4325 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4326 let peer_state = &mut *peer_state_lock;
4327 match peer_state.channel_by_id.entry(funding_msg.channel_id) {
4328 hash_map::Entry::Occupied(_) => {
4329 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
4331 hash_map::Entry::Vacant(e) => {
4332 let mut id_to_peer = self.id_to_peer.lock().unwrap();
4333 match id_to_peer.entry(chan.channel_id()) {
4334 hash_map::Entry::Occupied(_) => {
4335 return Err(MsgHandleErrInternal::send_err_msg_no_close(
4336 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
4337 funding_msg.channel_id))
4339 hash_map::Entry::Vacant(i_e) => {
4340 i_e.insert(chan.get_counterparty_node_id());
4343 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
4344 node_id: counterparty_node_id.clone(),
4347 if let Some(msg) = channel_ready {
4348 send_channel_ready!(self, peer_state.pending_msg_events, chan, msg);
4356 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
4358 let best_block = *self.best_block.read().unwrap();
4359 let per_peer_state = self.per_peer_state.read().unwrap();
4360 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4361 if let None = peer_state_mutex_opt {
4362 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))
4365 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4366 let peer_state = &mut *peer_state_lock;
4367 match peer_state.channel_by_id.entry(msg.channel_id) {
4368 hash_map::Entry::Occupied(mut chan) => {
4369 let (monitor, funding_tx, channel_ready) = match chan.get_mut().funding_signed(&msg, best_block, &self.signer_provider, &self.logger) {
4370 Ok(update) => update,
4371 Err(e) => try_chan_entry!(self, Err(e), chan),
4373 match self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
4374 ChannelMonitorUpdateStatus::Completed => {},
4376 let mut res = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::RevokeAndACKFirst, channel_ready.is_some(), OPTIONALLY_RESEND_FUNDING_LOCKED);
4377 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
4378 // We weren't able to watch the channel to begin with, so no updates should be made on
4379 // it. Previously, full_stack_target found an (unreachable) panic when the
4380 // monitor update contained within `shutdown_finish` was applied.
4381 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
4382 shutdown_finish.0.take();
4388 if let Some(msg) = channel_ready {
4389 send_channel_ready!(self, peer_state.pending_msg_events, chan.get(), msg);
4393 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4396 log_info!(self.logger, "Broadcasting funding transaction with txid {}", funding_tx.txid());
4397 self.tx_broadcaster.broadcast_transaction(&funding_tx);
4401 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
4402 let per_peer_state = self.per_peer_state.read().unwrap();
4403 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4404 if let None = peer_state_mutex_opt {
4405 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id));
4407 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4408 let peer_state = &mut *peer_state_lock;
4409 match peer_state.channel_by_id.entry(msg.channel_id) {
4410 hash_map::Entry::Occupied(mut chan) => {
4411 let announcement_sigs_opt = try_chan_entry!(self, chan.get_mut().channel_ready(&msg, &self.node_signer,
4412 self.genesis_hash.clone(), &self.default_configuration, &self.best_block.read().unwrap(), &self.logger), chan);
4413 if let Some(announcement_sigs) = announcement_sigs_opt {
4414 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(chan.get().channel_id()));
4415 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4416 node_id: counterparty_node_id.clone(),
4417 msg: announcement_sigs,
4419 } else if chan.get().is_usable() {
4420 // If we're sending an announcement_signatures, we'll send the (public)
4421 // channel_update after sending a channel_announcement when we receive our
4422 // counterparty's announcement_signatures. Thus, we only bother to send a
4423 // channel_update here if the channel is not public, i.e. we're not sending an
4424 // announcement_signatures.
4425 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", log_bytes!(chan.get().channel_id()));
4426 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
4427 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4428 node_id: counterparty_node_id.clone(),
4434 emit_channel_ready_event!(self, chan.get_mut());
4438 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4442 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
4443 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
4444 let result: Result<(), _> = loop {
4445 let per_peer_state = self.per_peer_state.read().unwrap();
4446 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4447 if let None = peer_state_mutex_opt {
4448 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))
4450 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4451 let peer_state = &mut *peer_state_lock;
4452 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
4453 hash_map::Entry::Occupied(mut chan_entry) => {
4455 if !chan_entry.get().received_shutdown() {
4456 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
4457 log_bytes!(msg.channel_id),
4458 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
4461 let (shutdown, monitor_update, htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&self.signer_provider, &peer_state.latest_features, &msg), chan_entry);
4462 dropped_htlcs = htlcs;
4464 // Update the monitor with the shutdown script if necessary.
4465 if let Some(monitor_update) = monitor_update {
4466 let update_res = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), &monitor_update);
4467 let (result, is_permanent) =
4468 handle_monitor_update_res!(self, update_res, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
4470 remove_channel!(self, chan_entry);
4475 if let Some(msg) = shutdown {
4476 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
4477 node_id: *counterparty_node_id,
4484 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4487 for htlc_source in dropped_htlcs.drain(..) {
4488 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
4489 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
4490 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
4493 let _ = handle_error!(self, result, *counterparty_node_id);
4497 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
4498 let per_peer_state = self.per_peer_state.read().unwrap();
4499 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4500 if let None = peer_state_mutex_opt {
4501 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))
4503 let (tx, chan_option) = {
4504 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4505 let peer_state = &mut *peer_state_lock;
4506 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
4507 hash_map::Entry::Occupied(mut chan_entry) => {
4508 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), chan_entry);
4509 if let Some(msg) = closing_signed {
4510 peer_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
4511 node_id: counterparty_node_id.clone(),
4516 // We're done with this channel, we've got a signed closing transaction and
4517 // will send the closing_signed back to the remote peer upon return. This
4518 // also implies there are no pending HTLCs left on the channel, so we can
4519 // fully delete it from tracking (the channel monitor is still around to
4520 // watch for old state broadcasts)!
4521 (tx, Some(remove_channel!(self, chan_entry)))
4522 } else { (tx, None) }
4524 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4527 if let Some(broadcast_tx) = tx {
4528 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
4529 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
4531 if let Some(chan) = chan_option {
4532 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4533 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4534 let peer_state = &mut *peer_state_lock;
4535 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4539 self.issue_channel_close_events(&chan, ClosureReason::CooperativeClosure);
4544 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
4545 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
4546 //determine the state of the payment based on our response/if we forward anything/the time
4547 //we take to respond. We should take care to avoid allowing such an attack.
4549 //TODO: There exists a further attack where a node may garble the onion data, forward it to
4550 //us repeatedly garbled in different ways, and compare our error messages, which are
4551 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
4552 //but we should prevent it anyway.
4554 let pending_forward_info = self.decode_update_add_htlc_onion(msg);
4555 let per_peer_state = self.per_peer_state.read().unwrap();
4556 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4557 if let None = peer_state_mutex_opt {
4558 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))
4560 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4561 let peer_state = &mut *peer_state_lock;
4562 match peer_state.channel_by_id.entry(msg.channel_id) {
4563 hash_map::Entry::Occupied(mut chan) => {
4565 let create_pending_htlc_status = |chan: &Channel<<SP::Target as SignerProvider>::Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
4566 // If the update_add is completely bogus, the call will Err and we will close,
4567 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
4568 // want to reject the new HTLC and fail it backwards instead of forwarding.
4569 match pending_forward_info {
4570 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
4571 let reason = if (error_code & 0x1000) != 0 {
4572 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
4573 HTLCFailReason::reason(real_code, error_data)
4575 HTLCFailReason::from_failure_code(error_code)
4576 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
4577 let msg = msgs::UpdateFailHTLC {
4578 channel_id: msg.channel_id,
4579 htlc_id: msg.htlc_id,
4582 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
4584 _ => pending_forward_info
4587 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), chan);
4589 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4594 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
4595 let (htlc_source, forwarded_htlc_value) = {
4596 let per_peer_state = self.per_peer_state.read().unwrap();
4597 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4598 if let None = peer_state_mutex_opt {
4599 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id));
4601 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4602 let peer_state = &mut *peer_state_lock;
4603 match peer_state.channel_by_id.entry(msg.channel_id) {
4604 hash_map::Entry::Occupied(mut chan) => {
4605 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), chan)
4607 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4610 self.claim_funds_internal(htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, msg.channel_id);
4614 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
4615 let per_peer_state = self.per_peer_state.read().unwrap();
4616 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4617 if let None = peer_state_mutex_opt {
4618 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id));
4620 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4621 let peer_state = &mut *peer_state_lock;
4622 match peer_state.channel_by_id.entry(msg.channel_id) {
4623 hash_map::Entry::Occupied(mut chan) => {
4624 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan);
4626 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4631 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
4632 let per_peer_state = self.per_peer_state.read().unwrap();
4633 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4634 if let None = peer_state_mutex_opt {
4635 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))
4637 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4638 let peer_state = &mut *peer_state_lock;
4639 match peer_state.channel_by_id.entry(msg.channel_id) {
4640 hash_map::Entry::Occupied(mut chan) => {
4641 if (msg.failure_code & 0x8000) == 0 {
4642 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
4643 try_chan_entry!(self, Err(chan_err), chan);
4645 try_chan_entry!(self, chan.get_mut().update_fail_malformed_htlc(&msg, HTLCFailReason::reason(msg.failure_code, msg.sha256_of_onion.to_vec())), chan);
4648 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4652 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
4653 let per_peer_state = self.per_peer_state.read().unwrap();
4654 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4655 if let None = peer_state_mutex_opt {
4656 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))
4658 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4659 let peer_state = &mut *peer_state_lock;
4660 match peer_state.channel_by_id.entry(msg.channel_id) {
4661 hash_map::Entry::Occupied(mut chan) => {
4662 let (revoke_and_ack, commitment_signed, monitor_update) =
4663 match chan.get_mut().commitment_signed(&msg, &self.logger) {
4664 Err((None, e)) => try_chan_entry!(self, Err(e), chan),
4665 Err((Some(update), e)) => {
4666 assert!(chan.get().is_awaiting_monitor_update());
4667 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), &update);
4668 try_chan_entry!(self, Err(e), chan);
4673 let update_res = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), &monitor_update);
4674 if let Err(e) = handle_monitor_update_res!(self, update_res, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some()) {
4678 peer_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
4679 node_id: counterparty_node_id.clone(),
4680 msg: revoke_and_ack,
4682 if let Some(msg) = commitment_signed {
4683 peer_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4684 node_id: counterparty_node_id.clone(),
4685 updates: msgs::CommitmentUpdate {
4686 update_add_htlcs: Vec::new(),
4687 update_fulfill_htlcs: Vec::new(),
4688 update_fail_htlcs: Vec::new(),
4689 update_fail_malformed_htlcs: Vec::new(),
4691 commitment_signed: msg,
4697 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4702 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
4703 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
4704 let mut forward_event = None;
4705 let mut new_intercept_events = Vec::new();
4706 let mut failed_intercept_forwards = Vec::new();
4707 if !pending_forwards.is_empty() {
4708 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
4709 let scid = match forward_info.routing {
4710 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
4711 PendingHTLCRouting::Receive { .. } => 0,
4712 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
4714 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
4715 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
4717 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
4718 let forward_htlcs_empty = forward_htlcs.is_empty();
4719 match forward_htlcs.entry(scid) {
4720 hash_map::Entry::Occupied(mut entry) => {
4721 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4722 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
4724 hash_map::Entry::Vacant(entry) => {
4725 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
4726 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.genesis_hash)
4728 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).into_inner());
4729 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
4730 match pending_intercepts.entry(intercept_id) {
4731 hash_map::Entry::Vacant(entry) => {
4732 new_intercept_events.push(events::Event::HTLCIntercepted {
4733 requested_next_hop_scid: scid,
4734 payment_hash: forward_info.payment_hash,
4735 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
4736 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
4739 entry.insert(PendingAddHTLCInfo {
4740 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
4742 hash_map::Entry::Occupied(_) => {
4743 log_info!(self.logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
4744 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4745 short_channel_id: prev_short_channel_id,
4746 outpoint: prev_funding_outpoint,
4747 htlc_id: prev_htlc_id,
4748 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
4749 phantom_shared_secret: None,
4752 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
4753 HTLCFailReason::from_failure_code(0x4000 | 10),
4754 HTLCDestination::InvalidForward { requested_forward_scid: scid },
4759 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
4760 // payments are being processed.
4761 if forward_htlcs_empty {
4762 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
4764 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4765 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
4772 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
4773 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4776 if !new_intercept_events.is_empty() {
4777 let mut events = self.pending_events.lock().unwrap();
4778 events.append(&mut new_intercept_events);
4781 match forward_event {
4783 let mut pending_events = self.pending_events.lock().unwrap();
4784 pending_events.push(events::Event::PendingHTLCsForwardable {
4785 time_forwardable: time
4793 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
4794 let mut htlcs_to_fail = Vec::new();
4796 let per_peer_state = self.per_peer_state.read().unwrap();
4797 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4798 if let None = peer_state_mutex_opt {
4799 break Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))
4801 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4802 let peer_state = &mut *peer_state_lock;
4803 match peer_state.channel_by_id.entry(msg.channel_id) {
4804 hash_map::Entry::Occupied(mut chan) => {
4805 let was_paused_for_mon_update = chan.get().is_awaiting_monitor_update();
4806 let raa_updates = break_chan_entry!(self,
4807 chan.get_mut().revoke_and_ack(&msg, &self.logger), chan);
4808 htlcs_to_fail = raa_updates.holding_cell_failed_htlcs;
4809 let update_res = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), &raa_updates.monitor_update);
4810 if was_paused_for_mon_update {
4811 assert!(update_res != ChannelMonitorUpdateStatus::Completed);
4812 assert!(raa_updates.commitment_update.is_none());
4813 assert!(raa_updates.accepted_htlcs.is_empty());
4814 assert!(raa_updates.failed_htlcs.is_empty());
4815 assert!(raa_updates.finalized_claimed_htlcs.is_empty());
4816 break Err(MsgHandleErrInternal::ignore_no_close("Existing pending monitor update prevented responses to RAA".to_owned()));
4818 if update_res != ChannelMonitorUpdateStatus::Completed {
4819 if let Err(e) = handle_monitor_update_res!(self, update_res, chan,
4820 RAACommitmentOrder::CommitmentFirst, false,
4821 raa_updates.commitment_update.is_some(), false,
4822 raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
4823 raa_updates.finalized_claimed_htlcs) {
4825 } else { unreachable!(); }
4827 if let Some(updates) = raa_updates.commitment_update {
4828 peer_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4829 node_id: counterparty_node_id.clone(),
4833 break Ok((raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
4834 raa_updates.finalized_claimed_htlcs,
4835 chan.get().get_short_channel_id()
4836 .unwrap_or(chan.get().outbound_scid_alias()),
4837 chan.get().get_funding_txo().unwrap(),
4838 chan.get().get_user_id()))
4840 hash_map::Entry::Vacant(_) => break Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4843 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
4845 Ok((pending_forwards, mut pending_failures, finalized_claim_htlcs,
4846 short_channel_id, channel_outpoint, user_channel_id)) =>
4848 for failure in pending_failures.drain(..) {
4849 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: channel_outpoint.to_channel_id() };
4850 self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
4852 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, user_channel_id, pending_forwards)]);
4853 self.finalize_claims(finalized_claim_htlcs);
4860 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
4861 let per_peer_state = self.per_peer_state.read().unwrap();
4862 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4863 if let None = peer_state_mutex_opt {
4864 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id));
4866 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4867 let peer_state = &mut *peer_state_lock;
4868 match peer_state.channel_by_id.entry(msg.channel_id) {
4869 hash_map::Entry::Occupied(mut chan) => {
4870 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg, &self.logger), chan);
4872 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4877 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
4878 let per_peer_state = self.per_peer_state.read().unwrap();
4879 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4880 if let None = peer_state_mutex_opt {
4881 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id));
4883 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4884 let peer_state = &mut *peer_state_lock;
4885 match peer_state.channel_by_id.entry(msg.channel_id) {
4886 hash_map::Entry::Occupied(mut chan) => {
4887 if !chan.get().is_usable() {
4888 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
4891 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
4892 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(
4893 &self.node_signer, self.genesis_hash.clone(), self.best_block.read().unwrap().height(),
4894 msg, &self.default_configuration
4896 // Note that announcement_signatures fails if the channel cannot be announced,
4897 // so get_channel_update_for_broadcast will never fail by the time we get here.
4898 update_msg: self.get_channel_update_for_broadcast(chan.get()).unwrap(),
4901 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4906 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
4907 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
4908 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
4909 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
4911 // It's not a local channel
4912 return Ok(NotifyOption::SkipPersist)
4915 let per_peer_state = self.per_peer_state.read().unwrap();
4916 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
4917 if let None = peer_state_mutex_opt {
4918 return Ok(NotifyOption::SkipPersist)
4920 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4921 let peer_state = &mut *peer_state_lock;
4922 match peer_state.channel_by_id.entry(chan_id) {
4923 hash_map::Entry::Occupied(mut chan) => {
4924 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4925 if chan.get().should_announce() {
4926 // If the announcement is about a channel of ours which is public, some
4927 // other peer may simply be forwarding all its gossip to us. Don't provide
4928 // a scary-looking error message and return Ok instead.
4929 return Ok(NotifyOption::SkipPersist);
4931 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));
4933 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().get_counterparty_node_id().serialize()[..];
4934 let msg_from_node_one = msg.contents.flags & 1 == 0;
4935 if were_node_one == msg_from_node_one {
4936 return Ok(NotifyOption::SkipPersist);
4938 log_debug!(self.logger, "Received channel_update for channel {}.", log_bytes!(chan_id));
4939 try_chan_entry!(self, chan.get_mut().channel_update(&msg), chan);
4942 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersist)
4944 Ok(NotifyOption::DoPersist)
4947 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
4949 let need_lnd_workaround = {
4950 let per_peer_state = self.per_peer_state.read().unwrap();
4952 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4953 if let None = peer_state_mutex_opt {
4954 return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id));
4956 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4957 let peer_state = &mut *peer_state_lock;
4958 match peer_state.channel_by_id.entry(msg.channel_id) {
4959 hash_map::Entry::Occupied(mut chan) => {
4960 // Currently, we expect all holding cell update_adds to be dropped on peer
4961 // disconnect, so Channel's reestablish will never hand us any holding cell
4962 // freed HTLCs to fail backwards. If in the future we no longer drop pending
4963 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
4964 let responses = try_chan_entry!(self, chan.get_mut().channel_reestablish(
4965 msg, &self.logger, &self.node_signer, self.genesis_hash,
4966 &self.default_configuration, &*self.best_block.read().unwrap()), chan);
4967 let mut channel_update = None;
4968 if let Some(msg) = responses.shutdown_msg {
4969 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
4970 node_id: counterparty_node_id.clone(),
4973 } else if chan.get().is_usable() {
4974 // If the channel is in a usable state (ie the channel is not being shut
4975 // down), send a unicast channel_update to our counterparty to make sure
4976 // they have the latest channel parameters.
4977 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
4978 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
4979 node_id: chan.get().get_counterparty_node_id(),
4984 let need_lnd_workaround = chan.get_mut().workaround_lnd_bug_4006.take();
4985 htlc_forwards = self.handle_channel_resumption(
4986 &mut peer_state.pending_msg_events, chan.get_mut(), responses.raa, responses.commitment_update, responses.order,
4987 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
4988 if let Some(upd) = channel_update {
4989 peer_state.pending_msg_events.push(upd);
4993 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4997 if let Some(forwards) = htlc_forwards {
4998 self.forward_htlcs(&mut [forwards][..]);
5001 if let Some(channel_ready_msg) = need_lnd_workaround {
5002 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
5007 /// Process pending events from the `chain::Watch`, returning whether any events were processed.
5008 fn process_pending_monitor_events(&self) -> bool {
5009 let mut failed_channels = Vec::new();
5010 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
5011 let has_pending_monitor_events = !pending_monitor_events.is_empty();
5012 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
5013 for monitor_event in monitor_events.drain(..) {
5014 match monitor_event {
5015 MonitorEvent::HTLCEvent(htlc_update) => {
5016 if let Some(preimage) = htlc_update.payment_preimage {
5017 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
5018 self.claim_funds_internal(htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, funding_outpoint.to_channel_id());
5020 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
5021 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
5022 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
5023 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
5026 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
5027 MonitorEvent::UpdateFailed(funding_outpoint) => {
5028 let counterparty_node_id_opt = match counterparty_node_id {
5029 Some(cp_id) => Some(cp_id),
5031 // TODO: Once we can rely on the counterparty_node_id from the
5032 // monitor event, this and the id_to_peer map should be removed.
5033 let id_to_peer = self.id_to_peer.lock().unwrap();
5034 id_to_peer.get(&funding_outpoint.to_channel_id()).cloned()
5037 if let Some(counterparty_node_id) = counterparty_node_id_opt {
5038 let per_peer_state = self.per_peer_state.read().unwrap();
5039 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
5040 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5041 let peer_state = &mut *peer_state_lock;
5042 let pending_msg_events = &mut peer_state.pending_msg_events;
5043 if let hash_map::Entry::Occupied(chan_entry) = peer_state.channel_by_id.entry(funding_outpoint.to_channel_id()) {
5044 let mut chan = remove_channel!(self, chan_entry);
5045 failed_channels.push(chan.force_shutdown(false));
5046 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5047 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5051 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
5052 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
5054 ClosureReason::CommitmentTxConfirmed
5056 self.issue_channel_close_events(&chan, reason);
5057 pending_msg_events.push(events::MessageSendEvent::HandleError {
5058 node_id: chan.get_counterparty_node_id(),
5059 action: msgs::ErrorAction::SendErrorMessage {
5060 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
5067 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
5068 self.channel_monitor_updated(&funding_txo, monitor_update_id, counterparty_node_id.as_ref());
5074 for failure in failed_channels.drain(..) {
5075 self.finish_force_close_channel(failure);
5078 has_pending_monitor_events
5081 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
5082 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
5083 /// update events as a separate process method here.
5085 pub fn process_monitor_events(&self) {
5086 self.process_pending_monitor_events();
5089 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
5090 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
5091 /// update was applied.
5092 fn check_free_holding_cells(&self) -> bool {
5093 let mut has_monitor_update = false;
5094 let mut failed_htlcs = Vec::new();
5095 let mut handle_errors = Vec::new();
5097 let per_peer_state = self.per_peer_state.read().unwrap();
5099 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5100 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5101 let peer_state = &mut *peer_state_lock;
5102 let pending_msg_events = &mut peer_state.pending_msg_events;
5103 peer_state.channel_by_id.retain(|channel_id, chan| {
5104 match chan.maybe_free_holding_cell_htlcs(&self.logger) {
5105 Ok((commitment_opt, holding_cell_failed_htlcs)) => {
5106 if !holding_cell_failed_htlcs.is_empty() {
5108 holding_cell_failed_htlcs,
5110 chan.get_counterparty_node_id()
5113 if let Some((commitment_update, monitor_update)) = commitment_opt {
5114 match self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), &monitor_update) {
5115 ChannelMonitorUpdateStatus::Completed => {
5116 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5117 node_id: chan.get_counterparty_node_id(),
5118 updates: commitment_update,
5122 has_monitor_update = true;
5123 let (res, close_channel) = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, channel_id, COMMITMENT_UPDATE_ONLY);
5124 handle_errors.push((chan.get_counterparty_node_id(), res));
5125 if close_channel { return false; }
5132 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
5133 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5134 // ChannelClosed event is generated by handle_error for us
5142 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
5143 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
5144 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
5147 for (counterparty_node_id, err) in handle_errors.drain(..) {
5148 let _ = handle_error!(self, err, counterparty_node_id);
5154 /// Check whether any channels have finished removing all pending updates after a shutdown
5155 /// exchange and can now send a closing_signed.
5156 /// Returns whether any closing_signed messages were generated.
5157 fn maybe_generate_initial_closing_signed(&self) -> bool {
5158 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
5159 let mut has_update = false;
5161 let per_peer_state = self.per_peer_state.read().unwrap();
5163 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5164 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5165 let peer_state = &mut *peer_state_lock;
5166 let pending_msg_events = &mut peer_state.pending_msg_events;
5167 peer_state.channel_by_id.retain(|channel_id, chan| {
5168 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
5169 Ok((msg_opt, tx_opt)) => {
5170 if let Some(msg) = msg_opt {
5172 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5173 node_id: chan.get_counterparty_node_id(), msg,
5176 if let Some(tx) = tx_opt {
5177 // We're done with this channel. We got a closing_signed and sent back
5178 // a closing_signed with a closing transaction to broadcast.
5179 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5180 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5185 self.issue_channel_close_events(chan, ClosureReason::CooperativeClosure);
5187 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
5188 self.tx_broadcaster.broadcast_transaction(&tx);
5189 update_maps_on_chan_removal!(self, chan);
5195 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
5196 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5204 for (counterparty_node_id, err) in handle_errors.drain(..) {
5205 let _ = handle_error!(self, err, counterparty_node_id);
5211 /// Handle a list of channel failures during a block_connected or block_disconnected call,
5212 /// pushing the channel monitor update (if any) to the background events queue and removing the
5214 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
5215 for mut failure in failed_channels.drain(..) {
5216 // Either a commitment transactions has been confirmed on-chain or
5217 // Channel::block_disconnected detected that the funding transaction has been
5218 // reorganized out of the main chain.
5219 // We cannot broadcast our latest local state via monitor update (as
5220 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
5221 // so we track the update internally and handle it when the user next calls
5222 // timer_tick_occurred, guaranteeing we're running normally.
5223 if let Some((funding_txo, update)) = failure.0.take() {
5224 assert_eq!(update.updates.len(), 1);
5225 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
5226 assert!(should_broadcast);
5227 } else { unreachable!(); }
5228 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
5230 self.finish_force_close_channel(failure);
5234 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> {
5235 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
5237 if min_value_msat.is_some() && min_value_msat.unwrap() > MAX_VALUE_MSAT {
5238 return Err(APIError::APIMisuseError { err: format!("min_value_msat of {} greater than total 21 million bitcoin supply", min_value_msat.unwrap()) });
5241 let payment_secret = PaymentSecret(self.entropy_source.get_secure_random_bytes());
5243 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5244 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5245 match payment_secrets.entry(payment_hash) {
5246 hash_map::Entry::Vacant(e) => {
5247 e.insert(PendingInboundPayment {
5248 payment_secret, min_value_msat, payment_preimage,
5249 user_payment_id: 0, // For compatibility with version 0.0.103 and earlier
5250 // We assume that highest_seen_timestamp is pretty close to the current time -
5251 // it's updated when we receive a new block with the maximum time we've seen in
5252 // a header. It should never be more than two hours in the future.
5253 // Thus, we add two hours here as a buffer to ensure we absolutely
5254 // never fail a payment too early.
5255 // Note that we assume that received blocks have reasonably up-to-date
5257 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
5260 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
5265 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
5268 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
5269 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
5271 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
5272 /// will have the [`PaymentClaimable::payment_preimage`] field filled in. That should then be
5273 /// passed directly to [`claim_funds`].
5275 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
5277 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5278 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5282 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5283 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5285 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5287 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
5288 /// on versions of LDK prior to 0.0.114.
5290 /// [`claim_funds`]: Self::claim_funds
5291 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
5292 /// [`PaymentClaimable::payment_preimage`]: events::Event::PaymentClaimable::payment_preimage
5293 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5294 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
5295 min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
5296 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs,
5297 &self.entropy_source, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
5298 min_final_cltv_expiry_delta)
5301 /// Legacy version of [`create_inbound_payment`]. Use this method if you wish to share
5302 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5304 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5307 /// This method is deprecated and will be removed soon.
5309 /// [`create_inbound_payment`]: Self::create_inbound_payment
5311 pub fn create_inbound_payment_legacy(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), APIError> {
5312 let payment_preimage = PaymentPreimage(self.entropy_source.get_secure_random_bytes());
5313 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
5314 let payment_secret = self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs)?;
5315 Ok((payment_hash, payment_secret))
5318 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
5319 /// stored external to LDK.
5321 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
5322 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
5323 /// the `min_value_msat` provided here, if one is provided.
5325 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
5326 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
5329 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
5330 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
5331 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
5332 /// sender "proof-of-payment" unless they have paid the required amount.
5334 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
5335 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
5336 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
5337 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
5338 /// invoices when no timeout is set.
5340 /// Note that we use block header time to time-out pending inbound payments (with some margin
5341 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
5342 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
5343 /// If you need exact expiry semantics, you should enforce them upon receipt of
5344 /// [`PaymentClaimable`].
5346 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
5347 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
5349 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5350 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5354 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5355 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5357 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5359 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
5360 /// on versions of LDK prior to 0.0.114.
5362 /// [`create_inbound_payment`]: Self::create_inbound_payment
5363 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
5364 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>,
5365 invoice_expiry_delta_secs: u32, min_final_cltv_expiry: Option<u16>) -> Result<PaymentSecret, ()> {
5366 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash,
5367 invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
5368 min_final_cltv_expiry)
5371 /// Legacy version of [`create_inbound_payment_for_hash`]. Use this method if you wish to share
5372 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5374 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5377 /// This method is deprecated and will be removed soon.
5379 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5381 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> {
5382 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
5385 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
5386 /// previously returned from [`create_inbound_payment`].
5388 /// [`create_inbound_payment`]: Self::create_inbound_payment
5389 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
5390 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
5393 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
5394 /// are used when constructing the phantom invoice's route hints.
5396 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5397 pub fn get_phantom_scid(&self) -> u64 {
5398 let best_block_height = self.best_block.read().unwrap().height();
5399 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
5401 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
5402 // Ensure the generated scid doesn't conflict with a real channel.
5403 match short_to_chan_info.get(&scid_candidate) {
5404 Some(_) => continue,
5405 None => return scid_candidate
5410 /// Gets route hints for use in receiving [phantom node payments].
5412 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5413 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
5415 channels: self.list_usable_channels(),
5416 phantom_scid: self.get_phantom_scid(),
5417 real_node_pubkey: self.get_our_node_id(),
5421 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
5422 /// used when constructing the route hints for HTLCs intended to be intercepted. See
5423 /// [`ChannelManager::forward_intercepted_htlc`].
5425 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
5426 /// times to get a unique scid.
5427 pub fn get_intercept_scid(&self) -> u64 {
5428 let best_block_height = self.best_block.read().unwrap().height();
5429 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
5431 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
5432 // Ensure the generated scid doesn't conflict with a real channel.
5433 if short_to_chan_info.contains_key(&scid_candidate) { continue }
5434 return scid_candidate
5438 /// Gets inflight HTLC information by processing pending outbound payments that are in
5439 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
5440 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
5441 let mut inflight_htlcs = InFlightHtlcs::new();
5443 let per_peer_state = self.per_peer_state.read().unwrap();
5444 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5445 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5446 let peer_state = &mut *peer_state_lock;
5447 for chan in peer_state.channel_by_id.values() {
5448 for (htlc_source, _) in chan.inflight_htlc_sources() {
5449 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
5450 inflight_htlcs.process_path(path, self.get_our_node_id());
5459 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
5460 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
5461 let events = core::cell::RefCell::new(Vec::new());
5462 let event_handler = |event: events::Event| events.borrow_mut().push(event);
5463 self.process_pending_events(&event_handler);
5468 pub fn pop_pending_event(&self) -> Option<events::Event> {
5469 let mut events = self.pending_events.lock().unwrap();
5470 if events.is_empty() { None } else { Some(events.remove(0)) }
5474 pub fn has_pending_payments(&self) -> bool {
5475 self.pending_outbound_payments.has_pending_payments()
5479 pub fn clear_pending_payments(&self) {
5480 self.pending_outbound_payments.clear_pending_payments()
5483 /// Processes any events asynchronously in the order they were generated since the last call
5484 /// using the given event handler.
5486 /// See the trait-level documentation of [`EventsProvider`] for requirements.
5487 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
5490 // We'll acquire our total consistency lock until the returned future completes so that
5491 // we can be sure no other persists happen while processing events.
5492 let _read_guard = self.total_consistency_lock.read().unwrap();
5494 let mut result = NotifyOption::SkipPersist;
5496 // TODO: This behavior should be documented. It's unintuitive that we query
5497 // ChannelMonitors when clearing other events.
5498 if self.process_pending_monitor_events() {
5499 result = NotifyOption::DoPersist;
5502 let pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5503 if !pending_events.is_empty() {
5504 result = NotifyOption::DoPersist;
5507 for event in pending_events {
5508 handler(event).await;
5511 if result == NotifyOption::DoPersist {
5512 self.persistence_notifier.notify();
5517 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<M, T, ES, NS, SP, F, R, L>
5519 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5520 T::Target: BroadcasterInterface,
5521 ES::Target: EntropySource,
5522 NS::Target: NodeSigner,
5523 SP::Target: SignerProvider,
5524 F::Target: FeeEstimator,
5528 /// Returns `MessageSendEvent`s strictly ordered per-peer, in the order they were generated.
5529 /// The returned array will contain `MessageSendEvent`s for different peers if
5530 /// `MessageSendEvent`s to more than one peer exists, but `MessageSendEvent`s to the same peer
5531 /// is always placed next to each other.
5533 /// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
5534 /// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
5535 /// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
5536 /// will randomly be placed first or last in the returned array.
5538 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
5539 /// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
5540 /// the `MessageSendEvent`s to the specific peer they were generated under.
5541 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
5542 let events = RefCell::new(Vec::new());
5543 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5544 let mut result = NotifyOption::SkipPersist;
5546 // TODO: This behavior should be documented. It's unintuitive that we query
5547 // ChannelMonitors when clearing other events.
5548 if self.process_pending_monitor_events() {
5549 result = NotifyOption::DoPersist;
5552 if self.check_free_holding_cells() {
5553 result = NotifyOption::DoPersist;
5555 if self.maybe_generate_initial_closing_signed() {
5556 result = NotifyOption::DoPersist;
5559 let mut pending_events = Vec::new();
5560 let per_peer_state = self.per_peer_state.read().unwrap();
5561 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5562 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5563 let peer_state = &mut *peer_state_lock;
5564 if peer_state.pending_msg_events.len() > 0 {
5565 let mut peer_pending_events = Vec::new();
5566 mem::swap(&mut peer_pending_events, &mut peer_state.pending_msg_events);
5567 pending_events.append(&mut peer_pending_events);
5571 if !pending_events.is_empty() {
5572 events.replace(pending_events);
5581 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> EventsProvider for ChannelManager<M, T, ES, NS, SP, F, R, L>
5583 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5584 T::Target: BroadcasterInterface,
5585 ES::Target: EntropySource,
5586 NS::Target: NodeSigner,
5587 SP::Target: SignerProvider,
5588 F::Target: FeeEstimator,
5592 /// Processes events that must be periodically handled.
5594 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
5595 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
5596 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
5597 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5598 let mut result = NotifyOption::SkipPersist;
5600 // TODO: This behavior should be documented. It's unintuitive that we query
5601 // ChannelMonitors when clearing other events.
5602 if self.process_pending_monitor_events() {
5603 result = NotifyOption::DoPersist;
5606 let pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5607 if !pending_events.is_empty() {
5608 result = NotifyOption::DoPersist;
5611 for event in pending_events {
5612 handler.handle_event(event);
5620 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> chain::Listen for ChannelManager<M, T, ES, NS, SP, F, R, L>
5622 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5623 T::Target: BroadcasterInterface,
5624 ES::Target: EntropySource,
5625 NS::Target: NodeSigner,
5626 SP::Target: SignerProvider,
5627 F::Target: FeeEstimator,
5631 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5633 let best_block = self.best_block.read().unwrap();
5634 assert_eq!(best_block.block_hash(), header.prev_blockhash,
5635 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
5636 assert_eq!(best_block.height(), height - 1,
5637 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
5640 self.transactions_confirmed(header, txdata, height);
5641 self.best_block_updated(header, height);
5644 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
5645 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5646 let new_height = height - 1;
5648 let mut best_block = self.best_block.write().unwrap();
5649 assert_eq!(best_block.block_hash(), header.block_hash(),
5650 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
5651 assert_eq!(best_block.height(), height,
5652 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
5653 *best_block = BestBlock::new(header.prev_blockhash, new_height)
5656 self.do_chain_event(Some(new_height), |channel| channel.best_block_updated(new_height, header.time, self.genesis_hash.clone(), &self.node_signer, &self.default_configuration, &self.logger));
5660 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> chain::Confirm for ChannelManager<M, T, ES, NS, SP, F, R, L>
5662 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5663 T::Target: BroadcasterInterface,
5664 ES::Target: EntropySource,
5665 NS::Target: NodeSigner,
5666 SP::Target: SignerProvider,
5667 F::Target: FeeEstimator,
5671 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5672 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5673 // during initialization prior to the chain_monitor being fully configured in some cases.
5674 // See the docs for `ChannelManagerReadArgs` for more.
5676 let block_hash = header.block_hash();
5677 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
5679 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5680 self.do_chain_event(Some(height), |channel| channel.transactions_confirmed(&block_hash, height, txdata, self.genesis_hash.clone(), &self.node_signer, &self.default_configuration, &self.logger)
5681 .map(|(a, b)| (a, Vec::new(), b)));
5683 let last_best_block_height = self.best_block.read().unwrap().height();
5684 if height < last_best_block_height {
5685 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
5686 self.do_chain_event(Some(last_best_block_height), |channel| channel.best_block_updated(last_best_block_height, timestamp as u32, self.genesis_hash.clone(), &self.node_signer, &self.default_configuration, &self.logger));
5690 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
5691 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5692 // during initialization prior to the chain_monitor being fully configured in some cases.
5693 // See the docs for `ChannelManagerReadArgs` for more.
5695 let block_hash = header.block_hash();
5696 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
5698 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5700 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
5702 self.do_chain_event(Some(height), |channel| channel.best_block_updated(height, header.time, self.genesis_hash.clone(), &self.node_signer, &self.default_configuration, &self.logger));
5704 macro_rules! max_time {
5705 ($timestamp: expr) => {
5707 // Update $timestamp to be the max of its current value and the block
5708 // timestamp. This should keep us close to the current time without relying on
5709 // having an explicit local time source.
5710 // Just in case we end up in a race, we loop until we either successfully
5711 // update $timestamp or decide we don't need to.
5712 let old_serial = $timestamp.load(Ordering::Acquire);
5713 if old_serial >= header.time as usize { break; }
5714 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
5720 max_time!(self.highest_seen_timestamp);
5721 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5722 payment_secrets.retain(|_, inbound_payment| {
5723 inbound_payment.expiry_time > header.time as u64
5727 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
5728 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
5729 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
5730 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5731 let peer_state = &mut *peer_state_lock;
5732 for chan in peer_state.channel_by_id.values() {
5733 if let (Some(funding_txo), block_hash) = (chan.get_funding_txo(), chan.get_funding_tx_confirmed_in()) {
5734 res.push((funding_txo.txid, block_hash));
5741 fn transaction_unconfirmed(&self, txid: &Txid) {
5742 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5743 self.do_chain_event(None, |channel| {
5744 if let Some(funding_txo) = channel.get_funding_txo() {
5745 if funding_txo.txid == *txid {
5746 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
5747 } else { Ok((None, Vec::new(), None)) }
5748 } else { Ok((None, Vec::new(), None)) }
5753 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> ChannelManager<M, T, ES, NS, SP, F, R, L>
5755 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5756 T::Target: BroadcasterInterface,
5757 ES::Target: EntropySource,
5758 NS::Target: NodeSigner,
5759 SP::Target: SignerProvider,
5760 F::Target: FeeEstimator,
5764 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
5765 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
5767 fn do_chain_event<FN: Fn(&mut Channel<<SP::Target as SignerProvider>::Signer>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
5768 (&self, height_opt: Option<u32>, f: FN) {
5769 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5770 // during initialization prior to the chain_monitor being fully configured in some cases.
5771 // See the docs for `ChannelManagerReadArgs` for more.
5773 let mut failed_channels = Vec::new();
5774 let mut timed_out_htlcs = Vec::new();
5776 let per_peer_state = self.per_peer_state.read().unwrap();
5777 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5778 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5779 let peer_state = &mut *peer_state_lock;
5780 let pending_msg_events = &mut peer_state.pending_msg_events;
5781 peer_state.channel_by_id.retain(|_, channel| {
5782 let res = f(channel);
5783 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
5784 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
5785 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
5786 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
5787 HTLCDestination::NextHopChannel { node_id: Some(channel.get_counterparty_node_id()), channel_id: channel.channel_id() }));
5789 if let Some(channel_ready) = channel_ready_opt {
5790 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
5791 if channel.is_usable() {
5792 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", log_bytes!(channel.channel_id()));
5793 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
5794 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
5795 node_id: channel.get_counterparty_node_id(),
5800 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", log_bytes!(channel.channel_id()));
5804 emit_channel_ready_event!(self, channel);
5806 if let Some(announcement_sigs) = announcement_sigs {
5807 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(channel.channel_id()));
5808 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5809 node_id: channel.get_counterparty_node_id(),
5810 msg: announcement_sigs,
5812 if let Some(height) = height_opt {
5813 if let Some(announcement) = channel.get_signed_channel_announcement(&self.node_signer, self.genesis_hash, height, &self.default_configuration) {
5814 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5816 // Note that announcement_signatures fails if the channel cannot be announced,
5817 // so get_channel_update_for_broadcast will never fail by the time we get here.
5818 update_msg: self.get_channel_update_for_broadcast(channel).unwrap(),
5823 if channel.is_our_channel_ready() {
5824 if let Some(real_scid) = channel.get_short_channel_id() {
5825 // If we sent a 0conf channel_ready, and now have an SCID, we add it
5826 // to the short_to_chan_info map here. Note that we check whether we
5827 // can relay using the real SCID at relay-time (i.e.
5828 // enforce option_scid_alias then), and if the funding tx is ever
5829 // un-confirmed we force-close the channel, ensuring short_to_chan_info
5830 // is always consistent.
5831 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
5832 let scid_insert = short_to_chan_info.insert(real_scid, (channel.get_counterparty_node_id(), channel.channel_id()));
5833 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.get_counterparty_node_id(), channel.channel_id()),
5834 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
5835 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
5838 } else if let Err(reason) = res {
5839 update_maps_on_chan_removal!(self, channel);
5840 // It looks like our counterparty went on-chain or funding transaction was
5841 // reorged out of the main chain. Close the channel.
5842 failed_channels.push(channel.force_shutdown(true));
5843 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
5844 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5848 let reason_message = format!("{}", reason);
5849 self.issue_channel_close_events(channel, reason);
5850 pending_msg_events.push(events::MessageSendEvent::HandleError {
5851 node_id: channel.get_counterparty_node_id(),
5852 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
5853 channel_id: channel.channel_id(),
5854 data: reason_message,
5864 if let Some(height) = height_opt {
5865 self.claimable_payments.lock().unwrap().claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
5866 htlcs.retain(|htlc| {
5867 // If height is approaching the number of blocks we think it takes us to get
5868 // our commitment transaction confirmed before the HTLC expires, plus the
5869 // number of blocks we generally consider it to take to do a commitment update,
5870 // just give up on it and fail the HTLC.
5871 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
5872 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5873 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
5875 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
5876 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
5877 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
5881 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
5884 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
5885 intercepted_htlcs.retain(|_, htlc| {
5886 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
5887 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
5888 short_channel_id: htlc.prev_short_channel_id,
5889 htlc_id: htlc.prev_htlc_id,
5890 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
5891 phantom_shared_secret: None,
5892 outpoint: htlc.prev_funding_outpoint,
5895 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
5896 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
5897 _ => unreachable!(),
5899 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
5900 HTLCFailReason::from_failure_code(0x2000 | 2),
5901 HTLCDestination::InvalidForward { requested_forward_scid }));
5902 log_trace!(self.logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
5908 self.handle_init_event_channel_failures(failed_channels);
5910 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
5911 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
5915 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
5916 /// indicating whether persistence is necessary. Only one listener on
5917 /// [`await_persistable_update`], [`await_persistable_update_timeout`], or a future returned by
5918 /// [`get_persistable_update_future`] is guaranteed to be woken up.
5920 /// Note that this method is not available with the `no-std` feature.
5922 /// [`await_persistable_update`]: Self::await_persistable_update
5923 /// [`await_persistable_update_timeout`]: Self::await_persistable_update_timeout
5924 /// [`get_persistable_update_future`]: Self::get_persistable_update_future
5925 #[cfg(any(test, feature = "std"))]
5926 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
5927 self.persistence_notifier.wait_timeout(max_wait)
5930 /// Blocks until ChannelManager needs to be persisted. Only one listener on
5931 /// [`await_persistable_update`], `await_persistable_update_timeout`, or a future returned by
5932 /// [`get_persistable_update_future`] is guaranteed to be woken up.
5934 /// [`await_persistable_update`]: Self::await_persistable_update
5935 /// [`get_persistable_update_future`]: Self::get_persistable_update_future
5936 pub fn await_persistable_update(&self) {
5937 self.persistence_notifier.wait()
5940 /// Gets a [`Future`] that completes when a persistable update is available. Note that
5941 /// callbacks registered on the [`Future`] MUST NOT call back into this [`ChannelManager`] and
5942 /// should instead register actions to be taken later.
5943 pub fn get_persistable_update_future(&self) -> Future {
5944 self.persistence_notifier.get_future()
5947 #[cfg(any(test, feature = "_test_utils"))]
5948 pub fn get_persistence_condvar_value(&self) -> bool {
5949 self.persistence_notifier.notify_pending()
5952 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
5953 /// [`chain::Confirm`] interfaces.
5954 pub fn current_best_block(&self) -> BestBlock {
5955 self.best_block.read().unwrap().clone()
5958 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
5959 /// [`ChannelManager`].
5960 pub fn node_features(&self) -> NodeFeatures {
5961 provided_node_features(&self.default_configuration)
5964 /// Fetches the set of [`InvoiceFeatures`] flags which are provided by or required by
5965 /// [`ChannelManager`].
5967 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
5968 /// or not. Thus, this method is not public.
5969 #[cfg(any(feature = "_test_utils", test))]
5970 pub fn invoice_features(&self) -> InvoiceFeatures {
5971 provided_invoice_features(&self.default_configuration)
5974 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
5975 /// [`ChannelManager`].
5976 pub fn channel_features(&self) -> ChannelFeatures {
5977 provided_channel_features(&self.default_configuration)
5980 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
5981 /// [`ChannelManager`].
5982 pub fn channel_type_features(&self) -> ChannelTypeFeatures {
5983 provided_channel_type_features(&self.default_configuration)
5986 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
5987 /// [`ChannelManager`].
5988 pub fn init_features(&self) -> InitFeatures {
5989 provided_init_features(&self.default_configuration)
5993 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
5994 ChannelMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
5996 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5997 T::Target: BroadcasterInterface,
5998 ES::Target: EntropySource,
5999 NS::Target: NodeSigner,
6000 SP::Target: SignerProvider,
6001 F::Target: FeeEstimator,
6005 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) {
6006 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6007 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, msg), *counterparty_node_id);
6010 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
6011 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6012 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, msg), *counterparty_node_id);
6015 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
6016 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6017 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
6020 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
6021 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6022 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
6025 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
6026 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6027 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
6030 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
6031 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6032 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
6035 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
6036 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6037 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
6040 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
6041 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6042 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
6045 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
6046 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6047 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
6050 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
6051 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6052 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
6055 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
6056 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6057 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
6060 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
6061 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6062 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
6065 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
6066 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6067 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
6070 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
6071 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6072 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
6075 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
6076 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6077 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
6080 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
6081 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
6082 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
6085 NotifyOption::SkipPersist
6090 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
6091 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6092 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
6095 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
6096 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6097 let mut failed_channels = Vec::new();
6098 let mut no_channels_remain = true;
6099 let mut per_peer_state = self.per_peer_state.write().unwrap();
6101 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates. We believe we {} make future connections to this peer.",
6102 log_pubkey!(counterparty_node_id), if no_connection_possible { "cannot" } else { "can" });
6103 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
6104 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6105 let peer_state = &mut *peer_state_lock;
6106 let pending_msg_events = &mut peer_state.pending_msg_events;
6107 peer_state.channel_by_id.retain(|_, chan| {
6108 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
6109 if chan.is_shutdown() {
6110 update_maps_on_chan_removal!(self, chan);
6111 self.issue_channel_close_events(chan, ClosureReason::DisconnectedPeer);
6114 no_channels_remain = false;
6118 pending_msg_events.retain(|msg| {
6120 &events::MessageSendEvent::SendAcceptChannel { .. } => false,
6121 &events::MessageSendEvent::SendOpenChannel { .. } => false,
6122 &events::MessageSendEvent::SendFundingCreated { .. } => false,
6123 &events::MessageSendEvent::SendFundingSigned { .. } => false,
6124 &events::MessageSendEvent::SendChannelReady { .. } => false,
6125 &events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
6126 &events::MessageSendEvent::UpdateHTLCs { .. } => false,
6127 &events::MessageSendEvent::SendRevokeAndACK { .. } => false,
6128 &events::MessageSendEvent::SendClosingSigned { .. } => false,
6129 &events::MessageSendEvent::SendShutdown { .. } => false,
6130 &events::MessageSendEvent::SendChannelReestablish { .. } => false,
6131 &events::MessageSendEvent::SendChannelAnnouncement { .. } => false,
6132 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
6133 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
6134 &events::MessageSendEvent::SendChannelUpdate { .. } => false,
6135 &events::MessageSendEvent::HandleError { .. } => false,
6136 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
6137 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
6138 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
6139 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
6144 if no_channels_remain {
6145 per_peer_state.remove(counterparty_node_id);
6147 mem::drop(per_peer_state);
6149 for failure in failed_channels.drain(..) {
6150 self.finish_force_close_channel(failure);
6154 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) -> Result<(), ()> {
6155 if !init_msg.features.supports_static_remote_key() {
6156 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(counterparty_node_id));
6160 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
6162 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6165 let mut peer_state_lock = self.per_peer_state.write().unwrap();
6166 match peer_state_lock.entry(counterparty_node_id.clone()) {
6167 hash_map::Entry::Vacant(e) => {
6168 e.insert(Mutex::new(PeerState {
6169 channel_by_id: HashMap::new(),
6170 latest_features: init_msg.features.clone(),
6171 pending_msg_events: Vec::new(),
6174 hash_map::Entry::Occupied(e) => {
6175 e.get().lock().unwrap().latest_features = init_msg.features.clone();
6180 let per_peer_state = self.per_peer_state.read().unwrap();
6182 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6183 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6184 let peer_state = &mut *peer_state_lock;
6185 let pending_msg_events = &mut peer_state.pending_msg_events;
6186 peer_state.channel_by_id.retain(|_, chan| {
6187 let retain = if chan.get_counterparty_node_id() == *counterparty_node_id {
6188 if !chan.have_received_message() {
6189 // If we created this (outbound) channel while we were disconnected from the
6190 // peer we probably failed to send the open_channel message, which is now
6191 // lost. We can't have had anything pending related to this channel, so we just
6195 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
6196 node_id: chan.get_counterparty_node_id(),
6197 msg: chan.get_channel_reestablish(&self.logger),
6202 if retain && chan.get_counterparty_node_id() != *counterparty_node_id {
6203 if let Some(msg) = chan.get_signed_channel_announcement(&self.node_signer, self.genesis_hash.clone(), self.best_block.read().unwrap().height(), &self.default_configuration) {
6204 if let Ok(update_msg) = self.get_channel_update_for_broadcast(chan) {
6205 pending_msg_events.push(events::MessageSendEvent::SendChannelAnnouncement {
6206 node_id: *counterparty_node_id,
6215 //TODO: Also re-broadcast announcement_signatures
6219 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
6220 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6222 if msg.channel_id == [0; 32] {
6223 let channel_ids: Vec<[u8; 32]> = {
6224 let per_peer_state = self.per_peer_state.read().unwrap();
6225 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
6226 if let None = peer_state_mutex_opt { return; }
6227 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
6228 let peer_state = &mut *peer_state_lock;
6229 peer_state.channel_by_id.keys().cloned().collect()
6231 for channel_id in channel_ids {
6232 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6233 let _ = self.force_close_channel_with_peer(&channel_id, counterparty_node_id, Some(&msg.data), true);
6237 // First check if we can advance the channel type and try again.
6238 let per_peer_state = self.per_peer_state.read().unwrap();
6239 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
6240 if let None = peer_state_mutex_opt { return; }
6241 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
6242 let peer_state = &mut *peer_state_lock;
6243 if let Some(chan) = peer_state.channel_by_id.get_mut(&msg.channel_id) {
6244 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash) {
6245 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
6246 node_id: *counterparty_node_id,
6254 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6255 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
6259 fn provided_node_features(&self) -> NodeFeatures {
6260 provided_node_features(&self.default_configuration)
6263 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
6264 provided_init_features(&self.default_configuration)
6268 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
6269 /// [`ChannelManager`].
6270 pub(crate) fn provided_node_features(config: &UserConfig) -> NodeFeatures {
6271 provided_init_features(config).to_context()
6274 /// Fetches the set of [`InvoiceFeatures`] flags which are provided by or required by
6275 /// [`ChannelManager`].
6277 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
6278 /// or not. Thus, this method is not public.
6279 #[cfg(any(feature = "_test_utils", test))]
6280 pub(crate) fn provided_invoice_features(config: &UserConfig) -> InvoiceFeatures {
6281 provided_init_features(config).to_context()
6284 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
6285 /// [`ChannelManager`].
6286 pub(crate) fn provided_channel_features(config: &UserConfig) -> ChannelFeatures {
6287 provided_init_features(config).to_context()
6290 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
6291 /// [`ChannelManager`].
6292 pub(crate) fn provided_channel_type_features(config: &UserConfig) -> ChannelTypeFeatures {
6293 ChannelTypeFeatures::from_init(&provided_init_features(config))
6296 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
6297 /// [`ChannelManager`].
6298 pub fn provided_init_features(_config: &UserConfig) -> InitFeatures {
6299 // Note that if new features are added here which other peers may (eventually) require, we
6300 // should also add the corresponding (optional) bit to the ChannelMessageHandler impl for
6301 // ErroringMessageHandler.
6302 let mut features = InitFeatures::empty();
6303 features.set_data_loss_protect_optional();
6304 features.set_upfront_shutdown_script_optional();
6305 features.set_variable_length_onion_required();
6306 features.set_static_remote_key_required();
6307 features.set_payment_secret_required();
6308 features.set_basic_mpp_optional();
6309 features.set_wumbo_optional();
6310 features.set_shutdown_any_segwit_optional();
6311 features.set_channel_type_optional();
6312 features.set_scid_privacy_optional();
6313 features.set_zero_conf_optional();
6315 { // Attributes are not allowed on if expressions on our current MSRV of 1.41.
6316 if _config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx {
6317 features.set_anchors_zero_fee_htlc_tx_optional();
6323 const SERIALIZATION_VERSION: u8 = 1;
6324 const MIN_SERIALIZATION_VERSION: u8 = 1;
6326 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
6327 (2, fee_base_msat, required),
6328 (4, fee_proportional_millionths, required),
6329 (6, cltv_expiry_delta, required),
6332 impl_writeable_tlv_based!(ChannelCounterparty, {
6333 (2, node_id, required),
6334 (4, features, required),
6335 (6, unspendable_punishment_reserve, required),
6336 (8, forwarding_info, option),
6337 (9, outbound_htlc_minimum_msat, option),
6338 (11, outbound_htlc_maximum_msat, option),
6341 impl Writeable for ChannelDetails {
6342 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6343 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
6344 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
6345 let user_channel_id_low = self.user_channel_id as u64;
6346 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
6347 write_tlv_fields!(writer, {
6348 (1, self.inbound_scid_alias, option),
6349 (2, self.channel_id, required),
6350 (3, self.channel_type, option),
6351 (4, self.counterparty, required),
6352 (5, self.outbound_scid_alias, option),
6353 (6, self.funding_txo, option),
6354 (7, self.config, option),
6355 (8, self.short_channel_id, option),
6356 (9, self.confirmations, option),
6357 (10, self.channel_value_satoshis, required),
6358 (12, self.unspendable_punishment_reserve, option),
6359 (14, user_channel_id_low, required),
6360 (16, self.balance_msat, required),
6361 (18, self.outbound_capacity_msat, required),
6362 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6363 // filled in, so we can safely unwrap it here.
6364 (19, self.next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6365 (20, self.inbound_capacity_msat, required),
6366 (22, self.confirmations_required, option),
6367 (24, self.force_close_spend_delay, option),
6368 (26, self.is_outbound, required),
6369 (28, self.is_channel_ready, required),
6370 (30, self.is_usable, required),
6371 (32, self.is_public, required),
6372 (33, self.inbound_htlc_minimum_msat, option),
6373 (35, self.inbound_htlc_maximum_msat, option),
6374 (37, user_channel_id_high_opt, option),
6380 impl Readable for ChannelDetails {
6381 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6382 _init_and_read_tlv_fields!(reader, {
6383 (1, inbound_scid_alias, option),
6384 (2, channel_id, required),
6385 (3, channel_type, option),
6386 (4, counterparty, required),
6387 (5, outbound_scid_alias, option),
6388 (6, funding_txo, option),
6389 (7, config, option),
6390 (8, short_channel_id, option),
6391 (9, confirmations, option),
6392 (10, channel_value_satoshis, required),
6393 (12, unspendable_punishment_reserve, option),
6394 (14, user_channel_id_low, required),
6395 (16, balance_msat, required),
6396 (18, outbound_capacity_msat, required),
6397 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6398 // filled in, so we can safely unwrap it here.
6399 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6400 (20, inbound_capacity_msat, required),
6401 (22, confirmations_required, option),
6402 (24, force_close_spend_delay, option),
6403 (26, is_outbound, required),
6404 (28, is_channel_ready, required),
6405 (30, is_usable, required),
6406 (32, is_public, required),
6407 (33, inbound_htlc_minimum_msat, option),
6408 (35, inbound_htlc_maximum_msat, option),
6409 (37, user_channel_id_high_opt, option),
6412 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
6413 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
6414 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
6415 let user_channel_id = user_channel_id_low as u128 +
6416 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
6420 channel_id: channel_id.0.unwrap(),
6422 counterparty: counterparty.0.unwrap(),
6423 outbound_scid_alias,
6427 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
6428 unspendable_punishment_reserve,
6430 balance_msat: balance_msat.0.unwrap(),
6431 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
6432 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
6433 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
6434 confirmations_required,
6436 force_close_spend_delay,
6437 is_outbound: is_outbound.0.unwrap(),
6438 is_channel_ready: is_channel_ready.0.unwrap(),
6439 is_usable: is_usable.0.unwrap(),
6440 is_public: is_public.0.unwrap(),
6441 inbound_htlc_minimum_msat,
6442 inbound_htlc_maximum_msat,
6447 impl_writeable_tlv_based!(PhantomRouteHints, {
6448 (2, channels, vec_type),
6449 (4, phantom_scid, required),
6450 (6, real_node_pubkey, required),
6453 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
6455 (0, onion_packet, required),
6456 (2, short_channel_id, required),
6459 (0, payment_data, required),
6460 (1, phantom_shared_secret, option),
6461 (2, incoming_cltv_expiry, required),
6463 (2, ReceiveKeysend) => {
6464 (0, payment_preimage, required),
6465 (2, incoming_cltv_expiry, required),
6469 impl_writeable_tlv_based!(PendingHTLCInfo, {
6470 (0, routing, required),
6471 (2, incoming_shared_secret, required),
6472 (4, payment_hash, required),
6473 (6, outgoing_amt_msat, required),
6474 (8, outgoing_cltv_value, required),
6475 (9, incoming_amt_msat, option),
6479 impl Writeable for HTLCFailureMsg {
6480 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6482 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
6484 channel_id.write(writer)?;
6485 htlc_id.write(writer)?;
6486 reason.write(writer)?;
6488 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6489 channel_id, htlc_id, sha256_of_onion, failure_code
6492 channel_id.write(writer)?;
6493 htlc_id.write(writer)?;
6494 sha256_of_onion.write(writer)?;
6495 failure_code.write(writer)?;
6502 impl Readable for HTLCFailureMsg {
6503 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6504 let id: u8 = Readable::read(reader)?;
6507 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
6508 channel_id: Readable::read(reader)?,
6509 htlc_id: Readable::read(reader)?,
6510 reason: Readable::read(reader)?,
6514 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6515 channel_id: Readable::read(reader)?,
6516 htlc_id: Readable::read(reader)?,
6517 sha256_of_onion: Readable::read(reader)?,
6518 failure_code: Readable::read(reader)?,
6521 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
6522 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
6523 // messages contained in the variants.
6524 // In version 0.0.101, support for reading the variants with these types was added, and
6525 // we should migrate to writing these variants when UpdateFailHTLC or
6526 // UpdateFailMalformedHTLC get TLV fields.
6528 let length: BigSize = Readable::read(reader)?;
6529 let mut s = FixedLengthReader::new(reader, length.0);
6530 let res = Readable::read(&mut s)?;
6531 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6532 Ok(HTLCFailureMsg::Relay(res))
6535 let length: BigSize = Readable::read(reader)?;
6536 let mut s = FixedLengthReader::new(reader, length.0);
6537 let res = Readable::read(&mut s)?;
6538 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6539 Ok(HTLCFailureMsg::Malformed(res))
6541 _ => Err(DecodeError::UnknownRequiredFeature),
6546 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
6551 impl_writeable_tlv_based!(HTLCPreviousHopData, {
6552 (0, short_channel_id, required),
6553 (1, phantom_shared_secret, option),
6554 (2, outpoint, required),
6555 (4, htlc_id, required),
6556 (6, incoming_packet_shared_secret, required)
6559 impl Writeable for ClaimableHTLC {
6560 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6561 let (payment_data, keysend_preimage) = match &self.onion_payload {
6562 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
6563 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
6565 write_tlv_fields!(writer, {
6566 (0, self.prev_hop, required),
6567 (1, self.total_msat, required),
6568 (2, self.value, required),
6569 (4, payment_data, option),
6570 (6, self.cltv_expiry, required),
6571 (8, keysend_preimage, option),
6577 impl Readable for ClaimableHTLC {
6578 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6579 let mut prev_hop = crate::util::ser::OptionDeserWrapper(None);
6581 let mut payment_data: Option<msgs::FinalOnionHopData> = None;
6582 let mut cltv_expiry = 0;
6583 let mut total_msat = None;
6584 let mut keysend_preimage: Option<PaymentPreimage> = None;
6585 read_tlv_fields!(reader, {
6586 (0, prev_hop, required),
6587 (1, total_msat, option),
6588 (2, value, required),
6589 (4, payment_data, option),
6590 (6, cltv_expiry, required),
6591 (8, keysend_preimage, option)
6593 let onion_payload = match keysend_preimage {
6595 if payment_data.is_some() {
6596 return Err(DecodeError::InvalidValue)
6598 if total_msat.is_none() {
6599 total_msat = Some(value);
6601 OnionPayload::Spontaneous(p)
6604 if total_msat.is_none() {
6605 if payment_data.is_none() {
6606 return Err(DecodeError::InvalidValue)
6608 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
6610 OnionPayload::Invoice { _legacy_hop_data: payment_data }
6614 prev_hop: prev_hop.0.unwrap(),
6617 total_msat: total_msat.unwrap(),
6624 impl Readable for HTLCSource {
6625 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6626 let id: u8 = Readable::read(reader)?;
6629 let mut session_priv: crate::util::ser::OptionDeserWrapper<SecretKey> = crate::util::ser::OptionDeserWrapper(None);
6630 let mut first_hop_htlc_msat: u64 = 0;
6631 let mut path = Some(Vec::new());
6632 let mut payment_id = None;
6633 let mut payment_secret = None;
6634 let mut payment_params = None;
6635 read_tlv_fields!(reader, {
6636 (0, session_priv, required),
6637 (1, payment_id, option),
6638 (2, first_hop_htlc_msat, required),
6639 (3, payment_secret, option),
6640 (4, path, vec_type),
6641 (5, payment_params, option),
6643 if payment_id.is_none() {
6644 // For backwards compat, if there was no payment_id written, use the session_priv bytes
6646 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
6648 Ok(HTLCSource::OutboundRoute {
6649 session_priv: session_priv.0.unwrap(),
6650 first_hop_htlc_msat,
6651 path: path.unwrap(),
6652 payment_id: payment_id.unwrap(),
6657 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
6658 _ => Err(DecodeError::UnknownRequiredFeature),
6663 impl Writeable for HTLCSource {
6664 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
6666 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id, payment_secret, payment_params } => {
6668 let payment_id_opt = Some(payment_id);
6669 write_tlv_fields!(writer, {
6670 (0, session_priv, required),
6671 (1, payment_id_opt, option),
6672 (2, first_hop_htlc_msat, required),
6673 (3, payment_secret, option),
6674 (4, *path, vec_type),
6675 (5, payment_params, option),
6678 HTLCSource::PreviousHopData(ref field) => {
6680 field.write(writer)?;
6687 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
6688 (0, forward_info, required),
6689 (1, prev_user_channel_id, (default_value, 0)),
6690 (2, prev_short_channel_id, required),
6691 (4, prev_htlc_id, required),
6692 (6, prev_funding_outpoint, required),
6695 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
6697 (0, htlc_id, required),
6698 (2, err_packet, required),
6703 impl_writeable_tlv_based!(PendingInboundPayment, {
6704 (0, payment_secret, required),
6705 (2, expiry_time, required),
6706 (4, user_payment_id, required),
6707 (6, payment_preimage, required),
6708 (8, min_value_msat, required),
6711 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> Writeable for ChannelManager<M, T, ES, NS, SP, F, R, L>
6713 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6714 T::Target: BroadcasterInterface,
6715 ES::Target: EntropySource,
6716 NS::Target: NodeSigner,
6717 SP::Target: SignerProvider,
6718 F::Target: FeeEstimator,
6722 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6723 let _consistency_lock = self.total_consistency_lock.write().unwrap();
6725 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
6727 self.genesis_hash.write(writer)?;
6729 let best_block = self.best_block.read().unwrap();
6730 best_block.height().write(writer)?;
6731 best_block.block_hash().write(writer)?;
6735 let per_peer_state = self.per_peer_state.read().unwrap();
6736 let mut unfunded_channels = 0;
6737 let mut number_of_channels = 0;
6738 for (_, peer_state_mutex) in per_peer_state.iter() {
6739 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6740 let peer_state = &mut *peer_state_lock;
6741 number_of_channels += peer_state.channel_by_id.len();
6742 for (_, channel) in peer_state.channel_by_id.iter() {
6743 if !channel.is_funding_initiated() {
6744 unfunded_channels += 1;
6749 ((number_of_channels - unfunded_channels) as u64).write(writer)?;
6751 for (_, peer_state_mutex) in per_peer_state.iter() {
6752 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6753 let peer_state = &mut *peer_state_lock;
6754 for (_, channel) in peer_state.channel_by_id.iter() {
6755 if channel.is_funding_initiated() {
6756 channel.write(writer)?;
6763 let forward_htlcs = self.forward_htlcs.lock().unwrap();
6764 (forward_htlcs.len() as u64).write(writer)?;
6765 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
6766 short_channel_id.write(writer)?;
6767 (pending_forwards.len() as u64).write(writer)?;
6768 for forward in pending_forwards {
6769 forward.write(writer)?;
6774 let per_peer_state = self.per_peer_state.write().unwrap();
6776 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
6777 let claimable_payments = self.claimable_payments.lock().unwrap();
6778 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
6780 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
6781 (claimable_payments.claimable_htlcs.len() as u64).write(writer)?;
6782 for (payment_hash, (purpose, previous_hops)) in claimable_payments.claimable_htlcs.iter() {
6783 payment_hash.write(writer)?;
6784 (previous_hops.len() as u64).write(writer)?;
6785 for htlc in previous_hops.iter() {
6786 htlc.write(writer)?;
6788 htlc_purposes.push(purpose);
6791 (per_peer_state.len() as u64).write(writer)?;
6792 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
6793 peer_pubkey.write(writer)?;
6794 let peer_state = peer_state_mutex.lock().unwrap();
6795 peer_state.latest_features.write(writer)?;
6798 let events = self.pending_events.lock().unwrap();
6799 (events.len() as u64).write(writer)?;
6800 for event in events.iter() {
6801 event.write(writer)?;
6804 let background_events = self.pending_background_events.lock().unwrap();
6805 (background_events.len() as u64).write(writer)?;
6806 for event in background_events.iter() {
6808 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
6810 funding_txo.write(writer)?;
6811 monitor_update.write(writer)?;
6816 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
6817 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
6818 // likely to be identical.
6819 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
6820 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
6822 (pending_inbound_payments.len() as u64).write(writer)?;
6823 for (hash, pending_payment) in pending_inbound_payments.iter() {
6824 hash.write(writer)?;
6825 pending_payment.write(writer)?;
6828 // For backwards compat, write the session privs and their total length.
6829 let mut num_pending_outbounds_compat: u64 = 0;
6830 for (_, outbound) in pending_outbound_payments.iter() {
6831 if !outbound.is_fulfilled() && !outbound.abandoned() {
6832 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
6835 num_pending_outbounds_compat.write(writer)?;
6836 for (_, outbound) in pending_outbound_payments.iter() {
6838 PendingOutboundPayment::Legacy { session_privs } |
6839 PendingOutboundPayment::Retryable { session_privs, .. } => {
6840 for session_priv in session_privs.iter() {
6841 session_priv.write(writer)?;
6844 PendingOutboundPayment::Fulfilled { .. } => {},
6845 PendingOutboundPayment::Abandoned { .. } => {},
6849 // Encode without retry info for 0.0.101 compatibility.
6850 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
6851 for (id, outbound) in pending_outbound_payments.iter() {
6853 PendingOutboundPayment::Legacy { session_privs } |
6854 PendingOutboundPayment::Retryable { session_privs, .. } => {
6855 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
6861 let mut pending_intercepted_htlcs = None;
6862 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
6863 if our_pending_intercepts.len() != 0 {
6864 pending_intercepted_htlcs = Some(our_pending_intercepts);
6867 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
6868 if pending_claiming_payments.as_ref().unwrap().is_empty() {
6869 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
6870 // map. Thus, if there are no entries we skip writing a TLV for it.
6871 pending_claiming_payments = None;
6873 debug_assert!(false, "While we have code to serialize pending_claiming_payments, the map should always be empty until a later PR");
6876 write_tlv_fields!(writer, {
6877 (1, pending_outbound_payments_no_retry, required),
6878 (2, pending_intercepted_htlcs, option),
6879 (3, pending_outbound_payments, required),
6880 (4, pending_claiming_payments, option),
6881 (5, self.our_network_pubkey, required),
6882 (7, self.fake_scid_rand_bytes, required),
6883 (9, htlc_purposes, vec_type),
6884 (11, self.probing_cookie_secret, required),
6891 /// Arguments for the creation of a ChannelManager that are not deserialized.
6893 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
6895 /// 1) Deserialize all stored [`ChannelMonitor`]s.
6896 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
6897 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
6898 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
6899 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
6900 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
6901 /// same way you would handle a [`chain::Filter`] call using
6902 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
6903 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
6904 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
6905 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
6906 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
6907 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
6909 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
6910 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
6912 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
6913 /// call any other methods on the newly-deserialized [`ChannelManager`].
6915 /// Note that because some channels may be closed during deserialization, it is critical that you
6916 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
6917 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
6918 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
6919 /// not force-close the same channels but consider them live), you may end up revoking a state for
6920 /// which you've already broadcasted the transaction.
6922 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
6923 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
6925 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6926 T::Target: BroadcasterInterface,
6927 ES::Target: EntropySource,
6928 NS::Target: NodeSigner,
6929 SP::Target: SignerProvider,
6930 F::Target: FeeEstimator,
6934 /// A cryptographically secure source of entropy.
6935 pub entropy_source: ES,
6937 /// A signer that is able to perform node-scoped cryptographic operations.
6938 pub node_signer: NS,
6940 /// The keys provider which will give us relevant keys. Some keys will be loaded during
6941 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
6943 pub signer_provider: SP,
6945 /// The fee_estimator for use in the ChannelManager in the future.
6947 /// No calls to the FeeEstimator will be made during deserialization.
6948 pub fee_estimator: F,
6949 /// The chain::Watch for use in the ChannelManager in the future.
6951 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
6952 /// you have deserialized ChannelMonitors separately and will add them to your
6953 /// chain::Watch after deserializing this ChannelManager.
6954 pub chain_monitor: M,
6956 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
6957 /// used to broadcast the latest local commitment transactions of channels which must be
6958 /// force-closed during deserialization.
6959 pub tx_broadcaster: T,
6960 /// The router which will be used in the ChannelManager in the future for finding routes
6961 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
6963 /// No calls to the router will be made during deserialization.
6965 /// The Logger for use in the ChannelManager and which may be used to log information during
6966 /// deserialization.
6968 /// Default settings used for new channels. Any existing channels will continue to use the
6969 /// runtime settings which were stored when the ChannelManager was serialized.
6970 pub default_config: UserConfig,
6972 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
6973 /// value.get_funding_txo() should be the key).
6975 /// If a monitor is inconsistent with the channel state during deserialization the channel will
6976 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
6977 /// is true for missing channels as well. If there is a monitor missing for which we find
6978 /// channel data Err(DecodeError::InvalidValue) will be returned.
6980 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
6983 /// (C-not exported) because we have no HashMap bindings
6984 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>,
6987 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
6988 ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>
6990 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6991 T::Target: BroadcasterInterface,
6992 ES::Target: EntropySource,
6993 NS::Target: NodeSigner,
6994 SP::Target: SignerProvider,
6995 F::Target: FeeEstimator,
6999 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
7000 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
7001 /// populate a HashMap directly from C.
7002 pub fn new(entropy_source: ES, node_signer: NS, signer_provider: SP, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, default_config: UserConfig,
7003 mut channel_monitors: Vec<&'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>) -> Self {
7005 entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
7006 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
7011 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
7012 // SipmleArcChannelManager type:
7013 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7014 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, ES, NS, SP, F, R, L>>)
7016 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7017 T::Target: BroadcasterInterface,
7018 ES::Target: EntropySource,
7019 NS::Target: NodeSigner,
7020 SP::Target: SignerProvider,
7021 F::Target: FeeEstimator,
7025 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
7026 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)>::read(reader, args)?;
7027 Ok((blockhash, Arc::new(chan_manager)))
7031 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7032 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)
7034 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7035 T::Target: BroadcasterInterface,
7036 ES::Target: EntropySource,
7037 NS::Target: NodeSigner,
7038 SP::Target: SignerProvider,
7039 F::Target: FeeEstimator,
7043 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
7044 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
7046 let genesis_hash: BlockHash = Readable::read(reader)?;
7047 let best_block_height: u32 = Readable::read(reader)?;
7048 let best_block_hash: BlockHash = Readable::read(reader)?;
7050 let mut failed_htlcs = Vec::new();
7052 let channel_count: u64 = Readable::read(reader)?;
7053 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
7054 let mut peer_channels: HashMap<PublicKey, HashMap<[u8; 32], Channel<<SP::Target as SignerProvider>::Signer>>> = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7055 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7056 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7057 let mut channel_closures = Vec::new();
7058 for _ in 0..channel_count {
7059 let mut channel: Channel<<SP::Target as SignerProvider>::Signer> = Channel::read(reader, (
7060 &args.entropy_source, &args.signer_provider, best_block_height, &provided_channel_type_features(&args.default_config)
7062 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
7063 funding_txo_set.insert(funding_txo.clone());
7064 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
7065 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
7066 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
7067 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
7068 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
7069 // If the channel is ahead of the monitor, return InvalidValue:
7070 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
7071 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
7072 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
7073 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
7074 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
7075 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
7076 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");
7077 return Err(DecodeError::InvalidValue);
7078 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
7079 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
7080 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
7081 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
7082 // But if the channel is behind of the monitor, close the channel:
7083 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
7084 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
7085 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
7086 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
7087 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
7088 failed_htlcs.append(&mut new_failed_htlcs);
7089 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
7090 channel_closures.push(events::Event::ChannelClosed {
7091 channel_id: channel.channel_id(),
7092 user_channel_id: channel.get_user_id(),
7093 reason: ClosureReason::OutdatedChannelManager
7095 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
7096 let mut found_htlc = false;
7097 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
7098 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
7101 // If we have some HTLCs in the channel which are not present in the newer
7102 // ChannelMonitor, they have been removed and should be failed back to
7103 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
7104 // were actually claimed we'd have generated and ensured the previous-hop
7105 // claim update ChannelMonitor updates were persisted prior to persising
7106 // the ChannelMonitor update for the forward leg, so attempting to fail the
7107 // backwards leg of the HTLC will simply be rejected.
7108 log_info!(args.logger,
7109 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
7110 log_bytes!(channel.channel_id()), log_bytes!(payment_hash.0));
7111 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.get_counterparty_node_id(), channel.channel_id()));
7115 log_info!(args.logger, "Successfully loaded channel {}", log_bytes!(channel.channel_id()));
7116 if let Some(short_channel_id) = channel.get_short_channel_id() {
7117 short_to_chan_info.insert(short_channel_id, (channel.get_counterparty_node_id(), channel.channel_id()));
7119 if channel.is_funding_initiated() {
7120 id_to_peer.insert(channel.channel_id(), channel.get_counterparty_node_id());
7122 match peer_channels.entry(channel.get_counterparty_node_id()) {
7123 hash_map::Entry::Occupied(mut entry) => {
7124 let by_id_map = entry.get_mut();
7125 by_id_map.insert(channel.channel_id(), channel);
7127 hash_map::Entry::Vacant(entry) => {
7128 let mut by_id_map = HashMap::new();
7129 by_id_map.insert(channel.channel_id(), channel);
7130 entry.insert(by_id_map);
7134 } else if channel.is_awaiting_initial_mon_persist() {
7135 // If we were persisted and shut down while the initial ChannelMonitor persistence
7136 // was in-progress, we never broadcasted the funding transaction and can still
7137 // safely discard the channel.
7138 let _ = channel.force_shutdown(false);
7139 channel_closures.push(events::Event::ChannelClosed {
7140 channel_id: channel.channel_id(),
7141 user_channel_id: channel.get_user_id(),
7142 reason: ClosureReason::DisconnectedPeer,
7145 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.channel_id()));
7146 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
7147 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
7148 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
7149 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");
7150 return Err(DecodeError::InvalidValue);
7154 for (funding_txo, monitor) in args.channel_monitors.iter_mut() {
7155 if !funding_txo_set.contains(funding_txo) {
7156 log_info!(args.logger, "Broadcasting latest holder commitment transaction for closed channel {}", log_bytes!(funding_txo.to_channel_id()));
7157 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
7161 const MAX_ALLOC_SIZE: usize = 1024 * 64;
7162 let forward_htlcs_count: u64 = Readable::read(reader)?;
7163 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
7164 for _ in 0..forward_htlcs_count {
7165 let short_channel_id = Readable::read(reader)?;
7166 let pending_forwards_count: u64 = Readable::read(reader)?;
7167 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
7168 for _ in 0..pending_forwards_count {
7169 pending_forwards.push(Readable::read(reader)?);
7171 forward_htlcs.insert(short_channel_id, pending_forwards);
7174 let claimable_htlcs_count: u64 = Readable::read(reader)?;
7175 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
7176 for _ in 0..claimable_htlcs_count {
7177 let payment_hash = Readable::read(reader)?;
7178 let previous_hops_len: u64 = Readable::read(reader)?;
7179 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
7180 for _ in 0..previous_hops_len {
7181 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
7183 claimable_htlcs_list.push((payment_hash, previous_hops));
7186 let peer_count: u64 = Readable::read(reader)?;
7187 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>)>()));
7188 for _ in 0..peer_count {
7189 let peer_pubkey = Readable::read(reader)?;
7190 let peer_state = PeerState {
7191 channel_by_id: peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new()),
7192 latest_features: Readable::read(reader)?,
7193 pending_msg_events: Vec::new(),
7195 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
7198 let event_count: u64 = Readable::read(reader)?;
7199 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>()));
7200 for _ in 0..event_count {
7201 match MaybeReadable::read(reader)? {
7202 Some(event) => pending_events_read.push(event),
7207 let background_event_count: u64 = Readable::read(reader)?;
7208 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>()));
7209 for _ in 0..background_event_count {
7210 match <u8 as Readable>::read(reader)? {
7211 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
7212 _ => return Err(DecodeError::InvalidValue),
7216 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
7217 let highest_seen_timestamp: u32 = Readable::read(reader)?;
7219 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
7220 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
7221 for _ in 0..pending_inbound_payment_count {
7222 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
7223 return Err(DecodeError::InvalidValue);
7227 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
7228 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
7229 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
7230 for _ in 0..pending_outbound_payments_count_compat {
7231 let session_priv = Readable::read(reader)?;
7232 let payment = PendingOutboundPayment::Legacy {
7233 session_privs: [session_priv].iter().cloned().collect()
7235 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
7236 return Err(DecodeError::InvalidValue)
7240 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
7241 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
7242 let mut pending_outbound_payments = None;
7243 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
7244 let mut received_network_pubkey: Option<PublicKey> = None;
7245 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
7246 let mut probing_cookie_secret: Option<[u8; 32]> = None;
7247 let mut claimable_htlc_purposes = None;
7248 let mut pending_claiming_payments = Some(HashMap::new());
7249 read_tlv_fields!(reader, {
7250 (1, pending_outbound_payments_no_retry, option),
7251 (2, pending_intercepted_htlcs, option),
7252 (3, pending_outbound_payments, option),
7253 (4, pending_claiming_payments, option),
7254 (5, received_network_pubkey, option),
7255 (7, fake_scid_rand_bytes, option),
7256 (9, claimable_htlc_purposes, vec_type),
7257 (11, probing_cookie_secret, option),
7259 if fake_scid_rand_bytes.is_none() {
7260 fake_scid_rand_bytes = Some(args.entropy_source.get_secure_random_bytes());
7263 if probing_cookie_secret.is_none() {
7264 probing_cookie_secret = Some(args.entropy_source.get_secure_random_bytes());
7267 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
7268 pending_outbound_payments = Some(pending_outbound_payments_compat);
7269 } else if pending_outbound_payments.is_none() {
7270 let mut outbounds = HashMap::new();
7271 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
7272 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
7274 pending_outbound_payments = Some(outbounds);
7276 // If we're tracking pending payments, ensure we haven't lost any by looking at the
7277 // ChannelMonitor data for any channels for which we do not have authorative state
7278 // (i.e. those for which we just force-closed above or we otherwise don't have a
7279 // corresponding `Channel` at all).
7280 // This avoids several edge-cases where we would otherwise "forget" about pending
7281 // payments which are still in-flight via their on-chain state.
7282 // We only rebuild the pending payments map if we were most recently serialized by
7284 for (_, monitor) in args.channel_monitors.iter() {
7285 if id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id()).is_none() {
7286 for (htlc_source, htlc) in monitor.get_pending_outbound_htlcs() {
7287 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, payment_secret, .. } = htlc_source {
7288 if path.is_empty() {
7289 log_error!(args.logger, "Got an empty path for a pending payment");
7290 return Err(DecodeError::InvalidValue);
7292 let path_amt = path.last().unwrap().fee_msat;
7293 let mut session_priv_bytes = [0; 32];
7294 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
7295 match pending_outbound_payments.as_mut().unwrap().entry(payment_id) {
7296 hash_map::Entry::Occupied(mut entry) => {
7297 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
7298 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
7299 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), log_bytes!(htlc.payment_hash.0));
7301 hash_map::Entry::Vacant(entry) => {
7302 let path_fee = path.get_path_fees();
7303 entry.insert(PendingOutboundPayment::Retryable {
7304 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
7305 payment_hash: htlc.payment_hash,
7307 pending_amt_msat: path_amt,
7308 pending_fee_msat: Some(path_fee),
7309 total_msat: path_amt,
7310 starting_block_height: best_block_height,
7312 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
7313 path_amt, log_bytes!(htlc.payment_hash.0), log_bytes!(session_priv_bytes));
7318 for (htlc_source, htlc) in monitor.get_all_current_outbound_htlcs() {
7319 if let HTLCSource::PreviousHopData(prev_hop_data) = htlc_source {
7320 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
7321 info.prev_funding_outpoint == prev_hop_data.outpoint &&
7322 info.prev_htlc_id == prev_hop_data.htlc_id
7324 // The ChannelMonitor is now responsible for this HTLC's
7325 // failure/success and will let us know what its outcome is. If we
7326 // still have an entry for this HTLC in `forward_htlcs` or
7327 // `pending_intercepted_htlcs`, we were apparently not persisted after
7328 // the monitor was when forwarding the payment.
7329 forward_htlcs.retain(|_, forwards| {
7330 forwards.retain(|forward| {
7331 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
7332 if pending_forward_matches_htlc(&htlc_info) {
7333 log_info!(args.logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
7334 log_bytes!(htlc.payment_hash.0), log_bytes!(monitor.get_funding_txo().0.to_channel_id()));
7339 !forwards.is_empty()
7341 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
7342 if pending_forward_matches_htlc(&htlc_info) {
7343 log_info!(args.logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
7344 log_bytes!(htlc.payment_hash.0), log_bytes!(monitor.get_funding_txo().0.to_channel_id()));
7345 pending_events_read.retain(|event| {
7346 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
7347 intercepted_id != ev_id
7359 if !forward_htlcs.is_empty() {
7360 // If we have pending HTLCs to forward, assume we either dropped a
7361 // `PendingHTLCsForwardable` or the user received it but never processed it as they
7362 // shut down before the timer hit. Either way, set the time_forwardable to a small
7363 // constant as enough time has likely passed that we should simply handle the forwards
7364 // now, or at least after the user gets a chance to reconnect to our peers.
7365 pending_events_read.push(events::Event::PendingHTLCsForwardable {
7366 time_forwardable: Duration::from_secs(2),
7370 let inbound_pmt_key_material = args.node_signer.get_inbound_payment_key_material();
7371 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
7373 let mut claimable_htlcs = HashMap::with_capacity(claimable_htlcs_list.len());
7374 if let Some(mut purposes) = claimable_htlc_purposes {
7375 if purposes.len() != claimable_htlcs_list.len() {
7376 return Err(DecodeError::InvalidValue);
7378 for (purpose, (payment_hash, previous_hops)) in purposes.drain(..).zip(claimable_htlcs_list.drain(..)) {
7379 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7382 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
7383 // include a `_legacy_hop_data` in the `OnionPayload`.
7384 for (payment_hash, previous_hops) in claimable_htlcs_list.drain(..) {
7385 if previous_hops.is_empty() {
7386 return Err(DecodeError::InvalidValue);
7388 let purpose = match &previous_hops[0].onion_payload {
7389 OnionPayload::Invoice { _legacy_hop_data } => {
7390 if let Some(hop_data) = _legacy_hop_data {
7391 events::PaymentPurpose::InvoicePayment {
7392 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
7393 Some(inbound_payment) => inbound_payment.payment_preimage,
7394 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
7395 Ok((payment_preimage, _)) => payment_preimage,
7397 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));
7398 return Err(DecodeError::InvalidValue);
7402 payment_secret: hop_data.payment_secret,
7404 } else { return Err(DecodeError::InvalidValue); }
7406 OnionPayload::Spontaneous(payment_preimage) =>
7407 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
7409 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7413 let mut secp_ctx = Secp256k1::new();
7414 secp_ctx.seeded_randomize(&args.entropy_source.get_secure_random_bytes());
7416 if !channel_closures.is_empty() {
7417 pending_events_read.append(&mut channel_closures);
7420 let our_network_pubkey = match args.node_signer.get_node_id(Recipient::Node) {
7422 Err(()) => return Err(DecodeError::InvalidValue)
7424 if let Some(network_pubkey) = received_network_pubkey {
7425 if network_pubkey != our_network_pubkey {
7426 log_error!(args.logger, "Key that was generated does not match the existing key.");
7427 return Err(DecodeError::InvalidValue);
7431 let mut outbound_scid_aliases = HashSet::new();
7432 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
7433 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7434 let peer_state = &mut *peer_state_lock;
7435 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
7436 if chan.outbound_scid_alias() == 0 {
7437 let mut outbound_scid_alias;
7439 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
7440 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.entropy_source);
7441 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
7443 chan.set_outbound_scid_alias(outbound_scid_alias);
7444 } else if !outbound_scid_aliases.insert(chan.outbound_scid_alias()) {
7445 // Note that in rare cases its possible to hit this while reading an older
7446 // channel if we just happened to pick a colliding outbound alias above.
7447 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7448 return Err(DecodeError::InvalidValue);
7450 if chan.is_usable() {
7451 if short_to_chan_info.insert(chan.outbound_scid_alias(), (chan.get_counterparty_node_id(), *chan_id)).is_some() {
7452 // Note that in rare cases its possible to hit this while reading an older
7453 // channel if we just happened to pick a colliding outbound alias above.
7454 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7455 return Err(DecodeError::InvalidValue);
7461 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
7463 for (_, monitor) in args.channel_monitors.iter() {
7464 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
7465 if let Some((payment_purpose, claimable_htlcs)) = claimable_htlcs.remove(&payment_hash) {
7466 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", log_bytes!(payment_hash.0));
7467 let mut claimable_amt_msat = 0;
7468 let mut receiver_node_id = Some(our_network_pubkey);
7469 let phantom_shared_secret = claimable_htlcs[0].prev_hop.phantom_shared_secret;
7470 if phantom_shared_secret.is_some() {
7471 let phantom_pubkey = args.node_signer.get_node_id(Recipient::PhantomNode)
7472 .expect("Failed to get node_id for phantom node recipient");
7473 receiver_node_id = Some(phantom_pubkey)
7475 for claimable_htlc in claimable_htlcs {
7476 claimable_amt_msat += claimable_htlc.value;
7478 // Add a holding-cell claim of the payment to the Channel, which should be
7479 // applied ~immediately on peer reconnection. Because it won't generate a
7480 // new commitment transaction we can just provide the payment preimage to
7481 // the corresponding ChannelMonitor and nothing else.
7483 // We do so directly instead of via the normal ChannelMonitor update
7484 // procedure as the ChainMonitor hasn't yet been initialized, implying
7485 // we're not allowed to call it directly yet. Further, we do the update
7486 // without incrementing the ChannelMonitor update ID as there isn't any
7488 // If we were to generate a new ChannelMonitor update ID here and then
7489 // crash before the user finishes block connect we'd end up force-closing
7490 // this channel as well. On the flip side, there's no harm in restarting
7491 // without the new monitor persisted - we'll end up right back here on
7493 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
7494 if let Some(peer_node_id) = id_to_peer.get(&previous_channel_id){
7495 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
7496 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7497 let peer_state = &mut *peer_state_lock;
7498 if let Some(channel) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
7499 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
7502 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
7503 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
7506 pending_events_read.push(events::Event::PaymentClaimed {
7509 purpose: payment_purpose,
7510 amount_msat: claimable_amt_msat,
7516 let channel_manager = ChannelManager {
7518 fee_estimator: bounded_fee_estimator,
7519 chain_monitor: args.chain_monitor,
7520 tx_broadcaster: args.tx_broadcaster,
7521 router: args.router,
7523 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
7525 inbound_payment_key: expanded_inbound_key,
7526 pending_inbound_payments: Mutex::new(pending_inbound_payments),
7527 pending_outbound_payments: OutboundPayments { pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()) },
7528 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
7530 forward_htlcs: Mutex::new(forward_htlcs),
7531 claimable_payments: Mutex::new(ClaimablePayments { claimable_htlcs, pending_claiming_payments: pending_claiming_payments.unwrap() }),
7532 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
7533 id_to_peer: Mutex::new(id_to_peer),
7534 short_to_chan_info: FairRwLock::new(short_to_chan_info),
7535 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
7537 probing_cookie_secret: probing_cookie_secret.unwrap(),
7542 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
7544 per_peer_state: FairRwLock::new(per_peer_state),
7546 pending_events: Mutex::new(pending_events_read),
7547 pending_background_events: Mutex::new(pending_background_events_read),
7548 total_consistency_lock: RwLock::new(()),
7549 persistence_notifier: Notifier::new(),
7551 entropy_source: args.entropy_source,
7552 node_signer: args.node_signer,
7553 signer_provider: args.signer_provider,
7555 logger: args.logger,
7556 default_configuration: args.default_config,
7559 for htlc_source in failed_htlcs.drain(..) {
7560 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
7561 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
7562 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
7563 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
7566 //TODO: Broadcast channel update for closed channels, but only after we've made a
7567 //connection or two.
7569 Ok((best_block_hash.clone(), channel_manager))
7575 use bitcoin::hashes::Hash;
7576 use bitcoin::hashes::sha256::Hash as Sha256;
7577 use bitcoin::hashes::hex::FromHex;
7578 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
7579 use bitcoin::secp256k1::ecdsa::Signature;
7580 use bitcoin::secp256k1::ffi::Signature as FFISignature;
7581 use bitcoin::blockdata::script::Script;
7583 use core::time::Duration;
7584 use core::sync::atomic::Ordering;
7585 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
7586 use crate::ln::channelmanager::{inbound_payment, PaymentId, PaymentSendFailure, InterceptId};
7587 use crate::ln::functional_test_utils::*;
7588 use crate::ln::msgs;
7589 use crate::ln::msgs::{ChannelMessageHandler, OptionalField};
7590 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
7591 use crate::util::errors::APIError;
7592 use crate::util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
7593 use crate::util::test_utils;
7594 use crate::util::config::ChannelConfig;
7595 use crate::chain::keysinterface::EntropySource;
7598 fn test_notify_limits() {
7599 // Check that a few cases which don't require the persistence of a new ChannelManager,
7600 // indeed, do not cause the persistence of a new ChannelManager.
7601 let chanmon_cfgs = create_chanmon_cfgs(3);
7602 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7603 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7604 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7606 // All nodes start with a persistable update pending as `create_network` connects each node
7607 // with all other nodes to make most tests simpler.
7608 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7609 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7610 assert!(nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7612 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1);
7614 // We check that the channel info nodes have doesn't change too early, even though we try
7615 // to connect messages with new values
7616 chan.0.contents.fee_base_msat *= 2;
7617 chan.1.contents.fee_base_msat *= 2;
7618 let node_a_chan_info = nodes[0].node.list_channels()[0].clone();
7619 let node_b_chan_info = nodes[1].node.list_channels()[0].clone();
7621 // The first two nodes (which opened a channel) should now require fresh persistence
7622 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7623 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7624 // ... but the last node should not.
7625 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7626 // After persisting the first two nodes they should no longer need fresh persistence.
7627 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7628 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7630 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
7631 // about the channel.
7632 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
7633 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
7634 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7636 // The nodes which are a party to the channel should also ignore messages from unrelated
7638 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7639 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7640 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7641 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7642 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7643 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7645 // At this point the channel info given by peers should still be the same.
7646 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7647 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7649 // An earlier version of handle_channel_update didn't check the directionality of the
7650 // update message and would always update the local fee info, even if our peer was
7651 // (spuriously) forwarding us our own channel_update.
7652 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
7653 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
7654 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
7656 // First deliver each peers' own message, checking that the node doesn't need to be
7657 // persisted and that its channel info remains the same.
7658 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
7659 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
7660 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7661 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7662 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7663 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7665 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
7666 // the channel info has updated.
7667 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
7668 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
7669 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7670 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7671 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
7672 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
7676 fn test_keysend_dup_hash_partial_mpp() {
7677 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
7679 let chanmon_cfgs = create_chanmon_cfgs(2);
7680 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7681 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7682 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7683 create_announced_chan_between_nodes(&nodes, 0, 1);
7685 // First, send a partial MPP payment.
7686 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
7687 let mut mpp_route = route.clone();
7688 mpp_route.paths.push(mpp_route.paths[0].clone());
7690 let payment_id = PaymentId([42; 32]);
7691 // Use the utility function send_payment_along_path to send the payment with MPP data which
7692 // indicates there are more HTLCs coming.
7693 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.
7694 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash, Some(payment_secret), payment_id, &mpp_route).unwrap();
7695 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();
7696 check_added_monitors!(nodes[0], 1);
7697 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7698 assert_eq!(events.len(), 1);
7699 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
7701 // Next, send a keysend payment with the same payment_hash and make sure it fails.
7702 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7703 check_added_monitors!(nodes[0], 1);
7704 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7705 assert_eq!(events.len(), 1);
7706 let ev = events.drain(..).next().unwrap();
7707 let payment_event = SendEvent::from_event(ev);
7708 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7709 check_added_monitors!(nodes[1], 0);
7710 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7711 expect_pending_htlcs_forwardable!(nodes[1]);
7712 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
7713 check_added_monitors!(nodes[1], 1);
7714 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7715 assert!(updates.update_add_htlcs.is_empty());
7716 assert!(updates.update_fulfill_htlcs.is_empty());
7717 assert_eq!(updates.update_fail_htlcs.len(), 1);
7718 assert!(updates.update_fail_malformed_htlcs.is_empty());
7719 assert!(updates.update_fee.is_none());
7720 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7721 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7722 expect_payment_failed!(nodes[0], our_payment_hash, true);
7724 // Send the second half of the original MPP payment.
7725 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();
7726 check_added_monitors!(nodes[0], 1);
7727 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7728 assert_eq!(events.len(), 1);
7729 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
7731 // Claim the full MPP payment. Note that we can't use a test utility like
7732 // claim_funds_along_route because the ordering of the messages causes the second half of the
7733 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
7734 // lightning messages manually.
7735 nodes[1].node.claim_funds(payment_preimage);
7736 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
7737 check_added_monitors!(nodes[1], 2);
7739 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7740 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
7741 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
7742 check_added_monitors!(nodes[0], 1);
7743 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7744 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
7745 check_added_monitors!(nodes[1], 1);
7746 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7747 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
7748 check_added_monitors!(nodes[1], 1);
7749 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7750 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
7751 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
7752 check_added_monitors!(nodes[0], 1);
7753 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7754 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
7755 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7756 check_added_monitors!(nodes[0], 1);
7757 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
7758 check_added_monitors!(nodes[1], 1);
7759 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
7760 check_added_monitors!(nodes[1], 1);
7761 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7762 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
7763 check_added_monitors!(nodes[0], 1);
7765 // Note that successful MPP payments will generate a single PaymentSent event upon the first
7766 // path's success and a PaymentPathSuccessful event for each path's success.
7767 let events = nodes[0].node.get_and_clear_pending_events();
7768 assert_eq!(events.len(), 3);
7770 Event::PaymentSent { payment_id: ref id, payment_preimage: ref preimage, payment_hash: ref hash, .. } => {
7771 assert_eq!(Some(payment_id), *id);
7772 assert_eq!(payment_preimage, *preimage);
7773 assert_eq!(our_payment_hash, *hash);
7775 _ => panic!("Unexpected event"),
7778 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7779 assert_eq!(payment_id, *actual_payment_id);
7780 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7781 assert_eq!(route.paths[0], *path);
7783 _ => panic!("Unexpected event"),
7786 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7787 assert_eq!(payment_id, *actual_payment_id);
7788 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7789 assert_eq!(route.paths[0], *path);
7791 _ => panic!("Unexpected event"),
7796 fn test_keysend_dup_payment_hash() {
7797 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
7798 // outbound regular payment fails as expected.
7799 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
7800 // fails as expected.
7801 let chanmon_cfgs = create_chanmon_cfgs(2);
7802 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7803 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7804 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7805 create_announced_chan_between_nodes(&nodes, 0, 1);
7806 let scorer = test_utils::TestScorer::with_penalty(0);
7807 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7809 // To start (1), send a regular payment but don't claim it.
7810 let expected_route = [&nodes[1]];
7811 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
7813 // Next, attempt a keysend payment and make sure it fails.
7814 let route_params = RouteParameters {
7815 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id()),
7816 final_value_msat: 100_000,
7817 final_cltv_expiry_delta: TEST_FINAL_CLTV,
7819 let route = find_route(
7820 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
7821 None, nodes[0].logger, &scorer, &random_seed_bytes
7823 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7824 check_added_monitors!(nodes[0], 1);
7825 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7826 assert_eq!(events.len(), 1);
7827 let ev = events.drain(..).next().unwrap();
7828 let payment_event = SendEvent::from_event(ev);
7829 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7830 check_added_monitors!(nodes[1], 0);
7831 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7832 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
7833 // fails), the second will process the resulting failure and fail the HTLC backward
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, claim the original payment.
7848 claim_payment(&nodes[0], &expected_route, payment_preimage);
7850 // To start (2), send a keysend payment but don't claim it.
7851 let payment_preimage = PaymentPreimage([42; 32]);
7852 let route = find_route(
7853 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
7854 None, nodes[0].logger, &scorer, &random_seed_bytes
7856 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7857 check_added_monitors!(nodes[0], 1);
7858 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7859 assert_eq!(events.len(), 1);
7860 let event = events.pop().unwrap();
7861 let path = vec![&nodes[1]];
7862 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
7864 // Next, attempt a regular payment and make sure it fails.
7865 let payment_secret = PaymentSecret([43; 32]);
7866 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
7867 check_added_monitors!(nodes[0], 1);
7868 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7869 assert_eq!(events.len(), 1);
7870 let ev = events.drain(..).next().unwrap();
7871 let payment_event = SendEvent::from_event(ev);
7872 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7873 check_added_monitors!(nodes[1], 0);
7874 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7875 expect_pending_htlcs_forwardable!(nodes[1]);
7876 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
7877 check_added_monitors!(nodes[1], 1);
7878 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7879 assert!(updates.update_add_htlcs.is_empty());
7880 assert!(updates.update_fulfill_htlcs.is_empty());
7881 assert_eq!(updates.update_fail_htlcs.len(), 1);
7882 assert!(updates.update_fail_malformed_htlcs.is_empty());
7883 assert!(updates.update_fee.is_none());
7884 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7885 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7886 expect_payment_failed!(nodes[0], payment_hash, true);
7888 // Finally, succeed the keysend payment.
7889 claim_payment(&nodes[0], &expected_route, payment_preimage);
7893 fn test_keysend_hash_mismatch() {
7894 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
7895 // preimage doesn't match the msg's payment hash.
7896 let chanmon_cfgs = create_chanmon_cfgs(2);
7897 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7898 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7899 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7901 let payer_pubkey = nodes[0].node.get_our_node_id();
7902 let payee_pubkey = nodes[1].node.get_our_node_id();
7903 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }).unwrap();
7904 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }).unwrap();
7906 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
7907 let route_params = RouteParameters {
7908 payment_params: PaymentParameters::for_keysend(payee_pubkey),
7909 final_value_msat: 10_000,
7910 final_cltv_expiry_delta: 40,
7912 let network_graph = nodes[0].network_graph.clone();
7913 let first_hops = nodes[0].node.list_usable_channels();
7914 let scorer = test_utils::TestScorer::with_penalty(0);
7915 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7916 let route = find_route(
7917 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
7918 nodes[0].logger, &scorer, &random_seed_bytes
7921 let test_preimage = PaymentPreimage([42; 32]);
7922 let mismatch_payment_hash = PaymentHash([43; 32]);
7923 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash, None, PaymentId(mismatch_payment_hash.0), &route).unwrap();
7924 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash, &None, Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
7925 check_added_monitors!(nodes[0], 1);
7927 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7928 assert_eq!(updates.update_add_htlcs.len(), 1);
7929 assert!(updates.update_fulfill_htlcs.is_empty());
7930 assert!(updates.update_fail_htlcs.is_empty());
7931 assert!(updates.update_fail_malformed_htlcs.is_empty());
7932 assert!(updates.update_fee.is_none());
7933 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7935 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Payment preimage didn't match payment hash".to_string(), 1);
7939 fn test_keysend_msg_with_secret_err() {
7940 // Test that we error as expected if we receive a keysend payment that includes a payment secret.
7941 let chanmon_cfgs = create_chanmon_cfgs(2);
7942 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7943 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7944 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7946 let payer_pubkey = nodes[0].node.get_our_node_id();
7947 let payee_pubkey = nodes[1].node.get_our_node_id();
7948 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: nodes[1].node.init_features(), remote_network_address: None }).unwrap();
7949 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: nodes[0].node.init_features(), remote_network_address: None }).unwrap();
7951 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
7952 let route_params = RouteParameters {
7953 payment_params: PaymentParameters::for_keysend(payee_pubkey),
7954 final_value_msat: 10_000,
7955 final_cltv_expiry_delta: 40,
7957 let network_graph = nodes[0].network_graph.clone();
7958 let first_hops = nodes[0].node.list_usable_channels();
7959 let scorer = test_utils::TestScorer::with_penalty(0);
7960 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7961 let route = find_route(
7962 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
7963 nodes[0].logger, &scorer, &random_seed_bytes
7966 let test_preimage = PaymentPreimage([42; 32]);
7967 let test_secret = PaymentSecret([43; 32]);
7968 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
7969 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash, Some(test_secret), PaymentId(payment_hash.0), &route).unwrap();
7970 nodes[0].node.test_send_payment_internal(&route, payment_hash, &Some(test_secret), Some(test_preimage), PaymentId(payment_hash.0), None, session_privs).unwrap();
7971 check_added_monitors!(nodes[0], 1);
7973 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7974 assert_eq!(updates.update_add_htlcs.len(), 1);
7975 assert!(updates.update_fulfill_htlcs.is_empty());
7976 assert!(updates.update_fail_htlcs.is_empty());
7977 assert!(updates.update_fail_malformed_htlcs.is_empty());
7978 assert!(updates.update_fee.is_none());
7979 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7981 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "We don't support MPP keysend payments".to_string(), 1);
7985 fn test_multi_hop_missing_secret() {
7986 let chanmon_cfgs = create_chanmon_cfgs(4);
7987 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7988 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7989 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7991 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
7992 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
7993 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
7994 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
7996 // Marshall an MPP route.
7997 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
7998 let path = route.paths[0].clone();
7999 route.paths.push(path);
8000 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8001 route.paths[0][0].short_channel_id = chan_1_id;
8002 route.paths[0][1].short_channel_id = chan_3_id;
8003 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8004 route.paths[1][0].short_channel_id = chan_2_id;
8005 route.paths[1][1].short_channel_id = chan_4_id;
8007 match nodes[0].node.send_payment(&route, payment_hash, &None, PaymentId(payment_hash.0)).unwrap_err() {
8008 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
8009 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err)) },
8010 _ => panic!("unexpected error")
8015 fn bad_inbound_payment_hash() {
8016 // Add coverage for checking that a user-provided payment hash matches the payment secret.
8017 let chanmon_cfgs = create_chanmon_cfgs(2);
8018 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8019 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8020 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8022 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
8023 let payment_data = msgs::FinalOnionHopData {
8025 total_msat: 100_000,
8028 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
8029 // payment verification fails as expected.
8030 let mut bad_payment_hash = payment_hash.clone();
8031 bad_payment_hash.0[0] += 1;
8032 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) {
8033 Ok(_) => panic!("Unexpected ok"),
8035 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment".to_string(), "Failing HTLC with user-generated payment_hash".to_string(), 1);
8039 // Check that using the original payment hash succeeds.
8040 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());
8044 fn test_id_to_peer_coverage() {
8045 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
8046 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
8047 // the channel is successfully closed.
8048 let chanmon_cfgs = create_chanmon_cfgs(2);
8049 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8050 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8051 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8053 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
8054 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8055 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
8056 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8057 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
8059 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
8060 let channel_id = &tx.txid().into_inner();
8062 // Ensure that the `id_to_peer` map is empty until either party has received the
8063 // funding transaction, and have the real `channel_id`.
8064 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
8065 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8068 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
8070 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
8071 // as it has the funding 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 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8079 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8081 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8083 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8084 assert_eq!(nodes_0_lock.len(), 1);
8085 assert!(nodes_0_lock.contains_key(channel_id));
8087 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
8088 // as it has the funding transaction.
8089 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8090 assert_eq!(nodes_1_lock.len(), 1);
8091 assert!(nodes_1_lock.contains_key(channel_id));
8093 check_added_monitors!(nodes[1], 1);
8094 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8095 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
8096 check_added_monitors!(nodes[0], 1);
8097 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8098 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
8099 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
8101 nodes[0].node.close_channel(channel_id, &nodes[1].node.get_our_node_id()).unwrap();
8102 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id()));
8103 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
8104 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &nodes_1_shutdown);
8106 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
8107 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
8109 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
8110 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
8111 // fee for the closing transaction has been negotiated and the parties has the other
8112 // party's signature for the fee negotiated closing transaction.)
8113 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8114 assert_eq!(nodes_0_lock.len(), 1);
8115 assert!(nodes_0_lock.contains_key(channel_id));
8117 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
8118 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
8119 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
8120 // kept in the `nodes[1]`'s `id_to_peer` map.
8121 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8122 assert_eq!(nodes_1_lock.len(), 1);
8123 assert!(nodes_1_lock.contains_key(channel_id));
8126 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()));
8128 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
8129 // therefore has all it needs to fully close the channel (both signatures for the
8130 // closing transaction).
8131 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
8132 // fully closed by `nodes[0]`.
8133 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
8135 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
8136 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
8137 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8138 assert_eq!(nodes_1_lock.len(), 1);
8139 assert!(nodes_1_lock.contains_key(channel_id));
8142 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
8144 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
8146 // Assert that the channel has now been removed from both parties `id_to_peer` map once
8147 // they both have everything required to fully close the channel.
8148 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8150 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
8152 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
8153 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
8156 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
8157 let expected_message = format!("Not connected to node: {}", expected_public_key);
8158 check_api_misuse_error_message(expected_message, res_err)
8161 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
8162 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
8163 check_api_misuse_error_message(expected_message, res_err)
8166 fn check_api_misuse_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
8168 Err(APIError::APIMisuseError { err }) => {
8169 assert_eq!(err, expected_err_message);
8171 Ok(_) => panic!("Unexpected Ok"),
8172 Err(_) => panic!("Unexpected Error"),
8177 fn test_api_calls_with_unkown_counterparty_node() {
8178 // Tests that our API functions and message handlers that expects a `counterparty_node_id`
8179 // as input, behaves as expected if the `counterparty_node_id` is an unkown peer in the
8180 // `ChannelManager::per_peer_state` map.
8181 let chanmon_cfg = create_chanmon_cfgs(2);
8182 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
8183 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
8184 let nodes = create_network(2, &node_cfg, &node_chanmgr);
8186 // Boilerplate code to produce `open_channel` and `accept_channel` msgs more densly than
8187 // creating dummy ones.
8188 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
8189 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8190 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
8191 let accept_channel_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8194 let channel_id = [4; 32];
8195 let signature = Signature::from(unsafe { FFISignature::new() });
8196 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
8197 let intercept_id = InterceptId([0; 32]);
8200 let funding_created_msg = msgs::FundingCreated {
8201 temporary_channel_id: open_channel_msg.temporary_channel_id,
8202 funding_txid: Txid::from_hex("ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap(),
8203 funding_output_index: 0,
8204 signature: signature,
8207 let funding_signed_msg = msgs::FundingSigned {
8208 channel_id: channel_id,
8209 signature: signature,
8212 let channel_ready_msg = msgs::ChannelReady {
8213 channel_id: channel_id,
8214 next_per_commitment_point: unkown_public_key,
8215 short_channel_id_alias: None,
8218 let announcement_signatures_msg = msgs::AnnouncementSignatures {
8219 channel_id: channel_id,
8220 short_channel_id: 0,
8221 node_signature: signature,
8222 bitcoin_signature: signature,
8225 let channel_reestablish_msg = msgs::ChannelReestablish {
8226 channel_id: channel_id,
8227 next_local_commitment_number: 0,
8228 next_remote_commitment_number: 0,
8229 data_loss_protect: OptionalField::Absent,
8232 let closing_signed_msg = msgs::ClosingSigned {
8233 channel_id: channel_id,
8235 signature: signature,
8239 let shutdown_msg = msgs::Shutdown {
8240 channel_id: channel_id,
8241 scriptpubkey: Script::new(),
8244 let onion_routing_packet = msgs::OnionPacket {
8246 public_key: Ok(unkown_public_key),
8247 hop_data: [1; 20*65],
8251 let update_add_htlc_msg = msgs::UpdateAddHTLC {
8252 channel_id: channel_id,
8254 amount_msat: 1000000,
8255 payment_hash: PaymentHash([1; 32]),
8256 cltv_expiry: 821716,
8257 onion_routing_packet
8260 let commitment_signed_msg = msgs::CommitmentSigned {
8261 channel_id: channel_id,
8262 signature: signature,
8263 htlc_signatures: Vec::new(),
8266 let update_fee_msg = msgs::UpdateFee {
8267 channel_id: channel_id,
8268 feerate_per_kw: 1000,
8271 let malformed_update_msg = msgs::UpdateFailMalformedHTLC{
8272 channel_id: channel_id,
8274 sha256_of_onion: [1; 32],
8275 failure_code: 0x8000,
8278 let fulfill_update_msg = msgs::UpdateFulfillHTLC{
8279 channel_id: channel_id,
8281 payment_preimage: PaymentPreimage([1; 32]),
8284 let fail_update_msg = msgs::UpdateFailHTLC{
8285 channel_id: channel_id,
8287 reason: msgs::OnionErrorPacket { data: Vec::new()},
8290 let revoke_and_ack_msg = msgs::RevokeAndACK {
8291 channel_id: channel_id,
8292 per_commitment_secret: [1; 32],
8293 next_per_commitment_point: unkown_public_key,
8296 // Test the API functions and message handlers.
8297 check_not_connected_to_peer_error(nodes[0].node.create_channel(unkown_public_key, 1_000_000, 500_000_000, 42, None), unkown_public_key);
8299 nodes[1].node.handle_open_channel(&unkown_public_key, &open_channel_msg);
8301 nodes[0].node.handle_accept_channel(&unkown_public_key, &accept_channel_msg);
8303 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&open_channel_msg.temporary_channel_id, &unkown_public_key, 42), unkown_public_key);
8305 nodes[1].node.handle_funding_created(&unkown_public_key, &funding_created_msg);
8307 nodes[0].node.handle_funding_signed(&unkown_public_key, &funding_signed_msg);
8309 nodes[0].node.handle_channel_ready(&unkown_public_key, &channel_ready_msg);
8311 nodes[1].node.handle_announcement_signatures(&unkown_public_key, &announcement_signatures_msg);
8313 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
8315 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
8317 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
8319 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
8321 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
8323 nodes[0].node.handle_shutdown(&unkown_public_key, &shutdown_msg);
8325 nodes[1].node.handle_closing_signed(&unkown_public_key, &closing_signed_msg);
8327 nodes[0].node.handle_channel_reestablish(&unkown_public_key, &channel_reestablish_msg);
8329 nodes[1].node.handle_update_add_htlc(&unkown_public_key, &update_add_htlc_msg);
8331 nodes[1].node.handle_commitment_signed(&unkown_public_key, &commitment_signed_msg);
8333 nodes[1].node.handle_update_fail_malformed_htlc(&unkown_public_key, &malformed_update_msg);
8335 nodes[1].node.handle_update_fail_htlc(&unkown_public_key, &fail_update_msg);
8337 nodes[1].node.handle_update_fulfill_htlc(&unkown_public_key, &fulfill_update_msg);
8339 nodes[1].node.handle_revoke_and_ack(&unkown_public_key, &revoke_and_ack_msg);
8341 nodes[1].node.handle_update_fee(&unkown_public_key, &update_fee_msg);
8346 fn test_anchors_zero_fee_htlc_tx_fallback() {
8347 // Tests that if both nodes support anchors, but the remote node does not want to accept
8348 // anchor channels at the moment, an error it sent to the local node such that it can retry
8349 // the channel without the anchors feature.
8350 let chanmon_cfgs = create_chanmon_cfgs(2);
8351 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8352 let mut anchors_config = test_default_channel_config();
8353 anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
8354 anchors_config.manually_accept_inbound_channels = true;
8355 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config.clone()), Some(anchors_config.clone())]);
8356 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8358 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 0, None).unwrap();
8359 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8360 assert!(open_channel_msg.channel_type.as_ref().unwrap().supports_anchors_zero_fee_htlc_tx());
8362 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
8363 let events = nodes[1].node.get_and_clear_pending_events();
8365 Event::OpenChannelRequest { temporary_channel_id, .. } => {
8366 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
8368 _ => panic!("Unexpected event"),
8371 let error_msg = get_err_msg!(nodes[1], nodes[0].node.get_our_node_id());
8372 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &error_msg);
8374 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8375 assert!(!open_channel_msg.channel_type.unwrap().supports_anchors_zero_fee_htlc_tx());
8377 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
8381 #[cfg(all(any(test, feature = "_test_utils"), feature = "_bench_unstable"))]
8383 use crate::chain::Listen;
8384 use crate::chain::chainmonitor::{ChainMonitor, Persist};
8385 use crate::chain::keysinterface::{EntropySource, KeysManager, InMemorySigner};
8386 use crate::ln::channelmanager::{self, BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId};
8387 use crate::ln::functional_test_utils::*;
8388 use crate::ln::msgs::{ChannelMessageHandler, Init};
8389 use crate::routing::gossip::NetworkGraph;
8390 use crate::routing::router::{PaymentParameters, get_route};
8391 use crate::util::test_utils;
8392 use crate::util::config::UserConfig;
8393 use crate::util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
8395 use bitcoin::hashes::Hash;
8396 use bitcoin::hashes::sha256::Hash as Sha256;
8397 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
8399 use crate::sync::{Arc, Mutex};
8403 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
8404 node: &'a ChannelManager<
8405 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
8406 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
8407 &'a test_utils::TestLogger, &'a P>,
8408 &'a test_utils::TestBroadcaster, &'a KeysManager, &'a KeysManager, &'a KeysManager,
8409 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
8410 &'a test_utils::TestLogger>,
8415 fn bench_sends(bench: &mut Bencher) {
8416 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
8419 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
8420 // Do a simple benchmark of sending a payment back and forth between two nodes.
8421 // Note that this is unrealistic as each payment send will require at least two fsync
8423 let network = bitcoin::Network::Testnet;
8424 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
8426 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
8427 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
8428 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
8429 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(genesis_hash, &logger_a)));
8431 let mut config: UserConfig = Default::default();
8432 config.channel_handshake_config.minimum_depth = 1;
8434 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
8435 let seed_a = [1u8; 32];
8436 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
8437 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &router, &logger_a, &keys_manager_a, &keys_manager_a, &keys_manager_a, config.clone(), ChainParameters {
8439 best_block: BestBlock::from_genesis(network),
8441 let node_a_holder = NodeHolder { node: &node_a };
8443 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
8444 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
8445 let seed_b = [2u8; 32];
8446 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
8447 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &router, &logger_b, &keys_manager_b, &keys_manager_b, &keys_manager_b, config.clone(), ChainParameters {
8449 best_block: BestBlock::from_genesis(network),
8451 let node_b_holder = NodeHolder { node: &node_b };
8453 node_a.peer_connected(&node_b.get_our_node_id(), &Init { features: node_b.init_features(), remote_network_address: None }).unwrap();
8454 node_b.peer_connected(&node_a.get_our_node_id(), &Init { features: node_a.init_features(), remote_network_address: None }).unwrap();
8455 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
8456 node_b.handle_open_channel(&node_a.get_our_node_id(), &get_event_msg!(node_a_holder, MessageSendEvent::SendOpenChannel, node_b.get_our_node_id()));
8457 node_a.handle_accept_channel(&node_b.get_our_node_id(), &get_event_msg!(node_b_holder, MessageSendEvent::SendAcceptChannel, node_a.get_our_node_id()));
8460 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
8461 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
8462 value: 8_000_000, script_pubkey: output_script,
8464 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
8465 } else { panic!(); }
8467 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()));
8468 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()));
8470 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
8473 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
8476 Listen::block_connected(&node_a, &block, 1);
8477 Listen::block_connected(&node_b, &block, 1);
8479 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()));
8480 let msg_events = node_a.get_and_clear_pending_msg_events();
8481 assert_eq!(msg_events.len(), 2);
8482 match msg_events[0] {
8483 MessageSendEvent::SendChannelReady { ref msg, .. } => {
8484 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
8485 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
8489 match msg_events[1] {
8490 MessageSendEvent::SendChannelUpdate { .. } => {},
8494 let events_a = node_a.get_and_clear_pending_events();
8495 assert_eq!(events_a.len(), 1);
8497 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8498 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
8500 _ => panic!("Unexpected event"),
8503 let events_b = node_b.get_and_clear_pending_events();
8504 assert_eq!(events_b.len(), 1);
8506 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8507 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
8509 _ => panic!("Unexpected event"),
8512 let dummy_graph = NetworkGraph::new(genesis_hash, &logger_a);
8514 let mut payment_count: u64 = 0;
8515 macro_rules! send_payment {
8516 ($node_a: expr, $node_b: expr) => {
8517 let usable_channels = $node_a.list_usable_channels();
8518 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id())
8519 .with_features($node_b.invoice_features());
8520 let scorer = test_utils::TestScorer::with_penalty(0);
8521 let seed = [3u8; 32];
8522 let keys_manager = KeysManager::new(&seed, 42, 42);
8523 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8524 let route = get_route(&$node_a.get_our_node_id(), &payment_params, &dummy_graph.read_only(),
8525 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), 10_000, TEST_FINAL_CLTV, &logger_a, &scorer, &random_seed_bytes).unwrap();
8527 let mut payment_preimage = PaymentPreimage([0; 32]);
8528 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
8530 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
8531 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
8533 $node_a.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
8534 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
8535 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
8536 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
8537 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
8538 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
8539 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
8540 $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()));
8542 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
8543 expect_payment_claimable!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
8544 $node_b.claim_funds(payment_preimage);
8545 expect_payment_claimed!(NodeHolder { node: &$node_b }, payment_hash, 10_000);
8547 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
8548 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
8549 assert_eq!(node_id, $node_a.get_our_node_id());
8550 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8551 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
8553 _ => panic!("Failed to generate claim event"),
8556 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
8557 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
8558 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
8559 $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()));
8561 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
8566 send_payment!(node_a, node_b);
8567 send_payment!(node_b, node_a);