1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! The top-level channel management and payment tracking stuff lives here.
12 //! The ChannelManager is the main chunk of logic implementing the lightning protocol and is
13 //! responsible for tracking which channels are open, HTLCs are in flight and reestablishing those
14 //! upon reconnect to the relevant peer(s).
16 //! It does not manage routing logic (see [`find_route`] for that) nor does it manage constructing
17 //! on-chain transactions (it only monitors the chain to watch for any force-closes that might
18 //! imply it needs to fail HTLCs/payments/channels it manages).
20 //! [`find_route`]: crate::routing::router::find_route
22 use bitcoin::blockdata::block::BlockHeader;
23 use bitcoin::blockdata::transaction::Transaction;
24 use bitcoin::blockdata::constants::genesis_block;
25 use bitcoin::network::constants::Network;
27 use bitcoin::hashes::Hash;
28 use bitcoin::hashes::sha256::Hash as Sha256;
29 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
30 use bitcoin::hash_types::{BlockHash, Txid};
32 use bitcoin::secp256k1::{SecretKey,PublicKey};
33 use bitcoin::secp256k1::Secp256k1;
34 use bitcoin::secp256k1::ecdh::SharedSecret;
35 use bitcoin::{LockTime, secp256k1, Sequence};
38 use crate::chain::{Confirm, ChannelMonitorUpdateStatus, Watch, BestBlock};
39 use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator};
40 use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
41 use crate::chain::transaction::{OutPoint, TransactionData};
42 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
43 // construct one themselves.
44 use crate::ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
45 use crate::ln::channel::{Channel, ChannelError, ChannelUpdateStatus, UpdateFulfillCommitFetch};
46 use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
47 #[cfg(any(feature = "_test_utils", test))]
48 use crate::ln::features::InvoiceFeatures;
49 use crate::routing::gossip::NetworkGraph;
50 use crate::routing::router::{DefaultRouter, InFlightHtlcs, PaymentParameters, Route, RouteHop, RoutePath, Router};
51 use crate::routing::scoring::ProbabilisticScorer;
53 use crate::ln::onion_utils;
54 use crate::ln::onion_utils::HTLCFailReason;
55 use crate::ln::msgs::{ChannelMessageHandler, DecodeError, LightningError, MAX_VALUE_MSAT};
57 use crate::ln::outbound_payment;
58 use crate::ln::outbound_payment::{OutboundPayments, PendingOutboundPayment};
59 use crate::ln::wire::Encode;
60 use crate::chain::keysinterface::{EntropySource, KeysInterface, KeysManager, NodeSigner, Recipient, Sign, SignerProvider};
61 use crate::util::config::{UserConfig, ChannelConfig};
62 use crate::util::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
63 use crate::util::events;
64 use crate::util::wakers::{Future, Notifier};
65 use crate::util::scid_utils::fake_scid;
66 use crate::util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
67 use crate::util::logger::{Level, Logger};
68 use crate::util::errors::APIError;
71 use crate::prelude::*;
73 use core::cell::RefCell;
75 use crate::sync::{Arc, Mutex, MutexGuard, RwLock, RwLockReadGuard, FairRwLock};
76 use core::sync::atomic::{AtomicUsize, Ordering};
77 use core::time::Duration;
80 // Re-export this for use in the public API.
81 pub use crate::ln::outbound_payment::PaymentSendFailure;
83 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
85 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
86 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
87 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
89 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
90 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
91 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
92 // before we forward it.
94 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
95 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
96 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
97 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
98 // our payment, which we can use to decode errors or inform the user that the payment was sent.
100 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
101 pub(super) enum PendingHTLCRouting {
103 onion_packet: msgs::OnionPacket,
104 /// The SCID from the onion that we should forward to. This could be a real SCID or a fake one
105 /// generated using `get_fake_scid` from the scid_utils::fake_scid module.
106 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
109 payment_data: msgs::FinalOnionHopData,
110 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
111 phantom_shared_secret: Option<[u8; 32]>,
114 payment_preimage: PaymentPreimage,
115 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
119 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
120 pub(super) struct PendingHTLCInfo {
121 pub(super) routing: PendingHTLCRouting,
122 pub(super) incoming_shared_secret: [u8; 32],
123 payment_hash: PaymentHash,
124 pub(super) incoming_amt_msat: Option<u64>, // Added in 0.0.113
125 pub(super) outgoing_amt_msat: u64,
126 pub(super) outgoing_cltv_value: u32,
129 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
130 pub(super) enum HTLCFailureMsg {
131 Relay(msgs::UpdateFailHTLC),
132 Malformed(msgs::UpdateFailMalformedHTLC),
135 /// Stores whether we can't forward an HTLC or relevant forwarding info
136 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
137 pub(super) enum PendingHTLCStatus {
138 Forward(PendingHTLCInfo),
139 Fail(HTLCFailureMsg),
142 pub(super) struct PendingAddHTLCInfo {
143 pub(super) forward_info: PendingHTLCInfo,
145 // These fields are produced in `forward_htlcs()` and consumed in
146 // `process_pending_htlc_forwards()` for constructing the
147 // `HTLCSource::PreviousHopData` for failed and forwarded
150 // Note that this may be an outbound SCID alias for the associated channel.
151 prev_short_channel_id: u64,
153 prev_funding_outpoint: OutPoint,
154 prev_user_channel_id: u128,
157 pub(super) enum HTLCForwardInfo {
158 AddHTLC(PendingAddHTLCInfo),
161 err_packet: msgs::OnionErrorPacket,
165 /// Tracks the inbound corresponding to an outbound HTLC
166 #[derive(Clone, Hash, PartialEq, Eq)]
167 pub(crate) struct HTLCPreviousHopData {
168 // Note that this may be an outbound SCID alias for the associated channel.
169 short_channel_id: u64,
171 incoming_packet_shared_secret: [u8; 32],
172 phantom_shared_secret: Option<[u8; 32]>,
174 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
175 // channel with a preimage provided by the forward channel.
180 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
182 /// This is only here for backwards-compatibility in serialization, in the future it can be
183 /// removed, breaking clients running 0.0.106 and earlier.
184 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
186 /// Contains the payer-provided preimage.
187 Spontaneous(PaymentPreimage),
190 /// HTLCs that are to us and can be failed/claimed by the user
191 struct ClaimableHTLC {
192 prev_hop: HTLCPreviousHopData,
194 /// The amount (in msats) of this MPP part
196 onion_payload: OnionPayload,
198 /// The sum total of all MPP parts
202 /// A payment identifier used to uniquely identify a payment to LDK.
203 /// (C-not exported) as we just use [u8; 32] directly
204 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
205 pub struct PaymentId(pub [u8; 32]);
207 impl Writeable for PaymentId {
208 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
213 impl Readable for PaymentId {
214 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
215 let buf: [u8; 32] = Readable::read(r)?;
220 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
221 /// (C-not exported) as we just use [u8; 32] directly
222 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
223 pub struct InterceptId(pub [u8; 32]);
225 impl Writeable for InterceptId {
226 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
231 impl Readable for InterceptId {
232 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
233 let buf: [u8; 32] = Readable::read(r)?;
237 /// Tracks the inbound corresponding to an outbound HTLC
238 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
239 #[derive(Clone, PartialEq, Eq)]
240 pub(crate) enum HTLCSource {
241 PreviousHopData(HTLCPreviousHopData),
244 session_priv: SecretKey,
245 /// Technically we can recalculate this from the route, but we cache it here to avoid
246 /// doing a double-pass on route when we get a failure back
247 first_hop_htlc_msat: u64,
248 payment_id: PaymentId,
249 payment_secret: Option<PaymentSecret>,
250 payment_params: Option<PaymentParameters>,
253 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
254 impl core::hash::Hash for HTLCSource {
255 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
257 HTLCSource::PreviousHopData(prev_hop_data) => {
259 prev_hop_data.hash(hasher);
261 HTLCSource::OutboundRoute { path, session_priv, payment_id, payment_secret, first_hop_htlc_msat, payment_params } => {
264 session_priv[..].hash(hasher);
265 payment_id.hash(hasher);
266 payment_secret.hash(hasher);
267 first_hop_htlc_msat.hash(hasher);
268 payment_params.hash(hasher);
273 #[cfg(not(feature = "grind_signatures"))]
276 pub fn dummy() -> Self {
277 HTLCSource::OutboundRoute {
279 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
280 first_hop_htlc_msat: 0,
281 payment_id: PaymentId([2; 32]),
282 payment_secret: None,
283 payment_params: None,
288 struct ReceiveError {
294 type ShutdownResult = (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash, PublicKey, [u8; 32])>);
296 /// Error type returned across the peer_state mutex boundary. When an Err is generated for a
297 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
298 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
299 /// peer_state lock. We then return the set of things that need to be done outside the lock in
300 /// this struct and call handle_error!() on it.
302 struct MsgHandleErrInternal {
303 err: msgs::LightningError,
304 chan_id: Option<([u8; 32], u128)>, // If Some a channel of ours has been closed
305 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
307 impl MsgHandleErrInternal {
309 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
311 err: LightningError {
313 action: msgs::ErrorAction::SendErrorMessage {
314 msg: msgs::ErrorMessage {
321 shutdown_finish: None,
325 fn ignore_no_close(err: String) -> Self {
327 err: LightningError {
329 action: msgs::ErrorAction::IgnoreError,
332 shutdown_finish: None,
336 fn from_no_close(err: msgs::LightningError) -> Self {
337 Self { err, chan_id: None, shutdown_finish: None }
340 fn from_finish_shutdown(err: String, channel_id: [u8; 32], user_channel_id: u128, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
342 err: LightningError {
344 action: msgs::ErrorAction::SendErrorMessage {
345 msg: msgs::ErrorMessage {
351 chan_id: Some((channel_id, user_channel_id)),
352 shutdown_finish: Some((shutdown_res, channel_update)),
356 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
359 ChannelError::Warn(msg) => LightningError {
361 action: msgs::ErrorAction::SendWarningMessage {
362 msg: msgs::WarningMessage {
366 log_level: Level::Warn,
369 ChannelError::Ignore(msg) => LightningError {
371 action: msgs::ErrorAction::IgnoreError,
373 ChannelError::Close(msg) => LightningError {
375 action: msgs::ErrorAction::SendErrorMessage {
376 msg: msgs::ErrorMessage {
384 shutdown_finish: None,
389 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
390 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
391 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
392 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
393 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
395 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
396 /// be sent in the order they appear in the return value, however sometimes the order needs to be
397 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
398 /// they were originally sent). In those cases, this enum is also returned.
399 #[derive(Clone, PartialEq)]
400 pub(super) enum RAACommitmentOrder {
401 /// Send the CommitmentUpdate messages first
403 /// Send the RevokeAndACK message first
407 /// Information about a payment which is currently being claimed.
408 struct ClaimingPayment {
410 payment_purpose: events::PaymentPurpose,
411 receiver_node_id: PublicKey,
413 impl_writeable_tlv_based!(ClaimingPayment, {
414 (0, amount_msat, required),
415 (2, payment_purpose, required),
416 (4, receiver_node_id, required),
419 /// Information about claimable or being-claimed payments
420 struct ClaimablePayments {
421 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
422 /// failed/claimed by the user.
424 /// Note that, no consistency guarantees are made about the channels given here actually
425 /// existing anymore by the time you go to read them!
427 /// When adding to the map, [`Self::pending_claiming_payments`] must also be checked to ensure
428 /// we don't get a duplicate payment.
429 claimable_htlcs: HashMap<PaymentHash, (events::PaymentPurpose, Vec<ClaimableHTLC>)>,
431 /// Map from payment hash to the payment data for HTLCs which we have begun claiming, but which
432 /// are waiting on a [`ChannelMonitorUpdate`] to complete in order to be surfaced to the user
433 /// as an [`events::Event::PaymentClaimed`].
434 pending_claiming_payments: HashMap<PaymentHash, ClaimingPayment>,
437 // Note this is only exposed in cfg(test):
438 pub(super) struct ChannelHolder {
439 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
440 /// for broadcast messages, where ordering isn't as strict).
441 pub(super) pending_msg_events: Vec<MessageSendEvent>,
444 /// Events which we process internally but cannot be procsesed immediately at the generation site
445 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
446 /// quite some time lag.
447 enum BackgroundEvent {
448 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
449 /// commitment transaction.
450 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
453 pub(crate) enum MonitorUpdateCompletionAction {
454 /// Indicates that a payment ultimately destined for us was claimed and we should emit an
455 /// [`events::Event::PaymentClaimed`] to the user if we haven't yet generated such an event for
456 /// this payment. Note that this is only best-effort. On restart it's possible such a duplicate
457 /// event can be generated.
458 PaymentClaimed { payment_hash: PaymentHash },
459 /// Indicates an [`events::Event`] should be surfaced to the user.
460 EmitEvent { event: events::Event },
463 /// State we hold per-peer.
464 pub(super) struct PeerState<Signer: Sign> {
465 /// `temporary_channel_id` or `channel_id` -> `channel`.
467 /// Holds all channels where the peer is the counterparty. Once a channel has been assigned a
468 /// `channel_id`, the `temporary_channel_id` key in the map is updated and is replaced by the
470 pub(super) channel_by_id: HashMap<[u8; 32], Channel<Signer>>,
471 /// The latest `InitFeatures` we heard from the peer.
472 latest_features: InitFeatures,
475 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
476 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
478 /// For users who don't want to bother doing their own payment preimage storage, we also store that
481 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
482 /// and instead encoding it in the payment secret.
483 struct PendingInboundPayment {
484 /// The payment secret that the sender must use for us to accept this payment
485 payment_secret: PaymentSecret,
486 /// Time at which this HTLC expires - blocks with a header time above this value will result in
487 /// this payment being removed.
489 /// Arbitrary identifier the user specifies (or not)
490 user_payment_id: u64,
491 // Other required attributes of the payment, optionally enforced:
492 payment_preimage: Option<PaymentPreimage>,
493 min_value_msat: Option<u64>,
496 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
497 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
498 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
499 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
500 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
501 /// that implements KeysInterface or Router for its keys manager and router, respectively, but this
502 /// type alias chooses the concrete types of KeysManager and DefaultRouter.
504 /// (C-not exported) as Arcs don't make sense in bindings
505 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
511 Arc<NetworkGraph<Arc<L>>>,
513 Arc<Mutex<ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>>
518 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
519 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
520 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
521 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
522 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
523 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
524 /// that implements KeysInterface or Router for its keys manager and router, respectively, but this
525 /// type alias chooses the concrete types of KeysManager and DefaultRouter.
527 /// (C-not exported) as Arcs don't make sense in bindings
528 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> = ChannelManager<&'a M, &'b T, &'c KeysManager, &'d F, &'e DefaultRouter<&'f NetworkGraph<&'g L>, &'g L, &'h Mutex<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>>, &'g L>;
530 /// Manager which keeps track of a number of channels and sends messages to the appropriate
531 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
533 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
534 /// to individual Channels.
536 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
537 /// all peers during write/read (though does not modify this instance, only the instance being
538 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
539 /// called funding_transaction_generated for outbound channels).
541 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
542 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
543 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
544 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
545 /// the serialization process). If the deserialized version is out-of-date compared to the
546 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
547 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
549 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
550 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
551 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
552 /// block_connected() to step towards your best block) upon deserialization before using the
555 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
556 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
557 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
558 /// offline for a full minute. In order to track this, you must call
559 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
561 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
562 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
563 /// essentially you should default to using a SimpleRefChannelManager, and use a
564 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
565 /// you're using lightning-net-tokio.
568 // The tree structure below illustrates the lock order requirements for the different locks of the
569 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
570 // and should then be taken in the order of the lowest to the highest level in the tree.
571 // Note that locks on different branches shall not be taken at the same time, as doing so will
572 // create a new lock order for those specific locks in the order they were taken.
576 // `total_consistency_lock`
578 // |__`forward_htlcs`
580 // | |__`pending_intercepted_htlcs`
582 // |__`pending_inbound_payments`
584 // | |__`claimable_payments`
586 // | |__`pending_outbound_payments` // This field's struct contains a map of pending outbounds
588 // | |__`channel_state`
590 // | |__`per_peer_state`
596 // | |__`short_to_chan_info`
598 // | |__`outbound_scid_aliases`
602 // | |__`pending_events`
604 // | |__`pending_background_events`
606 pub struct ChannelManager<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref>
608 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
609 T::Target: BroadcasterInterface,
610 K::Target: KeysInterface,
611 F::Target: FeeEstimator,
615 default_configuration: UserConfig,
616 genesis_hash: BlockHash,
617 fee_estimator: LowerBoundedFeeEstimator<F>,
623 /// See `ChannelManager` struct-level documentation for lock order requirements.
625 pub(super) best_block: RwLock<BestBlock>,
627 best_block: RwLock<BestBlock>,
628 secp_ctx: Secp256k1<secp256k1::All>,
630 /// See `ChannelManager` struct-level documentation for lock order requirements.
631 #[cfg(any(test, feature = "_test_utils"))]
632 pub(super) channel_state: Mutex<ChannelHolder>,
633 #[cfg(not(any(test, feature = "_test_utils")))]
634 channel_state: Mutex<ChannelHolder>,
636 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
637 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
638 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
639 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
641 /// See `ChannelManager` struct-level documentation for lock order requirements.
642 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
644 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
645 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
646 /// (if the channel has been force-closed), however we track them here to prevent duplicative
647 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
648 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
649 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
650 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
651 /// after reloading from disk while replaying blocks against ChannelMonitors.
653 /// See `PendingOutboundPayment` documentation for more info.
655 /// See `ChannelManager` struct-level documentation for lock order requirements.
656 pending_outbound_payments: OutboundPayments,
658 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
660 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
661 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
662 /// and via the classic SCID.
664 /// Note that no consistency guarantees are made about the existence of a channel with the
665 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
667 /// See `ChannelManager` struct-level documentation for lock order requirements.
669 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
671 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
672 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
673 /// until the user tells us what we should do with them.
675 /// See `ChannelManager` struct-level documentation for lock order requirements.
676 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
678 /// The sets of payments which are claimable or currently being claimed. See
679 /// [`ClaimablePayments`]' individual field docs for more info.
681 /// See `ChannelManager` struct-level documentation for lock order requirements.
682 claimable_payments: Mutex<ClaimablePayments>,
684 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
685 /// and some closed channels which reached a usable state prior to being closed. This is used
686 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
687 /// active channel list on load.
689 /// See `ChannelManager` struct-level documentation for lock order requirements.
690 outbound_scid_aliases: Mutex<HashSet<u64>>,
692 /// `channel_id` -> `counterparty_node_id`.
694 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
695 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
696 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
698 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
699 /// the corresponding channel for the event, as we only have access to the `channel_id` during
700 /// the handling of the events.
702 /// Note that no consistency guarantees are made about the existence of a peer with the
703 /// `counterparty_node_id` in our other maps.
706 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
707 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
708 /// would break backwards compatability.
709 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
710 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
711 /// required to access the channel with the `counterparty_node_id`.
713 /// See `ChannelManager` struct-level documentation for lock order requirements.
714 id_to_peer: Mutex<HashMap<[u8; 32], PublicKey>>,
716 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
718 /// Outbound SCID aliases are added here once the channel is available for normal use, with
719 /// SCIDs being added once the funding transaction is confirmed at the channel's required
720 /// confirmation depth.
722 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
723 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
724 /// channel with the `channel_id` in our other maps.
726 /// See `ChannelManager` struct-level documentation for lock order requirements.
728 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
730 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
732 our_network_key: SecretKey,
733 our_network_pubkey: PublicKey,
735 inbound_payment_key: inbound_payment::ExpandedKey,
737 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
738 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
739 /// we encrypt the namespace identifier using these bytes.
741 /// [fake scids]: crate::util::scid_utils::fake_scid
742 fake_scid_rand_bytes: [u8; 32],
744 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
745 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
746 /// keeping additional state.
747 probing_cookie_secret: [u8; 32],
749 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
750 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
751 /// very far in the past, and can only ever be up to two hours in the future.
752 highest_seen_timestamp: AtomicUsize,
754 /// The bulk of our storage will eventually be here (message queues and the like). Currently
755 /// the `per_peer_state` stores our channels on a per-peer basis, as well as the peer's latest
758 /// If we are connected to a peer we always at least have an entry here, even if no channels
759 /// are currently open with that peer.
761 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
762 /// operate on the inner value freely. This opens up for parallel per-peer operation for
765 /// Note that the same thread must never acquire two inner `PeerState` locks at the same time.
767 /// See `ChannelManager` struct-level documentation for lock order requirements.
768 #[cfg(not(any(test, feature = "_test_utils")))]
769 per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<<K::Target as SignerProvider>::Signer>>>>,
770 #[cfg(any(test, feature = "_test_utils"))]
771 pub(super) per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<<K::Target as SignerProvider>::Signer>>>>,
773 /// See `ChannelManager` struct-level documentation for lock order requirements.
774 pending_events: Mutex<Vec<events::Event>>,
775 /// See `ChannelManager` struct-level documentation for lock order requirements.
776 pending_background_events: Mutex<Vec<BackgroundEvent>>,
777 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
778 /// Essentially just when we're serializing ourselves out.
779 /// Taken first everywhere where we are making changes before any other locks.
780 /// When acquiring this lock in read mode, rather than acquiring it directly, call
781 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
782 /// Notifier the lock contains sends out a notification when the lock is released.
783 total_consistency_lock: RwLock<()>,
785 persistence_notifier: Notifier,
792 /// Chain-related parameters used to construct a new `ChannelManager`.
794 /// Typically, the block-specific parameters are derived from the best block hash for the network,
795 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
796 /// are not needed when deserializing a previously constructed `ChannelManager`.
797 #[derive(Clone, Copy, PartialEq)]
798 pub struct ChainParameters {
799 /// The network for determining the `chain_hash` in Lightning messages.
800 pub network: Network,
802 /// The hash and height of the latest block successfully connected.
804 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
805 pub best_block: BestBlock,
808 #[derive(Copy, Clone, PartialEq)]
814 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
815 /// desirable to notify any listeners on `await_persistable_update_timeout`/
816 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
817 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
818 /// sending the aforementioned notification (since the lock being released indicates that the
819 /// updates are ready for persistence).
821 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
822 /// notify or not based on whether relevant changes have been made, providing a closure to
823 /// `optionally_notify` which returns a `NotifyOption`.
824 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
825 persistence_notifier: &'a Notifier,
827 // We hold onto this result so the lock doesn't get released immediately.
828 _read_guard: RwLockReadGuard<'a, ()>,
831 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
832 fn notify_on_drop(lock: &'a RwLock<()>, notifier: &'a Notifier) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
833 PersistenceNotifierGuard::optionally_notify(lock, notifier, || -> NotifyOption { NotifyOption::DoPersist })
836 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a Notifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
837 let read_guard = lock.read().unwrap();
839 PersistenceNotifierGuard {
840 persistence_notifier: notifier,
841 should_persist: persist_check,
842 _read_guard: read_guard,
847 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
849 if (self.should_persist)() == NotifyOption::DoPersist {
850 self.persistence_notifier.notify();
855 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
856 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
858 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
860 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
861 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
862 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
863 /// the maximum required amount in lnd as of March 2021.
864 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
866 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
867 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
869 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
871 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
872 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
873 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
874 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
875 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
876 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
877 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
878 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
879 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
880 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
881 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
882 // routing failure for any HTLC sender picking up an LDK node among the first hops.
883 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
885 /// Minimum CLTV difference between the current block height and received inbound payments.
886 /// Invoices generated for payment to us must set their `min_final_cltv_expiry` field to at least
888 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
889 // any payments to succeed. Further, we don't want payments to fail if a block was found while
890 // a payment was being routed, so we add an extra block to be safe.
891 pub const MIN_FINAL_CLTV_EXPIRY: u32 = HTLC_FAIL_BACK_BUFFER + 3;
893 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
894 // ie that if the next-hop peer fails the HTLC within
895 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
896 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
897 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
898 // LATENCY_GRACE_PERIOD_BLOCKS.
901 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;
903 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
904 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
907 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
909 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
910 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
912 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until we time-out the
913 /// idempotency of payments by [`PaymentId`]. See
914 /// [`OutboundPayments::remove_stale_resolved_payments`].
915 pub(crate) const IDEMPOTENCY_TIMEOUT_TICKS: u8 = 7;
917 /// Information needed for constructing an invoice route hint for this channel.
918 #[derive(Clone, Debug, PartialEq)]
919 pub struct CounterpartyForwardingInfo {
920 /// Base routing fee in millisatoshis.
921 pub fee_base_msat: u32,
922 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
923 pub fee_proportional_millionths: u32,
924 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
925 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
926 /// `cltv_expiry_delta` for more details.
927 pub cltv_expiry_delta: u16,
930 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
931 /// to better separate parameters.
932 #[derive(Clone, Debug, PartialEq)]
933 pub struct ChannelCounterparty {
934 /// The node_id of our counterparty
935 pub node_id: PublicKey,
936 /// The Features the channel counterparty provided upon last connection.
937 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
938 /// many routing-relevant features are present in the init context.
939 pub features: InitFeatures,
940 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
941 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
942 /// claiming at least this value on chain.
944 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
946 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
947 pub unspendable_punishment_reserve: u64,
948 /// Information on the fees and requirements that the counterparty requires when forwarding
949 /// payments to us through this channel.
950 pub forwarding_info: Option<CounterpartyForwardingInfo>,
951 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
952 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
953 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
954 pub outbound_htlc_minimum_msat: Option<u64>,
955 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
956 pub outbound_htlc_maximum_msat: Option<u64>,
959 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
960 #[derive(Clone, Debug, PartialEq)]
961 pub struct ChannelDetails {
962 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
963 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
964 /// Note that this means this value is *not* persistent - it can change once during the
965 /// lifetime of the channel.
966 pub channel_id: [u8; 32],
967 /// Parameters which apply to our counterparty. See individual fields for more information.
968 pub counterparty: ChannelCounterparty,
969 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
970 /// our counterparty already.
972 /// Note that, if this has been set, `channel_id` will be equivalent to
973 /// `funding_txo.unwrap().to_channel_id()`.
974 pub funding_txo: Option<OutPoint>,
975 /// The features which this channel operates with. See individual features for more info.
977 /// `None` until negotiation completes and the channel type is finalized.
978 pub channel_type: Option<ChannelTypeFeatures>,
979 /// The position of the funding transaction in the chain. None if the funding transaction has
980 /// not yet been confirmed and the channel fully opened.
982 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
983 /// payments instead of this. See [`get_inbound_payment_scid`].
985 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
986 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
988 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
989 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
990 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
991 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
992 /// [`confirmations_required`]: Self::confirmations_required
993 pub short_channel_id: Option<u64>,
994 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
995 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
996 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
999 /// This will be `None` as long as the channel is not available for routing outbound payments.
1001 /// [`short_channel_id`]: Self::short_channel_id
1002 /// [`confirmations_required`]: Self::confirmations_required
1003 pub outbound_scid_alias: Option<u64>,
1004 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1005 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1006 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1007 /// when they see a payment to be routed to us.
1009 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1010 /// previous values for inbound payment forwarding.
1012 /// [`short_channel_id`]: Self::short_channel_id
1013 pub inbound_scid_alias: Option<u64>,
1014 /// The value, in satoshis, of this channel as appears in the funding output
1015 pub channel_value_satoshis: u64,
1016 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1017 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1018 /// this value on chain.
1020 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1022 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1024 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1025 pub unspendable_punishment_reserve: Option<u64>,
1026 /// The `user_channel_id` passed in to create_channel, or a random value if the channel was
1027 /// inbound. This may be zero for inbound channels serialized with LDK versions prior to
1029 pub user_channel_id: u128,
1030 /// Our total balance. This is the amount we would get if we close the channel.
1031 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1032 /// amount is not likely to be recoverable on close.
1034 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1035 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1036 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1037 /// This does not consider any on-chain fees.
1039 /// See also [`ChannelDetails::outbound_capacity_msat`]
1040 pub balance_msat: u64,
1041 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1042 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1043 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1044 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1046 /// See also [`ChannelDetails::balance_msat`]
1048 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1049 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1050 /// should be able to spend nearly this amount.
1051 pub outbound_capacity_msat: u64,
1052 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1053 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1054 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1055 /// to use a limit as close as possible to the HTLC limit we can currently send.
1057 /// See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
1058 pub next_outbound_htlc_limit_msat: u64,
1059 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1060 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1061 /// available for inclusion in new inbound HTLCs).
1062 /// Note that there are some corner cases not fully handled here, so the actual available
1063 /// inbound capacity may be slightly higher than this.
1065 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1066 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1067 /// However, our counterparty should be able to spend nearly this amount.
1068 pub inbound_capacity_msat: u64,
1069 /// The number of required confirmations on the funding transaction before the funding will be
1070 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1071 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1072 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1073 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1075 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1077 /// [`is_outbound`]: ChannelDetails::is_outbound
1078 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1079 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1080 pub confirmations_required: Option<u32>,
1081 /// The current number of confirmations on the funding transaction.
1083 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1084 pub confirmations: Option<u32>,
1085 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1086 /// until we can claim our funds after we force-close the channel. During this time our
1087 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1088 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1089 /// time to claim our non-HTLC-encumbered funds.
1091 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1092 pub force_close_spend_delay: Option<u16>,
1093 /// True if the channel was initiated (and thus funded) by us.
1094 pub is_outbound: bool,
1095 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1096 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1097 /// required confirmation count has been reached (and we were connected to the peer at some
1098 /// point after the funding transaction received enough confirmations). The required
1099 /// confirmation count is provided in [`confirmations_required`].
1101 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1102 pub is_channel_ready: bool,
1103 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1104 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1106 /// This is a strict superset of `is_channel_ready`.
1107 pub is_usable: bool,
1108 /// True if this channel is (or will be) publicly-announced.
1109 pub is_public: bool,
1110 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1111 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1112 pub inbound_htlc_minimum_msat: Option<u64>,
1113 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1114 pub inbound_htlc_maximum_msat: Option<u64>,
1115 /// Set of configurable parameters that affect channel operation.
1117 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1118 pub config: Option<ChannelConfig>,
1121 impl ChannelDetails {
1122 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1123 /// This should be used for providing invoice hints or in any other context where our
1124 /// counterparty will forward a payment to us.
1126 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1127 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1128 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1129 self.inbound_scid_alias.or(self.short_channel_id)
1132 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1133 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1134 /// we're sending or forwarding a payment outbound over this channel.
1136 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1137 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1138 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1139 self.short_channel_id.or(self.outbound_scid_alias)
1143 /// Route hints used in constructing invoices for [phantom node payents].
1145 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
1147 pub struct PhantomRouteHints {
1148 /// The list of channels to be included in the invoice route hints.
1149 pub channels: Vec<ChannelDetails>,
1150 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1152 pub phantom_scid: u64,
1153 /// The pubkey of the real backing node that would ultimately receive the payment.
1154 pub real_node_pubkey: PublicKey,
1157 macro_rules! handle_error {
1158 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
1161 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish }) => {
1162 #[cfg(debug_assertions)]
1164 // In testing, ensure there are no deadlocks where the lock is already held upon
1165 // entering the macro.
1166 assert!($self.channel_state.try_lock().is_ok());
1167 assert!($self.pending_events.try_lock().is_ok());
1170 let mut msg_events = Vec::with_capacity(2);
1172 if let Some((shutdown_res, update_option)) = shutdown_finish {
1173 $self.finish_force_close_channel(shutdown_res);
1174 if let Some(update) = update_option {
1175 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1179 if let Some((channel_id, user_channel_id)) = chan_id {
1180 $self.pending_events.lock().unwrap().push(events::Event::ChannelClosed {
1181 channel_id, user_channel_id,
1182 reason: ClosureReason::ProcessingError { err: err.err.clone() }
1187 log_error!($self.logger, "{}", err.err);
1188 if let msgs::ErrorAction::IgnoreError = err.action {
1190 msg_events.push(events::MessageSendEvent::HandleError {
1191 node_id: $counterparty_node_id,
1192 action: err.action.clone()
1196 if !msg_events.is_empty() {
1197 $self.channel_state.lock().unwrap().pending_msg_events.append(&mut msg_events);
1200 // Return error in case higher-API need one
1207 macro_rules! update_maps_on_chan_removal {
1208 ($self: expr, $channel: expr) => {{
1209 $self.id_to_peer.lock().unwrap().remove(&$channel.channel_id());
1210 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1211 if let Some(short_id) = $channel.get_short_channel_id() {
1212 short_to_chan_info.remove(&short_id);
1214 // If the channel was never confirmed on-chain prior to its closure, remove the
1215 // outbound SCID alias we used for it from the collision-prevention set. While we
1216 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1217 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1218 // opening a million channels with us which are closed before we ever reach the funding
1220 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel.outbound_scid_alias());
1221 debug_assert!(alias_removed);
1223 short_to_chan_info.remove(&$channel.outbound_scid_alias());
1227 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1228 macro_rules! convert_chan_err {
1229 ($self: ident, $err: expr, $channel: expr, $channel_id: expr) => {
1231 ChannelError::Warn(msg) => {
1232 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), $channel_id.clone()))
1234 ChannelError::Ignore(msg) => {
1235 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
1237 ChannelError::Close(msg) => {
1238 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
1239 update_maps_on_chan_removal!($self, $channel);
1240 let shutdown_res = $channel.force_shutdown(true);
1241 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
1242 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
1248 macro_rules! break_chan_entry {
1249 ($self: ident, $res: expr, $entry: expr) => {
1253 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1255 $entry.remove_entry();
1263 macro_rules! try_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! remove_channel {
1279 ($self: expr, $entry: expr) => {
1281 let channel = $entry.remove_entry().1;
1282 update_maps_on_chan_removal!($self, channel);
1288 macro_rules! handle_monitor_update_res {
1289 ($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) => {
1291 ChannelMonitorUpdateStatus::PermanentFailure => {
1292 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateStatus::PermanentFailure", log_bytes!($chan_id[..]));
1293 update_maps_on_chan_removal!($self, $chan);
1294 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
1295 // chain in a confused state! We need to move them into the ChannelMonitor which
1296 // will be responsible for failing backwards once things confirm on-chain.
1297 // It's ok that we drop $failed_forwards here - at this point we'd rather they
1298 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
1299 // us bother trying to claim it just to forward on to another peer. If we're
1300 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
1301 // given up the preimage yet, so might as well just wait until the payment is
1302 // retried, avoiding the on-chain fees.
1303 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure".to_owned(), *$chan_id, $chan.get_user_id(),
1304 $chan.force_shutdown(false), $self.get_channel_update_for_broadcast(&$chan).ok() ));
1307 ChannelMonitorUpdateStatus::InProgress => {
1308 log_info!($self.logger, "Disabling channel {} due to monitor update in progress. On restore will send {} and process {} forwards, {} fails, and {} fulfill finalizations",
1309 log_bytes!($chan_id[..]),
1310 if $resend_commitment && $resend_raa {
1311 match $action_type {
1312 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
1313 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
1315 } else if $resend_commitment { "commitment" }
1316 else if $resend_raa { "RAA" }
1318 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
1319 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len(),
1320 (&$failed_finalized_fulfills as &Vec<HTLCSource>).len());
1321 if !$resend_commitment {
1322 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
1325 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
1327 $chan.monitor_updating_paused($resend_raa, $resend_commitment, $resend_channel_ready, $failed_forwards, $failed_fails, $failed_finalized_fulfills);
1328 (Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$chan_id)), false)
1330 ChannelMonitorUpdateStatus::Completed => {
1335 ($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) => { {
1336 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());
1338 $entry.remove_entry();
1342 ($self: ident, $err: expr, $entry: expr, $action_type: path, $chan_id: expr, COMMITMENT_UPDATE_ONLY) => { {
1343 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst);
1344 handle_monitor_update_res!($self, $err, $entry, $action_type, false, true, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1346 ($self: ident, $err: expr, $entry: expr, $action_type: path, $chan_id: expr, NO_UPDATE) => {
1347 handle_monitor_update_res!($self, $err, $entry, $action_type, false, false, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1349 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_channel_ready: expr, OPTIONALLY_RESEND_FUNDING_LOCKED) => {
1350 handle_monitor_update_res!($self, $err, $entry, $action_type, false, false, $resend_channel_ready, Vec::new(), Vec::new(), Vec::new())
1352 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1353 handle_monitor_update_res!($self, $err, $entry, $action_type, $resend_raa, $resend_commitment, false, Vec::new(), Vec::new(), Vec::new())
1355 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
1356 handle_monitor_update_res!($self, $err, $entry, $action_type, $resend_raa, $resend_commitment, false, $failed_forwards, $failed_fails, Vec::new())
1360 macro_rules! send_channel_ready {
1361 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
1362 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1363 node_id: $channel.get_counterparty_node_id(),
1364 msg: $channel_ready_msg,
1366 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1367 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1368 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1369 let outbound_alias_insert = short_to_chan_info.insert($channel.outbound_scid_alias(), ($channel.get_counterparty_node_id(), $channel.channel_id()));
1370 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1371 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1372 if let Some(real_scid) = $channel.get_short_channel_id() {
1373 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.get_counterparty_node_id(), $channel.channel_id()));
1374 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1375 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1380 macro_rules! emit_channel_ready_event {
1381 ($self: expr, $channel: expr) => {
1382 if $channel.should_emit_channel_ready_event() {
1384 let mut pending_events = $self.pending_events.lock().unwrap();
1385 pending_events.push(events::Event::ChannelReady {
1386 channel_id: $channel.channel_id(),
1387 user_channel_id: $channel.get_user_id(),
1388 counterparty_node_id: $channel.get_counterparty_node_id(),
1389 channel_type: $channel.get_channel_type().clone(),
1392 $channel.set_channel_ready_event_emitted();
1397 impl<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref> ChannelManager<M, T, K, F, R, L>
1399 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
1400 T::Target: BroadcasterInterface,
1401 K::Target: KeysInterface,
1402 F::Target: FeeEstimator,
1406 /// Constructs a new ChannelManager to hold several channels and route between them.
1408 /// This is the main "logic hub" for all channel-related actions, and implements
1409 /// ChannelMessageHandler.
1411 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1413 /// Users need to notify the new ChannelManager when a new block is connected or
1414 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
1415 /// from after `params.latest_hash`.
1416 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, keys_manager: K, config: UserConfig, params: ChainParameters) -> Self {
1417 let mut secp_ctx = Secp256k1::new();
1418 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
1419 let inbound_pmt_key_material = keys_manager.get_inbound_payment_key_material();
1420 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
1422 default_configuration: config.clone(),
1423 genesis_hash: genesis_block(params.network).header.block_hash(),
1424 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
1429 best_block: RwLock::new(params.best_block),
1431 channel_state: Mutex::new(ChannelHolder{
1432 pending_msg_events: Vec::new(),
1434 outbound_scid_aliases: Mutex::new(HashSet::new()),
1435 pending_inbound_payments: Mutex::new(HashMap::new()),
1436 pending_outbound_payments: OutboundPayments::new(),
1437 forward_htlcs: Mutex::new(HashMap::new()),
1438 claimable_payments: Mutex::new(ClaimablePayments { claimable_htlcs: HashMap::new(), pending_claiming_payments: HashMap::new() }),
1439 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
1440 id_to_peer: Mutex::new(HashMap::new()),
1441 short_to_chan_info: FairRwLock::new(HashMap::new()),
1443 our_network_key: keys_manager.get_node_secret(Recipient::Node).unwrap(),
1444 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret(Recipient::Node).unwrap()),
1447 inbound_payment_key: expanded_inbound_key,
1448 fake_scid_rand_bytes: keys_manager.get_secure_random_bytes(),
1450 probing_cookie_secret: keys_manager.get_secure_random_bytes(),
1452 highest_seen_timestamp: AtomicUsize::new(0),
1454 per_peer_state: FairRwLock::new(HashMap::new()),
1456 pending_events: Mutex::new(Vec::new()),
1457 pending_background_events: Mutex::new(Vec::new()),
1458 total_consistency_lock: RwLock::new(()),
1459 persistence_notifier: Notifier::new(),
1467 /// Gets the current configuration applied to all new channels.
1468 pub fn get_current_default_configuration(&self) -> &UserConfig {
1469 &self.default_configuration
1472 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
1473 let height = self.best_block.read().unwrap().height();
1474 let mut outbound_scid_alias = 0;
1477 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
1478 outbound_scid_alias += 1;
1480 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
1482 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
1486 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"); }
1491 /// Creates a new outbound channel to the given remote node and with the given value.
1493 /// `user_channel_id` will be provided back as in
1494 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
1495 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
1496 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
1497 /// is simply copied to events and otherwise ignored.
1499 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
1500 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
1502 /// Note that we do not check if you are currently connected to the given peer. If no
1503 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
1504 /// the channel eventually being silently forgotten (dropped on reload).
1506 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
1507 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
1508 /// [`ChannelDetails::channel_id`] until after
1509 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
1510 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
1511 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
1513 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
1514 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
1515 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
1516 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> {
1517 if channel_value_satoshis < 1000 {
1518 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
1521 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1522 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
1523 debug_assert!(&self.total_consistency_lock.try_write().is_err());
1525 let mut channel_state = self.channel_state.lock().unwrap();
1526 let per_peer_state = self.per_peer_state.read().unwrap();
1528 let peer_state_mutex_opt = per_peer_state.get(&their_network_key);
1529 if let None = peer_state_mutex_opt {
1530 return Err(APIError::APIMisuseError { err: format!("Not connected to node: {}", their_network_key) });
1533 let mut peer_state = peer_state_mutex_opt.unwrap().lock().unwrap();
1535 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
1536 let their_features = &peer_state.latest_features;
1537 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
1538 match Channel::new_outbound(&self.fee_estimator, &self.keys_manager, their_network_key,
1539 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
1540 self.best_block.read().unwrap().height(), outbound_scid_alias)
1544 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
1549 let res = channel.get_open_channel(self.genesis_hash.clone());
1551 let temporary_channel_id = channel.channel_id();
1552 match peer_state.channel_by_id.entry(temporary_channel_id) {
1553 hash_map::Entry::Occupied(_) => {
1555 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
1557 panic!("RNG is bad???");
1560 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
1563 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
1564 node_id: their_network_key,
1567 Ok(temporary_channel_id)
1570 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<<K::Target as SignerProvider>::Signer>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
1571 let mut res = Vec::new();
1572 // Allocate our best estimate of the number of channels we have in the `res`
1573 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
1574 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
1575 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
1576 // unlikely as the `short_to_chan_info` map often contains 2 entries for
1577 // the same channel.
1578 res.reserve(self.short_to_chan_info.read().unwrap().len());
1580 let best_block_height = self.best_block.read().unwrap().height();
1581 let per_peer_state = self.per_peer_state.read().unwrap();
1582 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
1583 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
1584 let peer_state = &mut *peer_state_lock;
1585 for (channel_id, channel) in peer_state.channel_by_id.iter().filter(f) {
1586 let balance = channel.get_available_balances();
1587 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1588 channel.get_holder_counterparty_selected_channel_reserve_satoshis();
1589 res.push(ChannelDetails {
1590 channel_id: (*channel_id).clone(),
1591 counterparty: ChannelCounterparty {
1592 node_id: channel.get_counterparty_node_id(),
1593 features: peer_state.latest_features.clone(),
1594 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1595 forwarding_info: channel.counterparty_forwarding_info(),
1596 // Ensures that we have actually received the `htlc_minimum_msat` value
1597 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1598 // message (as they are always the first message from the counterparty).
1599 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1600 // default `0` value set by `Channel::new_outbound`.
1601 outbound_htlc_minimum_msat: if channel.have_received_message() {
1602 Some(channel.get_counterparty_htlc_minimum_msat()) } else { None },
1603 outbound_htlc_maximum_msat: channel.get_counterparty_htlc_maximum_msat(),
1605 funding_txo: channel.get_funding_txo(),
1606 // Note that accept_channel (or open_channel) is always the first message, so
1607 // `have_received_message` indicates that type negotiation has completed.
1608 channel_type: if channel.have_received_message() { Some(channel.get_channel_type().clone()) } else { None },
1609 short_channel_id: channel.get_short_channel_id(),
1610 outbound_scid_alias: if channel.is_usable() { Some(channel.outbound_scid_alias()) } else { None },
1611 inbound_scid_alias: channel.latest_inbound_scid_alias(),
1612 channel_value_satoshis: channel.get_value_satoshis(),
1613 unspendable_punishment_reserve: to_self_reserve_satoshis,
1614 balance_msat: balance.balance_msat,
1615 inbound_capacity_msat: balance.inbound_capacity_msat,
1616 outbound_capacity_msat: balance.outbound_capacity_msat,
1617 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1618 user_channel_id: channel.get_user_id(),
1619 confirmations_required: channel.minimum_depth(),
1620 confirmations: Some(channel.get_funding_tx_confirmations(best_block_height)),
1621 force_close_spend_delay: channel.get_counterparty_selected_contest_delay(),
1622 is_outbound: channel.is_outbound(),
1623 is_channel_ready: channel.is_usable(),
1624 is_usable: channel.is_live(),
1625 is_public: channel.should_announce(),
1626 inbound_htlc_minimum_msat: Some(channel.get_holder_htlc_minimum_msat()),
1627 inbound_htlc_maximum_msat: channel.get_holder_htlc_maximum_msat(),
1628 config: Some(channel.config()),
1636 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
1637 /// more information.
1638 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1639 self.list_channels_with_filter(|_| true)
1642 /// Gets the list of usable channels, in random order. Useful as an argument to [`find_route`]
1643 /// to ensure non-announced channels are used.
1645 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1646 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1649 /// [`find_route`]: crate::routing::router::find_route
1650 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1651 // Note we use is_live here instead of usable which leads to somewhat confused
1652 // internal/external nomenclature, but that's ok cause that's probably what the user
1653 // really wanted anyway.
1654 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1657 /// Helper function that issues the channel close events
1658 fn issue_channel_close_events(&self, channel: &Channel<<K::Target as SignerProvider>::Signer>, closure_reason: ClosureReason) {
1659 let mut pending_events_lock = self.pending_events.lock().unwrap();
1660 match channel.unbroadcasted_funding() {
1661 Some(transaction) => {
1662 pending_events_lock.push(events::Event::DiscardFunding { channel_id: channel.channel_id(), transaction })
1666 pending_events_lock.push(events::Event::ChannelClosed {
1667 channel_id: channel.channel_id(),
1668 user_channel_id: channel.get_user_id(),
1669 reason: closure_reason
1673 fn close_channel_internal(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>) -> Result<(), APIError> {
1674 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1676 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
1677 let result: Result<(), _> = loop {
1678 let mut channel_state_lock = self.channel_state.lock().unwrap();
1679 let channel_state = &mut *channel_state_lock;
1680 let per_peer_state = self.per_peer_state.read().unwrap();
1682 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
1683 if let None = peer_state_mutex_opt {
1684 return Err(APIError::APIMisuseError { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) });
1687 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
1688 let peer_state = &mut *peer_state_lock;
1689 match peer_state.channel_by_id.entry(channel_id.clone()) {
1690 hash_map::Entry::Occupied(mut chan_entry) => {
1691 let (shutdown_msg, monitor_update, htlcs) = chan_entry.get_mut().get_shutdown(&self.keys_manager, &peer_state.latest_features, target_feerate_sats_per_1000_weight)?;
1692 failed_htlcs = htlcs;
1694 // Update the monitor with the shutdown script if necessary.
1695 if let Some(monitor_update) = monitor_update {
1696 let update_res = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update);
1697 let (result, is_permanent) =
1698 handle_monitor_update_res!(self, update_res, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
1700 remove_channel!(self, chan_entry);
1705 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1706 node_id: *counterparty_node_id,
1710 if chan_entry.get().is_shutdown() {
1711 let channel = remove_channel!(self, chan_entry);
1712 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
1713 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1717 self.issue_channel_close_events(&channel, ClosureReason::HolderForceClosed);
1721 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) })
1725 for htlc_source in failed_htlcs.drain(..) {
1726 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
1727 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
1728 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
1731 let _ = handle_error!(self, result, *counterparty_node_id);
1735 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1736 /// will be accepted on the given channel, and after additional timeout/the closing of all
1737 /// pending HTLCs, the channel will be closed on chain.
1739 /// * If we are the channel initiator, we will pay between our [`Background`] and
1740 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1742 /// * If our counterparty is the channel initiator, we will require a channel closing
1743 /// transaction feerate of at least our [`Background`] feerate or the feerate which
1744 /// would appear on a force-closure transaction, whichever is lower. We will allow our
1745 /// counterparty to pay as much fee as they'd like, however.
1747 /// May generate a SendShutdown message event on success, which should be relayed.
1749 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1750 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1751 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1752 pub fn close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
1753 self.close_channel_internal(channel_id, counterparty_node_id, None)
1756 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1757 /// will be accepted on the given channel, and after additional timeout/the closing of all
1758 /// pending HTLCs, the channel will be closed on chain.
1760 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
1761 /// the channel being closed or not:
1762 /// * If we are the channel initiator, we will pay at least this feerate on the closing
1763 /// transaction. The upper-bound is set by
1764 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1765 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
1766 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
1767 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
1768 /// will appear on a force-closure transaction, whichever is lower).
1770 /// May generate a SendShutdown message event on success, which should be relayed.
1772 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1773 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1774 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1775 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> {
1776 self.close_channel_internal(channel_id, counterparty_node_id, Some(target_feerate_sats_per_1000_weight))
1780 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1781 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1782 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
1783 for htlc_source in failed_htlcs.drain(..) {
1784 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
1785 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
1786 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
1787 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
1789 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1790 // There isn't anything we can do if we get an update failure - we're already
1791 // force-closing. The monitor update on the required in-memory copy should broadcast
1792 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1793 // ignore the result here.
1794 let _ = self.chain_monitor.update_channel(funding_txo, monitor_update);
1798 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
1799 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
1800 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
1801 -> Result<PublicKey, APIError> {
1803 let per_peer_state = self.per_peer_state.read().unwrap();
1804 if let None = per_peer_state.get(peer_node_id) {
1805 return Err(APIError::APIMisuseError{ err: format!("Can't find a peer matching the passed counterparty node_id {}", peer_node_id) });
1807 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
1808 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
1809 let peer_state = &mut *peer_state_lock;
1810 if let hash_map::Entry::Occupied(chan) = peer_state.channel_by_id.entry(channel_id.clone()) {
1811 if let Some(peer_msg) = peer_msg {
1812 self.issue_channel_close_events(chan.get(),ClosureReason::CounterpartyForceClosed { peer_msg: peer_msg.to_string() });
1814 self.issue_channel_close_events(chan.get(),ClosureReason::HolderForceClosed);
1816 remove_channel!(self, chan)
1818 return Err(APIError::ChannelUnavailable{ err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*channel_id), peer_node_id) });
1821 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
1822 self.finish_force_close_channel(chan.force_shutdown(broadcast));
1823 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
1824 let mut channel_state = self.channel_state.lock().unwrap();
1825 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1830 Ok(chan.get_counterparty_node_id())
1833 fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
1834 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1835 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
1836 Ok(counterparty_node_id) => {
1837 self.channel_state.lock().unwrap().pending_msg_events.push(
1838 events::MessageSendEvent::HandleError {
1839 node_id: counterparty_node_id,
1840 action: msgs::ErrorAction::SendErrorMessage {
1841 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
1851 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
1852 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
1853 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
1855 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
1856 -> Result<(), APIError> {
1857 self.force_close_sending_error(channel_id, counterparty_node_id, true)
1860 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
1861 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
1862 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
1864 /// You can always get the latest local transaction(s) to broadcast from
1865 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
1866 pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
1867 -> Result<(), APIError> {
1868 self.force_close_sending_error(channel_id, counterparty_node_id, false)
1871 /// Force close all channels, immediately broadcasting the latest local commitment transaction
1872 /// for each to the chain and rejecting new HTLCs on each.
1873 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
1874 for chan in self.list_channels() {
1875 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
1879 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
1880 /// local transaction(s).
1881 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
1882 for chan in self.list_channels() {
1883 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
1887 fn construct_recv_pending_htlc_info(&self, hop_data: msgs::OnionHopData, shared_secret: [u8; 32],
1888 payment_hash: PaymentHash, amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>) -> Result<PendingHTLCInfo, ReceiveError>
1890 // final_incorrect_cltv_expiry
1891 if hop_data.outgoing_cltv_value != cltv_expiry {
1892 return Err(ReceiveError {
1893 msg: "Upstream node set CLTV to the wrong value",
1895 err_data: cltv_expiry.to_be_bytes().to_vec()
1898 // final_expiry_too_soon
1899 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
1900 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
1901 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
1902 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
1903 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
1904 let current_height: u32 = self.best_block.read().unwrap().height();
1905 if (hop_data.outgoing_cltv_value as u64) <= current_height as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
1906 let mut err_data = Vec::with_capacity(12);
1907 err_data.extend_from_slice(&amt_msat.to_be_bytes());
1908 err_data.extend_from_slice(¤t_height.to_be_bytes());
1909 return Err(ReceiveError {
1910 err_code: 0x4000 | 15, err_data,
1911 msg: "The final CLTV expiry is too soon to handle",
1914 if hop_data.amt_to_forward > amt_msat {
1915 return Err(ReceiveError {
1917 err_data: amt_msat.to_be_bytes().to_vec(),
1918 msg: "Upstream node sent less than we were supposed to receive in payment",
1922 let routing = match hop_data.format {
1923 msgs::OnionHopDataFormat::NonFinalNode { .. } => {
1924 return Err(ReceiveError {
1925 err_code: 0x4000|22,
1926 err_data: Vec::new(),
1927 msg: "Got non final data with an HMAC of 0",
1930 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage } => {
1931 if payment_data.is_some() && keysend_preimage.is_some() {
1932 return Err(ReceiveError {
1933 err_code: 0x4000|22,
1934 err_data: Vec::new(),
1935 msg: "We don't support MPP keysend payments",
1937 } else if let Some(data) = payment_data {
1938 PendingHTLCRouting::Receive {
1940 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
1941 phantom_shared_secret,
1943 } else if let Some(payment_preimage) = keysend_preimage {
1944 // We need to check that the sender knows the keysend preimage before processing this
1945 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
1946 // could discover the final destination of X, by probing the adjacent nodes on the route
1947 // with a keysend payment of identical payment hash to X and observing the processing
1948 // time discrepancies due to a hash collision with X.
1949 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
1950 if hashed_preimage != payment_hash {
1951 return Err(ReceiveError {
1952 err_code: 0x4000|22,
1953 err_data: Vec::new(),
1954 msg: "Payment preimage didn't match payment hash",
1958 PendingHTLCRouting::ReceiveKeysend {
1960 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
1963 return Err(ReceiveError {
1964 err_code: 0x4000|0x2000|3,
1965 err_data: Vec::new(),
1966 msg: "We require payment_secrets",
1971 Ok(PendingHTLCInfo {
1974 incoming_shared_secret: shared_secret,
1975 incoming_amt_msat: Some(amt_msat),
1976 outgoing_amt_msat: amt_msat,
1977 outgoing_cltv_value: hop_data.outgoing_cltv_value,
1981 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> PendingHTLCStatus {
1982 macro_rules! return_malformed_err {
1983 ($msg: expr, $err_code: expr) => {
1985 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
1986 return PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
1987 channel_id: msg.channel_id,
1988 htlc_id: msg.htlc_id,
1989 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
1990 failure_code: $err_code,
1996 if let Err(_) = msg.onion_routing_packet.public_key {
1997 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2000 let shared_secret = SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key).secret_bytes();
2002 if msg.onion_routing_packet.version != 0 {
2003 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2004 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2005 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2006 //receiving node would have to brute force to figure out which version was put in the
2007 //packet by the node that send us the message, in the case of hashing the hop_data, the
2008 //node knows the HMAC matched, so they already know what is there...
2009 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2011 macro_rules! return_err {
2012 ($msg: expr, $err_code: expr, $data: expr) => {
2014 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2015 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2016 channel_id: msg.channel_id,
2017 htlc_id: msg.htlc_id,
2018 reason: HTLCFailReason::reason($err_code, $data.to_vec())
2019 .get_encrypted_failure_packet(&shared_secret, &None),
2025 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) {
2027 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2028 return_malformed_err!(err_msg, err_code);
2030 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2031 return_err!(err_msg, err_code, &[0; 0]);
2035 let pending_forward_info = match next_hop {
2036 onion_utils::Hop::Receive(next_hop_data) => {
2038 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash, msg.amount_msat, msg.cltv_expiry, None) {
2040 // Note that we could obviously respond immediately with an update_fulfill_htlc
2041 // message, however that would leak that we are the recipient of this payment, so
2042 // instead we stay symmetric with the forwarding case, only responding (after a
2043 // delay) once they've send us a commitment_signed!
2044 PendingHTLCStatus::Forward(info)
2046 Err(ReceiveError { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
2049 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
2050 let new_pubkey = msg.onion_routing_packet.public_key.unwrap();
2051 let outgoing_packet = msgs::OnionPacket {
2053 public_key: onion_utils::next_hop_packet_pubkey(&self.secp_ctx, new_pubkey, &shared_secret),
2054 hop_data: new_packet_bytes,
2055 hmac: next_hop_hmac.clone(),
2058 let short_channel_id = match next_hop_data.format {
2059 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
2060 msgs::OnionHopDataFormat::FinalNode { .. } => {
2061 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
2065 PendingHTLCStatus::Forward(PendingHTLCInfo {
2066 routing: PendingHTLCRouting::Forward {
2067 onion_packet: outgoing_packet,
2070 payment_hash: msg.payment_hash.clone(),
2071 incoming_shared_secret: shared_secret,
2072 incoming_amt_msat: Some(msg.amount_msat),
2073 outgoing_amt_msat: next_hop_data.amt_to_forward,
2074 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
2079 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref outgoing_amt_msat, ref outgoing_cltv_value, .. }) = &pending_forward_info {
2080 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
2081 // with a short_channel_id of 0. This is important as various things later assume
2082 // short_channel_id is non-0 in any ::Forward.
2083 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
2084 if let Some((err, mut code, chan_update)) = loop {
2085 let id_option = self.short_to_chan_info.read().unwrap().get(&short_channel_id).cloned();
2086 let forwarding_chan_info_opt = match id_option {
2087 None => { // unknown_next_peer
2088 // Note that this is likely a timing oracle for detecting whether an scid is a
2089 // phantom or an intercept.
2090 if (self.default_configuration.accept_intercept_htlcs &&
2091 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, *short_channel_id, &self.genesis_hash)) ||
2092 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, *short_channel_id, &self.genesis_hash)
2096 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2099 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
2101 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
2102 let per_peer_state = self.per_peer_state.read().unwrap();
2103 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
2104 if let None = peer_state_mutex_opt {
2105 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2107 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
2108 let peer_state = &mut *peer_state_lock;
2109 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id) {
2111 // Channel was removed. The short_to_chan_info and channel_by_id maps
2112 // have no consistency guarantees.
2113 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2117 if !chan.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
2118 // Note that the behavior here should be identical to the above block - we
2119 // should NOT reveal the existence or non-existence of a private channel if
2120 // we don't allow forwards outbound over them.
2121 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
2123 if chan.get_channel_type().supports_scid_privacy() && *short_channel_id != chan.outbound_scid_alias() {
2124 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
2125 // "refuse to forward unless the SCID alias was used", so we pretend
2126 // we don't have the channel here.
2127 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
2129 let chan_update_opt = self.get_channel_update_for_onion(*short_channel_id, chan).ok();
2131 // Note that we could technically not return an error yet here and just hope
2132 // that the connection is reestablished or monitor updated by the time we get
2133 // around to doing the actual forward, but better to fail early if we can and
2134 // hopefully an attacker trying to path-trace payments cannot make this occur
2135 // on a small/per-node/per-channel scale.
2136 if !chan.is_live() { // channel_disabled
2137 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, chan_update_opt));
2139 if *outgoing_amt_msat < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
2140 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
2142 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, *outgoing_amt_msat, *outgoing_cltv_value) {
2143 break Some((err, code, chan_update_opt));
2147 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 {
2148 // We really should set `incorrect_cltv_expiry` here but as we're not
2149 // forwarding over a real channel we can't generate a channel_update
2150 // for it. Instead we just return a generic temporary_node_failure.
2152 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
2159 let cur_height = self.best_block.read().unwrap().height() + 1;
2160 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
2161 // but we want to be robust wrt to counterparty packet sanitization (see
2162 // HTLC_FAIL_BACK_BUFFER rationale).
2163 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
2164 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
2166 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
2167 break Some(("CLTV expiry is too far in the future", 21, None));
2169 // If the HTLC expires ~now, don't bother trying to forward it to our
2170 // counterparty. They should fail it anyway, but we don't want to bother with
2171 // the round-trips or risk them deciding they definitely want the HTLC and
2172 // force-closing to ensure they get it if we're offline.
2173 // We previously had a much more aggressive check here which tried to ensure
2174 // our counterparty receives an HTLC which has *our* risk threshold met on it,
2175 // but there is no need to do that, and since we're a bit conservative with our
2176 // risk threshold it just results in failing to forward payments.
2177 if (*outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
2178 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
2184 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
2185 if let Some(chan_update) = chan_update {
2186 if code == 0x1000 | 11 || code == 0x1000 | 12 {
2187 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
2189 else if code == 0x1000 | 13 {
2190 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
2192 else if code == 0x1000 | 20 {
2193 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
2194 0u16.write(&mut res).expect("Writes cannot fail");
2196 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
2197 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
2198 chan_update.write(&mut res).expect("Writes cannot fail");
2199 } else if code & 0x1000 == 0x1000 {
2200 // If we're trying to return an error that requires a `channel_update` but
2201 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
2202 // generate an update), just use the generic "temporary_node_failure"
2206 return_err!(err, code, &res.0[..]);
2211 pending_forward_info
2214 /// Gets the current channel_update for the given channel. This first checks if the channel is
2215 /// public, and thus should be called whenever the result is going to be passed out in a
2216 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
2218 /// May be called with peer_state already locked!
2219 fn get_channel_update_for_broadcast(&self, chan: &Channel<<K::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2220 if !chan.should_announce() {
2221 return Err(LightningError {
2222 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
2223 action: msgs::ErrorAction::IgnoreError
2226 if chan.get_short_channel_id().is_none() {
2227 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
2229 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.channel_id()));
2230 self.get_channel_update_for_unicast(chan)
2233 /// Gets the current channel_update for the given channel. This does not check if the channel
2234 /// is public (only returning an Err if the channel does not yet have an assigned short_id),
2235 /// and thus MUST NOT be called unless the recipient of the resulting message has already
2236 /// provided evidence that they know about the existence of the channel.
2237 /// May be called with peer_state already locked!
2238 fn get_channel_update_for_unicast(&self, chan: &Channel<<K::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2239 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.channel_id()));
2240 let short_channel_id = match chan.get_short_channel_id().or(chan.latest_inbound_scid_alias()) {
2241 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
2245 self.get_channel_update_for_onion(short_channel_id, chan)
2247 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<<K::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2248 log_trace!(self.logger, "Generating channel update for channel {}", log_bytes!(chan.channel_id()));
2249 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
2251 let unsigned = msgs::UnsignedChannelUpdate {
2252 chain_hash: self.genesis_hash,
2254 timestamp: chan.get_update_time_counter(),
2255 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
2256 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
2257 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
2258 htlc_maximum_msat: chan.get_announced_htlc_max_msat(),
2259 fee_base_msat: chan.get_outbound_forwarding_fee_base_msat(),
2260 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
2261 excess_data: Vec::new(),
2264 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
2265 let sig = self.secp_ctx.sign_ecdsa(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
2267 Ok(msgs::ChannelUpdate {
2273 // Only public for testing, this should otherwise never be called direcly
2274 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> {
2275 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
2276 let prng_seed = self.keys_manager.get_secure_random_bytes();
2277 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
2279 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
2280 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected"})?;
2281 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
2282 if onion_utils::route_size_insane(&onion_payloads) {
2283 return Err(APIError::InvalidRoute{err: "Route size too large considering onion data"});
2285 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
2287 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2289 let err: Result<(), _> = loop {
2290 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.first().unwrap().short_channel_id) {
2291 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
2292 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
2295 let mut channel_lock = self.channel_state.lock().unwrap();
2296 let channel_state = &mut *channel_lock;
2297 let per_peer_state = self.per_peer_state.read().unwrap();
2298 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
2299 if let None = peer_state_mutex_opt {
2300 return Err(APIError::InvalidRoute{err: "No peer matching the path's first hop found!" });
2302 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
2303 let peer_state = &mut *peer_state_lock;
2304 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(id) {
2306 if !chan.get().is_live() {
2307 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
2309 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(
2310 htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
2312 session_priv: session_priv.clone(),
2313 first_hop_htlc_msat: htlc_msat,
2315 payment_secret: payment_secret.clone(),
2316 payment_params: payment_params.clone(),
2317 }, onion_packet, &self.logger),
2320 Some((update_add, commitment_signed, monitor_update)) => {
2321 let update_err = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update);
2322 let chan_id = chan.get().channel_id();
2324 handle_monitor_update_res!(self, update_err, chan,
2325 RAACommitmentOrder::CommitmentFirst, false, true))
2327 (ChannelMonitorUpdateStatus::PermanentFailure, Err(e)) => break Err(e),
2328 (ChannelMonitorUpdateStatus::Completed, Ok(())) => {},
2329 (ChannelMonitorUpdateStatus::InProgress, Err(_)) => {
2330 // Note that MonitorUpdateInProgress here indicates (per function
2331 // docs) that we will resend the commitment update once monitor
2332 // updating completes. Therefore, we must return an error
2333 // indicating that it is unsafe to retry the payment wholesale,
2334 // which we do in the send_payment check for
2335 // MonitorUpdateInProgress, below.
2336 return Err(APIError::MonitorUpdateInProgress);
2338 _ => unreachable!(),
2341 log_debug!(self.logger, "Sending payment along path resulted in a commitment_signed for channel {}", log_bytes!(chan_id));
2342 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2343 node_id: path.first().unwrap().pubkey,
2344 updates: msgs::CommitmentUpdate {
2345 update_add_htlcs: vec![update_add],
2346 update_fulfill_htlcs: Vec::new(),
2347 update_fail_htlcs: Vec::new(),
2348 update_fail_malformed_htlcs: Vec::new(),
2357 // The channel was likely removed after we fetched the id from the
2358 // `short_to_chan_info` map, but before we successfully locked the
2359 // `channel_by_id` map.
2360 // This can occur as no consistency guarantees exists between the two maps.
2361 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
2366 match handle_error!(self, err, path.first().unwrap().pubkey) {
2367 Ok(_) => unreachable!(),
2369 Err(APIError::ChannelUnavailable { err: e.err })
2374 /// Sends a payment along a given route.
2376 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
2377 /// fields for more info.
2379 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
2380 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
2381 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
2382 /// [`Event::PaymentSent`]) LDK will not stop you from sending a second payment with the same
2385 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
2386 /// tracking of payments, including state to indicate once a payment has completed. Because you
2387 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
2388 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
2389 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
2391 /// May generate SendHTLCs message(s) event on success, which should be relayed (e.g. via
2392 /// [`PeerManager::process_events`]).
2394 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
2395 /// each entry matching the corresponding-index entry in the route paths, see
2396 /// PaymentSendFailure for more info.
2398 /// In general, a path may raise:
2399 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
2400 /// node public key) is specified.
2401 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
2402 /// (including due to previous monitor update failure or new permanent monitor update
2404 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
2405 /// relevant updates.
2407 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
2408 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
2409 /// different route unless you intend to pay twice!
2411 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
2412 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
2413 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
2414 /// must not contain multiple paths as multi-path payments require a recipient-provided
2417 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
2418 /// bit set (either as required or as available). If multiple paths are present in the Route,
2419 /// we assume the invoice had the basic_mpp feature set.
2421 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2422 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
2423 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2424 let best_block_height = self.best_block.read().unwrap().height();
2425 self.pending_outbound_payments
2426 .send_payment_with_route(route, payment_hash, payment_secret, payment_id, &self.keys_manager, best_block_height,
2427 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2428 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2432 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> {
2433 let best_block_height = self.best_block.read().unwrap().height();
2434 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, payment_secret, keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.keys_manager, best_block_height,
2435 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2436 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2440 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> {
2441 let best_block_height = self.best_block.read().unwrap().height();
2442 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, payment_secret, payment_id, route, &self.keys_manager, best_block_height)
2446 /// Retries a payment along the given [`Route`].
2448 /// Errors returned are a superset of those returned from [`send_payment`], so see
2449 /// [`send_payment`] documentation for more details on errors. This method will also error if the
2450 /// retry amount puts the payment more than 10% over the payment's total amount, if the payment
2451 /// for the given `payment_id` cannot be found (likely due to timeout or success), or if
2452 /// further retries have been disabled with [`abandon_payment`].
2454 /// [`send_payment`]: [`ChannelManager::send_payment`]
2455 /// [`abandon_payment`]: [`ChannelManager::abandon_payment`]
2456 pub fn retry_payment(&self, route: &Route, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2457 let best_block_height = self.best_block.read().unwrap().height();
2458 self.pending_outbound_payments.retry_payment_with_route(route, payment_id, &self.keys_manager, best_block_height,
2459 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2460 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2463 /// Signals that no further retries for the given payment will occur.
2465 /// After this method returns, no future calls to [`retry_payment`] for the given `payment_id`
2466 /// are allowed. If no [`Event::PaymentFailed`] event had been generated before, one will be
2467 /// generated as soon as there are no remaining pending HTLCs for this payment.
2469 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
2470 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
2471 /// determine the ultimate status of a payment.
2473 /// If an [`Event::PaymentFailed`] event is generated and we restart without this
2474 /// [`ChannelManager`] having been persisted, the payment may still be in the pending state
2475 /// upon restart. This allows further calls to [`retry_payment`] (and requiring a second call
2476 /// to [`abandon_payment`] to mark the payment as failed again). Otherwise, future calls to
2477 /// [`retry_payment`] will fail with [`PaymentSendFailure::ParameterError`].
2479 /// [`abandon_payment`]: Self::abandon_payment
2480 /// [`retry_payment`]: Self::retry_payment
2481 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
2482 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2483 pub fn abandon_payment(&self, payment_id: PaymentId) {
2484 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2485 if let Some(payment_failed_ev) = self.pending_outbound_payments.abandon_payment(payment_id) {
2486 self.pending_events.lock().unwrap().push(payment_failed_ev);
2490 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
2491 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
2492 /// the preimage, it must be a cryptographically secure random value that no intermediate node
2493 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
2494 /// never reach the recipient.
2496 /// See [`send_payment`] documentation for more details on the return value of this function
2497 /// and idempotency guarantees provided by the [`PaymentId`] key.
2499 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
2500 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
2502 /// Note that `route` must have exactly one path.
2504 /// [`send_payment`]: Self::send_payment
2505 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
2506 let best_block_height = self.best_block.read().unwrap().height();
2507 self.pending_outbound_payments.send_spontaneous_payment(route, payment_preimage, payment_id, &self.keys_manager, best_block_height,
2508 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2509 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2512 /// Send a payment that is probing the given route for liquidity. We calculate the
2513 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
2514 /// us to easily discern them from real payments.
2515 pub fn send_probe(&self, hops: Vec<RouteHop>) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
2516 let best_block_height = self.best_block.read().unwrap().height();
2517 self.pending_outbound_payments.send_probe(hops, self.probing_cookie_secret, &self.keys_manager, best_block_height,
2518 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2519 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2522 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
2525 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
2526 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
2529 /// Handles the generation of a funding transaction, optionally (for tests) with a function
2530 /// which checks the correctness of the funding transaction given the associated channel.
2531 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<<K::Target as SignerProvider>::Signer>, &Transaction) -> Result<OutPoint, APIError>>(
2532 &self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
2533 ) -> Result<(), APIError> {
2534 let mut channel_state = self.channel_state.lock().unwrap();
2535 let per_peer_state = self.per_peer_state.read().unwrap();
2536 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
2537 if let None = peer_state_mutex_opt {
2538 return Err(APIError::APIMisuseError { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })
2541 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
2542 let peer_state = &mut *peer_state_lock;
2545 match peer_state.channel_by_id.remove(temporary_channel_id) {
2547 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
2549 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
2550 .map_err(|e| if let ChannelError::Close(msg) = e {
2551 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.get_user_id(), chan.force_shutdown(true), None)
2552 } else { unreachable!(); })
2555 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) }) },
2558 match handle_error!(self, res, chan.get_counterparty_node_id()) {
2559 Ok(funding_msg) => {
2562 Err(_) => { return Err(APIError::ChannelUnavailable {
2563 err: "Error deriving keys or signing initial commitment transactions - either our RNG or our counterparty's RNG is broken or the Signer refused to sign".to_owned()
2568 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
2569 node_id: chan.get_counterparty_node_id(),
2572 mem::drop(channel_state);
2573 match peer_state.channel_by_id.entry(chan.channel_id()) {
2574 hash_map::Entry::Occupied(_) => {
2575 panic!("Generated duplicate funding txid?");
2577 hash_map::Entry::Vacant(e) => {
2578 let mut id_to_peer = self.id_to_peer.lock().unwrap();
2579 if id_to_peer.insert(chan.channel_id(), chan.get_counterparty_node_id()).is_some() {
2580 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
2589 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> {
2590 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
2591 Ok(OutPoint { txid: tx.txid(), index: output_index })
2595 /// Call this upon creation of a funding transaction for the given channel.
2597 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
2598 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
2600 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
2601 /// across the p2p network.
2603 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
2604 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
2606 /// May panic if the output found in the funding transaction is duplicative with some other
2607 /// channel (note that this should be trivially prevented by using unique funding transaction
2608 /// keys per-channel).
2610 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
2611 /// counterparty's signature the funding transaction will automatically be broadcast via the
2612 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
2614 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
2615 /// not currently support replacing a funding transaction on an existing channel. Instead,
2616 /// create a new channel with a conflicting funding transaction.
2618 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
2619 /// the wallet software generating the funding transaction to apply anti-fee sniping as
2620 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
2621 /// for more details.
2623 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
2624 /// [`Event::ChannelClosed`]: crate::util::events::Event::ChannelClosed
2625 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
2626 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2628 for inp in funding_transaction.input.iter() {
2629 if inp.witness.is_empty() {
2630 return Err(APIError::APIMisuseError {
2631 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
2636 let height = self.best_block.read().unwrap().height();
2637 // Transactions are evaluated as final by network mempools at the next block. However, the modules
2638 // constituting our Lightning node might not have perfect sync about their blockchain views. Thus, if
2639 // the wallet module is in advance on the LDK view, allow one more block of headroom.
2640 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 {
2641 return Err(APIError::APIMisuseError {
2642 err: "Funding transaction absolute timelock is non-final".to_owned()
2646 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
2647 let mut output_index = None;
2648 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
2649 for (idx, outp) in tx.output.iter().enumerate() {
2650 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
2651 if output_index.is_some() {
2652 return Err(APIError::APIMisuseError {
2653 err: "Multiple outputs matched the expected script and value".to_owned()
2656 if idx > u16::max_value() as usize {
2657 return Err(APIError::APIMisuseError {
2658 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
2661 output_index = Some(idx as u16);
2664 if output_index.is_none() {
2665 return Err(APIError::APIMisuseError {
2666 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
2669 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
2673 /// Atomically updates the [`ChannelConfig`] for the given channels.
2675 /// Once the updates are applied, each eligible channel (advertised with a known short channel
2676 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
2677 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
2678 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
2680 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
2681 /// `counterparty_node_id` is provided.
2683 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
2684 /// below [`MIN_CLTV_EXPIRY_DELTA`].
2686 /// If an error is returned, none of the updates should be considered applied.
2688 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
2689 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
2690 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
2691 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
2692 /// [`ChannelUpdate`]: msgs::ChannelUpdate
2693 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
2694 /// [`APIMisuseError`]: APIError::APIMisuseError
2695 pub fn update_channel_config(
2696 &self, counterparty_node_id: &PublicKey, channel_ids: &[[u8; 32]], config: &ChannelConfig,
2697 ) -> Result<(), APIError> {
2698 if config.cltv_expiry_delta < MIN_CLTV_EXPIRY_DELTA {
2699 return Err(APIError::APIMisuseError {
2700 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
2704 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(
2705 &self.total_consistency_lock, &self.persistence_notifier,
2707 let mut channel_state_lock = self.channel_state.lock().unwrap();
2708 let channel_state = &mut *channel_state_lock;
2709 let per_peer_state = self.per_peer_state.read().unwrap();
2710 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
2711 if let None = peer_state_mutex_opt {
2712 return Err(APIError::APIMisuseError{ err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) });
2714 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
2715 let peer_state = &mut *peer_state_lock;
2716 for channel_id in channel_ids {
2717 if !peer_state.channel_by_id.contains_key(channel_id) {
2718 return Err(APIError::ChannelUnavailable {
2719 err: format!("Channel with ID {} was not found for the passed counterparty_node_id {}", log_bytes!(*channel_id), counterparty_node_id),
2723 for channel_id in channel_ids {
2724 let channel = peer_state.channel_by_id.get_mut(channel_id).unwrap();
2725 if !channel.update_config(config) {
2728 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
2729 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
2730 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
2731 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
2732 node_id: channel.get_counterparty_node_id(),
2740 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
2741 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
2743 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
2744 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
2746 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
2747 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
2748 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
2749 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
2750 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
2752 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
2753 /// you from forwarding more than you received.
2755 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
2758 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
2759 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
2760 // TODO: when we move to deciding the best outbound channel at forward time, only take
2761 // `next_node_id` and not `next_hop_channel_id`
2762 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> {
2763 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2765 let next_hop_scid = {
2766 let peer_state_lock = self.per_peer_state.read().unwrap();
2767 if let Some(peer_state_mutex) = peer_state_lock.get(&next_node_id) {
2768 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2769 let peer_state = &mut *peer_state_lock;
2770 match peer_state.channel_by_id.get(next_hop_channel_id) {
2772 if !chan.is_usable() {
2773 return Err(APIError::ChannelUnavailable {
2774 err: format!("Channel with id {} not fully established", log_bytes!(*next_hop_channel_id))
2777 chan.get_short_channel_id().unwrap_or(chan.outbound_scid_alias())
2779 None => return Err(APIError::ChannelUnavailable {
2780 err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*next_hop_channel_id), next_node_id)
2784 return Err(APIError::APIMisuseError{ err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) });
2788 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
2789 .ok_or_else(|| APIError::APIMisuseError {
2790 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
2793 let routing = match payment.forward_info.routing {
2794 PendingHTLCRouting::Forward { onion_packet, .. } => {
2795 PendingHTLCRouting::Forward { onion_packet, short_channel_id: next_hop_scid }
2797 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
2799 let pending_htlc_info = PendingHTLCInfo {
2800 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
2803 let mut per_source_pending_forward = [(
2804 payment.prev_short_channel_id,
2805 payment.prev_funding_outpoint,
2806 payment.prev_user_channel_id,
2807 vec![(pending_htlc_info, payment.prev_htlc_id)]
2809 self.forward_htlcs(&mut per_source_pending_forward);
2813 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
2814 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
2816 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
2819 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
2820 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
2821 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2823 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
2824 .ok_or_else(|| APIError::APIMisuseError {
2825 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
2828 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
2829 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2830 short_channel_id: payment.prev_short_channel_id,
2831 outpoint: payment.prev_funding_outpoint,
2832 htlc_id: payment.prev_htlc_id,
2833 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
2834 phantom_shared_secret: None,
2837 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
2838 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
2839 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
2840 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
2845 /// Processes HTLCs which are pending waiting on random forward delay.
2847 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
2848 /// Will likely generate further events.
2849 pub fn process_pending_htlc_forwards(&self) {
2850 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2852 let mut new_events = Vec::new();
2853 let mut failed_forwards = Vec::new();
2854 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
2856 let mut forward_htlcs = HashMap::new();
2857 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
2859 for (short_chan_id, mut pending_forwards) in forward_htlcs {
2860 if short_chan_id != 0 {
2861 macro_rules! forwarding_channel_not_found {
2863 for forward_info in pending_forwards.drain(..) {
2864 match forward_info {
2865 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
2866 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
2867 forward_info: PendingHTLCInfo {
2868 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
2869 outgoing_cltv_value, incoming_amt_msat: _
2872 macro_rules! failure_handler {
2873 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
2874 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2876 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2877 short_channel_id: prev_short_channel_id,
2878 outpoint: prev_funding_outpoint,
2879 htlc_id: prev_htlc_id,
2880 incoming_packet_shared_secret: incoming_shared_secret,
2881 phantom_shared_secret: $phantom_ss,
2884 let reason = if $next_hop_unknown {
2885 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
2887 HTLCDestination::FailedPayment{ payment_hash }
2890 failed_forwards.push((htlc_source, payment_hash,
2891 HTLCFailReason::reason($err_code, $err_data),
2897 macro_rules! fail_forward {
2898 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
2900 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
2904 macro_rules! failed_payment {
2905 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
2907 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
2911 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
2912 let phantom_secret_res = self.keys_manager.get_node_secret(Recipient::PhantomNode);
2913 if phantom_secret_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.genesis_hash) {
2914 let phantom_shared_secret = SharedSecret::new(&onion_packet.public_key.unwrap(), &phantom_secret_res.unwrap()).secret_bytes();
2915 let next_hop = match onion_utils::decode_next_payment_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
2917 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2918 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
2919 // In this scenario, the phantom would have sent us an
2920 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
2921 // if it came from us (the second-to-last hop) but contains the sha256
2923 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
2925 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2926 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
2930 onion_utils::Hop::Receive(hop_data) => {
2931 match self.construct_recv_pending_htlc_info(hop_data, incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value, Some(phantom_shared_secret)) {
2932 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
2933 Err(ReceiveError { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
2939 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
2942 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
2945 HTLCForwardInfo::FailHTLC { .. } => {
2946 // Channel went away before we could fail it. This implies
2947 // the channel is now on chain and our counterparty is
2948 // trying to broadcast the HTLC-Timeout, but that's their
2949 // problem, not ours.
2955 let (counterparty_node_id, forward_chan_id) = match self.short_to_chan_info.read().unwrap().get(&short_chan_id) {
2956 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
2958 forwarding_channel_not_found!();
2962 let per_peer_state = self.per_peer_state.read().unwrap();
2963 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
2964 if let None = peer_state_mutex_opt {
2965 forwarding_channel_not_found!();
2968 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
2969 let peer_state = &mut *peer_state_lock;
2970 match peer_state.channel_by_id.entry(forward_chan_id) {
2971 hash_map::Entry::Vacant(_) => {
2972 forwarding_channel_not_found!();
2975 hash_map::Entry::Occupied(mut chan) => {
2976 for forward_info in pending_forwards.drain(..) {
2977 match forward_info {
2978 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
2979 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id: _,
2980 forward_info: PendingHTLCInfo {
2981 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
2982 routing: PendingHTLCRouting::Forward { onion_packet, .. }, incoming_amt_msat: _,
2985 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);
2986 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2987 short_channel_id: prev_short_channel_id,
2988 outpoint: prev_funding_outpoint,
2989 htlc_id: prev_htlc_id,
2990 incoming_packet_shared_secret: incoming_shared_secret,
2991 // Phantom payments are only PendingHTLCRouting::Receive.
2992 phantom_shared_secret: None,
2994 if let Err(e) = chan.get_mut().queue_add_htlc(outgoing_amt_msat,
2995 payment_hash, outgoing_cltv_value, htlc_source.clone(),
2996 onion_packet, &self.logger)
2998 if let ChannelError::Ignore(msg) = e {
2999 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
3001 panic!("Stated return value requirements in send_htlc() were not met");
3003 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan.get());
3004 failed_forwards.push((htlc_source, payment_hash,
3005 HTLCFailReason::reason(failure_code, data),
3006 HTLCDestination::NextHopChannel { node_id: Some(chan.get().get_counterparty_node_id()), channel_id: forward_chan_id }
3011 HTLCForwardInfo::AddHTLC { .. } => {
3012 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
3014 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
3015 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
3016 if let Err(e) = chan.get_mut().queue_fail_htlc(
3017 htlc_id, err_packet, &self.logger
3019 if let ChannelError::Ignore(msg) = e {
3020 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
3022 panic!("Stated return value requirements in queue_fail_htlc() were not met");
3024 // fail-backs are best-effort, we probably already have one
3025 // pending, and if not that's OK, if not, the channel is on
3026 // the chain and sending the HTLC-Timeout is their problem.
3035 for forward_info in pending_forwards.drain(..) {
3036 match forward_info {
3037 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3038 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3039 forward_info: PendingHTLCInfo {
3040 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat, ..
3043 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret) = match routing {
3044 PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry, phantom_shared_secret } => {
3045 let _legacy_hop_data = Some(payment_data.clone());
3046 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data }, Some(payment_data), phantom_shared_secret)
3048 PendingHTLCRouting::ReceiveKeysend { payment_preimage, incoming_cltv_expiry } =>
3049 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage), None, None),
3051 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
3054 let claimable_htlc = ClaimableHTLC {
3055 prev_hop: HTLCPreviousHopData {
3056 short_channel_id: prev_short_channel_id,
3057 outpoint: prev_funding_outpoint,
3058 htlc_id: prev_htlc_id,
3059 incoming_packet_shared_secret: incoming_shared_secret,
3060 phantom_shared_secret,
3062 value: outgoing_amt_msat,
3064 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
3069 macro_rules! fail_htlc {
3070 ($htlc: expr, $payment_hash: expr) => {
3071 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
3072 htlc_msat_height_data.extend_from_slice(
3073 &self.best_block.read().unwrap().height().to_be_bytes(),
3075 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
3076 short_channel_id: $htlc.prev_hop.short_channel_id,
3077 outpoint: prev_funding_outpoint,
3078 htlc_id: $htlc.prev_hop.htlc_id,
3079 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
3080 phantom_shared_secret,
3082 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
3083 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
3087 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
3088 let mut receiver_node_id = self.our_network_pubkey;
3089 if phantom_shared_secret.is_some() {
3090 receiver_node_id = self.keys_manager.get_node_id(Recipient::PhantomNode)
3091 .expect("Failed to get node_id for phantom node recipient");
3094 macro_rules! check_total_value {
3095 ($payment_data: expr, $payment_preimage: expr) => {{
3096 let mut payment_claimable_generated = false;
3098 events::PaymentPurpose::InvoicePayment {
3099 payment_preimage: $payment_preimage,
3100 payment_secret: $payment_data.payment_secret,
3103 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3104 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
3105 fail_htlc!(claimable_htlc, payment_hash);
3108 let (_, htlcs) = claimable_payments.claimable_htlcs.entry(payment_hash)
3109 .or_insert_with(|| (purpose(), Vec::new()));
3110 if htlcs.len() == 1 {
3111 if let OnionPayload::Spontaneous(_) = htlcs[0].onion_payload {
3112 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));
3113 fail_htlc!(claimable_htlc, payment_hash);
3117 let mut total_value = claimable_htlc.value;
3118 for htlc in htlcs.iter() {
3119 total_value += htlc.value;
3120 match &htlc.onion_payload {
3121 OnionPayload::Invoice { .. } => {
3122 if htlc.total_msat != $payment_data.total_msat {
3123 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
3124 log_bytes!(payment_hash.0), $payment_data.total_msat, htlc.total_msat);
3125 total_value = msgs::MAX_VALUE_MSAT;
3127 if total_value >= msgs::MAX_VALUE_MSAT { break; }
3129 _ => unreachable!(),
3132 if total_value >= msgs::MAX_VALUE_MSAT || total_value > $payment_data.total_msat {
3133 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
3134 log_bytes!(payment_hash.0), total_value, $payment_data.total_msat);
3135 fail_htlc!(claimable_htlc, payment_hash);
3136 } else if total_value == $payment_data.total_msat {
3137 let prev_channel_id = prev_funding_outpoint.to_channel_id();
3138 htlcs.push(claimable_htlc);
3139 new_events.push(events::Event::PaymentClaimable {
3140 receiver_node_id: Some(receiver_node_id),
3143 amount_msat: total_value,
3144 via_channel_id: Some(prev_channel_id),
3145 via_user_channel_id: Some(prev_user_channel_id),
3147 payment_claimable_generated = true;
3149 // Nothing to do - we haven't reached the total
3150 // payment value yet, wait until we receive more
3152 htlcs.push(claimable_htlc);
3154 payment_claimable_generated
3158 // Check that the payment hash and secret are known. Note that we
3159 // MUST take care to handle the "unknown payment hash" and
3160 // "incorrect payment secret" cases here identically or we'd expose
3161 // that we are the ultimate recipient of the given payment hash.
3162 // Further, we must not expose whether we have any other HTLCs
3163 // associated with the same payment_hash pending or not.
3164 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
3165 match payment_secrets.entry(payment_hash) {
3166 hash_map::Entry::Vacant(_) => {
3167 match claimable_htlc.onion_payload {
3168 OnionPayload::Invoice { .. } => {
3169 let payment_data = payment_data.unwrap();
3170 let payment_preimage = match inbound_payment::verify(payment_hash, &payment_data, self.highest_seen_timestamp.load(Ordering::Acquire) as u64, &self.inbound_payment_key, &self.logger) {
3171 Ok(payment_preimage) => payment_preimage,
3173 fail_htlc!(claimable_htlc, payment_hash);
3177 check_total_value!(payment_data, payment_preimage);
3179 OnionPayload::Spontaneous(preimage) => {
3180 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3181 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
3182 fail_htlc!(claimable_htlc, payment_hash);
3185 match claimable_payments.claimable_htlcs.entry(payment_hash) {
3186 hash_map::Entry::Vacant(e) => {
3187 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
3188 e.insert((purpose.clone(), vec![claimable_htlc]));
3189 let prev_channel_id = prev_funding_outpoint.to_channel_id();
3190 new_events.push(events::Event::PaymentClaimable {
3191 receiver_node_id: Some(receiver_node_id),
3193 amount_msat: outgoing_amt_msat,
3195 via_channel_id: Some(prev_channel_id),
3196 via_user_channel_id: Some(prev_user_channel_id),
3199 hash_map::Entry::Occupied(_) => {
3200 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
3201 fail_htlc!(claimable_htlc, payment_hash);
3207 hash_map::Entry::Occupied(inbound_payment) => {
3208 if payment_data.is_none() {
3209 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));
3210 fail_htlc!(claimable_htlc, payment_hash);
3213 let payment_data = payment_data.unwrap();
3214 if inbound_payment.get().payment_secret != payment_data.payment_secret {
3215 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
3216 fail_htlc!(claimable_htlc, payment_hash);
3217 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
3218 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
3219 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
3220 fail_htlc!(claimable_htlc, payment_hash);
3222 let payment_claimable_generated = check_total_value!(payment_data, inbound_payment.get().payment_preimage);
3223 if payment_claimable_generated {
3224 inbound_payment.remove_entry();
3230 HTLCForwardInfo::FailHTLC { .. } => {
3231 panic!("Got pending fail of our own HTLC");
3239 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
3240 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
3242 self.forward_htlcs(&mut phantom_receives);
3244 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
3245 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
3246 // nice to do the work now if we can rather than while we're trying to get messages in the
3248 self.check_free_holding_cells();
3250 if new_events.is_empty() { return }
3251 let mut events = self.pending_events.lock().unwrap();
3252 events.append(&mut new_events);
3255 /// Free the background events, generally called from timer_tick_occurred.
3257 /// Exposed for testing to allow us to process events quickly without generating accidental
3258 /// BroadcastChannelUpdate events in timer_tick_occurred.
3260 /// Expects the caller to have a total_consistency_lock read lock.
3261 fn process_background_events(&self) -> bool {
3262 let mut background_events = Vec::new();
3263 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
3264 if background_events.is_empty() {
3268 for event in background_events.drain(..) {
3270 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
3271 // The channel has already been closed, so no use bothering to care about the
3272 // monitor updating completing.
3273 let _ = self.chain_monitor.update_channel(funding_txo, update);
3280 #[cfg(any(test, feature = "_test_utils"))]
3281 /// Process background events, for functional testing
3282 pub fn test_process_background_events(&self) {
3283 self.process_background_events();
3286 fn update_channel_fee(&self, chan_id: &[u8; 32], chan: &mut Channel<<K::Target as SignerProvider>::Signer>, new_feerate: u32) -> NotifyOption {
3287 if !chan.is_outbound() { return NotifyOption::SkipPersist; }
3288 // If the feerate has decreased by less than half, don't bother
3289 if new_feerate <= chan.get_feerate() && new_feerate * 2 > chan.get_feerate() {
3290 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
3291 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3292 return NotifyOption::SkipPersist;
3294 if !chan.is_live() {
3295 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).",
3296 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3297 return NotifyOption::SkipPersist;
3299 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
3300 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3302 chan.queue_update_fee(new_feerate, &self.logger);
3303 NotifyOption::DoPersist
3307 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
3308 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
3309 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
3310 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
3311 pub fn maybe_update_chan_fees(&self) {
3312 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3313 let mut should_persist = NotifyOption::SkipPersist;
3315 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3317 let per_peer_state = self.per_peer_state.read().unwrap();
3318 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
3319 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3320 let peer_state = &mut *peer_state_lock;
3321 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
3322 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
3323 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3331 /// Performs actions which should happen on startup and roughly once per minute thereafter.
3333 /// This currently includes:
3334 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
3335 /// * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
3336 /// than a minute, informing the network that they should no longer attempt to route over
3338 /// * Expiring a channel's previous `ChannelConfig` if necessary to only allow forwarding HTLCs
3339 /// with the current `ChannelConfig`.
3341 /// Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
3342 /// estimate fetches.
3343 pub fn timer_tick_occurred(&self) {
3344 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3345 let mut should_persist = NotifyOption::SkipPersist;
3346 if self.process_background_events() { should_persist = NotifyOption::DoPersist; }
3348 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3350 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
3351 let mut timed_out_mpp_htlcs = Vec::new();
3353 let mut channel_state_lock = self.channel_state.lock().unwrap();
3354 let channel_state = &mut *channel_state_lock;
3355 let pending_msg_events = &mut channel_state.pending_msg_events;
3356 let per_peer_state = self.per_peer_state.read().unwrap();
3357 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
3358 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3359 let peer_state = &mut *peer_state_lock;
3360 peer_state.channel_by_id.retain(|chan_id, chan| {
3361 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
3362 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3364 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
3365 let (needs_close, err) = convert_chan_err!(self, e, chan, chan_id);
3366 handle_errors.push((Err(err), *counterparty_node_id));
3367 if needs_close { return false; }
3370 match chan.channel_update_status() {
3371 ChannelUpdateStatus::Enabled if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged),
3372 ChannelUpdateStatus::Disabled if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged),
3373 ChannelUpdateStatus::DisabledStaged if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
3374 ChannelUpdateStatus::EnabledStaged if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
3375 ChannelUpdateStatus::DisabledStaged if !chan.is_live() => {
3376 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3377 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3381 should_persist = NotifyOption::DoPersist;
3382 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
3384 ChannelUpdateStatus::EnabledStaged if chan.is_live() => {
3385 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3386 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3390 should_persist = NotifyOption::DoPersist;
3391 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
3396 chan.maybe_expire_prev_config();
3403 self.claimable_payments.lock().unwrap().claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
3404 if htlcs.is_empty() {
3405 // This should be unreachable
3406 debug_assert!(false);
3409 if let OnionPayload::Invoice { .. } = htlcs[0].onion_payload {
3410 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
3411 // In this case we're not going to handle any timeouts of the parts here.
3412 if htlcs[0].total_msat == htlcs.iter().fold(0, |total, htlc| total + htlc.value) {
3414 } else if htlcs.into_iter().any(|htlc| {
3415 htlc.timer_ticks += 1;
3416 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
3418 timed_out_mpp_htlcs.extend(htlcs.drain(..).map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
3425 for htlc_source in timed_out_mpp_htlcs.drain(..) {
3426 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
3427 let reason = HTLCFailReason::from_failure_code(23);
3428 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
3429 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
3432 for (err, counterparty_node_id) in handle_errors.drain(..) {
3433 let _ = handle_error!(self, err, counterparty_node_id);
3436 self.pending_outbound_payments.remove_stale_resolved_payments(&self.pending_events);
3438 // Technically we don't need to do this here, but if we have holding cell entries in a
3439 // channel that need freeing, it's better to do that here and block a background task
3440 // than block the message queueing pipeline.
3441 if self.check_free_holding_cells() {
3442 should_persist = NotifyOption::DoPersist;
3449 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
3450 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
3451 /// along the path (including in our own channel on which we received it).
3453 /// Note that in some cases around unclean shutdown, it is possible the payment may have
3454 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
3455 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
3456 /// may have already been failed automatically by LDK if it was nearing its expiration time.
3458 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
3459 /// [`ChannelManager::claim_funds`]), you should still monitor for
3460 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
3461 /// startup during which time claims that were in-progress at shutdown may be replayed.
3462 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
3463 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3465 let removed_source = self.claimable_payments.lock().unwrap().claimable_htlcs.remove(payment_hash);
3466 if let Some((_, mut sources)) = removed_source {
3467 for htlc in sources.drain(..) {
3468 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
3469 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
3470 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
3471 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
3472 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
3473 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
3478 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3479 /// that we want to return and a channel.
3481 /// This is for failures on the channel on which the HTLC was *received*, not failures
3483 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<<K::Target as SignerProvider>::Signer>) -> (u16, Vec<u8>) {
3484 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
3485 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
3486 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
3487 // an inbound SCID alias before the real SCID.
3488 let scid_pref = if chan.should_announce() {
3489 chan.get_short_channel_id().or(chan.latest_inbound_scid_alias())
3491 chan.latest_inbound_scid_alias().or(chan.get_short_channel_id())
3493 if let Some(scid) = scid_pref {
3494 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
3496 (0x4000|10, Vec::new())
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.
3503 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<<K::Target as SignerProvider>::Signer>) -> (u16, Vec<u8>) {
3504 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
3505 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
3506 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
3507 if desired_err_code == 0x1000 | 20 {
3508 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
3509 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
3510 0u16.write(&mut enc).expect("Writes cannot fail");
3512 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
3513 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
3514 upd.write(&mut enc).expect("Writes cannot fail");
3515 (desired_err_code, enc.0)
3517 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
3518 // which means we really shouldn't have gotten a payment to be forwarded over this
3519 // channel yet, or if we did it's from a route hint. Either way, returning an error of
3520 // PERM|no_such_channel should be fine.
3521 (0x4000|10, Vec::new())
3525 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
3526 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
3527 // be surfaced to the user.
3528 fn fail_holding_cell_htlcs(
3529 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32],
3530 counterparty_node_id: &PublicKey
3532 let (failure_code, onion_failure_data) = {
3533 let per_peer_state = self.per_peer_state.read().unwrap();
3534 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
3535 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3536 let peer_state = &mut *peer_state_lock;
3537 match peer_state.channel_by_id.entry(channel_id) {
3538 hash_map::Entry::Occupied(chan_entry) => {
3539 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan_entry.get())
3541 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
3543 } else { (0x4000|10, Vec::new()) }
3546 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
3547 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
3548 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
3549 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
3553 /// Fails an HTLC backwards to the sender of it to us.
3554 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
3555 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
3556 #[cfg(all(debug_assertions, feature = "std"))]
3558 // Ensure that the `channel_state` and no peer state channel storage lock is not held
3559 // when calling this function.
3560 // This ensures that future code doesn't introduce a lock_order requirement for
3561 // `forward_htlcs` to be locked after the `channel_state` and `per_peer_state` locks,
3562 // which calling this function with the locks aquired would.
3563 assert!(self.channel_state.try_lock().is_ok());
3564 assert!(self.per_peer_state.try_write().is_ok());
3567 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
3568 //identify whether we sent it or not based on the (I presume) very different runtime
3569 //between the branches here. We should make this async and move it into the forward HTLCs
3572 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3573 // from block_connected which may run during initialization prior to the chain_monitor
3574 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
3576 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, ref payment_params, .. } => {
3577 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);
3579 HTLCSource::PreviousHopData(HTLCPreviousHopData { ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret, ref phantom_shared_secret, ref outpoint }) => {
3580 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with {:?}", log_bytes!(payment_hash.0), onion_error);
3581 let err_packet = onion_error.get_encrypted_failure_packet(incoming_packet_shared_secret, phantom_shared_secret);
3583 let mut forward_event = None;
3584 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
3585 if forward_htlcs.is_empty() {
3586 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
3588 match forward_htlcs.entry(*short_channel_id) {
3589 hash_map::Entry::Occupied(mut entry) => {
3590 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet });
3592 hash_map::Entry::Vacant(entry) => {
3593 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }));
3596 mem::drop(forward_htlcs);
3597 let mut pending_events = self.pending_events.lock().unwrap();
3598 if let Some(time) = forward_event {
3599 pending_events.push(events::Event::PendingHTLCsForwardable {
3600 time_forwardable: time
3603 pending_events.push(events::Event::HTLCHandlingFailed {
3604 prev_channel_id: outpoint.to_channel_id(),
3605 failed_next_destination: destination,
3611 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
3612 /// [`MessageSendEvent`]s needed to claim the payment.
3614 /// Note that calling this method does *not* guarantee that the payment has been claimed. You
3615 /// *must* wait for an [`Event::PaymentClaimed`] event which upon a successful claim will be
3616 /// provided to your [`EventHandler`] when [`process_pending_events`] is next called.
3618 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
3619 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
3620 /// event matches your expectation. If you fail to do so and call this method, you may provide
3621 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
3623 /// [`Event::PaymentClaimable`]: crate::util::events::Event::PaymentClaimable
3624 /// [`Event::PaymentClaimed`]: crate::util::events::Event::PaymentClaimed
3625 /// [`process_pending_events`]: EventsProvider::process_pending_events
3626 /// [`create_inbound_payment`]: Self::create_inbound_payment
3627 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
3628 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
3629 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
3631 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3634 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3635 if let Some((payment_purpose, sources)) = claimable_payments.claimable_htlcs.remove(&payment_hash) {
3636 let mut receiver_node_id = self.our_network_pubkey;
3637 for htlc in sources.iter() {
3638 if htlc.prev_hop.phantom_shared_secret.is_some() {
3639 let phantom_pubkey = self.keys_manager.get_node_id(Recipient::PhantomNode)
3640 .expect("Failed to get node_id for phantom node recipient");
3641 receiver_node_id = phantom_pubkey;
3646 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
3647 ClaimingPayment { amount_msat: sources.iter().map(|source| source.value).sum(),
3648 payment_purpose, receiver_node_id,
3650 if dup_purpose.is_some() {
3651 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
3652 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
3653 log_bytes!(payment_hash.0));
3658 debug_assert!(!sources.is_empty());
3660 // If we are claiming an MPP payment, we check that all channels which contain a claimable
3661 // HTLC still exist. While this isn't guaranteed to remain true if a channel closes while
3662 // we're claiming (or even after we claim, before the commitment update dance completes),
3663 // it should be a relatively rare race, and we'd rather not claim HTLCs that require us to
3664 // go on-chain (and lose the on-chain fee to do so) than just reject the payment.
3666 // Note that we'll still always get our funds - as long as the generated
3667 // `ChannelMonitorUpdate` makes it out to the relevant monitor we can claim on-chain.
3669 // If we find an HTLC which we would need to claim but for which we do not have a
3670 // channel, we will fail all parts of the MPP payment. While we could wait and see if
3671 // the sender retries the already-failed path(s), it should be a pretty rare case where
3672 // we got all the HTLCs and then a channel closed while we were waiting for the user to
3673 // provide the preimage, so worrying too much about the optimal handling isn't worth
3675 let mut claimable_amt_msat = 0;
3676 let mut expected_amt_msat = None;
3677 let mut valid_mpp = true;
3678 let mut errs = Vec::new();
3679 let mut channel_state = Some(self.channel_state.lock().unwrap());
3680 let mut per_peer_state = Some(self.per_peer_state.read().unwrap());
3681 for htlc in sources.iter() {
3682 let (counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&htlc.prev_hop.short_channel_id) {
3683 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3690 if let None = per_peer_state.as_ref().unwrap().get(&counterparty_node_id) {
3695 let peer_state_mutex = per_peer_state.as_ref().unwrap().get(&counterparty_node_id).unwrap();
3696 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3697 let peer_state = &mut *peer_state_lock;
3699 if let None = peer_state.channel_by_id.get(&chan_id) {
3704 if expected_amt_msat.is_some() && expected_amt_msat != Some(htlc.total_msat) {
3705 log_error!(self.logger, "Somehow ended up with an MPP payment with different total amounts - this should not be reachable!");
3706 debug_assert!(false);
3711 expected_amt_msat = Some(htlc.total_msat);
3712 if let OnionPayload::Spontaneous(_) = &htlc.onion_payload {
3713 // We don't currently support MPP for spontaneous payments, so just check
3714 // that there's one payment here and move on.
3715 if sources.len() != 1 {
3716 log_error!(self.logger, "Somehow ended up with an MPP spontaneous payment - this should not be reachable!");
3717 debug_assert!(false);
3723 claimable_amt_msat += htlc.value;
3725 if sources.is_empty() || expected_amt_msat.is_none() {
3726 mem::drop(channel_state);
3727 mem::drop(per_peer_state);
3728 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
3729 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
3732 if claimable_amt_msat != expected_amt_msat.unwrap() {
3733 mem::drop(channel_state);
3734 mem::drop(per_peer_state);
3735 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
3736 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
3737 expected_amt_msat.unwrap(), claimable_amt_msat);
3741 for htlc in sources.drain(..) {
3742 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
3743 if per_peer_state.is_none() { per_peer_state = Some(self.per_peer_state.read().unwrap()); }
3744 if let Err((pk, err)) = self.claim_funds_from_hop(channel_state.take().unwrap(), per_peer_state.take().unwrap(),
3745 htlc.prev_hop, payment_preimage,
3746 |_| Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash }))
3748 if let msgs::ErrorAction::IgnoreError = err.err.action {
3749 // We got a temporary failure updating monitor, but will claim the
3750 // HTLC when the monitor updating is restored (or on chain).
3751 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
3752 } else { errs.push((pk, err)); }
3756 mem::drop(channel_state);
3757 mem::drop(per_peer_state);
3759 for htlc in sources.drain(..) {
3760 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
3761 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
3762 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
3763 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
3764 let receiver = HTLCDestination::FailedPayment { payment_hash };
3765 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
3767 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
3770 // Now we can handle any errors which were generated.
3771 for (counterparty_node_id, err) in errs.drain(..) {
3772 let res: Result<(), _> = Err(err);
3773 let _ = handle_error!(self, res, counterparty_node_id);
3777 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>) -> Option<MonitorUpdateCompletionAction>>(&self,
3778 mut channel_state_lock: MutexGuard<ChannelHolder>,
3779 per_peer_state_lock: RwLockReadGuard<HashMap<PublicKey, Mutex<PeerState<<K::Target as SignerProvider>::Signer>>>>,
3780 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
3781 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
3782 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
3784 let chan_id = prev_hop.outpoint.to_channel_id();
3785 let channel_state = &mut *channel_state_lock;
3787 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
3788 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
3792 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() {
3793 let peer_mutex = per_peer_state_lock.get(&counterparty_node_id_opt.unwrap()).unwrap();
3794 let peer_state = peer_mutex.lock().unwrap();
3795 let found_channel = peer_state.channel_by_id.contains_key(&chan_id);
3796 (found_channel, Some(peer_state))
3797 } else { (false, None) };
3800 if let hash_map::Entry::Occupied(mut chan) = peer_state_opt.as_mut().unwrap().channel_by_id.entry(chan_id) {
3801 let counterparty_node_id = chan.get().get_counterparty_node_id();
3802 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
3803 Ok(msgs_monitor_option) => {
3804 if let UpdateFulfillCommitFetch::NewClaim { msgs, htlc_value_msat, monitor_update } = msgs_monitor_option {
3805 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3806 ChannelMonitorUpdateStatus::Completed => {},
3808 log_given_level!(self.logger, if e == ChannelMonitorUpdateStatus::PermanentFailure { Level::Error } else { Level::Debug },
3809 "Failed to update channel monitor with preimage {:?}: {:?}",
3810 payment_preimage, e);
3811 let err = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()).unwrap_err();
3812 mem::drop(channel_state_lock);
3813 mem::drop(peer_state_opt);
3814 mem::drop(per_peer_state_lock);
3815 self.handle_monitor_update_completion_actions(completion_action(Some(htlc_value_msat)));
3816 return Err((counterparty_node_id, err));
3819 if let Some((msg, commitment_signed)) = msgs {
3820 log_debug!(self.logger, "Claiming funds for HTLC with preimage {} resulted in a commitment_signed for channel {}",
3821 log_bytes!(payment_preimage.0), log_bytes!(chan.get().channel_id()));
3822 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3823 node_id: chan.get().get_counterparty_node_id(),
3824 updates: msgs::CommitmentUpdate {
3825 update_add_htlcs: Vec::new(),
3826 update_fulfill_htlcs: vec![msg],
3827 update_fail_htlcs: Vec::new(),
3828 update_fail_malformed_htlcs: Vec::new(),
3834 mem::drop(channel_state_lock);
3835 mem::drop(peer_state_opt);
3836 mem::drop(per_peer_state_lock);
3837 self.handle_monitor_update_completion_actions(completion_action(Some(htlc_value_msat)));
3843 Err((e, monitor_update)) => {
3844 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3845 ChannelMonitorUpdateStatus::Completed => {},
3847 // TODO: This needs to be handled somehow - if we receive a monitor update
3848 // with a preimage we *must* somehow manage to propagate it to the upstream
3849 // channel, or we must have an ability to receive the same update and try
3850 // again on restart.
3851 log_given_level!(self.logger, if e == ChannelMonitorUpdateStatus::PermanentFailure { Level::Error } else { Level::Info },
3852 "Failed to update channel monitor with preimage {:?} immediately prior to force-close: {:?}",
3853 payment_preimage, e);
3856 let (drop, res) = convert_chan_err!(self, e, chan.get_mut(), &chan_id);
3858 chan.remove_entry();
3860 mem::drop(channel_state_lock);
3861 mem::drop(peer_state_opt);
3862 mem::drop(per_peer_state_lock);
3863 self.handle_monitor_update_completion_actions(completion_action(None));
3864 Err((counterparty_node_id, res))
3868 // We've held the peer_state mutex since finding the channel and setting
3869 // found_channel to true, so the channel can't have been dropped.
3873 let preimage_update = ChannelMonitorUpdate {
3874 update_id: CLOSED_CHANNEL_UPDATE_ID,
3875 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
3879 // We update the ChannelMonitor on the backward link, after
3880 // receiving an `update_fulfill_htlc` from the forward link.
3881 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, preimage_update);
3882 if update_res != ChannelMonitorUpdateStatus::Completed {
3883 // TODO: This needs to be handled somehow - if we receive a monitor update
3884 // with a preimage we *must* somehow manage to propagate it to the upstream
3885 // channel, or we must have an ability to receive the same event and try
3886 // again on restart.
3887 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
3888 payment_preimage, update_res);
3890 mem::drop(channel_state_lock);
3891 mem::drop(peer_state_opt);
3892 mem::drop(per_peer_state_lock);
3893 // Note that we do process the completion action here. This totally could be a
3894 // duplicate claim, but we have no way of knowing without interrogating the
3895 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
3896 // generally always allowed to be duplicative (and it's specifically noted in
3897 // `PaymentForwarded`).
3898 self.handle_monitor_update_completion_actions(completion_action(None));
3903 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
3904 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
3907 fn claim_funds_internal(&self, channel_state_lock: MutexGuard<ChannelHolder>, source: HTLCSource, payment_preimage: PaymentPreimage, forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, next_channel_id: [u8; 32]) {
3909 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
3910 mem::drop(channel_state_lock);
3911 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage, session_priv, path, from_onchain, &self.pending_events, &self.logger);
3913 HTLCSource::PreviousHopData(hop_data) => {
3914 let prev_outpoint = hop_data.outpoint;
3915 let res = self.claim_funds_from_hop(channel_state_lock, self.per_peer_state.read().unwrap(), hop_data, payment_preimage,
3916 |htlc_claim_value_msat| {
3917 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
3918 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
3919 Some(claimed_htlc_value - forwarded_htlc_value)
3922 let prev_channel_id = Some(prev_outpoint.to_channel_id());
3923 let next_channel_id = Some(next_channel_id);
3925 Some(MonitorUpdateCompletionAction::EmitEvent { event: events::Event::PaymentForwarded {
3927 claim_from_onchain_tx: from_onchain,
3933 if let Err((pk, err)) = res {
3934 let result: Result<(), _> = Err(err);
3935 let _ = handle_error!(self, result, pk);
3941 /// Gets the node_id held by this ChannelManager
3942 pub fn get_our_node_id(&self) -> PublicKey {
3943 self.our_network_pubkey.clone()
3946 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
3947 for action in actions.into_iter() {
3949 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
3950 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
3951 if let Some(ClaimingPayment { amount_msat, payment_purpose: purpose, receiver_node_id }) = payment {
3952 self.pending_events.lock().unwrap().push(events::Event::PaymentClaimed {
3953 payment_hash, purpose, amount_msat, receiver_node_id: Some(receiver_node_id),
3957 MonitorUpdateCompletionAction::EmitEvent { event } => {
3958 self.pending_events.lock().unwrap().push(event);
3964 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
3965 /// update completion.
3966 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
3967 channel: &mut Channel<<K::Target as SignerProvider>::Signer>, raa: Option<msgs::RevokeAndACK>,
3968 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
3969 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
3970 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
3971 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
3972 let mut htlc_forwards = None;
3974 let counterparty_node_id = channel.get_counterparty_node_id();
3975 if !pending_forwards.is_empty() {
3976 htlc_forwards = Some((channel.get_short_channel_id().unwrap_or(channel.outbound_scid_alias()),
3977 channel.get_funding_txo().unwrap(), channel.get_user_id(), pending_forwards));
3980 if let Some(msg) = channel_ready {
3981 send_channel_ready!(self, pending_msg_events, channel, msg);
3983 if let Some(msg) = announcement_sigs {
3984 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
3985 node_id: counterparty_node_id,
3990 emit_channel_ready_event!(self, channel);
3992 macro_rules! handle_cs { () => {
3993 if let Some(update) = commitment_update {
3994 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3995 node_id: counterparty_node_id,
4000 macro_rules! handle_raa { () => {
4001 if let Some(revoke_and_ack) = raa {
4002 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
4003 node_id: counterparty_node_id,
4004 msg: revoke_and_ack,
4009 RAACommitmentOrder::CommitmentFirst => {
4013 RAACommitmentOrder::RevokeAndACKFirst => {
4019 if let Some(tx) = funding_broadcastable {
4020 log_info!(self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
4021 self.tx_broadcaster.broadcast_transaction(&tx);
4027 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
4028 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4031 let (mut pending_failures, finalized_claims, counterparty_node_id) = {
4032 let mut channel_lock = self.channel_state.lock().unwrap();
4033 let channel_state = &mut *channel_lock;
4034 let counterparty_node_id = match counterparty_node_id {
4035 Some(cp_id) => cp_id.clone(),
4037 // TODO: Once we can rely on the counterparty_node_id from the
4038 // monitor event, this and the id_to_peer map should be removed.
4039 let id_to_peer = self.id_to_peer.lock().unwrap();
4040 match id_to_peer.get(&funding_txo.to_channel_id()) {
4041 Some(cp_id) => cp_id.clone(),
4046 let per_peer_state = self.per_peer_state.read().unwrap();
4047 let mut peer_state_lock;
4049 if let None = per_peer_state.get(&counterparty_node_id) { return }
4050 let peer_state_mutex = per_peer_state.get(&counterparty_node_id).unwrap();
4051 peer_state_lock = peer_state_mutex.lock().unwrap();
4052 let peer_state = &mut *peer_state_lock;
4053 match peer_state.channel_by_id.entry(funding_txo.to_channel_id()){
4054 hash_map::Entry::Occupied(chan) => chan,
4055 hash_map::Entry::Vacant(_) => return,
4058 if !channel.get().is_awaiting_monitor_update() || channel.get().get_latest_monitor_update_id() != highest_applied_update_id {
4062 let updates = channel.get_mut().monitor_updating_restored(&self.logger, self.get_our_node_id(), self.genesis_hash, self.best_block.read().unwrap().height());
4063 let channel_update = if updates.channel_ready.is_some() && channel.get().is_usable() {
4064 // We only send a channel_update in the case where we are just now sending a
4065 // channel_ready and the channel is in a usable state. We may re-send a
4066 // channel_update later through the announcement_signatures process for public
4067 // channels, but there's no reason not to just inform our counterparty of our fees
4069 if let Ok(msg) = self.get_channel_update_for_unicast(channel.get()) {
4070 Some(events::MessageSendEvent::SendChannelUpdate {
4071 node_id: channel.get().get_counterparty_node_id(),
4076 htlc_forwards = self.handle_channel_resumption(&mut channel_state.pending_msg_events, channel.get_mut(), updates.raa, updates.commitment_update, updates.order, updates.accepted_htlcs, updates.funding_broadcastable, updates.channel_ready, updates.announcement_sigs);
4077 if let Some(upd) = channel_update {
4078 channel_state.pending_msg_events.push(upd);
4081 (updates.failed_htlcs, updates.finalized_claimed_htlcs, counterparty_node_id)
4083 if let Some(forwards) = htlc_forwards {
4084 self.forward_htlcs(&mut [forwards][..]);
4086 self.finalize_claims(finalized_claims);
4087 for failure in pending_failures.drain(..) {
4088 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id: funding_txo.to_channel_id() };
4089 self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
4093 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
4095 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
4096 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
4099 /// The `user_channel_id` parameter will be provided back in
4100 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4101 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4103 /// Note that this method will return an error and reject the channel, if it requires support
4104 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
4105 /// used to accept such channels.
4107 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4108 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4109 pub fn accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
4110 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
4113 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
4114 /// it as confirmed immediately.
4116 /// The `user_channel_id` parameter will be provided back in
4117 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4118 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4120 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
4121 /// and (if the counterparty agrees), enables forwarding of payments immediately.
4123 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
4124 /// transaction and blindly assumes that it will eventually confirm.
4126 /// If it does not confirm before we decide to close the channel, or if the funding transaction
4127 /// does not pay to the correct script the correct amount, *you will lose funds*.
4129 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4130 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4131 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> {
4132 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
4135 fn do_accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
4136 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4138 let mut channel_state_lock = self.channel_state.lock().unwrap();
4139 let channel_state = &mut *channel_state_lock;
4140 let per_peer_state = self.per_peer_state.read().unwrap();
4141 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4142 if let None = peer_state_mutex_opt {
4143 return Err(APIError::APIMisuseError { err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) });
4145 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4146 let peer_state = &mut *peer_state_lock;
4147 match peer_state.channel_by_id.entry(temporary_channel_id.clone()) {
4148 hash_map::Entry::Occupied(mut channel) => {
4149 if !channel.get().inbound_is_awaiting_accept() {
4150 return Err(APIError::APIMisuseError { err: "The channel isn't currently awaiting to be accepted.".to_owned() });
4153 channel.get_mut().set_0conf();
4154 } else if channel.get().get_channel_type().requires_zero_conf() {
4155 let send_msg_err_event = events::MessageSendEvent::HandleError {
4156 node_id: channel.get().get_counterparty_node_id(),
4157 action: msgs::ErrorAction::SendErrorMessage{
4158 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
4161 channel_state.pending_msg_events.push(send_msg_err_event);
4162 let _ = remove_channel!(self, channel);
4163 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
4166 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4167 node_id: channel.get().get_counterparty_node_id(),
4168 msg: channel.get_mut().accept_inbound_channel(user_channel_id),
4171 hash_map::Entry::Vacant(_) => {
4172 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) });
4178 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
4179 if msg.chain_hash != self.genesis_hash {
4180 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
4183 if !self.default_configuration.accept_inbound_channels {
4184 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4187 let mut random_bytes = [0u8; 16];
4188 random_bytes.copy_from_slice(&self.keys_manager.get_secure_random_bytes()[..16]);
4189 let user_channel_id = u128::from_be_bytes(random_bytes);
4191 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
4192 let mut channel = match Channel::new_from_req(&self.fee_estimator, &self.keys_manager,
4193 counterparty_node_id.clone(), &their_features, msg, user_channel_id, &self.default_configuration,
4194 self.best_block.read().unwrap().height(), &self.logger, outbound_scid_alias)
4197 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4198 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
4202 let mut channel_state_lock = self.channel_state.lock().unwrap();
4203 let channel_state = &mut *channel_state_lock;
4204 let per_peer_state = self.per_peer_state.read().unwrap();
4205 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4206 if let None = peer_state_mutex_opt {
4207 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()))
4209 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4210 let peer_state = &mut *peer_state_lock;
4211 match peer_state.channel_by_id.entry(channel.channel_id()) {
4212 hash_map::Entry::Occupied(_) => {
4213 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4214 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision for the same peer!".to_owned(), msg.temporary_channel_id.clone()))
4216 hash_map::Entry::Vacant(entry) => {
4217 if !self.default_configuration.manually_accept_inbound_channels {
4218 if channel.get_channel_type().requires_zero_conf() {
4219 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4221 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4222 node_id: counterparty_node_id.clone(),
4223 msg: channel.accept_inbound_channel(user_channel_id),
4226 let mut pending_events = self.pending_events.lock().unwrap();
4227 pending_events.push(
4228 events::Event::OpenChannelRequest {
4229 temporary_channel_id: msg.temporary_channel_id.clone(),
4230 counterparty_node_id: counterparty_node_id.clone(),
4231 funding_satoshis: msg.funding_satoshis,
4232 push_msat: msg.push_msat,
4233 channel_type: channel.get_channel_type().clone(),
4238 entry.insert(channel);
4244 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
4245 let (value, output_script, user_id) = {
4246 let per_peer_state = self.per_peer_state.read().unwrap();
4247 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4248 if let None = peer_state_mutex_opt {
4249 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))
4251 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4252 let peer_state = &mut *peer_state_lock;
4253 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
4254 hash_map::Entry::Occupied(mut chan) => {
4255 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &their_features), chan);
4256 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
4258 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))
4261 let mut pending_events = self.pending_events.lock().unwrap();
4262 pending_events.push(events::Event::FundingGenerationReady {
4263 temporary_channel_id: msg.temporary_channel_id,
4264 counterparty_node_id: *counterparty_node_id,
4265 channel_value_satoshis: value,
4267 user_channel_id: user_id,
4272 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
4273 let mut channel_state_lock = self.channel_state.lock().unwrap();
4274 let channel_state = &mut *channel_state_lock;
4275 let per_peer_state = self.per_peer_state.read().unwrap();
4276 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4277 if let None = peer_state_mutex_opt {
4278 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))
4280 let ((funding_msg, monitor, mut channel_ready), mut chan) = {
4281 let best_block = *self.best_block.read().unwrap();
4282 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4283 let peer_state = &mut *peer_state_lock;
4284 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
4285 hash_map::Entry::Occupied(mut chan) => {
4286 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.keys_manager, &self.logger), chan), chan.remove())
4288 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))
4291 // Because we have exclusive ownership of the channel here we can release the peer_state
4292 // lock before watch_channel
4293 match self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
4294 ChannelMonitorUpdateStatus::Completed => {},
4295 ChannelMonitorUpdateStatus::PermanentFailure => {
4296 // Note that we reply with the new channel_id in error messages if we gave up on the
4297 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
4298 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
4299 // any messages referencing a previously-closed channel anyway.
4300 // We do not propagate the monitor update to the user as it would be for a monitor
4301 // that we didn't manage to store (and that we don't care about - we don't respond
4302 // with the funding_signed so the channel can never go on chain).
4303 let (_monitor_update, failed_htlcs) = chan.force_shutdown(false);
4304 assert!(failed_htlcs.is_empty());
4305 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
4307 ChannelMonitorUpdateStatus::InProgress => {
4308 // There's no problem signing a counterparty's funding transaction if our monitor
4309 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
4310 // accepted payment from yet. We do, however, need to wait to send our channel_ready
4311 // until we have persisted our monitor.
4312 chan.monitor_updating_paused(false, false, channel_ready.is_some(), Vec::new(), Vec::new(), Vec::new());
4313 channel_ready = None; // Don't send the channel_ready now
4316 // It's safe to unwrap as we've held the `per_peer_state` read lock since checking that the
4317 // peer exists, despite the inner PeerState potentially having no channels after removing
4318 // the channel above.
4319 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4320 let peer_state = &mut *peer_state_lock;
4321 match peer_state.channel_by_id.entry(funding_msg.channel_id) {
4322 hash_map::Entry::Occupied(_) => {
4323 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
4325 hash_map::Entry::Vacant(e) => {
4326 let mut id_to_peer = self.id_to_peer.lock().unwrap();
4327 match id_to_peer.entry(chan.channel_id()) {
4328 hash_map::Entry::Occupied(_) => {
4329 return Err(MsgHandleErrInternal::send_err_msg_no_close(
4330 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
4331 funding_msg.channel_id))
4333 hash_map::Entry::Vacant(i_e) => {
4334 i_e.insert(chan.get_counterparty_node_id());
4337 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
4338 node_id: counterparty_node_id.clone(),
4341 if let Some(msg) = channel_ready {
4342 send_channel_ready!(self, channel_state.pending_msg_events, chan, msg);
4350 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
4352 let best_block = *self.best_block.read().unwrap();
4353 let mut channel_lock = self.channel_state.lock().unwrap();
4354 let channel_state = &mut *channel_lock;
4355 let per_peer_state = self.per_peer_state.read().unwrap();
4356 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4357 if let None = peer_state_mutex_opt {
4358 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))
4361 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4362 let peer_state = &mut *peer_state_lock;
4363 match peer_state.channel_by_id.entry(msg.channel_id) {
4364 hash_map::Entry::Occupied(mut chan) => {
4365 let (monitor, funding_tx, channel_ready) = match chan.get_mut().funding_signed(&msg, best_block, &self.keys_manager, &self.logger) {
4366 Ok(update) => update,
4367 Err(e) => try_chan_entry!(self, Err(e), chan),
4369 match self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
4370 ChannelMonitorUpdateStatus::Completed => {},
4372 let mut res = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::RevokeAndACKFirst, channel_ready.is_some(), OPTIONALLY_RESEND_FUNDING_LOCKED);
4373 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
4374 // We weren't able to watch the channel to begin with, so no updates should be made on
4375 // it. Previously, full_stack_target found an (unreachable) panic when the
4376 // monitor update contained within `shutdown_finish` was applied.
4377 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
4378 shutdown_finish.0.take();
4384 if let Some(msg) = channel_ready {
4385 send_channel_ready!(self, channel_state.pending_msg_events, chan.get(), msg);
4389 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))
4392 log_info!(self.logger, "Broadcasting funding transaction with txid {}", funding_tx.txid());
4393 self.tx_broadcaster.broadcast_transaction(&funding_tx);
4397 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
4398 let mut channel_state_lock = self.channel_state.lock().unwrap();
4399 let channel_state = &mut *channel_state_lock;
4400 let per_peer_state = self.per_peer_state.read().unwrap();
4401 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4402 if let None = peer_state_mutex_opt {
4403 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));
4405 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4406 let peer_state = &mut *peer_state_lock;
4407 match peer_state.channel_by_id.entry(msg.channel_id) {
4408 hash_map::Entry::Occupied(mut chan) => {
4409 let announcement_sigs_opt = try_chan_entry!(self, chan.get_mut().channel_ready(&msg, self.get_our_node_id(),
4410 self.genesis_hash.clone(), &self.best_block.read().unwrap(), &self.logger), chan);
4411 if let Some(announcement_sigs) = announcement_sigs_opt {
4412 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(chan.get().channel_id()));
4413 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4414 node_id: counterparty_node_id.clone(),
4415 msg: announcement_sigs,
4417 } else if chan.get().is_usable() {
4418 // If we're sending an announcement_signatures, we'll send the (public)
4419 // channel_update after sending a channel_announcement when we receive our
4420 // counterparty's announcement_signatures. Thus, we only bother to send a
4421 // channel_update here if the channel is not public, i.e. we're not sending an
4422 // announcement_signatures.
4423 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", log_bytes!(chan.get().channel_id()));
4424 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
4425 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4426 node_id: counterparty_node_id.clone(),
4432 emit_channel_ready_event!(self, chan.get_mut());
4436 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))
4440 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
4441 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
4442 let result: Result<(), _> = loop {
4443 let mut channel_state_lock = self.channel_state.lock().unwrap();
4444 let channel_state = &mut *channel_state_lock;
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.keys_manager, &their_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 channel_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 (tx, chan_option) = {
4499 let mut channel_state_lock = self.channel_state.lock().unwrap();
4500 let channel_state = &mut *channel_state_lock;
4501 let per_peer_state = self.per_peer_state.read().unwrap();
4502 if let None = per_peer_state.get(counterparty_node_id) {
4503 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))
4505 let peer_state_mutex = per_peer_state.get(counterparty_node_id).unwrap();
4506 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4507 let peer_state = &mut *peer_state_lock;
4508 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
4509 hash_map::Entry::Occupied(mut chan_entry) => {
4510 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), chan_entry);
4511 if let Some(msg) = closing_signed {
4512 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
4513 node_id: counterparty_node_id.clone(),
4518 // We're done with this channel, we've got a signed closing transaction and
4519 // will send the closing_signed back to the remote peer upon return. This
4520 // also implies there are no pending HTLCs left on the channel, so we can
4521 // fully delete it from tracking (the channel monitor is still around to
4522 // watch for old state broadcasts)!
4523 (tx, Some(remove_channel!(self, chan_entry)))
4524 } else { (tx, None) }
4526 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))
4529 if let Some(broadcast_tx) = tx {
4530 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
4531 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
4533 if let Some(chan) = chan_option {
4534 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4535 let mut channel_state = self.channel_state.lock().unwrap();
4536 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4540 self.issue_channel_close_events(&chan, ClosureReason::CooperativeClosure);
4545 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
4546 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
4547 //determine the state of the payment based on our response/if we forward anything/the time
4548 //we take to respond. We should take care to avoid allowing such an attack.
4550 //TODO: There exists a further attack where a node may garble the onion data, forward it to
4551 //us repeatedly garbled in different ways, and compare our error messages, which are
4552 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
4553 //but we should prevent it anyway.
4555 let pending_forward_info = self.decode_update_add_htlc_onion(msg);
4556 let per_peer_state = self.per_peer_state.read().unwrap();
4557 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4558 if let None = peer_state_mutex_opt {
4559 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))
4561 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4562 let peer_state = &mut *peer_state_lock;
4563 match peer_state.channel_by_id.entry(msg.channel_id) {
4564 hash_map::Entry::Occupied(mut chan) => {
4566 let create_pending_htlc_status = |chan: &Channel<<K::Target as SignerProvider>::Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
4567 // If the update_add is completely bogus, the call will Err and we will close,
4568 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
4569 // want to reject the new HTLC and fail it backwards instead of forwarding.
4570 match pending_forward_info {
4571 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
4572 let reason = if (error_code & 0x1000) != 0 {
4573 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
4574 HTLCFailReason::reason(real_code, error_data)
4576 HTLCFailReason::from_failure_code(error_code)
4577 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
4578 let msg = msgs::UpdateFailHTLC {
4579 channel_id: msg.channel_id,
4580 htlc_id: msg.htlc_id,
4583 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
4585 _ => pending_forward_info
4588 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), chan);
4590 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))
4595 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
4596 let channel_lock = self.channel_state.lock().unwrap();
4597 let (htlc_source, forwarded_htlc_value) = {
4598 let per_peer_state = self.per_peer_state.read().unwrap();
4599 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4600 if let None = peer_state_mutex_opt {
4601 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));
4603 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4604 let peer_state = &mut *peer_state_lock;
4605 match peer_state.channel_by_id.entry(msg.channel_id) {
4606 hash_map::Entry::Occupied(mut chan) => {
4607 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), chan)
4609 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))
4612 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, msg.channel_id);
4616 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
4617 let per_peer_state = self.per_peer_state.read().unwrap();
4618 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4619 if let None = peer_state_mutex_opt {
4620 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));
4622 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4623 let peer_state = &mut *peer_state_lock;
4624 match peer_state.channel_by_id.entry(msg.channel_id) {
4625 hash_map::Entry::Occupied(mut chan) => {
4626 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan);
4628 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))
4633 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
4634 let per_peer_state = self.per_peer_state.read().unwrap();
4635 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4636 if let None = peer_state_mutex_opt {
4637 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))
4639 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4640 let peer_state = &mut *peer_state_lock;
4641 match peer_state.channel_by_id.entry(msg.channel_id) {
4642 hash_map::Entry::Occupied(mut chan) => {
4643 if (msg.failure_code & 0x8000) == 0 {
4644 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
4645 try_chan_entry!(self, Err(chan_err), chan);
4647 try_chan_entry!(self, chan.get_mut().update_fail_malformed_htlc(&msg, HTLCFailReason::reason(msg.failure_code, msg.sha256_of_onion.to_vec())), chan);
4650 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))
4654 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
4655 let mut channel_state_lock = self.channel_state.lock().unwrap();
4656 let channel_state = &mut *channel_state_lock;
4657 let per_peer_state = self.per_peer_state.read().unwrap();
4658 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4659 if let None = peer_state_mutex_opt {
4660 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))
4662 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4663 let peer_state = &mut *peer_state_lock;
4664 match peer_state.channel_by_id.entry(msg.channel_id) {
4665 hash_map::Entry::Occupied(mut chan) => {
4666 let (revoke_and_ack, commitment_signed, monitor_update) =
4667 match chan.get_mut().commitment_signed(&msg, &self.logger) {
4668 Err((None, e)) => try_chan_entry!(self, Err(e), chan),
4669 Err((Some(update), e)) => {
4670 assert!(chan.get().is_awaiting_monitor_update());
4671 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), update);
4672 try_chan_entry!(self, Err(e), chan);
4677 let update_res = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update);
4678 if let Err(e) = handle_monitor_update_res!(self, update_res, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some()) {
4682 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
4683 node_id: counterparty_node_id.clone(),
4684 msg: revoke_and_ack,
4686 if let Some(msg) = commitment_signed {
4687 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4688 node_id: counterparty_node_id.clone(),
4689 updates: msgs::CommitmentUpdate {
4690 update_add_htlcs: Vec::new(),
4691 update_fulfill_htlcs: Vec::new(),
4692 update_fail_htlcs: Vec::new(),
4693 update_fail_malformed_htlcs: Vec::new(),
4695 commitment_signed: msg,
4701 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))
4706 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
4707 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
4708 let mut forward_event = None;
4709 let mut new_intercept_events = Vec::new();
4710 let mut failed_intercept_forwards = Vec::new();
4711 if !pending_forwards.is_empty() {
4712 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
4713 let scid = match forward_info.routing {
4714 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
4715 PendingHTLCRouting::Receive { .. } => 0,
4716 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
4718 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
4719 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
4721 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
4722 let forward_htlcs_empty = forward_htlcs.is_empty();
4723 match forward_htlcs.entry(scid) {
4724 hash_map::Entry::Occupied(mut entry) => {
4725 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4726 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
4728 hash_map::Entry::Vacant(entry) => {
4729 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
4730 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.genesis_hash)
4732 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).into_inner());
4733 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
4734 match pending_intercepts.entry(intercept_id) {
4735 hash_map::Entry::Vacant(entry) => {
4736 new_intercept_events.push(events::Event::HTLCIntercepted {
4737 requested_next_hop_scid: scid,
4738 payment_hash: forward_info.payment_hash,
4739 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
4740 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
4743 entry.insert(PendingAddHTLCInfo {
4744 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
4746 hash_map::Entry::Occupied(_) => {
4747 log_info!(self.logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
4748 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4749 short_channel_id: prev_short_channel_id,
4750 outpoint: prev_funding_outpoint,
4751 htlc_id: prev_htlc_id,
4752 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
4753 phantom_shared_secret: None,
4756 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
4757 HTLCFailReason::from_failure_code(0x4000 | 10),
4758 HTLCDestination::InvalidForward { requested_forward_scid: scid },
4763 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
4764 // payments are being processed.
4765 if forward_htlcs_empty {
4766 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
4768 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4769 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
4776 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
4777 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4780 if !new_intercept_events.is_empty() {
4781 let mut events = self.pending_events.lock().unwrap();
4782 events.append(&mut new_intercept_events);
4785 match forward_event {
4787 let mut pending_events = self.pending_events.lock().unwrap();
4788 pending_events.push(events::Event::PendingHTLCsForwardable {
4789 time_forwardable: time
4797 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
4798 let mut htlcs_to_fail = Vec::new();
4800 let mut channel_state_lock = self.channel_state.lock().unwrap();
4801 let channel_state = &mut *channel_state_lock;
4802 let per_peer_state = self.per_peer_state.read().unwrap();
4803 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4804 if let None = peer_state_mutex_opt {
4805 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))
4807 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4808 let peer_state = &mut *peer_state_lock;
4809 match peer_state.channel_by_id.entry(msg.channel_id) {
4810 hash_map::Entry::Occupied(mut chan) => {
4811 let was_paused_for_mon_update = chan.get().is_awaiting_monitor_update();
4812 let raa_updates = break_chan_entry!(self,
4813 chan.get_mut().revoke_and_ack(&msg, &self.logger), chan);
4814 htlcs_to_fail = raa_updates.holding_cell_failed_htlcs;
4815 let update_res = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), raa_updates.monitor_update);
4816 if was_paused_for_mon_update {
4817 assert!(update_res != ChannelMonitorUpdateStatus::Completed);
4818 assert!(raa_updates.commitment_update.is_none());
4819 assert!(raa_updates.accepted_htlcs.is_empty());
4820 assert!(raa_updates.failed_htlcs.is_empty());
4821 assert!(raa_updates.finalized_claimed_htlcs.is_empty());
4822 break Err(MsgHandleErrInternal::ignore_no_close("Existing pending monitor update prevented responses to RAA".to_owned()));
4824 if update_res != ChannelMonitorUpdateStatus::Completed {
4825 if let Err(e) = handle_monitor_update_res!(self, update_res, chan,
4826 RAACommitmentOrder::CommitmentFirst, false,
4827 raa_updates.commitment_update.is_some(), false,
4828 raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
4829 raa_updates.finalized_claimed_htlcs) {
4831 } else { unreachable!(); }
4833 if let Some(updates) = raa_updates.commitment_update {
4834 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4835 node_id: counterparty_node_id.clone(),
4839 break Ok((raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
4840 raa_updates.finalized_claimed_htlcs,
4841 chan.get().get_short_channel_id()
4842 .unwrap_or(chan.get().outbound_scid_alias()),
4843 chan.get().get_funding_txo().unwrap(),
4844 chan.get().get_user_id()))
4846 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))
4849 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
4851 Ok((pending_forwards, mut pending_failures, finalized_claim_htlcs,
4852 short_channel_id, channel_outpoint, user_channel_id)) =>
4854 for failure in pending_failures.drain(..) {
4855 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: channel_outpoint.to_channel_id() };
4856 self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
4858 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, user_channel_id, pending_forwards)]);
4859 self.finalize_claims(finalized_claim_htlcs);
4866 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
4867 let per_peer_state = self.per_peer_state.read().unwrap();
4868 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4869 if let None = peer_state_mutex_opt {
4870 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));
4872 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4873 let peer_state = &mut *peer_state_lock;
4874 match peer_state.channel_by_id.entry(msg.channel_id) {
4875 hash_map::Entry::Occupied(mut chan) => {
4876 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg, &self.logger), chan);
4878 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))
4883 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
4884 let mut channel_state_lock = self.channel_state.lock().unwrap();
4885 let channel_state = &mut *channel_state_lock;
4886 let per_peer_state = self.per_peer_state.read().unwrap();
4887 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4888 if let None = peer_state_mutex_opt {
4889 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));
4891 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4892 let peer_state = &mut *peer_state_lock;
4893 match peer_state.channel_by_id.entry(msg.channel_id) {
4894 hash_map::Entry::Occupied(mut chan) => {
4895 if !chan.get().is_usable() {
4896 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
4899 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
4900 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(
4901 self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height(), msg), chan),
4902 // Note that announcement_signatures fails if the channel cannot be announced,
4903 // so get_channel_update_for_broadcast will never fail by the time we get here.
4904 update_msg: self.get_channel_update_for_broadcast(chan.get()).unwrap(),
4907 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))
4912 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
4913 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
4914 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
4915 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
4917 // It's not a local channel
4918 return Ok(NotifyOption::SkipPersist)
4921 let per_peer_state = self.per_peer_state.read().unwrap();
4922 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
4923 if let None = peer_state_mutex_opt {
4924 return Ok(NotifyOption::SkipPersist)
4926 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4927 let peer_state = &mut *peer_state_lock;
4928 match peer_state.channel_by_id.entry(chan_id) {
4929 hash_map::Entry::Occupied(mut chan) => {
4930 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4931 if chan.get().should_announce() {
4932 // If the announcement is about a channel of ours which is public, some
4933 // other peer may simply be forwarding all its gossip to us. Don't provide
4934 // a scary-looking error message and return Ok instead.
4935 return Ok(NotifyOption::SkipPersist);
4937 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));
4939 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().get_counterparty_node_id().serialize()[..];
4940 let msg_from_node_one = msg.contents.flags & 1 == 0;
4941 if were_node_one == msg_from_node_one {
4942 return Ok(NotifyOption::SkipPersist);
4944 log_debug!(self.logger, "Received channel_update for channel {}.", log_bytes!(chan_id));
4945 try_chan_entry!(self, chan.get_mut().channel_update(&msg), chan);
4948 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersist)
4950 Ok(NotifyOption::DoPersist)
4953 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
4955 let need_lnd_workaround = {
4956 let mut channel_state_lock = self.channel_state.lock().unwrap();
4957 let channel_state = &mut *channel_state_lock;
4958 let per_peer_state = self.per_peer_state.read().unwrap();
4960 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
4961 if let None = peer_state_mutex_opt {
4962 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));
4964 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4965 let peer_state = &mut *peer_state_lock;
4966 match peer_state.channel_by_id.entry(msg.channel_id) {
4967 hash_map::Entry::Occupied(mut chan) => {
4968 // Currently, we expect all holding cell update_adds to be dropped on peer
4969 // disconnect, so Channel's reestablish will never hand us any holding cell
4970 // freed HTLCs to fail backwards. If in the future we no longer drop pending
4971 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
4972 let responses = try_chan_entry!(self, chan.get_mut().channel_reestablish(
4973 msg, &self.logger, self.our_network_pubkey.clone(), self.genesis_hash,
4974 &*self.best_block.read().unwrap()), chan);
4975 let mut channel_update = None;
4976 if let Some(msg) = responses.shutdown_msg {
4977 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
4978 node_id: counterparty_node_id.clone(),
4981 } else if chan.get().is_usable() {
4982 // If the channel is in a usable state (ie the channel is not being shut
4983 // down), send a unicast channel_update to our counterparty to make sure
4984 // they have the latest channel parameters.
4985 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
4986 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
4987 node_id: chan.get().get_counterparty_node_id(),
4992 let need_lnd_workaround = chan.get_mut().workaround_lnd_bug_4006.take();
4993 htlc_forwards = self.handle_channel_resumption(
4994 &mut channel_state.pending_msg_events, chan.get_mut(), responses.raa, responses.commitment_update, responses.order,
4995 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
4996 if let Some(upd) = channel_update {
4997 channel_state.pending_msg_events.push(upd);
5001 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))
5005 if let Some(forwards) = htlc_forwards {
5006 self.forward_htlcs(&mut [forwards][..]);
5009 if let Some(channel_ready_msg) = need_lnd_workaround {
5010 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
5015 /// Process pending events from the `chain::Watch`, returning whether any events were processed.
5016 fn process_pending_monitor_events(&self) -> bool {
5017 let mut failed_channels = Vec::new();
5018 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
5019 let has_pending_monitor_events = !pending_monitor_events.is_empty();
5020 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
5021 for monitor_event in monitor_events.drain(..) {
5022 match monitor_event {
5023 MonitorEvent::HTLCEvent(htlc_update) => {
5024 if let Some(preimage) = htlc_update.payment_preimage {
5025 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
5026 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, funding_outpoint.to_channel_id());
5028 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
5029 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
5030 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
5031 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
5034 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
5035 MonitorEvent::UpdateFailed(funding_outpoint) => {
5036 let mut channel_lock = self.channel_state.lock().unwrap();
5037 let channel_state = &mut *channel_lock;
5038 let counterparty_node_id_opt = match counterparty_node_id {
5039 Some(cp_id) => Some(cp_id),
5041 // TODO: Once we can rely on the counterparty_node_id from the
5042 // monitor event, this and the id_to_peer map should be removed.
5043 let id_to_peer = self.id_to_peer.lock().unwrap();
5044 id_to_peer.get(&funding_outpoint.to_channel_id()).cloned()
5047 if let Some(counterparty_node_id) = counterparty_node_id_opt {
5048 let per_peer_state = self.per_peer_state.read().unwrap();
5049 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
5050 let pending_msg_events = &mut channel_state.pending_msg_events;
5051 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5052 let peer_state = &mut *peer_state_lock;
5053 if let hash_map::Entry::Occupied(chan_entry) = peer_state.channel_by_id.entry(funding_outpoint.to_channel_id()) {
5054 let mut chan = remove_channel!(self, chan_entry);
5055 failed_channels.push(chan.force_shutdown(false));
5056 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5057 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5061 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
5062 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
5064 ClosureReason::CommitmentTxConfirmed
5066 self.issue_channel_close_events(&chan, reason);
5067 pending_msg_events.push(events::MessageSendEvent::HandleError {
5068 node_id: chan.get_counterparty_node_id(),
5069 action: msgs::ErrorAction::SendErrorMessage {
5070 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
5077 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
5078 self.channel_monitor_updated(&funding_txo, monitor_update_id, counterparty_node_id.as_ref());
5084 for failure in failed_channels.drain(..) {
5085 self.finish_force_close_channel(failure);
5088 has_pending_monitor_events
5091 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
5092 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
5093 /// update events as a separate process method here.
5095 pub fn process_monitor_events(&self) {
5096 self.process_pending_monitor_events();
5099 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
5100 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
5101 /// update was applied.
5102 fn check_free_holding_cells(&self) -> bool {
5103 let mut has_monitor_update = false;
5104 let mut failed_htlcs = Vec::new();
5105 let mut handle_errors = Vec::new();
5107 let mut channel_state_lock = self.channel_state.lock().unwrap();
5108 let channel_state = &mut *channel_state_lock;
5109 let pending_msg_events = &mut channel_state.pending_msg_events;
5110 let per_peer_state = self.per_peer_state.read().unwrap();
5112 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5113 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5114 let peer_state = &mut *peer_state_lock;
5115 peer_state.channel_by_id.retain(|channel_id, chan| {
5116 match chan.maybe_free_holding_cell_htlcs(&self.logger) {
5117 Ok((commitment_opt, holding_cell_failed_htlcs)) => {
5118 if !holding_cell_failed_htlcs.is_empty() {
5120 holding_cell_failed_htlcs,
5122 chan.get_counterparty_node_id()
5125 if let Some((commitment_update, monitor_update)) = commitment_opt {
5126 match self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
5127 ChannelMonitorUpdateStatus::Completed => {
5128 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5129 node_id: chan.get_counterparty_node_id(),
5130 updates: commitment_update,
5134 has_monitor_update = true;
5135 let (res, close_channel) = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, channel_id, COMMITMENT_UPDATE_ONLY);
5136 handle_errors.push((chan.get_counterparty_node_id(), res));
5137 if close_channel { return false; }
5144 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
5145 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5146 // ChannelClosed event is generated by handle_error for us
5154 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
5155 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
5156 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
5159 for (counterparty_node_id, err) in handle_errors.drain(..) {
5160 let _ = handle_error!(self, err, counterparty_node_id);
5166 /// Check whether any channels have finished removing all pending updates after a shutdown
5167 /// exchange and can now send a closing_signed.
5168 /// Returns whether any closing_signed messages were generated.
5169 fn maybe_generate_initial_closing_signed(&self) -> bool {
5170 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
5171 let mut has_update = false;
5173 let mut channel_state_lock = self.channel_state.lock().unwrap();
5174 let channel_state = &mut *channel_state_lock;
5175 let pending_msg_events = &mut channel_state.pending_msg_events;
5176 let per_peer_state = self.per_peer_state.read().unwrap();
5178 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5179 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5180 let peer_state = &mut *peer_state_lock;
5181 peer_state.channel_by_id.retain(|channel_id, chan| {
5182 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
5183 Ok((msg_opt, tx_opt)) => {
5184 if let Some(msg) = msg_opt {
5186 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5187 node_id: chan.get_counterparty_node_id(), msg,
5190 if let Some(tx) = tx_opt {
5191 // We're done with this channel. We got a closing_signed and sent back
5192 // a closing_signed with a closing transaction to broadcast.
5193 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5194 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5199 self.issue_channel_close_events(chan, ClosureReason::CooperativeClosure);
5201 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
5202 self.tx_broadcaster.broadcast_transaction(&tx);
5203 update_maps_on_chan_removal!(self, chan);
5209 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
5210 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5218 for (counterparty_node_id, err) in handle_errors.drain(..) {
5219 let _ = handle_error!(self, err, counterparty_node_id);
5225 /// Handle a list of channel failures during a block_connected or block_disconnected call,
5226 /// pushing the channel monitor update (if any) to the background events queue and removing the
5228 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
5229 for mut failure in failed_channels.drain(..) {
5230 // Either a commitment transactions has been confirmed on-chain or
5231 // Channel::block_disconnected detected that the funding transaction has been
5232 // reorganized out of the main chain.
5233 // We cannot broadcast our latest local state via monitor update (as
5234 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
5235 // so we track the update internally and handle it when the user next calls
5236 // timer_tick_occurred, guaranteeing we're running normally.
5237 if let Some((funding_txo, update)) = failure.0.take() {
5238 assert_eq!(update.updates.len(), 1);
5239 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
5240 assert!(should_broadcast);
5241 } else { unreachable!(); }
5242 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
5244 self.finish_force_close_channel(failure);
5248 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> {
5249 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
5251 if min_value_msat.is_some() && min_value_msat.unwrap() > MAX_VALUE_MSAT {
5252 return Err(APIError::APIMisuseError { err: format!("min_value_msat of {} greater than total 21 million bitcoin supply", min_value_msat.unwrap()) });
5255 let payment_secret = PaymentSecret(self.keys_manager.get_secure_random_bytes());
5257 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5258 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5259 match payment_secrets.entry(payment_hash) {
5260 hash_map::Entry::Vacant(e) => {
5261 e.insert(PendingInboundPayment {
5262 payment_secret, min_value_msat, payment_preimage,
5263 user_payment_id: 0, // For compatibility with version 0.0.103 and earlier
5264 // We assume that highest_seen_timestamp is pretty close to the current time -
5265 // it's updated when we receive a new block with the maximum time we've seen in
5266 // a header. It should never be more than two hours in the future.
5267 // Thus, we add two hours here as a buffer to ensure we absolutely
5268 // never fail a payment too early.
5269 // Note that we assume that received blocks have reasonably up-to-date
5271 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
5274 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
5279 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
5282 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
5283 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
5285 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
5286 /// will have the [`PaymentClaimable::payment_preimage`] field filled in. That should then be
5287 /// passed directly to [`claim_funds`].
5289 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
5291 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5292 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5296 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5297 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5299 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5301 /// [`claim_funds`]: Self::claim_funds
5302 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
5303 /// [`PaymentClaimable::payment_preimage`]: events::Event::PaymentClaimable::payment_preimage
5304 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5305 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), ()> {
5306 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs, &self.keys_manager, self.highest_seen_timestamp.load(Ordering::Acquire) as u64)
5309 /// Legacy version of [`create_inbound_payment`]. Use this method if you wish to share
5310 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5312 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5315 /// This method is deprecated and will be removed soon.
5317 /// [`create_inbound_payment`]: Self::create_inbound_payment
5319 pub fn create_inbound_payment_legacy(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), APIError> {
5320 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
5321 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
5322 let payment_secret = self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs)?;
5323 Ok((payment_hash, payment_secret))
5326 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
5327 /// stored external to LDK.
5329 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
5330 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
5331 /// the `min_value_msat` provided here, if one is provided.
5333 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
5334 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
5337 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
5338 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
5339 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
5340 /// sender "proof-of-payment" unless they have paid the required amount.
5342 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
5343 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
5344 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
5345 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
5346 /// invoices when no timeout is set.
5348 /// Note that we use block header time to time-out pending inbound payments (with some margin
5349 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
5350 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
5351 /// If you need exact expiry semantics, you should enforce them upon receipt of
5352 /// [`PaymentClaimable`].
5354 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
5355 /// set to at least [`MIN_FINAL_CLTV_EXPIRY`].
5357 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5358 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5362 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5363 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5365 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5367 /// [`create_inbound_payment`]: Self::create_inbound_payment
5368 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
5369 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<PaymentSecret, ()> {
5370 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash, invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64)
5373 /// Legacy version of [`create_inbound_payment_for_hash`]. Use this method if you wish to share
5374 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5376 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5379 /// This method is deprecated and will be removed soon.
5381 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5383 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> {
5384 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
5387 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
5388 /// previously returned from [`create_inbound_payment`].
5390 /// [`create_inbound_payment`]: Self::create_inbound_payment
5391 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
5392 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
5395 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
5396 /// are used when constructing the phantom invoice's route hints.
5398 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5399 pub fn get_phantom_scid(&self) -> u64 {
5400 let best_block_height = self.best_block.read().unwrap().height();
5401 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
5403 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
5404 // Ensure the generated scid doesn't conflict with a real channel.
5405 match short_to_chan_info.get(&scid_candidate) {
5406 Some(_) => continue,
5407 None => return scid_candidate
5412 /// Gets route hints for use in receiving [phantom node payments].
5414 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5415 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
5417 channels: self.list_usable_channels(),
5418 phantom_scid: self.get_phantom_scid(),
5419 real_node_pubkey: self.get_our_node_id(),
5423 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
5424 /// used when constructing the route hints for HTLCs intended to be intercepted. See
5425 /// [`ChannelManager::forward_intercepted_htlc`].
5427 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
5428 /// times to get a unique scid.
5429 pub fn get_intercept_scid(&self) -> u64 {
5430 let best_block_height = self.best_block.read().unwrap().height();
5431 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
5433 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
5434 // Ensure the generated scid doesn't conflict with a real channel.
5435 if short_to_chan_info.contains_key(&scid_candidate) { continue }
5436 return scid_candidate
5440 /// Gets inflight HTLC information by processing pending outbound payments that are in
5441 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
5442 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
5443 let mut inflight_htlcs = InFlightHtlcs::new();
5445 let per_peer_state = self.per_peer_state.read().unwrap();
5446 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5447 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5448 let peer_state = &mut *peer_state_lock;
5449 for chan in peer_state.channel_by_id.values() {
5450 for (htlc_source, _) in chan.inflight_htlc_sources() {
5451 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
5452 inflight_htlcs.process_path(path, self.get_our_node_id());
5461 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
5462 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
5463 let events = core::cell::RefCell::new(Vec::new());
5464 let event_handler = |event: events::Event| events.borrow_mut().push(event);
5465 self.process_pending_events(&event_handler);
5470 pub fn pop_pending_event(&self) -> Option<events::Event> {
5471 let mut events = self.pending_events.lock().unwrap();
5472 if events.is_empty() { None } else { Some(events.remove(0)) }
5476 pub fn has_pending_payments(&self) -> bool {
5477 self.pending_outbound_payments.has_pending_payments()
5481 pub fn clear_pending_payments(&self) {
5482 self.pending_outbound_payments.clear_pending_payments()
5485 /// Processes any events asynchronously in the order they were generated since the last call
5486 /// using the given event handler.
5488 /// See the trait-level documentation of [`EventsProvider`] for requirements.
5489 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
5492 // We'll acquire our total consistency lock until the returned future completes so that
5493 // we can be sure no other persists happen while processing events.
5494 let _read_guard = self.total_consistency_lock.read().unwrap();
5496 let mut result = NotifyOption::SkipPersist;
5498 // TODO: This behavior should be documented. It's unintuitive that we query
5499 // ChannelMonitors when clearing other events.
5500 if self.process_pending_monitor_events() {
5501 result = NotifyOption::DoPersist;
5504 let pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5505 if !pending_events.is_empty() {
5506 result = NotifyOption::DoPersist;
5509 for event in pending_events {
5510 handler(event).await;
5513 if result == NotifyOption::DoPersist {
5514 self.persistence_notifier.notify();
5519 impl<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<M, T, K, F, R, L>
5521 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
5522 T::Target: BroadcasterInterface,
5523 K::Target: KeysInterface,
5524 F::Target: FeeEstimator,
5528 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
5529 let events = RefCell::new(Vec::new());
5530 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5531 let mut result = NotifyOption::SkipPersist;
5533 // TODO: This behavior should be documented. It's unintuitive that we query
5534 // ChannelMonitors when clearing other events.
5535 if self.process_pending_monitor_events() {
5536 result = NotifyOption::DoPersist;
5539 if self.check_free_holding_cells() {
5540 result = NotifyOption::DoPersist;
5542 if self.maybe_generate_initial_closing_signed() {
5543 result = NotifyOption::DoPersist;
5546 let mut pending_events = Vec::new();
5547 let mut channel_state = self.channel_state.lock().unwrap();
5548 mem::swap(&mut pending_events, &mut channel_state.pending_msg_events);
5550 if !pending_events.is_empty() {
5551 events.replace(pending_events);
5560 impl<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref> EventsProvider for ChannelManager<M, T, K, F, R, L>
5562 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
5563 T::Target: BroadcasterInterface,
5564 K::Target: KeysInterface,
5565 F::Target: FeeEstimator,
5569 /// Processes events that must be periodically handled.
5571 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
5572 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
5573 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
5574 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5575 let mut result = NotifyOption::SkipPersist;
5577 // TODO: This behavior should be documented. It's unintuitive that we query
5578 // ChannelMonitors when clearing other events.
5579 if self.process_pending_monitor_events() {
5580 result = NotifyOption::DoPersist;
5583 let pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5584 if !pending_events.is_empty() {
5585 result = NotifyOption::DoPersist;
5588 for event in pending_events {
5589 handler.handle_event(event);
5597 impl<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref> chain::Listen for ChannelManager<M, T, K, F, R, L>
5599 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
5600 T::Target: BroadcasterInterface,
5601 K::Target: KeysInterface,
5602 F::Target: FeeEstimator,
5606 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5608 let best_block = self.best_block.read().unwrap();
5609 assert_eq!(best_block.block_hash(), header.prev_blockhash,
5610 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
5611 assert_eq!(best_block.height(), height - 1,
5612 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
5615 self.transactions_confirmed(header, txdata, height);
5616 self.best_block_updated(header, height);
5619 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
5620 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5621 let new_height = height - 1;
5623 let mut best_block = self.best_block.write().unwrap();
5624 assert_eq!(best_block.block_hash(), header.block_hash(),
5625 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
5626 assert_eq!(best_block.height(), height,
5627 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
5628 *best_block = BestBlock::new(header.prev_blockhash, new_height)
5631 self.do_chain_event(Some(new_height), |channel| channel.best_block_updated(new_height, header.time, self.genesis_hash.clone(), self.get_our_node_id(), &self.logger));
5635 impl<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref> chain::Confirm for ChannelManager<M, T, K, F, R, L>
5637 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
5638 T::Target: BroadcasterInterface,
5639 K::Target: KeysInterface,
5640 F::Target: FeeEstimator,
5644 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5645 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5646 // during initialization prior to the chain_monitor being fully configured in some cases.
5647 // See the docs for `ChannelManagerReadArgs` for more.
5649 let block_hash = header.block_hash();
5650 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
5652 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5653 self.do_chain_event(Some(height), |channel| channel.transactions_confirmed(&block_hash, height, txdata, self.genesis_hash.clone(), self.get_our_node_id(), &self.logger)
5654 .map(|(a, b)| (a, Vec::new(), b)));
5656 let last_best_block_height = self.best_block.read().unwrap().height();
5657 if height < last_best_block_height {
5658 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
5659 self.do_chain_event(Some(last_best_block_height), |channel| channel.best_block_updated(last_best_block_height, timestamp as u32, self.genesis_hash.clone(), self.get_our_node_id(), &self.logger));
5663 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
5664 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5665 // during initialization prior to the chain_monitor being fully configured in some cases.
5666 // See the docs for `ChannelManagerReadArgs` for more.
5668 let block_hash = header.block_hash();
5669 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
5671 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5673 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
5675 self.do_chain_event(Some(height), |channel| channel.best_block_updated(height, header.time, self.genesis_hash.clone(), self.get_our_node_id(), &self.logger));
5677 macro_rules! max_time {
5678 ($timestamp: expr) => {
5680 // Update $timestamp to be the max of its current value and the block
5681 // timestamp. This should keep us close to the current time without relying on
5682 // having an explicit local time source.
5683 // Just in case we end up in a race, we loop until we either successfully
5684 // update $timestamp or decide we don't need to.
5685 let old_serial = $timestamp.load(Ordering::Acquire);
5686 if old_serial >= header.time as usize { break; }
5687 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
5693 max_time!(self.highest_seen_timestamp);
5694 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5695 payment_secrets.retain(|_, inbound_payment| {
5696 inbound_payment.expiry_time > header.time as u64
5700 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
5701 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
5702 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
5703 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5704 let peer_state = &mut *peer_state_lock;
5705 for chan in peer_state.channel_by_id.values() {
5706 if let (Some(funding_txo), block_hash) = (chan.get_funding_txo(), chan.get_funding_tx_confirmed_in()) {
5707 res.push((funding_txo.txid, block_hash));
5714 fn transaction_unconfirmed(&self, txid: &Txid) {
5715 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5716 self.do_chain_event(None, |channel| {
5717 if let Some(funding_txo) = channel.get_funding_txo() {
5718 if funding_txo.txid == *txid {
5719 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
5720 } else { Ok((None, Vec::new(), None)) }
5721 } else { Ok((None, Vec::new(), None)) }
5726 impl<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref> ChannelManager<M, T, K, F, R, L>
5728 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
5729 T::Target: BroadcasterInterface,
5730 K::Target: KeysInterface,
5731 F::Target: FeeEstimator,
5735 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
5736 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
5738 fn do_chain_event<FN: Fn(&mut Channel<<K::Target as SignerProvider>::Signer>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
5739 (&self, height_opt: Option<u32>, f: FN) {
5740 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5741 // during initialization prior to the chain_monitor being fully configured in some cases.
5742 // See the docs for `ChannelManagerReadArgs` for more.
5744 let mut failed_channels = Vec::new();
5745 let mut timed_out_htlcs = Vec::new();
5747 let mut channel_lock = self.channel_state.lock().unwrap();
5748 let channel_state = &mut *channel_lock;
5749 let pending_msg_events = &mut channel_state.pending_msg_events;
5750 let per_peer_state = self.per_peer_state.read().unwrap();
5751 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5752 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5753 let peer_state = &mut *peer_state_lock;
5754 peer_state.channel_by_id.retain(|_, channel| {
5755 let res = f(channel);
5756 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
5757 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
5758 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
5759 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
5760 HTLCDestination::NextHopChannel { node_id: Some(channel.get_counterparty_node_id()), channel_id: channel.channel_id() }));
5762 if let Some(channel_ready) = channel_ready_opt {
5763 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
5764 if channel.is_usable() {
5765 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", log_bytes!(channel.channel_id()));
5766 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
5767 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
5768 node_id: channel.get_counterparty_node_id(),
5773 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", log_bytes!(channel.channel_id()));
5777 emit_channel_ready_event!(self, channel);
5779 if let Some(announcement_sigs) = announcement_sigs {
5780 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(channel.channel_id()));
5781 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5782 node_id: channel.get_counterparty_node_id(),
5783 msg: announcement_sigs,
5785 if let Some(height) = height_opt {
5786 if let Some(announcement) = channel.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash, height) {
5787 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5789 // Note that announcement_signatures fails if the channel cannot be announced,
5790 // so get_channel_update_for_broadcast will never fail by the time we get here.
5791 update_msg: self.get_channel_update_for_broadcast(channel).unwrap(),
5796 if channel.is_our_channel_ready() {
5797 if let Some(real_scid) = channel.get_short_channel_id() {
5798 // If we sent a 0conf channel_ready, and now have an SCID, we add it
5799 // to the short_to_chan_info map here. Note that we check whether we
5800 // can relay using the real SCID at relay-time (i.e.
5801 // enforce option_scid_alias then), and if the funding tx is ever
5802 // un-confirmed we force-close the channel, ensuring short_to_chan_info
5803 // is always consistent.
5804 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
5805 let scid_insert = short_to_chan_info.insert(real_scid, (channel.get_counterparty_node_id(), channel.channel_id()));
5806 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.get_counterparty_node_id(), channel.channel_id()),
5807 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
5808 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
5811 } else if let Err(reason) = res {
5812 update_maps_on_chan_removal!(self, channel);
5813 // It looks like our counterparty went on-chain or funding transaction was
5814 // reorged out of the main chain. Close the channel.
5815 failed_channels.push(channel.force_shutdown(true));
5816 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
5817 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5821 let reason_message = format!("{}", reason);
5822 self.issue_channel_close_events(channel, reason);
5823 pending_msg_events.push(events::MessageSendEvent::HandleError {
5824 node_id: channel.get_counterparty_node_id(),
5825 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
5826 channel_id: channel.channel_id(),
5827 data: reason_message,
5837 if let Some(height) = height_opt {
5838 self.claimable_payments.lock().unwrap().claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
5839 htlcs.retain(|htlc| {
5840 // If height is approaching the number of blocks we think it takes us to get
5841 // our commitment transaction confirmed before the HTLC expires, plus the
5842 // number of blocks we generally consider it to take to do a commitment update,
5843 // just give up on it and fail the HTLC.
5844 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
5845 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5846 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
5848 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
5849 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
5850 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
5854 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
5857 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
5858 intercepted_htlcs.retain(|_, htlc| {
5859 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
5860 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
5861 short_channel_id: htlc.prev_short_channel_id,
5862 htlc_id: htlc.prev_htlc_id,
5863 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
5864 phantom_shared_secret: None,
5865 outpoint: htlc.prev_funding_outpoint,
5868 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
5869 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
5870 _ => unreachable!(),
5872 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
5873 HTLCFailReason::from_failure_code(0x2000 | 2),
5874 HTLCDestination::InvalidForward { requested_forward_scid }));
5875 log_trace!(self.logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
5881 self.handle_init_event_channel_failures(failed_channels);
5883 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
5884 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
5888 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
5889 /// indicating whether persistence is necessary. Only one listener on
5890 /// [`await_persistable_update`], [`await_persistable_update_timeout`], or a future returned by
5891 /// [`get_persistable_update_future`] is guaranteed to be woken up.
5893 /// Note that this method is not available with the `no-std` feature.
5895 /// [`await_persistable_update`]: Self::await_persistable_update
5896 /// [`await_persistable_update_timeout`]: Self::await_persistable_update_timeout
5897 /// [`get_persistable_update_future`]: Self::get_persistable_update_future
5898 #[cfg(any(test, feature = "std"))]
5899 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
5900 self.persistence_notifier.wait_timeout(max_wait)
5903 /// Blocks until ChannelManager needs to be persisted. Only one listener on
5904 /// [`await_persistable_update`], `await_persistable_update_timeout`, or a future returned by
5905 /// [`get_persistable_update_future`] is guaranteed to be woken up.
5907 /// [`await_persistable_update`]: Self::await_persistable_update
5908 /// [`get_persistable_update_future`]: Self::get_persistable_update_future
5909 pub fn await_persistable_update(&self) {
5910 self.persistence_notifier.wait()
5913 /// Gets a [`Future`] that completes when a persistable update is available. Note that
5914 /// callbacks registered on the [`Future`] MUST NOT call back into this [`ChannelManager`] and
5915 /// should instead register actions to be taken later.
5916 pub fn get_persistable_update_future(&self) -> Future {
5917 self.persistence_notifier.get_future()
5920 #[cfg(any(test, feature = "_test_utils"))]
5921 pub fn get_persistence_condvar_value(&self) -> bool {
5922 self.persistence_notifier.notify_pending()
5925 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
5926 /// [`chain::Confirm`] interfaces.
5927 pub fn current_best_block(&self) -> BestBlock {
5928 self.best_block.read().unwrap().clone()
5932 impl<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref>
5933 ChannelMessageHandler for ChannelManager<M, T, K, F, R, L>
5935 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
5936 T::Target: BroadcasterInterface,
5937 K::Target: KeysInterface,
5938 F::Target: FeeEstimator,
5942 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
5943 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5944 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
5947 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
5948 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5949 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
5952 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
5953 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5954 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
5957 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
5958 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5959 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
5962 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
5963 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5964 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
5967 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) {
5968 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5969 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, their_features, msg), *counterparty_node_id);
5972 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
5973 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5974 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
5977 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
5978 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5979 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
5982 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
5983 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5984 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
5987 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
5988 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5989 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
5992 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
5993 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5994 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
5997 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
5998 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5999 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
6002 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
6003 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6004 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
6007 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
6008 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6009 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
6012 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
6013 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6014 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
6017 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
6018 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
6019 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
6022 NotifyOption::SkipPersist
6027 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
6028 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6029 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
6032 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
6033 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6034 let mut failed_channels = Vec::new();
6035 let mut no_channels_remain = true;
6036 let mut channel_state = self.channel_state.lock().unwrap();
6037 let mut per_peer_state = self.per_peer_state.write().unwrap();
6039 let pending_msg_events = &mut channel_state.pending_msg_events;
6040 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates. We believe we {} make future connections to this peer.",
6041 log_pubkey!(counterparty_node_id), if no_connection_possible { "cannot" } else { "can" });
6042 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
6043 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6044 let peer_state = &mut *peer_state_lock;
6045 peer_state.channel_by_id.retain(|_, chan| {
6046 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
6047 if chan.is_shutdown() {
6048 update_maps_on_chan_removal!(self, chan);
6049 self.issue_channel_close_events(chan, ClosureReason::DisconnectedPeer);
6052 no_channels_remain = false;
6057 pending_msg_events.retain(|msg| {
6059 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != counterparty_node_id,
6060 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != counterparty_node_id,
6061 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != counterparty_node_id,
6062 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != counterparty_node_id,
6063 &events::MessageSendEvent::SendChannelReady { ref node_id, .. } => node_id != counterparty_node_id,
6064 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != counterparty_node_id,
6065 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != counterparty_node_id,
6066 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != counterparty_node_id,
6067 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != counterparty_node_id,
6068 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != counterparty_node_id,
6069 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != counterparty_node_id,
6070 &events::MessageSendEvent::SendChannelAnnouncement { ref node_id, .. } => node_id != counterparty_node_id,
6071 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
6072 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
6073 &events::MessageSendEvent::SendChannelUpdate { ref node_id, .. } => node_id != counterparty_node_id,
6074 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != counterparty_node_id,
6075 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
6076 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
6077 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
6078 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
6081 mem::drop(channel_state);
6083 if no_channels_remain {
6084 per_peer_state.remove(counterparty_node_id);
6086 mem::drop(per_peer_state);
6088 for failure in failed_channels.drain(..) {
6089 self.finish_force_close_channel(failure);
6093 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) -> Result<(), ()> {
6094 if !init_msg.features.supports_static_remote_key() {
6095 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(counterparty_node_id));
6099 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
6101 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6104 let mut peer_state_lock = self.per_peer_state.write().unwrap();
6105 match peer_state_lock.entry(counterparty_node_id.clone()) {
6106 hash_map::Entry::Vacant(e) => {
6107 e.insert(Mutex::new(PeerState {
6108 channel_by_id: HashMap::new(),
6109 latest_features: init_msg.features.clone(),
6112 hash_map::Entry::Occupied(e) => {
6113 e.get().lock().unwrap().latest_features = init_msg.features.clone();
6118 let mut channel_state_lock = self.channel_state.lock().unwrap();
6119 let channel_state = &mut *channel_state_lock;
6120 let pending_msg_events = &mut channel_state.pending_msg_events;
6121 let per_peer_state = self.per_peer_state.read().unwrap();
6123 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6124 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6125 let peer_state = &mut *peer_state_lock;
6126 peer_state.channel_by_id.retain(|_, chan| {
6127 let retain = if chan.get_counterparty_node_id() == *counterparty_node_id {
6128 if !chan.have_received_message() {
6129 // If we created this (outbound) channel while we were disconnected from the
6130 // peer we probably failed to send the open_channel message, which is now
6131 // lost. We can't have had anything pending related to this channel, so we just
6135 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
6136 node_id: chan.get_counterparty_node_id(),
6137 msg: chan.get_channel_reestablish(&self.logger),
6142 if retain && chan.get_counterparty_node_id() != *counterparty_node_id {
6143 if let Some(msg) = chan.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height()) {
6144 if let Ok(update_msg) = self.get_channel_update_for_broadcast(chan) {
6145 pending_msg_events.push(events::MessageSendEvent::SendChannelAnnouncement {
6146 node_id: *counterparty_node_id,
6155 //TODO: Also re-broadcast announcement_signatures
6159 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
6160 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6162 if msg.channel_id == [0; 32] {
6163 for chan in self.list_channels() {
6164 if chan.counterparty.node_id == *counterparty_node_id {
6165 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6166 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data), true);
6171 // First check if we can advance the channel type and try again.
6172 let mut channel_state = self.channel_state.lock().unwrap();
6173 let per_peer_state = self.per_peer_state.read().unwrap();
6174 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
6175 if let None = peer_state_mutex_opt { return; }
6176 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
6177 let peer_state = &mut *peer_state_lock;
6178 if let Some(chan) = peer_state.channel_by_id.get_mut(&msg.channel_id) {
6179 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash) {
6180 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
6181 node_id: *counterparty_node_id,
6189 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6190 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
6194 fn provided_node_features(&self) -> NodeFeatures {
6195 provided_node_features()
6198 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
6199 provided_init_features()
6203 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
6204 /// [`ChannelManager`].
6205 pub fn provided_node_features() -> NodeFeatures {
6206 provided_init_features().to_context()
6209 /// Fetches the set of [`InvoiceFeatures`] flags which are provided by or required by
6210 /// [`ChannelManager`].
6212 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
6213 /// or not. Thus, this method is not public.
6214 #[cfg(any(feature = "_test_utils", test))]
6215 pub fn provided_invoice_features() -> InvoiceFeatures {
6216 provided_init_features().to_context()
6219 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
6220 /// [`ChannelManager`].
6221 pub fn provided_channel_features() -> ChannelFeatures {
6222 provided_init_features().to_context()
6225 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
6226 /// [`ChannelManager`].
6227 pub fn provided_init_features() -> InitFeatures {
6228 // Note that if new features are added here which other peers may (eventually) require, we
6229 // should also add the corresponding (optional) bit to the ChannelMessageHandler impl for
6230 // ErroringMessageHandler.
6231 let mut features = InitFeatures::empty();
6232 features.set_data_loss_protect_optional();
6233 features.set_upfront_shutdown_script_optional();
6234 features.set_variable_length_onion_required();
6235 features.set_static_remote_key_required();
6236 features.set_payment_secret_required();
6237 features.set_basic_mpp_optional();
6238 features.set_wumbo_optional();
6239 features.set_shutdown_any_segwit_optional();
6240 features.set_channel_type_optional();
6241 features.set_scid_privacy_optional();
6242 features.set_zero_conf_optional();
6246 const SERIALIZATION_VERSION: u8 = 1;
6247 const MIN_SERIALIZATION_VERSION: u8 = 1;
6249 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
6250 (2, fee_base_msat, required),
6251 (4, fee_proportional_millionths, required),
6252 (6, cltv_expiry_delta, required),
6255 impl_writeable_tlv_based!(ChannelCounterparty, {
6256 (2, node_id, required),
6257 (4, features, required),
6258 (6, unspendable_punishment_reserve, required),
6259 (8, forwarding_info, option),
6260 (9, outbound_htlc_minimum_msat, option),
6261 (11, outbound_htlc_maximum_msat, option),
6264 impl Writeable for ChannelDetails {
6265 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6266 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
6267 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
6268 let user_channel_id_low = self.user_channel_id as u64;
6269 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
6270 write_tlv_fields!(writer, {
6271 (1, self.inbound_scid_alias, option),
6272 (2, self.channel_id, required),
6273 (3, self.channel_type, option),
6274 (4, self.counterparty, required),
6275 (5, self.outbound_scid_alias, option),
6276 (6, self.funding_txo, option),
6277 (7, self.config, option),
6278 (8, self.short_channel_id, option),
6279 (9, self.confirmations, option),
6280 (10, self.channel_value_satoshis, required),
6281 (12, self.unspendable_punishment_reserve, option),
6282 (14, user_channel_id_low, required),
6283 (16, self.balance_msat, required),
6284 (18, self.outbound_capacity_msat, required),
6285 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6286 // filled in, so we can safely unwrap it here.
6287 (19, self.next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6288 (20, self.inbound_capacity_msat, required),
6289 (22, self.confirmations_required, option),
6290 (24, self.force_close_spend_delay, option),
6291 (26, self.is_outbound, required),
6292 (28, self.is_channel_ready, required),
6293 (30, self.is_usable, required),
6294 (32, self.is_public, required),
6295 (33, self.inbound_htlc_minimum_msat, option),
6296 (35, self.inbound_htlc_maximum_msat, option),
6297 (37, user_channel_id_high_opt, option),
6303 impl Readable for ChannelDetails {
6304 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6305 init_and_read_tlv_fields!(reader, {
6306 (1, inbound_scid_alias, option),
6307 (2, channel_id, required),
6308 (3, channel_type, option),
6309 (4, counterparty, required),
6310 (5, outbound_scid_alias, option),
6311 (6, funding_txo, option),
6312 (7, config, option),
6313 (8, short_channel_id, option),
6314 (9, confirmations, option),
6315 (10, channel_value_satoshis, required),
6316 (12, unspendable_punishment_reserve, option),
6317 (14, user_channel_id_low, required),
6318 (16, balance_msat, required),
6319 (18, outbound_capacity_msat, required),
6320 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6321 // filled in, so we can safely unwrap it here.
6322 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6323 (20, inbound_capacity_msat, required),
6324 (22, confirmations_required, option),
6325 (24, force_close_spend_delay, option),
6326 (26, is_outbound, required),
6327 (28, is_channel_ready, required),
6328 (30, is_usable, required),
6329 (32, is_public, required),
6330 (33, inbound_htlc_minimum_msat, option),
6331 (35, inbound_htlc_maximum_msat, option),
6332 (37, user_channel_id_high_opt, option),
6335 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
6336 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
6337 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
6338 let user_channel_id = user_channel_id_low as u128 +
6339 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
6343 channel_id: channel_id.0.unwrap(),
6345 counterparty: counterparty.0.unwrap(),
6346 outbound_scid_alias,
6350 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
6351 unspendable_punishment_reserve,
6353 balance_msat: balance_msat.0.unwrap(),
6354 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
6355 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
6356 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
6357 confirmations_required,
6359 force_close_spend_delay,
6360 is_outbound: is_outbound.0.unwrap(),
6361 is_channel_ready: is_channel_ready.0.unwrap(),
6362 is_usable: is_usable.0.unwrap(),
6363 is_public: is_public.0.unwrap(),
6364 inbound_htlc_minimum_msat,
6365 inbound_htlc_maximum_msat,
6370 impl_writeable_tlv_based!(PhantomRouteHints, {
6371 (2, channels, vec_type),
6372 (4, phantom_scid, required),
6373 (6, real_node_pubkey, required),
6376 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
6378 (0, onion_packet, required),
6379 (2, short_channel_id, required),
6382 (0, payment_data, required),
6383 (1, phantom_shared_secret, option),
6384 (2, incoming_cltv_expiry, required),
6386 (2, ReceiveKeysend) => {
6387 (0, payment_preimage, required),
6388 (2, incoming_cltv_expiry, required),
6392 impl_writeable_tlv_based!(PendingHTLCInfo, {
6393 (0, routing, required),
6394 (2, incoming_shared_secret, required),
6395 (4, payment_hash, required),
6396 (6, outgoing_amt_msat, required),
6397 (8, outgoing_cltv_value, required),
6398 (9, incoming_amt_msat, option),
6402 impl Writeable for HTLCFailureMsg {
6403 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6405 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
6407 channel_id.write(writer)?;
6408 htlc_id.write(writer)?;
6409 reason.write(writer)?;
6411 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6412 channel_id, htlc_id, sha256_of_onion, failure_code
6415 channel_id.write(writer)?;
6416 htlc_id.write(writer)?;
6417 sha256_of_onion.write(writer)?;
6418 failure_code.write(writer)?;
6425 impl Readable for HTLCFailureMsg {
6426 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6427 let id: u8 = Readable::read(reader)?;
6430 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
6431 channel_id: Readable::read(reader)?,
6432 htlc_id: Readable::read(reader)?,
6433 reason: Readable::read(reader)?,
6437 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6438 channel_id: Readable::read(reader)?,
6439 htlc_id: Readable::read(reader)?,
6440 sha256_of_onion: Readable::read(reader)?,
6441 failure_code: Readable::read(reader)?,
6444 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
6445 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
6446 // messages contained in the variants.
6447 // In version 0.0.101, support for reading the variants with these types was added, and
6448 // we should migrate to writing these variants when UpdateFailHTLC or
6449 // UpdateFailMalformedHTLC get TLV fields.
6451 let length: BigSize = Readable::read(reader)?;
6452 let mut s = FixedLengthReader::new(reader, length.0);
6453 let res = Readable::read(&mut s)?;
6454 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6455 Ok(HTLCFailureMsg::Relay(res))
6458 let length: BigSize = Readable::read(reader)?;
6459 let mut s = FixedLengthReader::new(reader, length.0);
6460 let res = Readable::read(&mut s)?;
6461 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6462 Ok(HTLCFailureMsg::Malformed(res))
6464 _ => Err(DecodeError::UnknownRequiredFeature),
6469 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
6474 impl_writeable_tlv_based!(HTLCPreviousHopData, {
6475 (0, short_channel_id, required),
6476 (1, phantom_shared_secret, option),
6477 (2, outpoint, required),
6478 (4, htlc_id, required),
6479 (6, incoming_packet_shared_secret, required)
6482 impl Writeable for ClaimableHTLC {
6483 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6484 let (payment_data, keysend_preimage) = match &self.onion_payload {
6485 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
6486 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
6488 write_tlv_fields!(writer, {
6489 (0, self.prev_hop, required),
6490 (1, self.total_msat, required),
6491 (2, self.value, required),
6492 (4, payment_data, option),
6493 (6, self.cltv_expiry, required),
6494 (8, keysend_preimage, option),
6500 impl Readable for ClaimableHTLC {
6501 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6502 let mut prev_hop = crate::util::ser::OptionDeserWrapper(None);
6504 let mut payment_data: Option<msgs::FinalOnionHopData> = None;
6505 let mut cltv_expiry = 0;
6506 let mut total_msat = None;
6507 let mut keysend_preimage: Option<PaymentPreimage> = None;
6508 read_tlv_fields!(reader, {
6509 (0, prev_hop, required),
6510 (1, total_msat, option),
6511 (2, value, required),
6512 (4, payment_data, option),
6513 (6, cltv_expiry, required),
6514 (8, keysend_preimage, option)
6516 let onion_payload = match keysend_preimage {
6518 if payment_data.is_some() {
6519 return Err(DecodeError::InvalidValue)
6521 if total_msat.is_none() {
6522 total_msat = Some(value);
6524 OnionPayload::Spontaneous(p)
6527 if total_msat.is_none() {
6528 if payment_data.is_none() {
6529 return Err(DecodeError::InvalidValue)
6531 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
6533 OnionPayload::Invoice { _legacy_hop_data: payment_data }
6537 prev_hop: prev_hop.0.unwrap(),
6540 total_msat: total_msat.unwrap(),
6547 impl Readable for HTLCSource {
6548 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6549 let id: u8 = Readable::read(reader)?;
6552 let mut session_priv: crate::util::ser::OptionDeserWrapper<SecretKey> = crate::util::ser::OptionDeserWrapper(None);
6553 let mut first_hop_htlc_msat: u64 = 0;
6554 let mut path = Some(Vec::new());
6555 let mut payment_id = None;
6556 let mut payment_secret = None;
6557 let mut payment_params = None;
6558 read_tlv_fields!(reader, {
6559 (0, session_priv, required),
6560 (1, payment_id, option),
6561 (2, first_hop_htlc_msat, required),
6562 (3, payment_secret, option),
6563 (4, path, vec_type),
6564 (5, payment_params, option),
6566 if payment_id.is_none() {
6567 // For backwards compat, if there was no payment_id written, use the session_priv bytes
6569 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
6571 Ok(HTLCSource::OutboundRoute {
6572 session_priv: session_priv.0.unwrap(),
6573 first_hop_htlc_msat,
6574 path: path.unwrap(),
6575 payment_id: payment_id.unwrap(),
6580 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
6581 _ => Err(DecodeError::UnknownRequiredFeature),
6586 impl Writeable for HTLCSource {
6587 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
6589 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id, payment_secret, payment_params } => {
6591 let payment_id_opt = Some(payment_id);
6592 write_tlv_fields!(writer, {
6593 (0, session_priv, required),
6594 (1, payment_id_opt, option),
6595 (2, first_hop_htlc_msat, required),
6596 (3, payment_secret, option),
6597 (4, *path, vec_type),
6598 (5, payment_params, option),
6601 HTLCSource::PreviousHopData(ref field) => {
6603 field.write(writer)?;
6610 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
6611 (0, forward_info, required),
6612 (1, prev_user_channel_id, (default_value, 0)),
6613 (2, prev_short_channel_id, required),
6614 (4, prev_htlc_id, required),
6615 (6, prev_funding_outpoint, required),
6618 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
6620 (0, htlc_id, required),
6621 (2, err_packet, required),
6626 impl_writeable_tlv_based!(PendingInboundPayment, {
6627 (0, payment_secret, required),
6628 (2, expiry_time, required),
6629 (4, user_payment_id, required),
6630 (6, payment_preimage, required),
6631 (8, min_value_msat, required),
6634 impl<M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref> Writeable for ChannelManager<M, T, K, F, R, L>
6636 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
6637 T::Target: BroadcasterInterface,
6638 K::Target: KeysInterface,
6639 F::Target: FeeEstimator,
6643 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6644 let _consistency_lock = self.total_consistency_lock.write().unwrap();
6646 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
6648 self.genesis_hash.write(writer)?;
6650 let best_block = self.best_block.read().unwrap();
6651 best_block.height().write(writer)?;
6652 best_block.block_hash().write(writer)?;
6656 let per_peer_state = self.per_peer_state.read().unwrap();
6657 let mut unfunded_channels = 0;
6658 let mut number_of_channels = 0;
6659 for (_, peer_state_mutex) in per_peer_state.iter() {
6660 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6661 let peer_state = &mut *peer_state_lock;
6662 number_of_channels += peer_state.channel_by_id.len();
6663 for (_, channel) in peer_state.channel_by_id.iter() {
6664 if !channel.is_funding_initiated() {
6665 unfunded_channels += 1;
6670 ((number_of_channels - unfunded_channels) as u64).write(writer)?;
6672 for (_, peer_state_mutex) in per_peer_state.iter() {
6673 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6674 let peer_state = &mut *peer_state_lock;
6675 for (_, channel) in peer_state.channel_by_id.iter() {
6676 if channel.is_funding_initiated() {
6677 channel.write(writer)?;
6684 let forward_htlcs = self.forward_htlcs.lock().unwrap();
6685 (forward_htlcs.len() as u64).write(writer)?;
6686 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
6687 short_channel_id.write(writer)?;
6688 (pending_forwards.len() as u64).write(writer)?;
6689 for forward in pending_forwards {
6690 forward.write(writer)?;
6695 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
6696 let claimable_payments = self.claimable_payments.lock().unwrap();
6697 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
6699 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
6700 (claimable_payments.claimable_htlcs.len() as u64).write(writer)?;
6701 for (payment_hash, (purpose, previous_hops)) in claimable_payments.claimable_htlcs.iter() {
6702 payment_hash.write(writer)?;
6703 (previous_hops.len() as u64).write(writer)?;
6704 for htlc in previous_hops.iter() {
6705 htlc.write(writer)?;
6707 htlc_purposes.push(purpose);
6710 let per_peer_state = self.per_peer_state.write().unwrap();
6711 (per_peer_state.len() as u64).write(writer)?;
6712 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
6713 peer_pubkey.write(writer)?;
6714 let peer_state = peer_state_mutex.lock().unwrap();
6715 peer_state.latest_features.write(writer)?;
6718 let events = self.pending_events.lock().unwrap();
6719 (events.len() as u64).write(writer)?;
6720 for event in events.iter() {
6721 event.write(writer)?;
6724 let background_events = self.pending_background_events.lock().unwrap();
6725 (background_events.len() as u64).write(writer)?;
6726 for event in background_events.iter() {
6728 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
6730 funding_txo.write(writer)?;
6731 monitor_update.write(writer)?;
6736 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
6737 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
6738 // likely to be identical.
6739 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
6740 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
6742 (pending_inbound_payments.len() as u64).write(writer)?;
6743 for (hash, pending_payment) in pending_inbound_payments.iter() {
6744 hash.write(writer)?;
6745 pending_payment.write(writer)?;
6748 // For backwards compat, write the session privs and their total length.
6749 let mut num_pending_outbounds_compat: u64 = 0;
6750 for (_, outbound) in pending_outbound_payments.iter() {
6751 if !outbound.is_fulfilled() && !outbound.abandoned() {
6752 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
6755 num_pending_outbounds_compat.write(writer)?;
6756 for (_, outbound) in pending_outbound_payments.iter() {
6758 PendingOutboundPayment::Legacy { session_privs } |
6759 PendingOutboundPayment::Retryable { session_privs, .. } => {
6760 for session_priv in session_privs.iter() {
6761 session_priv.write(writer)?;
6764 PendingOutboundPayment::Fulfilled { .. } => {},
6765 PendingOutboundPayment::Abandoned { .. } => {},
6769 // Encode without retry info for 0.0.101 compatibility.
6770 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
6771 for (id, outbound) in pending_outbound_payments.iter() {
6773 PendingOutboundPayment::Legacy { session_privs } |
6774 PendingOutboundPayment::Retryable { session_privs, .. } => {
6775 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
6781 let mut pending_intercepted_htlcs = None;
6782 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
6783 if our_pending_intercepts.len() != 0 {
6784 pending_intercepted_htlcs = Some(our_pending_intercepts);
6787 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
6788 if pending_claiming_payments.as_ref().unwrap().is_empty() {
6789 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
6790 // map. Thus, if there are no entries we skip writing a TLV for it.
6791 pending_claiming_payments = None;
6793 debug_assert!(false, "While we have code to serialize pending_claiming_payments, the map should always be empty until a later PR");
6796 write_tlv_fields!(writer, {
6797 (1, pending_outbound_payments_no_retry, required),
6798 (2, pending_intercepted_htlcs, option),
6799 (3, pending_outbound_payments, required),
6800 (4, pending_claiming_payments, option),
6801 (5, self.our_network_pubkey, required),
6802 (7, self.fake_scid_rand_bytes, required),
6803 (9, htlc_purposes, vec_type),
6804 (11, self.probing_cookie_secret, required),
6811 /// Arguments for the creation of a ChannelManager that are not deserialized.
6813 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
6815 /// 1) Deserialize all stored [`ChannelMonitor`]s.
6816 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
6817 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
6818 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
6819 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
6820 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
6821 /// same way you would handle a [`chain::Filter`] call using
6822 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
6823 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
6824 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
6825 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
6826 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
6827 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
6829 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
6830 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
6832 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
6833 /// call any other methods on the newly-deserialized [`ChannelManager`].
6835 /// Note that because some channels may be closed during deserialization, it is critical that you
6836 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
6837 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
6838 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
6839 /// not force-close the same channels but consider them live), you may end up revoking a state for
6840 /// which you've already broadcasted the transaction.
6842 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
6843 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref>
6845 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
6846 T::Target: BroadcasterInterface,
6847 K::Target: KeysInterface,
6848 F::Target: FeeEstimator,
6852 /// The keys provider which will give us relevant keys. Some keys will be loaded during
6853 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
6855 pub keys_manager: K,
6857 /// The fee_estimator for use in the ChannelManager in the future.
6859 /// No calls to the FeeEstimator will be made during deserialization.
6860 pub fee_estimator: F,
6861 /// The chain::Watch for use in the ChannelManager in the future.
6863 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
6864 /// you have deserialized ChannelMonitors separately and will add them to your
6865 /// chain::Watch after deserializing this ChannelManager.
6866 pub chain_monitor: M,
6868 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
6869 /// used to broadcast the latest local commitment transactions of channels which must be
6870 /// force-closed during deserialization.
6871 pub tx_broadcaster: T,
6872 /// The router which will be used in the ChannelManager in the future for finding routes
6873 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
6875 /// No calls to the router will be made during deserialization.
6877 /// The Logger for use in the ChannelManager and which may be used to log information during
6878 /// deserialization.
6880 /// Default settings used for new channels. Any existing channels will continue to use the
6881 /// runtime settings which were stored when the ChannelManager was serialized.
6882 pub default_config: UserConfig,
6884 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
6885 /// value.get_funding_txo() should be the key).
6887 /// If a monitor is inconsistent with the channel state during deserialization the channel will
6888 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
6889 /// is true for missing channels as well. If there is a monitor missing for which we find
6890 /// channel data Err(DecodeError::InvalidValue) will be returned.
6892 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
6895 /// (C-not exported) because we have no HashMap bindings
6896 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<K::Target as SignerProvider>::Signer>>,
6899 impl<'a, M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref>
6900 ChannelManagerReadArgs<'a, M, T, K, F, R, L>
6902 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
6903 T::Target: BroadcasterInterface,
6904 K::Target: KeysInterface,
6905 F::Target: FeeEstimator,
6909 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
6910 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
6911 /// populate a HashMap directly from C.
6912 pub fn new(keys_manager: K, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, default_config: UserConfig,
6913 mut channel_monitors: Vec<&'a mut ChannelMonitor<<K::Target as SignerProvider>::Signer>>) -> Self {
6915 keys_manager, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
6916 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
6921 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
6922 // SipmleArcChannelManager type:
6923 impl<'a, M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref>
6924 ReadableArgs<ChannelManagerReadArgs<'a, M, T, K, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, K, F, R, L>>)
6926 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
6927 T::Target: BroadcasterInterface,
6928 K::Target: KeysInterface,
6929 F::Target: FeeEstimator,
6933 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, K, F, R, L>) -> Result<Self, DecodeError> {
6934 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, K, F, R, L>)>::read(reader, args)?;
6935 Ok((blockhash, Arc::new(chan_manager)))
6939 impl<'a, M: Deref, T: Deref, K: Deref, F: Deref, R: Deref, L: Deref>
6940 ReadableArgs<ChannelManagerReadArgs<'a, M, T, K, F, R, L>> for (BlockHash, ChannelManager<M, T, K, F, R, L>)
6942 M::Target: chain::Watch<<K::Target as SignerProvider>::Signer>,
6943 T::Target: BroadcasterInterface,
6944 K::Target: KeysInterface,
6945 F::Target: FeeEstimator,
6949 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, K, F, R, L>) -> Result<Self, DecodeError> {
6950 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
6952 let genesis_hash: BlockHash = Readable::read(reader)?;
6953 let best_block_height: u32 = Readable::read(reader)?;
6954 let best_block_hash: BlockHash = Readable::read(reader)?;
6956 let mut failed_htlcs = Vec::new();
6958 let channel_count: u64 = Readable::read(reader)?;
6959 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
6960 let mut peer_channels: HashMap<PublicKey, HashMap<[u8; 32], Channel<<K::Target as SignerProvider>::Signer>>> = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
6961 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
6962 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
6963 let mut channel_closures = Vec::new();
6964 for _ in 0..channel_count {
6965 let mut channel: Channel<<K::Target as SignerProvider>::Signer> = Channel::read(reader, (&args.keys_manager, best_block_height))?;
6966 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
6967 funding_txo_set.insert(funding_txo.clone());
6968 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
6969 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
6970 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
6971 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
6972 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
6973 // If the channel is ahead of the monitor, return InvalidValue:
6974 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
6975 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
6976 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
6977 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
6978 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
6979 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
6980 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");
6981 return Err(DecodeError::InvalidValue);
6982 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
6983 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
6984 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
6985 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
6986 // But if the channel is behind of the monitor, close the channel:
6987 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
6988 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
6989 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
6990 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
6991 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
6992 failed_htlcs.append(&mut new_failed_htlcs);
6993 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
6994 channel_closures.push(events::Event::ChannelClosed {
6995 channel_id: channel.channel_id(),
6996 user_channel_id: channel.get_user_id(),
6997 reason: ClosureReason::OutdatedChannelManager
6999 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
7000 let mut found_htlc = false;
7001 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
7002 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
7005 // If we have some HTLCs in the channel which are not present in the newer
7006 // ChannelMonitor, they have been removed and should be failed back to
7007 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
7008 // were actually claimed we'd have generated and ensured the previous-hop
7009 // claim update ChannelMonitor updates were persisted prior to persising
7010 // the ChannelMonitor update for the forward leg, so attempting to fail the
7011 // backwards leg of the HTLC will simply be rejected.
7012 log_info!(args.logger,
7013 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
7014 log_bytes!(channel.channel_id()), log_bytes!(payment_hash.0));
7015 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.get_counterparty_node_id(), channel.channel_id()));
7019 log_info!(args.logger, "Successfully loaded channel {}", log_bytes!(channel.channel_id()));
7020 if let Some(short_channel_id) = channel.get_short_channel_id() {
7021 short_to_chan_info.insert(short_channel_id, (channel.get_counterparty_node_id(), channel.channel_id()));
7023 if channel.is_funding_initiated() {
7024 id_to_peer.insert(channel.channel_id(), channel.get_counterparty_node_id());
7026 match peer_channels.entry(channel.get_counterparty_node_id()) {
7027 hash_map::Entry::Occupied(mut entry) => {
7028 let by_id_map = entry.get_mut();
7029 by_id_map.insert(channel.channel_id(), channel);
7031 hash_map::Entry::Vacant(entry) => {
7032 let mut by_id_map = HashMap::new();
7033 by_id_map.insert(channel.channel_id(), channel);
7034 entry.insert(by_id_map);
7038 } else if channel.is_awaiting_initial_mon_persist() {
7039 // If we were persisted and shut down while the initial ChannelMonitor persistence
7040 // was in-progress, we never broadcasted the funding transaction and can still
7041 // safely discard the channel.
7042 let _ = channel.force_shutdown(false);
7043 channel_closures.push(events::Event::ChannelClosed {
7044 channel_id: channel.channel_id(),
7045 user_channel_id: channel.get_user_id(),
7046 reason: ClosureReason::DisconnectedPeer,
7049 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.channel_id()));
7050 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
7051 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
7052 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
7053 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");
7054 return Err(DecodeError::InvalidValue);
7058 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
7059 if !funding_txo_set.contains(funding_txo) {
7060 log_info!(args.logger, "Broadcasting latest holder commitment transaction for closed channel {}", log_bytes!(funding_txo.to_channel_id()));
7061 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
7065 const MAX_ALLOC_SIZE: usize = 1024 * 64;
7066 let forward_htlcs_count: u64 = Readable::read(reader)?;
7067 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
7068 for _ in 0..forward_htlcs_count {
7069 let short_channel_id = Readable::read(reader)?;
7070 let pending_forwards_count: u64 = Readable::read(reader)?;
7071 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
7072 for _ in 0..pending_forwards_count {
7073 pending_forwards.push(Readable::read(reader)?);
7075 forward_htlcs.insert(short_channel_id, pending_forwards);
7078 let claimable_htlcs_count: u64 = Readable::read(reader)?;
7079 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
7080 for _ in 0..claimable_htlcs_count {
7081 let payment_hash = Readable::read(reader)?;
7082 let previous_hops_len: u64 = Readable::read(reader)?;
7083 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
7084 for _ in 0..previous_hops_len {
7085 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
7087 claimable_htlcs_list.push((payment_hash, previous_hops));
7090 let peer_count: u64 = Readable::read(reader)?;
7091 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<<K::Target as SignerProvider>::Signer>>)>()));
7092 for _ in 0..peer_count {
7093 let peer_pubkey = Readable::read(reader)?;
7094 let peer_state = PeerState {
7095 channel_by_id: peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new()),
7096 latest_features: Readable::read(reader)?,
7098 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
7101 let event_count: u64 = Readable::read(reader)?;
7102 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>()));
7103 for _ in 0..event_count {
7104 match MaybeReadable::read(reader)? {
7105 Some(event) => pending_events_read.push(event),
7110 let background_event_count: u64 = Readable::read(reader)?;
7111 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>()));
7112 for _ in 0..background_event_count {
7113 match <u8 as Readable>::read(reader)? {
7114 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
7115 _ => return Err(DecodeError::InvalidValue),
7119 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
7120 let highest_seen_timestamp: u32 = Readable::read(reader)?;
7122 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
7123 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
7124 for _ in 0..pending_inbound_payment_count {
7125 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
7126 return Err(DecodeError::InvalidValue);
7130 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
7131 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
7132 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
7133 for _ in 0..pending_outbound_payments_count_compat {
7134 let session_priv = Readable::read(reader)?;
7135 let payment = PendingOutboundPayment::Legacy {
7136 session_privs: [session_priv].iter().cloned().collect()
7138 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
7139 return Err(DecodeError::InvalidValue)
7143 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
7144 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
7145 let mut pending_outbound_payments = None;
7146 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
7147 let mut received_network_pubkey: Option<PublicKey> = None;
7148 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
7149 let mut probing_cookie_secret: Option<[u8; 32]> = None;
7150 let mut claimable_htlc_purposes = None;
7151 let mut pending_claiming_payments = Some(HashMap::new());
7152 read_tlv_fields!(reader, {
7153 (1, pending_outbound_payments_no_retry, option),
7154 (2, pending_intercepted_htlcs, option),
7155 (3, pending_outbound_payments, option),
7156 (4, pending_claiming_payments, option),
7157 (5, received_network_pubkey, option),
7158 (7, fake_scid_rand_bytes, option),
7159 (9, claimable_htlc_purposes, vec_type),
7160 (11, probing_cookie_secret, option),
7162 if fake_scid_rand_bytes.is_none() {
7163 fake_scid_rand_bytes = Some(args.keys_manager.get_secure_random_bytes());
7166 if probing_cookie_secret.is_none() {
7167 probing_cookie_secret = Some(args.keys_manager.get_secure_random_bytes());
7170 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
7171 pending_outbound_payments = Some(pending_outbound_payments_compat);
7172 } else if pending_outbound_payments.is_none() {
7173 let mut outbounds = HashMap::new();
7174 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
7175 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
7177 pending_outbound_payments = Some(outbounds);
7179 // If we're tracking pending payments, ensure we haven't lost any by looking at the
7180 // ChannelMonitor data for any channels for which we do not have authorative state
7181 // (i.e. those for which we just force-closed above or we otherwise don't have a
7182 // corresponding `Channel` at all).
7183 // This avoids several edge-cases where we would otherwise "forget" about pending
7184 // payments which are still in-flight via their on-chain state.
7185 // We only rebuild the pending payments map if we were most recently serialized by
7187 for (_, monitor) in args.channel_monitors.iter() {
7188 if id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id()).is_none() {
7189 for (htlc_source, htlc) in monitor.get_pending_outbound_htlcs() {
7190 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, payment_secret, .. } = htlc_source {
7191 if path.is_empty() {
7192 log_error!(args.logger, "Got an empty path for a pending payment");
7193 return Err(DecodeError::InvalidValue);
7195 let path_amt = path.last().unwrap().fee_msat;
7196 let mut session_priv_bytes = [0; 32];
7197 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
7198 match pending_outbound_payments.as_mut().unwrap().entry(payment_id) {
7199 hash_map::Entry::Occupied(mut entry) => {
7200 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
7201 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
7202 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), log_bytes!(htlc.payment_hash.0));
7204 hash_map::Entry::Vacant(entry) => {
7205 let path_fee = path.get_path_fees();
7206 entry.insert(PendingOutboundPayment::Retryable {
7207 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
7208 payment_hash: htlc.payment_hash,
7210 pending_amt_msat: path_amt,
7211 pending_fee_msat: Some(path_fee),
7212 total_msat: path_amt,
7213 starting_block_height: best_block_height,
7215 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
7216 path_amt, log_bytes!(htlc.payment_hash.0), log_bytes!(session_priv_bytes));
7221 for (htlc_source, htlc) in monitor.get_all_current_outbound_htlcs() {
7222 if let HTLCSource::PreviousHopData(prev_hop_data) = htlc_source {
7223 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
7224 info.prev_funding_outpoint == prev_hop_data.outpoint &&
7225 info.prev_htlc_id == prev_hop_data.htlc_id
7227 // The ChannelMonitor is now responsible for this HTLC's
7228 // failure/success and will let us know what its outcome is. If we
7229 // still have an entry for this HTLC in `forward_htlcs` or
7230 // `pending_intercepted_htlcs`, we were apparently not persisted after
7231 // the monitor was when forwarding the payment.
7232 forward_htlcs.retain(|_, forwards| {
7233 forwards.retain(|forward| {
7234 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
7235 if pending_forward_matches_htlc(&htlc_info) {
7236 log_info!(args.logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
7237 log_bytes!(htlc.payment_hash.0), log_bytes!(monitor.get_funding_txo().0.to_channel_id()));
7242 !forwards.is_empty()
7244 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
7245 if pending_forward_matches_htlc(&htlc_info) {
7246 log_info!(args.logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
7247 log_bytes!(htlc.payment_hash.0), log_bytes!(monitor.get_funding_txo().0.to_channel_id()));
7248 pending_events_read.retain(|event| {
7249 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
7250 intercepted_id != ev_id
7262 if !forward_htlcs.is_empty() {
7263 // If we have pending HTLCs to forward, assume we either dropped a
7264 // `PendingHTLCsForwardable` or the user received it but never processed it as they
7265 // shut down before the timer hit. Either way, set the time_forwardable to a small
7266 // constant as enough time has likely passed that we should simply handle the forwards
7267 // now, or at least after the user gets a chance to reconnect to our peers.
7268 pending_events_read.push(events::Event::PendingHTLCsForwardable {
7269 time_forwardable: Duration::from_secs(2),
7273 let inbound_pmt_key_material = args.keys_manager.get_inbound_payment_key_material();
7274 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
7276 let mut claimable_htlcs = HashMap::with_capacity(claimable_htlcs_list.len());
7277 if let Some(mut purposes) = claimable_htlc_purposes {
7278 if purposes.len() != claimable_htlcs_list.len() {
7279 return Err(DecodeError::InvalidValue);
7281 for (purpose, (payment_hash, previous_hops)) in purposes.drain(..).zip(claimable_htlcs_list.drain(..)) {
7282 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7285 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
7286 // include a `_legacy_hop_data` in the `OnionPayload`.
7287 for (payment_hash, previous_hops) in claimable_htlcs_list.drain(..) {
7288 if previous_hops.is_empty() {
7289 return Err(DecodeError::InvalidValue);
7291 let purpose = match &previous_hops[0].onion_payload {
7292 OnionPayload::Invoice { _legacy_hop_data } => {
7293 if let Some(hop_data) = _legacy_hop_data {
7294 events::PaymentPurpose::InvoicePayment {
7295 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
7296 Some(inbound_payment) => inbound_payment.payment_preimage,
7297 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
7298 Ok(payment_preimage) => payment_preimage,
7300 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));
7301 return Err(DecodeError::InvalidValue);
7305 payment_secret: hop_data.payment_secret,
7307 } else { return Err(DecodeError::InvalidValue); }
7309 OnionPayload::Spontaneous(payment_preimage) =>
7310 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
7312 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7316 let mut secp_ctx = Secp256k1::new();
7317 secp_ctx.seeded_randomize(&args.keys_manager.get_secure_random_bytes());
7319 if !channel_closures.is_empty() {
7320 pending_events_read.append(&mut channel_closures);
7323 let our_network_key = match args.keys_manager.get_node_secret(Recipient::Node) {
7325 Err(()) => return Err(DecodeError::InvalidValue)
7327 let our_network_pubkey = PublicKey::from_secret_key(&secp_ctx, &our_network_key);
7328 if let Some(network_pubkey) = received_network_pubkey {
7329 if network_pubkey != our_network_pubkey {
7330 log_error!(args.logger, "Key that was generated does not match the existing key.");
7331 return Err(DecodeError::InvalidValue);
7335 let mut outbound_scid_aliases = HashSet::new();
7336 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
7337 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7338 let peer_state = &mut *peer_state_lock;
7339 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
7340 if chan.outbound_scid_alias() == 0 {
7341 let mut outbound_scid_alias;
7343 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
7344 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.keys_manager);
7345 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
7347 chan.set_outbound_scid_alias(outbound_scid_alias);
7348 } else if !outbound_scid_aliases.insert(chan.outbound_scid_alias()) {
7349 // Note that in rare cases its possible to hit this while reading an older
7350 // channel if we just happened to pick a colliding outbound alias above.
7351 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7352 return Err(DecodeError::InvalidValue);
7354 if chan.is_usable() {
7355 if short_to_chan_info.insert(chan.outbound_scid_alias(), (chan.get_counterparty_node_id(), *chan_id)).is_some() {
7356 // Note that in rare cases its possible to hit this while reading an older
7357 // channel if we just happened to pick a colliding outbound alias above.
7358 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7359 return Err(DecodeError::InvalidValue);
7365 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
7367 for (_, monitor) in args.channel_monitors.iter() {
7368 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
7369 if let Some((payment_purpose, claimable_htlcs)) = claimable_htlcs.remove(&payment_hash) {
7370 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", log_bytes!(payment_hash.0));
7371 let mut claimable_amt_msat = 0;
7372 let mut receiver_node_id = Some(our_network_pubkey);
7373 let phantom_shared_secret = claimable_htlcs[0].prev_hop.phantom_shared_secret;
7374 if phantom_shared_secret.is_some() {
7375 let phantom_pubkey = args.keys_manager.get_node_id(Recipient::PhantomNode)
7376 .expect("Failed to get node_id for phantom node recipient");
7377 receiver_node_id = Some(phantom_pubkey)
7379 for claimable_htlc in claimable_htlcs {
7380 claimable_amt_msat += claimable_htlc.value;
7382 // Add a holding-cell claim of the payment to the Channel, which should be
7383 // applied ~immediately on peer reconnection. Because it won't generate a
7384 // new commitment transaction we can just provide the payment preimage to
7385 // the corresponding ChannelMonitor and nothing else.
7387 // We do so directly instead of via the normal ChannelMonitor update
7388 // procedure as the ChainMonitor hasn't yet been initialized, implying
7389 // we're not allowed to call it directly yet. Further, we do the update
7390 // without incrementing the ChannelMonitor update ID as there isn't any
7392 // If we were to generate a new ChannelMonitor update ID here and then
7393 // crash before the user finishes block connect we'd end up force-closing
7394 // this channel as well. On the flip side, there's no harm in restarting
7395 // without the new monitor persisted - we'll end up right back here on
7397 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
7398 if let Some(peer_node_id) = id_to_peer.get(&previous_channel_id){
7399 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
7400 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7401 let peer_state = &mut *peer_state_lock;
7402 if let Some(channel) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
7403 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
7406 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
7407 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
7410 pending_events_read.push(events::Event::PaymentClaimed {
7413 purpose: payment_purpose,
7414 amount_msat: claimable_amt_msat,
7420 let channel_manager = ChannelManager {
7422 fee_estimator: bounded_fee_estimator,
7423 chain_monitor: args.chain_monitor,
7424 tx_broadcaster: args.tx_broadcaster,
7425 router: args.router,
7427 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
7429 channel_state: Mutex::new(ChannelHolder {
7430 pending_msg_events: Vec::new(),
7432 inbound_payment_key: expanded_inbound_key,
7433 pending_inbound_payments: Mutex::new(pending_inbound_payments),
7434 pending_outbound_payments: OutboundPayments { pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()) },
7435 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
7437 forward_htlcs: Mutex::new(forward_htlcs),
7438 claimable_payments: Mutex::new(ClaimablePayments { claimable_htlcs, pending_claiming_payments: pending_claiming_payments.unwrap() }),
7439 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
7440 id_to_peer: Mutex::new(id_to_peer),
7441 short_to_chan_info: FairRwLock::new(short_to_chan_info),
7442 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
7444 probing_cookie_secret: probing_cookie_secret.unwrap(),
7450 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
7452 per_peer_state: FairRwLock::new(per_peer_state),
7454 pending_events: Mutex::new(pending_events_read),
7455 pending_background_events: Mutex::new(pending_background_events_read),
7456 total_consistency_lock: RwLock::new(()),
7457 persistence_notifier: Notifier::new(),
7459 keys_manager: args.keys_manager,
7460 logger: args.logger,
7461 default_configuration: args.default_config,
7464 for htlc_source in failed_htlcs.drain(..) {
7465 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
7466 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
7467 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
7468 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
7471 //TODO: Broadcast channel update for closed channels, but only after we've made a
7472 //connection or two.
7474 Ok((best_block_hash.clone(), channel_manager))
7480 use bitcoin::hashes::Hash;
7481 use bitcoin::hashes::sha256::Hash as Sha256;
7482 use bitcoin::hashes::hex::FromHex;
7483 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
7484 use bitcoin::secp256k1::ecdsa::Signature;
7485 use bitcoin::secp256k1::ffi::Signature as FFISignature;
7486 use bitcoin::blockdata::script::Script;
7488 use core::time::Duration;
7489 use core::sync::atomic::Ordering;
7490 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
7491 use crate::ln::channelmanager::{self, inbound_payment, PaymentId, PaymentSendFailure, InterceptId};
7492 use crate::ln::functional_test_utils::*;
7493 use crate::ln::msgs;
7494 use crate::ln::msgs::{ChannelMessageHandler, OptionalField};
7495 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
7496 use crate::util::errors::APIError;
7497 use crate::util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
7498 use crate::util::test_utils;
7499 use crate::util::config::ChannelConfig;
7500 use crate::chain::keysinterface::{EntropySource, KeysInterface};
7503 fn test_notify_limits() {
7504 // Check that a few cases which don't require the persistence of a new ChannelManager,
7505 // indeed, do not cause the persistence of a new ChannelManager.
7506 let chanmon_cfgs = create_chanmon_cfgs(3);
7507 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7508 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7509 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7511 // All nodes start with a persistable update pending as `create_network` connects each node
7512 // with all other nodes to make most tests simpler.
7513 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7514 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7515 assert!(nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7517 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7519 // We check that the channel info nodes have doesn't change too early, even though we try
7520 // to connect messages with new values
7521 chan.0.contents.fee_base_msat *= 2;
7522 chan.1.contents.fee_base_msat *= 2;
7523 let node_a_chan_info = nodes[0].node.list_channels()[0].clone();
7524 let node_b_chan_info = nodes[1].node.list_channels()[0].clone();
7526 // The first two nodes (which opened a channel) should now require fresh persistence
7527 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7528 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7529 // ... but the last node should not.
7530 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7531 // After persisting the first two nodes they should no longer need fresh persistence.
7532 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7533 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7535 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
7536 // about the channel.
7537 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
7538 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
7539 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7541 // The nodes which are a party to the channel should also ignore messages from unrelated
7543 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7544 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7545 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7546 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7547 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7548 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7550 // At this point the channel info given by peers should still be the same.
7551 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7552 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7554 // An earlier version of handle_channel_update didn't check the directionality of the
7555 // update message and would always update the local fee info, even if our peer was
7556 // (spuriously) forwarding us our own channel_update.
7557 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
7558 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
7559 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
7561 // First deliver each peers' own message, checking that the node doesn't need to be
7562 // persisted and that its channel info remains the same.
7563 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
7564 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
7565 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7566 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7567 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7568 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7570 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
7571 // the channel info has updated.
7572 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
7573 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
7574 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7575 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7576 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
7577 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
7581 fn test_keysend_dup_hash_partial_mpp() {
7582 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
7584 let chanmon_cfgs = create_chanmon_cfgs(2);
7585 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7586 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7587 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7588 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7590 // First, send a partial MPP payment.
7591 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
7592 let mut mpp_route = route.clone();
7593 mpp_route.paths.push(mpp_route.paths[0].clone());
7595 let payment_id = PaymentId([42; 32]);
7596 // Use the utility function send_payment_along_path to send the payment with MPP data which
7597 // indicates there are more HTLCs coming.
7598 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.
7599 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash, Some(payment_secret), payment_id, &mpp_route).unwrap();
7600 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();
7601 check_added_monitors!(nodes[0], 1);
7602 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7603 assert_eq!(events.len(), 1);
7604 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
7606 // Next, send a keysend payment with the same payment_hash and make sure it fails.
7607 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7608 check_added_monitors!(nodes[0], 1);
7609 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7610 assert_eq!(events.len(), 1);
7611 let ev = events.drain(..).next().unwrap();
7612 let payment_event = SendEvent::from_event(ev);
7613 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7614 check_added_monitors!(nodes[1], 0);
7615 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7616 expect_pending_htlcs_forwardable!(nodes[1]);
7617 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
7618 check_added_monitors!(nodes[1], 1);
7619 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7620 assert!(updates.update_add_htlcs.is_empty());
7621 assert!(updates.update_fulfill_htlcs.is_empty());
7622 assert_eq!(updates.update_fail_htlcs.len(), 1);
7623 assert!(updates.update_fail_malformed_htlcs.is_empty());
7624 assert!(updates.update_fee.is_none());
7625 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7626 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7627 expect_payment_failed!(nodes[0], our_payment_hash, true);
7629 // Send the second half of the original MPP payment.
7630 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();
7631 check_added_monitors!(nodes[0], 1);
7632 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7633 assert_eq!(events.len(), 1);
7634 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
7636 // Claim the full MPP payment. Note that we can't use a test utility like
7637 // claim_funds_along_route because the ordering of the messages causes the second half of the
7638 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
7639 // lightning messages manually.
7640 nodes[1].node.claim_funds(payment_preimage);
7641 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
7642 check_added_monitors!(nodes[1], 2);
7644 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7645 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
7646 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
7647 check_added_monitors!(nodes[0], 1);
7648 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7649 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
7650 check_added_monitors!(nodes[1], 1);
7651 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7652 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
7653 check_added_monitors!(nodes[1], 1);
7654 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7655 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
7656 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
7657 check_added_monitors!(nodes[0], 1);
7658 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7659 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
7660 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7661 check_added_monitors!(nodes[0], 1);
7662 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
7663 check_added_monitors!(nodes[1], 1);
7664 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
7665 check_added_monitors!(nodes[1], 1);
7666 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7667 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
7668 check_added_monitors!(nodes[0], 1);
7670 // Note that successful MPP payments will generate a single PaymentSent event upon the first
7671 // path's success and a PaymentPathSuccessful event for each path's success.
7672 let events = nodes[0].node.get_and_clear_pending_events();
7673 assert_eq!(events.len(), 3);
7675 Event::PaymentSent { payment_id: ref id, payment_preimage: ref preimage, payment_hash: ref hash, .. } => {
7676 assert_eq!(Some(payment_id), *id);
7677 assert_eq!(payment_preimage, *preimage);
7678 assert_eq!(our_payment_hash, *hash);
7680 _ => panic!("Unexpected event"),
7683 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7684 assert_eq!(payment_id, *actual_payment_id);
7685 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7686 assert_eq!(route.paths[0], *path);
7688 _ => panic!("Unexpected event"),
7691 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7692 assert_eq!(payment_id, *actual_payment_id);
7693 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7694 assert_eq!(route.paths[0], *path);
7696 _ => panic!("Unexpected event"),
7701 fn test_keysend_dup_payment_hash() {
7702 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
7703 // outbound regular payment fails as expected.
7704 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
7705 // fails as expected.
7706 let chanmon_cfgs = create_chanmon_cfgs(2);
7707 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7708 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7709 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7710 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7711 let scorer = test_utils::TestScorer::with_penalty(0);
7712 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7714 // To start (1), send a regular payment but don't claim it.
7715 let expected_route = [&nodes[1]];
7716 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
7718 // Next, attempt a keysend payment and make sure it fails.
7719 let route_params = RouteParameters {
7720 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id()),
7721 final_value_msat: 100_000,
7722 final_cltv_expiry_delta: TEST_FINAL_CLTV,
7724 let route = find_route(
7725 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
7726 None, nodes[0].logger, &scorer, &random_seed_bytes
7728 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7729 check_added_monitors!(nodes[0], 1);
7730 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7731 assert_eq!(events.len(), 1);
7732 let ev = events.drain(..).next().unwrap();
7733 let payment_event = SendEvent::from_event(ev);
7734 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7735 check_added_monitors!(nodes[1], 0);
7736 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7737 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
7738 // fails), the second will process the resulting failure and fail the HTLC backward
7739 expect_pending_htlcs_forwardable!(nodes[1]);
7740 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
7741 check_added_monitors!(nodes[1], 1);
7742 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7743 assert!(updates.update_add_htlcs.is_empty());
7744 assert!(updates.update_fulfill_htlcs.is_empty());
7745 assert_eq!(updates.update_fail_htlcs.len(), 1);
7746 assert!(updates.update_fail_malformed_htlcs.is_empty());
7747 assert!(updates.update_fee.is_none());
7748 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7749 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7750 expect_payment_failed!(nodes[0], payment_hash, true);
7752 // Finally, claim the original payment.
7753 claim_payment(&nodes[0], &expected_route, payment_preimage);
7755 // To start (2), send a keysend payment but don't claim it.
7756 let payment_preimage = PaymentPreimage([42; 32]);
7757 let route = find_route(
7758 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
7759 None, nodes[0].logger, &scorer, &random_seed_bytes
7761 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7762 check_added_monitors!(nodes[0], 1);
7763 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7764 assert_eq!(events.len(), 1);
7765 let event = events.pop().unwrap();
7766 let path = vec![&nodes[1]];
7767 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
7769 // Next, attempt a regular payment and make sure it fails.
7770 let payment_secret = PaymentSecret([43; 32]);
7771 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
7772 check_added_monitors!(nodes[0], 1);
7773 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7774 assert_eq!(events.len(), 1);
7775 let ev = events.drain(..).next().unwrap();
7776 let payment_event = SendEvent::from_event(ev);
7777 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7778 check_added_monitors!(nodes[1], 0);
7779 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7780 expect_pending_htlcs_forwardable!(nodes[1]);
7781 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
7782 check_added_monitors!(nodes[1], 1);
7783 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7784 assert!(updates.update_add_htlcs.is_empty());
7785 assert!(updates.update_fulfill_htlcs.is_empty());
7786 assert_eq!(updates.update_fail_htlcs.len(), 1);
7787 assert!(updates.update_fail_malformed_htlcs.is_empty());
7788 assert!(updates.update_fee.is_none());
7789 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7790 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7791 expect_payment_failed!(nodes[0], payment_hash, true);
7793 // Finally, succeed the keysend payment.
7794 claim_payment(&nodes[0], &expected_route, payment_preimage);
7798 fn test_keysend_hash_mismatch() {
7799 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
7800 // preimage doesn't match the msg's payment hash.
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);
7806 let payer_pubkey = nodes[0].node.get_our_node_id();
7807 let payee_pubkey = nodes[1].node.get_our_node_id();
7808 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7809 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7811 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], channelmanager::provided_init_features(), channelmanager::provided_init_features());
7812 let route_params = RouteParameters {
7813 payment_params: PaymentParameters::for_keysend(payee_pubkey),
7814 final_value_msat: 10_000,
7815 final_cltv_expiry_delta: 40,
7817 let network_graph = nodes[0].network_graph.clone();
7818 let first_hops = nodes[0].node.list_usable_channels();
7819 let scorer = test_utils::TestScorer::with_penalty(0);
7820 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7821 let route = find_route(
7822 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
7823 nodes[0].logger, &scorer, &random_seed_bytes
7826 let test_preimage = PaymentPreimage([42; 32]);
7827 let mismatch_payment_hash = PaymentHash([43; 32]);
7828 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash, None, PaymentId(mismatch_payment_hash.0), &route).unwrap();
7829 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash, &None, Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
7830 check_added_monitors!(nodes[0], 1);
7832 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7833 assert_eq!(updates.update_add_htlcs.len(), 1);
7834 assert!(updates.update_fulfill_htlcs.is_empty());
7835 assert!(updates.update_fail_htlcs.is_empty());
7836 assert!(updates.update_fail_malformed_htlcs.is_empty());
7837 assert!(updates.update_fee.is_none());
7838 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7840 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Payment preimage didn't match payment hash".to_string(), 1);
7844 fn test_keysend_msg_with_secret_err() {
7845 // Test that we error as expected if we receive a keysend payment that includes a payment secret.
7846 let chanmon_cfgs = create_chanmon_cfgs(2);
7847 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7848 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7849 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7851 let payer_pubkey = nodes[0].node.get_our_node_id();
7852 let payee_pubkey = nodes[1].node.get_our_node_id();
7853 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7854 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7856 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], channelmanager::provided_init_features(), channelmanager::provided_init_features());
7857 let route_params = RouteParameters {
7858 payment_params: PaymentParameters::for_keysend(payee_pubkey),
7859 final_value_msat: 10_000,
7860 final_cltv_expiry_delta: 40,
7862 let network_graph = nodes[0].network_graph.clone();
7863 let first_hops = nodes[0].node.list_usable_channels();
7864 let scorer = test_utils::TestScorer::with_penalty(0);
7865 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7866 let route = find_route(
7867 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
7868 nodes[0].logger, &scorer, &random_seed_bytes
7871 let test_preimage = PaymentPreimage([42; 32]);
7872 let test_secret = PaymentSecret([43; 32]);
7873 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
7874 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash, Some(test_secret), PaymentId(payment_hash.0), &route).unwrap();
7875 nodes[0].node.test_send_payment_internal(&route, payment_hash, &Some(test_secret), Some(test_preimage), PaymentId(payment_hash.0), None, session_privs).unwrap();
7876 check_added_monitors!(nodes[0], 1);
7878 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7879 assert_eq!(updates.update_add_htlcs.len(), 1);
7880 assert!(updates.update_fulfill_htlcs.is_empty());
7881 assert!(updates.update_fail_htlcs.is_empty());
7882 assert!(updates.update_fail_malformed_htlcs.is_empty());
7883 assert!(updates.update_fee.is_none());
7884 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7886 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "We don't support MPP keysend payments".to_string(), 1);
7890 fn test_multi_hop_missing_secret() {
7891 let chanmon_cfgs = create_chanmon_cfgs(4);
7892 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7893 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7894 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7896 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
7897 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
7898 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
7899 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
7901 // Marshall an MPP route.
7902 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
7903 let path = route.paths[0].clone();
7904 route.paths.push(path);
7905 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
7906 route.paths[0][0].short_channel_id = chan_1_id;
7907 route.paths[0][1].short_channel_id = chan_3_id;
7908 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
7909 route.paths[1][0].short_channel_id = chan_2_id;
7910 route.paths[1][1].short_channel_id = chan_4_id;
7912 match nodes[0].node.send_payment(&route, payment_hash, &None, PaymentId(payment_hash.0)).unwrap_err() {
7913 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
7914 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err)) },
7915 _ => panic!("unexpected error")
7920 fn bad_inbound_payment_hash() {
7921 // Add coverage for checking that a user-provided payment hash matches the payment secret.
7922 let chanmon_cfgs = create_chanmon_cfgs(2);
7923 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7924 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7925 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7927 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
7928 let payment_data = msgs::FinalOnionHopData {
7930 total_msat: 100_000,
7933 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
7934 // payment verification fails as expected.
7935 let mut bad_payment_hash = payment_hash.clone();
7936 bad_payment_hash.0[0] += 1;
7937 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) {
7938 Ok(_) => panic!("Unexpected ok"),
7940 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment".to_string(), "Failing HTLC with user-generated payment_hash".to_string(), 1);
7944 // Check that using the original payment hash succeeds.
7945 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());
7949 fn test_id_to_peer_coverage() {
7950 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
7951 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
7952 // the channel is successfully closed.
7953 let chanmon_cfgs = create_chanmon_cfgs(2);
7954 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7955 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7956 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7958 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
7959 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7960 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
7961 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7962 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
7964 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
7965 let channel_id = &tx.txid().into_inner();
7967 // Ensure that the `id_to_peer` map is empty until either party has received the
7968 // funding transaction, and have the real `channel_id`.
7969 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
7970 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
7973 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
7975 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
7976 // as it has the funding transaction.
7977 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
7978 assert_eq!(nodes_0_lock.len(), 1);
7979 assert!(nodes_0_lock.contains_key(channel_id));
7981 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
7984 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
7986 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
7988 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
7989 assert_eq!(nodes_0_lock.len(), 1);
7990 assert!(nodes_0_lock.contains_key(channel_id));
7992 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
7993 // as it has the funding transaction.
7994 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
7995 assert_eq!(nodes_1_lock.len(), 1);
7996 assert!(nodes_1_lock.contains_key(channel_id));
7998 check_added_monitors!(nodes[1], 1);
7999 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8000 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
8001 check_added_monitors!(nodes[0], 1);
8002 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8003 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
8004 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
8006 nodes[0].node.close_channel(channel_id, &nodes[1].node.get_our_node_id()).unwrap();
8007 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &channelmanager::provided_init_features(), &get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id()));
8008 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
8009 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &nodes_1_shutdown);
8011 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
8012 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
8014 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
8015 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
8016 // fee for the closing transaction has been negotiated and the parties has the other
8017 // party's signature for the fee negotiated closing transaction.)
8018 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8019 assert_eq!(nodes_0_lock.len(), 1);
8020 assert!(nodes_0_lock.contains_key(channel_id));
8022 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
8023 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
8024 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
8025 // kept in the `nodes[1]`'s `id_to_peer` map.
8026 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8027 assert_eq!(nodes_1_lock.len(), 1);
8028 assert!(nodes_1_lock.contains_key(channel_id));
8031 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()));
8033 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
8034 // therefore has all it needs to fully close the channel (both signatures for the
8035 // closing transaction).
8036 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
8037 // fully closed by `nodes[0]`.
8038 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
8040 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
8041 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
8042 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8043 assert_eq!(nodes_1_lock.len(), 1);
8044 assert!(nodes_1_lock.contains_key(channel_id));
8047 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
8049 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
8051 // Assert that the channel has now been removed from both parties `id_to_peer` map once
8052 // they both have everything required to fully close the channel.
8053 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8055 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
8057 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
8058 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
8061 fn check_unkown_peer_msg_event<'a, 'b: 'a, 'c: 'b>(node: &Node<'a, 'b, 'c>, closing_node_id: PublicKey, closed_channel_id: [u8; 32]){
8062 let close_msg_ev = node.node.get_and_clear_pending_msg_events();
8063 let expected_error_str = format!("Can't find a peer matching the passed counterparty node_id {}", closing_node_id);
8064 match close_msg_ev[0] {
8065 MessageSendEvent::HandleError {
8066 ref node_id, action: msgs::ErrorAction::SendErrorMessage {
8067 msg: msgs::ErrorMessage { ref channel_id, ref data }
8070 assert_eq!(*node_id, closing_node_id);
8071 assert_eq!(*data, expected_error_str);
8072 assert_eq!(*channel_id, closed_channel_id);
8074 _ => panic!("Unexpected event"),
8078 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
8079 let expected_message = format!("Not connected to node: {}", expected_public_key);
8080 check_api_misuse_error_message(expected_message, res_err)
8083 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
8084 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
8085 check_api_misuse_error_message(expected_message, res_err)
8088 fn check_api_misuse_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
8090 Err(APIError::APIMisuseError { err }) => {
8091 assert_eq!(err, expected_err_message);
8093 Ok(_) => panic!("Unexpected Ok"),
8094 Err(_) => panic!("Unexpected Error"),
8099 fn test_api_calls_with_unkown_counterparty_node() {
8100 // Tests that our API functions and message handlers that expects a `counterparty_node_id`
8101 // as input, behaves as expected if the `counterparty_node_id` is an unkown peer in the
8102 // `ChannelManager::per_peer_state` map.
8103 let chanmon_cfg = create_chanmon_cfgs(2);
8104 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
8105 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
8106 let nodes = create_network(2, &node_cfg, &node_chanmgr);
8108 // Boilerplate code to produce `open_channel` and `accept_channel` msgs more densly than
8109 // creating dummy ones.
8110 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
8111 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8112 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel_msg);
8113 let accept_channel_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8116 let channel_id = [4; 32];
8117 let signature = Signature::from(unsafe { FFISignature::new() });
8118 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
8119 let intercept_id = InterceptId([0; 32]);
8122 let funding_created_msg = msgs::FundingCreated {
8123 temporary_channel_id: open_channel_msg.temporary_channel_id,
8124 funding_txid: Txid::from_hex("ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap(),
8125 funding_output_index: 0,
8126 signature: signature,
8129 let funding_signed_msg = msgs::FundingSigned {
8130 channel_id: channel_id,
8131 signature: signature,
8134 let channel_ready_msg = msgs::ChannelReady {
8135 channel_id: channel_id,
8136 next_per_commitment_point: unkown_public_key,
8137 short_channel_id_alias: None,
8140 let announcement_signatures_msg = msgs::AnnouncementSignatures {
8141 channel_id: channel_id,
8142 short_channel_id: 0,
8143 node_signature: signature,
8144 bitcoin_signature: signature,
8147 let channel_reestablish_msg = msgs::ChannelReestablish {
8148 channel_id: channel_id,
8149 next_local_commitment_number: 0,
8150 next_remote_commitment_number: 0,
8151 data_loss_protect: OptionalField::Absent,
8154 let closing_signed_msg = msgs::ClosingSigned {
8155 channel_id: channel_id,
8157 signature: signature,
8161 let shutdown_msg = msgs::Shutdown {
8162 channel_id: channel_id,
8163 scriptpubkey: Script::new(),
8166 let onion_routing_packet = msgs::OnionPacket {
8168 public_key: Ok(unkown_public_key),
8169 hop_data: [1; 20*65],
8173 let update_add_htlc_msg = msgs::UpdateAddHTLC {
8174 channel_id: channel_id,
8176 amount_msat: 1000000,
8177 payment_hash: PaymentHash([1; 32]),
8178 cltv_expiry: 821716,
8179 onion_routing_packet
8182 let commitment_signed_msg = msgs::CommitmentSigned {
8183 channel_id: channel_id,
8184 signature: signature,
8185 htlc_signatures: Vec::new(),
8188 let update_fee_msg = msgs::UpdateFee {
8189 channel_id: channel_id,
8190 feerate_per_kw: 1000,
8193 let malformed_update_msg = msgs::UpdateFailMalformedHTLC{
8194 channel_id: channel_id,
8196 sha256_of_onion: [1; 32],
8197 failure_code: 0x8000,
8200 let fulfill_update_msg = msgs::UpdateFulfillHTLC{
8201 channel_id: channel_id,
8203 payment_preimage: PaymentPreimage([1; 32]),
8206 let fail_update_msg = msgs::UpdateFailHTLC{
8207 channel_id: channel_id,
8209 reason: msgs::OnionErrorPacket { data: Vec::new()},
8212 let revoke_and_ack_msg = msgs::RevokeAndACK {
8213 channel_id: channel_id,
8214 per_commitment_secret: [1; 32],
8215 next_per_commitment_point: unkown_public_key,
8218 // Test the API functions and message handlers.
8219 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);
8221 nodes[1].node.handle_open_channel(&unkown_public_key, channelmanager::provided_init_features(), &open_channel_msg);
8222 check_unkown_peer_msg_event(&nodes[1], unkown_public_key, open_channel_msg.temporary_channel_id);
8224 nodes[0].node.handle_accept_channel(&unkown_public_key, channelmanager::provided_init_features(), &accept_channel_msg);
8225 check_unkown_peer_msg_event(&nodes[0], unkown_public_key, open_channel_msg.temporary_channel_id);
8227 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&open_channel_msg.temporary_channel_id, &unkown_public_key, 42), unkown_public_key);
8228 nodes[1].node.handle_funding_created(&unkown_public_key, &funding_created_msg);
8229 check_unkown_peer_msg_event(&nodes[1], unkown_public_key, open_channel_msg.temporary_channel_id);
8231 nodes[0].node.handle_funding_signed(&unkown_public_key, &funding_signed_msg);
8232 check_unkown_peer_msg_event(&nodes[0], unkown_public_key, channel_id);
8234 nodes[0].node.handle_channel_ready(&unkown_public_key, &channel_ready_msg);
8235 check_unkown_peer_msg_event(&nodes[0], unkown_public_key, channel_id);
8237 nodes[1].node.handle_announcement_signatures(&unkown_public_key, &announcement_signatures_msg);
8238 check_unkown_peer_msg_event(&nodes[1], unkown_public_key, channel_id);
8240 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
8242 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
8244 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
8246 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
8248 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
8250 nodes[0].node.handle_shutdown(&unkown_public_key, &channelmanager::provided_init_features(), &shutdown_msg);
8251 check_unkown_peer_msg_event(&nodes[0], unkown_public_key, channel_id);
8253 nodes[1].node.handle_closing_signed(&unkown_public_key, &closing_signed_msg);
8254 check_unkown_peer_msg_event(&nodes[1], unkown_public_key, channel_id);
8256 nodes[0].node.handle_channel_reestablish(&unkown_public_key, &channel_reestablish_msg);
8257 check_unkown_peer_msg_event(&nodes[0], unkown_public_key, channel_id);
8259 nodes[1].node.handle_update_add_htlc(&unkown_public_key, &update_add_htlc_msg);
8260 check_unkown_peer_msg_event(&nodes[1], unkown_public_key, channel_id);
8262 nodes[1].node.handle_commitment_signed(&unkown_public_key, &commitment_signed_msg);
8263 check_unkown_peer_msg_event(&nodes[1], unkown_public_key, channel_id);
8265 nodes[1].node.handle_update_fail_malformed_htlc(&unkown_public_key, &malformed_update_msg);
8266 check_unkown_peer_msg_event(&nodes[1], unkown_public_key, channel_id);
8268 nodes[1].node.handle_update_fail_htlc(&unkown_public_key, &fail_update_msg);
8269 check_unkown_peer_msg_event(&nodes[1], unkown_public_key, channel_id);
8271 nodes[1].node.handle_update_fulfill_htlc(&unkown_public_key, &fulfill_update_msg);
8272 check_unkown_peer_msg_event(&nodes[1], unkown_public_key, channel_id);
8274 nodes[1].node.handle_revoke_and_ack(&unkown_public_key, &revoke_and_ack_msg);
8275 check_unkown_peer_msg_event(&nodes[1], unkown_public_key, channel_id);
8277 nodes[1].node.handle_update_fee(&unkown_public_key, &update_fee_msg);
8278 check_unkown_peer_msg_event(&nodes[1], unkown_public_key, channel_id);
8282 #[cfg(all(any(test, feature = "_test_utils"), feature = "_bench_unstable"))]
8284 use crate::chain::Listen;
8285 use crate::chain::chainmonitor::{ChainMonitor, Persist};
8286 use crate::chain::keysinterface::{EntropySource, KeysManager, KeysInterface, InMemorySigner};
8287 use crate::ln::channelmanager::{self, BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId};
8288 use crate::ln::functional_test_utils::*;
8289 use crate::ln::msgs::{ChannelMessageHandler, Init};
8290 use crate::routing::gossip::NetworkGraph;
8291 use crate::routing::router::{PaymentParameters, get_route};
8292 use crate::util::test_utils;
8293 use crate::util::config::UserConfig;
8294 use crate::util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
8296 use bitcoin::hashes::Hash;
8297 use bitcoin::hashes::sha256::Hash as Sha256;
8298 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
8300 use crate::sync::{Arc, Mutex};
8304 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
8305 node: &'a ChannelManager<
8306 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
8307 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
8308 &'a test_utils::TestLogger, &'a P>,
8309 &'a test_utils::TestBroadcaster, &'a KeysManager,
8310 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
8311 &'a test_utils::TestLogger>,
8316 fn bench_sends(bench: &mut Bencher) {
8317 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
8320 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
8321 // Do a simple benchmark of sending a payment back and forth between two nodes.
8322 // Note that this is unrealistic as each payment send will require at least two fsync
8324 let network = bitcoin::Network::Testnet;
8325 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
8327 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
8328 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
8329 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
8330 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(genesis_hash, &logger_a)));
8332 let mut config: UserConfig = Default::default();
8333 config.channel_handshake_config.minimum_depth = 1;
8335 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
8336 let seed_a = [1u8; 32];
8337 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
8338 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &router, &logger_a, &keys_manager_a, config.clone(), ChainParameters {
8340 best_block: BestBlock::from_genesis(network),
8342 let node_a_holder = NodeHolder { node: &node_a };
8344 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
8345 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
8346 let seed_b = [2u8; 32];
8347 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
8348 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &router, &logger_b, &keys_manager_b, config.clone(), ChainParameters {
8350 best_block: BestBlock::from_genesis(network),
8352 let node_b_holder = NodeHolder { node: &node_b };
8354 node_a.peer_connected(&node_b.get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8355 node_b.peer_connected(&node_a.get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8356 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
8357 node_b.handle_open_channel(&node_a.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(node_a_holder, MessageSendEvent::SendOpenChannel, node_b.get_our_node_id()));
8358 node_a.handle_accept_channel(&node_b.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(node_b_holder, MessageSendEvent::SendAcceptChannel, node_a.get_our_node_id()));
8361 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
8362 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
8363 value: 8_000_000, script_pubkey: output_script,
8365 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
8366 } else { panic!(); }
8368 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()));
8369 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()));
8371 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
8374 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
8377 Listen::block_connected(&node_a, &block, 1);
8378 Listen::block_connected(&node_b, &block, 1);
8380 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()));
8381 let msg_events = node_a.get_and_clear_pending_msg_events();
8382 assert_eq!(msg_events.len(), 2);
8383 match msg_events[0] {
8384 MessageSendEvent::SendChannelReady { ref msg, .. } => {
8385 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
8386 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
8390 match msg_events[1] {
8391 MessageSendEvent::SendChannelUpdate { .. } => {},
8395 let events_a = node_a.get_and_clear_pending_events();
8396 assert_eq!(events_a.len(), 1);
8398 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8399 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
8401 _ => panic!("Unexpected event"),
8404 let events_b = node_b.get_and_clear_pending_events();
8405 assert_eq!(events_b.len(), 1);
8407 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8408 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
8410 _ => panic!("Unexpected event"),
8413 let dummy_graph = NetworkGraph::new(genesis_hash, &logger_a);
8415 let mut payment_count: u64 = 0;
8416 macro_rules! send_payment {
8417 ($node_a: expr, $node_b: expr) => {
8418 let usable_channels = $node_a.list_usable_channels();
8419 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id())
8420 .with_features(channelmanager::provided_invoice_features());
8421 let scorer = test_utils::TestScorer::with_penalty(0);
8422 let seed = [3u8; 32];
8423 let keys_manager = KeysManager::new(&seed, 42, 42);
8424 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8425 let route = get_route(&$node_a.get_our_node_id(), &payment_params, &dummy_graph.read_only(),
8426 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), 10_000, TEST_FINAL_CLTV, &logger_a, &scorer, &random_seed_bytes).unwrap();
8428 let mut payment_preimage = PaymentPreimage([0; 32]);
8429 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
8431 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
8432 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200).unwrap();
8434 $node_a.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
8435 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
8436 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
8437 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
8438 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
8439 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
8440 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
8441 $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()));
8443 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
8444 expect_payment_claimable!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
8445 $node_b.claim_funds(payment_preimage);
8446 expect_payment_claimed!(NodeHolder { node: &$node_b }, payment_hash, 10_000);
8448 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
8449 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
8450 assert_eq!(node_id, $node_a.get_our_node_id());
8451 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8452 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
8454 _ => panic!("Failed to generate claim event"),
8457 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
8458 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
8459 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
8460 $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()));
8462 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
8467 send_payment!(node_a, node_b);
8468 send_payment!(node_b, node_a);