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::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, RoutePath, RouteParameters};
51 use crate::ln::onion_utils;
52 use crate::ln::msgs::{ChannelMessageHandler, DecodeError, LightningError, MAX_VALUE_MSAT};
53 use crate::ln::wire::Encode;
54 use crate::chain::keysinterface::{Sign, KeysInterface, KeysManager, Recipient};
55 use crate::util::config::{UserConfig, ChannelConfig};
56 use crate::util::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
57 use crate::util::{byte_utils, events};
58 use crate::util::wakers::{Future, Notifier};
59 use crate::util::scid_utils::fake_scid;
60 use crate::util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
61 use crate::util::logger::{Level, Logger};
62 use crate::util::errors::APIError;
65 use crate::prelude::*;
67 use core::cell::RefCell;
69 use crate::sync::{Arc, Mutex, MutexGuard, RwLock, RwLockReadGuard, FairRwLock};
70 use core::sync::atomic::{AtomicUsize, Ordering};
71 use core::time::Duration;
74 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
76 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
77 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
78 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
80 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
81 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
82 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
83 // before we forward it.
85 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
86 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
87 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
88 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
89 // our payment, which we can use to decode errors or inform the user that the payment was sent.
91 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
92 pub(super) enum PendingHTLCRouting {
94 onion_packet: msgs::OnionPacket,
95 /// The SCID from the onion that we should forward to. This could be a real SCID or a fake one
96 /// generated using `get_fake_scid` from the scid_utils::fake_scid module.
97 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
100 payment_data: msgs::FinalOnionHopData,
101 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
102 phantom_shared_secret: Option<[u8; 32]>,
105 payment_preimage: PaymentPreimage,
106 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
110 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
111 pub(super) struct PendingHTLCInfo {
112 pub(super) routing: PendingHTLCRouting,
113 pub(super) incoming_shared_secret: [u8; 32],
114 payment_hash: PaymentHash,
115 pub(super) incoming_amt_msat: Option<u64>, // Added in 0.0.113
116 pub(super) outgoing_amt_msat: u64,
117 pub(super) outgoing_cltv_value: u32,
120 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
121 pub(super) enum HTLCFailureMsg {
122 Relay(msgs::UpdateFailHTLC),
123 Malformed(msgs::UpdateFailMalformedHTLC),
126 /// Stores whether we can't forward an HTLC or relevant forwarding info
127 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
128 pub(super) enum PendingHTLCStatus {
129 Forward(PendingHTLCInfo),
130 Fail(HTLCFailureMsg),
133 pub(super) struct PendingAddHTLCInfo {
134 pub(super) forward_info: PendingHTLCInfo,
136 // These fields are produced in `forward_htlcs()` and consumed in
137 // `process_pending_htlc_forwards()` for constructing the
138 // `HTLCSource::PreviousHopData` for failed and forwarded
141 // Note that this may be an outbound SCID alias for the associated channel.
142 prev_short_channel_id: u64,
144 prev_funding_outpoint: OutPoint,
145 prev_user_channel_id: u128,
148 pub(super) enum HTLCForwardInfo {
149 AddHTLC(PendingAddHTLCInfo),
152 err_packet: msgs::OnionErrorPacket,
156 /// Tracks the inbound corresponding to an outbound HTLC
157 #[derive(Clone, Hash, PartialEq, Eq)]
158 pub(crate) struct HTLCPreviousHopData {
159 // Note that this may be an outbound SCID alias for the associated channel.
160 short_channel_id: u64,
162 incoming_packet_shared_secret: [u8; 32],
163 phantom_shared_secret: Option<[u8; 32]>,
165 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
166 // channel with a preimage provided by the forward channel.
171 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
173 /// This is only here for backwards-compatibility in serialization, in the future it can be
174 /// removed, breaking clients running 0.0.106 and earlier.
175 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
177 /// Contains the payer-provided preimage.
178 Spontaneous(PaymentPreimage),
181 /// HTLCs that are to us and can be failed/claimed by the user
182 struct ClaimableHTLC {
183 prev_hop: HTLCPreviousHopData,
185 /// The amount (in msats) of this MPP part
187 onion_payload: OnionPayload,
189 /// The sum total of all MPP parts
193 /// A payment identifier used to uniquely identify a payment to LDK.
194 /// (C-not exported) as we just use [u8; 32] directly
195 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
196 pub struct PaymentId(pub [u8; 32]);
198 impl Writeable for PaymentId {
199 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
204 impl Readable for PaymentId {
205 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
206 let buf: [u8; 32] = Readable::read(r)?;
211 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
212 /// (C-not exported) as we just use [u8; 32] directly
213 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
214 pub struct InterceptId(pub [u8; 32]);
216 impl Writeable for InterceptId {
217 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
222 impl Readable for InterceptId {
223 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
224 let buf: [u8; 32] = Readable::read(r)?;
228 /// Tracks the inbound corresponding to an outbound HTLC
229 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
230 #[derive(Clone, PartialEq, Eq)]
231 pub(crate) enum HTLCSource {
232 PreviousHopData(HTLCPreviousHopData),
235 session_priv: SecretKey,
236 /// Technically we can recalculate this from the route, but we cache it here to avoid
237 /// doing a double-pass on route when we get a failure back
238 first_hop_htlc_msat: u64,
239 payment_id: PaymentId,
240 payment_secret: Option<PaymentSecret>,
241 payment_params: Option<PaymentParameters>,
244 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
245 impl core::hash::Hash for HTLCSource {
246 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
248 HTLCSource::PreviousHopData(prev_hop_data) => {
250 prev_hop_data.hash(hasher);
252 HTLCSource::OutboundRoute { path, session_priv, payment_id, payment_secret, first_hop_htlc_msat, payment_params } => {
255 session_priv[..].hash(hasher);
256 payment_id.hash(hasher);
257 payment_secret.hash(hasher);
258 first_hop_htlc_msat.hash(hasher);
259 payment_params.hash(hasher);
264 #[cfg(not(feature = "grind_signatures"))]
267 pub fn dummy() -> Self {
268 HTLCSource::OutboundRoute {
270 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
271 first_hop_htlc_msat: 0,
272 payment_id: PaymentId([2; 32]),
273 payment_secret: None,
274 payment_params: None,
279 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
280 pub(super) enum HTLCFailReason {
282 err: msgs::OnionErrorPacket,
290 struct ReceiveError {
296 /// Return value for claim_funds_from_hop
297 enum ClaimFundsFromHop {
299 MonitorUpdateFail(PublicKey, MsgHandleErrInternal, Option<u64>),
304 type ShutdownResult = (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash, PublicKey, [u8; 32])>);
306 /// Error type returned across the channel_state mutex boundary. When an Err is generated for a
307 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
308 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
309 /// channel_state lock. We then return the set of things that need to be done outside the lock in
310 /// this struct and call handle_error!() on it.
312 struct MsgHandleErrInternal {
313 err: msgs::LightningError,
314 chan_id: Option<([u8; 32], u128)>, // If Some a channel of ours has been closed
315 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
317 impl MsgHandleErrInternal {
319 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
321 err: LightningError {
323 action: msgs::ErrorAction::SendErrorMessage {
324 msg: msgs::ErrorMessage {
331 shutdown_finish: None,
335 fn ignore_no_close(err: String) -> Self {
337 err: LightningError {
339 action: msgs::ErrorAction::IgnoreError,
342 shutdown_finish: None,
346 fn from_no_close(err: msgs::LightningError) -> Self {
347 Self { err, chan_id: None, shutdown_finish: None }
350 fn from_finish_shutdown(err: String, channel_id: [u8; 32], user_channel_id: u128, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
352 err: LightningError {
354 action: msgs::ErrorAction::SendErrorMessage {
355 msg: msgs::ErrorMessage {
361 chan_id: Some((channel_id, user_channel_id)),
362 shutdown_finish: Some((shutdown_res, channel_update)),
366 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
369 ChannelError::Warn(msg) => LightningError {
371 action: msgs::ErrorAction::SendWarningMessage {
372 msg: msgs::WarningMessage {
376 log_level: Level::Warn,
379 ChannelError::Ignore(msg) => LightningError {
381 action: msgs::ErrorAction::IgnoreError,
383 ChannelError::Close(msg) => LightningError {
385 action: msgs::ErrorAction::SendErrorMessage {
386 msg: msgs::ErrorMessage {
394 shutdown_finish: None,
399 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
400 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
401 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
402 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
403 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
405 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
406 /// be sent in the order they appear in the return value, however sometimes the order needs to be
407 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
408 /// they were originally sent). In those cases, this enum is also returned.
409 #[derive(Clone, PartialEq)]
410 pub(super) enum RAACommitmentOrder {
411 /// Send the CommitmentUpdate messages first
413 /// Send the RevokeAndACK message first
417 // Note this is only exposed in cfg(test):
418 pub(super) struct ChannelHolder<Signer: Sign> {
419 pub(super) by_id: HashMap<[u8; 32], Channel<Signer>>,
420 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
421 /// for broadcast messages, where ordering isn't as strict).
422 pub(super) pending_msg_events: Vec<MessageSendEvent>,
425 /// Events which we process internally but cannot be procsesed immediately at the generation site
426 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
427 /// quite some time lag.
428 enum BackgroundEvent {
429 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
430 /// commitment transaction.
431 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
434 /// State we hold per-peer. In the future we should put channels in here, but for now we only hold
435 /// the latest Init features we heard from the peer.
437 latest_features: InitFeatures,
440 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
441 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
443 /// For users who don't want to bother doing their own payment preimage storage, we also store that
446 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
447 /// and instead encoding it in the payment secret.
448 struct PendingInboundPayment {
449 /// The payment secret that the sender must use for us to accept this payment
450 payment_secret: PaymentSecret,
451 /// Time at which this HTLC expires - blocks with a header time above this value will result in
452 /// this payment being removed.
454 /// Arbitrary identifier the user specifies (or not)
455 user_payment_id: u64,
456 // Other required attributes of the payment, optionally enforced:
457 payment_preimage: Option<PaymentPreimage>,
458 min_value_msat: Option<u64>,
461 /// Stores the session_priv for each part of a payment that is still pending. For versions 0.0.102
462 /// and later, also stores information for retrying the payment.
463 pub(crate) enum PendingOutboundPayment {
465 session_privs: HashSet<[u8; 32]>,
468 session_privs: HashSet<[u8; 32]>,
469 payment_hash: PaymentHash,
470 payment_secret: Option<PaymentSecret>,
471 pending_amt_msat: u64,
472 /// Used to track the fee paid. Only present if the payment was serialized on 0.0.103+.
473 pending_fee_msat: Option<u64>,
474 /// The total payment amount across all paths, used to verify that a retry is not overpaying.
476 /// Our best known block height at the time this payment was initiated.
477 starting_block_height: u32,
479 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
480 /// been resolved. This ensures we don't look up pending payments in ChannelMonitors on restart
481 /// and add a pending payment that was already fulfilled.
483 session_privs: HashSet<[u8; 32]>,
484 payment_hash: Option<PaymentHash>,
485 timer_ticks_without_htlcs: u8,
487 /// When a payer gives up trying to retry a payment, they inform us, letting us generate a
488 /// `PaymentFailed` event when all HTLCs have irrevocably failed. This avoids a number of race
489 /// conditions in MPP-aware payment retriers (1), where the possibility of multiple
490 /// `PaymentPathFailed` events with `all_paths_failed` can be pending at once, confusing a
491 /// downstream event handler as to when a payment has actually failed.
493 /// (1) https://github.com/lightningdevkit/rust-lightning/issues/1164
495 session_privs: HashSet<[u8; 32]>,
496 payment_hash: PaymentHash,
500 impl PendingOutboundPayment {
501 fn is_fulfilled(&self) -> bool {
503 PendingOutboundPayment::Fulfilled { .. } => true,
507 fn abandoned(&self) -> bool {
509 PendingOutboundPayment::Abandoned { .. } => true,
513 fn get_pending_fee_msat(&self) -> Option<u64> {
515 PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
520 fn payment_hash(&self) -> Option<PaymentHash> {
522 PendingOutboundPayment::Legacy { .. } => None,
523 PendingOutboundPayment::Retryable { payment_hash, .. } => Some(*payment_hash),
524 PendingOutboundPayment::Fulfilled { payment_hash, .. } => *payment_hash,
525 PendingOutboundPayment::Abandoned { payment_hash, .. } => Some(*payment_hash),
529 fn mark_fulfilled(&mut self) {
530 let mut session_privs = HashSet::new();
531 core::mem::swap(&mut session_privs, match self {
532 PendingOutboundPayment::Legacy { session_privs } |
533 PendingOutboundPayment::Retryable { session_privs, .. } |
534 PendingOutboundPayment::Fulfilled { session_privs, .. } |
535 PendingOutboundPayment::Abandoned { session_privs, .. }
538 let payment_hash = self.payment_hash();
539 *self = PendingOutboundPayment::Fulfilled { session_privs, payment_hash, timer_ticks_without_htlcs: 0 };
542 fn mark_abandoned(&mut self) -> Result<(), ()> {
543 let mut session_privs = HashSet::new();
544 let our_payment_hash;
545 core::mem::swap(&mut session_privs, match self {
546 PendingOutboundPayment::Legacy { .. } |
547 PendingOutboundPayment::Fulfilled { .. } =>
549 PendingOutboundPayment::Retryable { session_privs, payment_hash, .. } |
550 PendingOutboundPayment::Abandoned { session_privs, payment_hash, .. } => {
551 our_payment_hash = *payment_hash;
555 *self = PendingOutboundPayment::Abandoned { session_privs, payment_hash: our_payment_hash };
559 /// panics if path is None and !self.is_fulfilled
560 fn remove(&mut self, session_priv: &[u8; 32], path: Option<&Vec<RouteHop>>) -> bool {
561 let remove_res = match self {
562 PendingOutboundPayment::Legacy { session_privs } |
563 PendingOutboundPayment::Retryable { session_privs, .. } |
564 PendingOutboundPayment::Fulfilled { session_privs, .. } |
565 PendingOutboundPayment::Abandoned { session_privs, .. } => {
566 session_privs.remove(session_priv)
570 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
571 let path = path.expect("Fulfilling a payment should always come with a path");
572 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
573 *pending_amt_msat -= path_last_hop.fee_msat;
574 if let Some(fee_msat) = pending_fee_msat.as_mut() {
575 *fee_msat -= path.get_path_fees();
582 fn insert(&mut self, session_priv: [u8; 32], path: &Vec<RouteHop>) -> bool {
583 let insert_res = match self {
584 PendingOutboundPayment::Legacy { session_privs } |
585 PendingOutboundPayment::Retryable { session_privs, .. } => {
586 session_privs.insert(session_priv)
588 PendingOutboundPayment::Fulfilled { .. } => false,
589 PendingOutboundPayment::Abandoned { .. } => false,
592 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
593 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
594 *pending_amt_msat += path_last_hop.fee_msat;
595 if let Some(fee_msat) = pending_fee_msat.as_mut() {
596 *fee_msat += path.get_path_fees();
603 fn remaining_parts(&self) -> usize {
605 PendingOutboundPayment::Legacy { session_privs } |
606 PendingOutboundPayment::Retryable { session_privs, .. } |
607 PendingOutboundPayment::Fulfilled { session_privs, .. } |
608 PendingOutboundPayment::Abandoned { session_privs, .. } => {
615 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
616 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
617 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
618 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
619 /// issues such as overly long function definitions. Note that the ChannelManager can take any
620 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
621 /// concrete type of the KeysManager.
623 /// (C-not exported) as Arcs don't make sense in bindings
624 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<Arc<M>, Arc<T>, Arc<KeysManager>, Arc<F>, Arc<L>>;
626 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
627 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
628 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
629 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
630 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
631 /// helps with issues such as long function definitions. Note that the ChannelManager can take any
632 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
633 /// concrete type of the KeysManager.
635 /// (C-not exported) as Arcs don't make sense in bindings
636 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L> = ChannelManager<&'a M, &'b T, &'c KeysManager, &'d F, &'e L>;
638 /// Manager which keeps track of a number of channels and sends messages to the appropriate
639 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
641 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
642 /// to individual Channels.
644 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
645 /// all peers during write/read (though does not modify this instance, only the instance being
646 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
647 /// called funding_transaction_generated for outbound channels).
649 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
650 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
651 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
652 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
653 /// the serialization process). If the deserialized version is out-of-date compared to the
654 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
655 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
657 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
658 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
659 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
660 /// block_connected() to step towards your best block) upon deserialization before using the
663 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
664 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
665 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
666 /// offline for a full minute. In order to track this, you must call
667 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
669 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
670 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
671 /// essentially you should default to using a SimpleRefChannelManager, and use a
672 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
673 /// you're using lightning-net-tokio.
676 // The tree structure below illustrates the lock order requirements for the different locks of the
677 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
678 // and should then be taken in the order of the lowest to the highest level in the tree.
679 // Note that locks on different branches shall not be taken at the same time, as doing so will
680 // create a new lock order for those specific locks in the order they were taken.
684 // `total_consistency_lock`
686 // |__`forward_htlcs`
688 // | |__`pending_intercepted_htlcs`
690 // |__`pending_inbound_payments`
692 // | |__`claimable_htlcs`
694 // | |__`pending_outbound_payments`
696 // | |__`channel_state`
700 // | |__`short_to_chan_info`
702 // | |__`per_peer_state`
704 // | |__`outbound_scid_aliases`
708 // | |__`pending_events`
710 // | |__`pending_background_events`
712 pub struct ChannelManager<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
713 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
714 T::Target: BroadcasterInterface,
715 K::Target: KeysInterface,
716 F::Target: FeeEstimator,
719 default_configuration: UserConfig,
720 genesis_hash: BlockHash,
721 fee_estimator: LowerBoundedFeeEstimator<F>,
725 /// See `ChannelManager` struct-level documentation for lock order requirements.
727 pub(super) best_block: RwLock<BestBlock>,
729 best_block: RwLock<BestBlock>,
730 secp_ctx: Secp256k1<secp256k1::All>,
732 /// See `ChannelManager` struct-level documentation for lock order requirements.
733 #[cfg(any(test, feature = "_test_utils"))]
734 pub(super) channel_state: Mutex<ChannelHolder<<K::Target as KeysInterface>::Signer>>,
735 #[cfg(not(any(test, feature = "_test_utils")))]
736 channel_state: Mutex<ChannelHolder<<K::Target as KeysInterface>::Signer>>,
738 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
739 /// expose them to users via a PaymentReceived event. HTLCs which do not meet the requirements
740 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
741 /// after we generate a PaymentReceived upon receipt of all MPP parts or when they time out.
743 /// See `ChannelManager` struct-level documentation for lock order requirements.
744 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
746 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
747 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
748 /// (if the channel has been force-closed), however we track them here to prevent duplicative
749 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
750 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
751 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
752 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
753 /// after reloading from disk while replaying blocks against ChannelMonitors.
755 /// See `PendingOutboundPayment` documentation for more info.
757 /// See `ChannelManager` struct-level documentation for lock order requirements.
758 pending_outbound_payments: Mutex<HashMap<PaymentId, PendingOutboundPayment>>,
760 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
762 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
763 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
764 /// and via the classic SCID.
766 /// Note that no consistency guarantees are made about the existence of a channel with the
767 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
769 /// See `ChannelManager` struct-level documentation for lock order requirements.
771 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
773 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
774 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
775 /// until the user tells us what we should do with them.
777 /// See `ChannelManager` struct-level documentation for lock order requirements.
778 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
780 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
781 /// failed/claimed by the user.
783 /// Note that, no consistency guarantees are made about the channels given here actually
784 /// existing anymore by the time you go to read them!
786 /// See `ChannelManager` struct-level documentation for lock order requirements.
787 claimable_htlcs: Mutex<HashMap<PaymentHash, (events::PaymentPurpose, Vec<ClaimableHTLC>)>>,
789 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
790 /// and some closed channels which reached a usable state prior to being closed. This is used
791 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
792 /// active channel list on load.
794 /// See `ChannelManager` struct-level documentation for lock order requirements.
795 outbound_scid_aliases: Mutex<HashSet<u64>>,
797 /// `channel_id` -> `counterparty_node_id`.
799 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
800 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
801 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
803 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
804 /// the corresponding channel for the event, as we only have access to the `channel_id` during
805 /// the handling of the events.
808 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
809 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
810 /// would break backwards compatability.
811 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
812 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
813 /// required to access the channel with the `counterparty_node_id`.
815 /// See `ChannelManager` struct-level documentation for lock order requirements.
816 id_to_peer: Mutex<HashMap<[u8; 32], PublicKey>>,
818 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
820 /// Outbound SCID aliases are added here once the channel is available for normal use, with
821 /// SCIDs being added once the funding transaction is confirmed at the channel's required
822 /// confirmation depth.
824 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
825 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
826 /// channel with the `channel_id` in our other maps.
828 /// See `ChannelManager` struct-level documentation for lock order requirements.
830 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
832 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
834 our_network_key: SecretKey,
835 our_network_pubkey: PublicKey,
837 inbound_payment_key: inbound_payment::ExpandedKey,
839 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
840 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
841 /// we encrypt the namespace identifier using these bytes.
843 /// [fake scids]: crate::util::scid_utils::fake_scid
844 fake_scid_rand_bytes: [u8; 32],
846 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
847 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
848 /// keeping additional state.
849 probing_cookie_secret: [u8; 32],
851 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
852 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
853 /// very far in the past, and can only ever be up to two hours in the future.
854 highest_seen_timestamp: AtomicUsize,
856 /// The bulk of our storage will eventually be here (channels and message queues and the like).
857 /// If we are connected to a peer we always at least have an entry here, even if no channels
858 /// are currently open with that peer.
859 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
860 /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
863 /// See `ChannelManager` struct-level documentation for lock order requirements.
864 per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
866 /// See `ChannelManager` struct-level documentation for lock order requirements.
867 pending_events: Mutex<Vec<events::Event>>,
868 /// See `ChannelManager` struct-level documentation for lock order requirements.
869 pending_background_events: Mutex<Vec<BackgroundEvent>>,
870 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
871 /// Essentially just when we're serializing ourselves out.
872 /// Taken first everywhere where we are making changes before any other locks.
873 /// When acquiring this lock in read mode, rather than acquiring it directly, call
874 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
875 /// Notifier the lock contains sends out a notification when the lock is released.
876 total_consistency_lock: RwLock<()>,
878 persistence_notifier: Notifier,
885 /// Chain-related parameters used to construct a new `ChannelManager`.
887 /// Typically, the block-specific parameters are derived from the best block hash for the network,
888 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
889 /// are not needed when deserializing a previously constructed `ChannelManager`.
890 #[derive(Clone, Copy, PartialEq)]
891 pub struct ChainParameters {
892 /// The network for determining the `chain_hash` in Lightning messages.
893 pub network: Network,
895 /// The hash and height of the latest block successfully connected.
897 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
898 pub best_block: BestBlock,
901 #[derive(Copy, Clone, PartialEq)]
907 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
908 /// desirable to notify any listeners on `await_persistable_update_timeout`/
909 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
910 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
911 /// sending the aforementioned notification (since the lock being released indicates that the
912 /// updates are ready for persistence).
914 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
915 /// notify or not based on whether relevant changes have been made, providing a closure to
916 /// `optionally_notify` which returns a `NotifyOption`.
917 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
918 persistence_notifier: &'a Notifier,
920 // We hold onto this result so the lock doesn't get released immediately.
921 _read_guard: RwLockReadGuard<'a, ()>,
924 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
925 fn notify_on_drop(lock: &'a RwLock<()>, notifier: &'a Notifier) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
926 PersistenceNotifierGuard::optionally_notify(lock, notifier, || -> NotifyOption { NotifyOption::DoPersist })
929 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a Notifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
930 let read_guard = lock.read().unwrap();
932 PersistenceNotifierGuard {
933 persistence_notifier: notifier,
934 should_persist: persist_check,
935 _read_guard: read_guard,
940 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
942 if (self.should_persist)() == NotifyOption::DoPersist {
943 self.persistence_notifier.notify();
948 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
949 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
951 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
953 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
954 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
955 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
956 /// the maximum required amount in lnd as of March 2021.
957 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
959 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
960 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
962 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
964 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
965 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
966 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
967 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
968 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
969 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
970 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
971 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
972 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
973 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
974 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
975 // routing failure for any HTLC sender picking up an LDK node among the first hops.
976 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
978 /// Minimum CLTV difference between the current block height and received inbound payments.
979 /// Invoices generated for payment to us must set their `min_final_cltv_expiry` field to at least
981 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
982 // any payments to succeed. Further, we don't want payments to fail if a block was found while
983 // a payment was being routed, so we add an extra block to be safe.
984 pub const MIN_FINAL_CLTV_EXPIRY: u32 = HTLC_FAIL_BACK_BUFFER + 3;
986 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
987 // ie that if the next-hop peer fails the HTLC within
988 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
989 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
990 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
991 // LATENCY_GRACE_PERIOD_BLOCKS.
994 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;
996 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
997 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
1000 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
1002 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
1003 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
1005 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until we time-out the
1006 /// idempotency of payments by [`PaymentId`]. See
1007 /// [`ChannelManager::remove_stale_resolved_payments`].
1008 pub(crate) const IDEMPOTENCY_TIMEOUT_TICKS: u8 = 7;
1010 /// Information needed for constructing an invoice route hint for this channel.
1011 #[derive(Clone, Debug, PartialEq)]
1012 pub struct CounterpartyForwardingInfo {
1013 /// Base routing fee in millisatoshis.
1014 pub fee_base_msat: u32,
1015 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
1016 pub fee_proportional_millionths: u32,
1017 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
1018 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
1019 /// `cltv_expiry_delta` for more details.
1020 pub cltv_expiry_delta: u16,
1023 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
1024 /// to better separate parameters.
1025 #[derive(Clone, Debug, PartialEq)]
1026 pub struct ChannelCounterparty {
1027 /// The node_id of our counterparty
1028 pub node_id: PublicKey,
1029 /// The Features the channel counterparty provided upon last connection.
1030 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
1031 /// many routing-relevant features are present in the init context.
1032 pub features: InitFeatures,
1033 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
1034 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
1035 /// claiming at least this value on chain.
1037 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
1039 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
1040 pub unspendable_punishment_reserve: u64,
1041 /// Information on the fees and requirements that the counterparty requires when forwarding
1042 /// payments to us through this channel.
1043 pub forwarding_info: Option<CounterpartyForwardingInfo>,
1044 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
1045 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
1046 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
1047 pub outbound_htlc_minimum_msat: Option<u64>,
1048 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
1049 pub outbound_htlc_maximum_msat: Option<u64>,
1052 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
1053 #[derive(Clone, Debug, PartialEq)]
1054 pub struct ChannelDetails {
1055 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
1056 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
1057 /// Note that this means this value is *not* persistent - it can change once during the
1058 /// lifetime of the channel.
1059 pub channel_id: [u8; 32],
1060 /// Parameters which apply to our counterparty. See individual fields for more information.
1061 pub counterparty: ChannelCounterparty,
1062 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
1063 /// our counterparty already.
1065 /// Note that, if this has been set, `channel_id` will be equivalent to
1066 /// `funding_txo.unwrap().to_channel_id()`.
1067 pub funding_txo: Option<OutPoint>,
1068 /// The features which this channel operates with. See individual features for more info.
1070 /// `None` until negotiation completes and the channel type is finalized.
1071 pub channel_type: Option<ChannelTypeFeatures>,
1072 /// The position of the funding transaction in the chain. None if the funding transaction has
1073 /// not yet been confirmed and the channel fully opened.
1075 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1076 /// payments instead of this. See [`get_inbound_payment_scid`].
1078 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1079 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1081 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1082 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1083 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1084 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1085 /// [`confirmations_required`]: Self::confirmations_required
1086 pub short_channel_id: Option<u64>,
1087 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1088 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1089 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1092 /// This will be `None` as long as the channel is not available for routing outbound payments.
1094 /// [`short_channel_id`]: Self::short_channel_id
1095 /// [`confirmations_required`]: Self::confirmations_required
1096 pub outbound_scid_alias: Option<u64>,
1097 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1098 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1099 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1100 /// when they see a payment to be routed to us.
1102 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1103 /// previous values for inbound payment forwarding.
1105 /// [`short_channel_id`]: Self::short_channel_id
1106 pub inbound_scid_alias: Option<u64>,
1107 /// The value, in satoshis, of this channel as appears in the funding output
1108 pub channel_value_satoshis: u64,
1109 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1110 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1111 /// this value on chain.
1113 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1115 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1117 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1118 pub unspendable_punishment_reserve: Option<u64>,
1119 /// The `user_channel_id` passed in to create_channel, or a random value if the channel was
1120 /// inbound. This may be zero for inbound channels serialized with LDK versions prior to
1122 pub user_channel_id: u128,
1123 /// Our total balance. This is the amount we would get if we close the channel.
1124 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1125 /// amount is not likely to be recoverable on close.
1127 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1128 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1129 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1130 /// This does not consider any on-chain fees.
1132 /// See also [`ChannelDetails::outbound_capacity_msat`]
1133 pub balance_msat: u64,
1134 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1135 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1136 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1137 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1139 /// See also [`ChannelDetails::balance_msat`]
1141 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1142 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1143 /// should be able to spend nearly this amount.
1144 pub outbound_capacity_msat: u64,
1145 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1146 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1147 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1148 /// to use a limit as close as possible to the HTLC limit we can currently send.
1150 /// See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
1151 pub next_outbound_htlc_limit_msat: u64,
1152 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1153 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1154 /// available for inclusion in new inbound HTLCs).
1155 /// Note that there are some corner cases not fully handled here, so the actual available
1156 /// inbound capacity may be slightly higher than this.
1158 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1159 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1160 /// However, our counterparty should be able to spend nearly this amount.
1161 pub inbound_capacity_msat: u64,
1162 /// The number of required confirmations on the funding transaction before the funding will be
1163 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1164 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1165 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1166 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1168 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1170 /// [`is_outbound`]: ChannelDetails::is_outbound
1171 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1172 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1173 pub confirmations_required: Option<u32>,
1174 /// The current number of confirmations on the funding transaction.
1176 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1177 pub confirmations: Option<u32>,
1178 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1179 /// until we can claim our funds after we force-close the channel. During this time our
1180 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1181 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1182 /// time to claim our non-HTLC-encumbered funds.
1184 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1185 pub force_close_spend_delay: Option<u16>,
1186 /// True if the channel was initiated (and thus funded) by us.
1187 pub is_outbound: bool,
1188 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1189 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1190 /// required confirmation count has been reached (and we were connected to the peer at some
1191 /// point after the funding transaction received enough confirmations). The required
1192 /// confirmation count is provided in [`confirmations_required`].
1194 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1195 pub is_channel_ready: bool,
1196 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1197 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1199 /// This is a strict superset of `is_channel_ready`.
1200 pub is_usable: bool,
1201 /// True if this channel is (or will be) publicly-announced.
1202 pub is_public: bool,
1203 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1204 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1205 pub inbound_htlc_minimum_msat: Option<u64>,
1206 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1207 pub inbound_htlc_maximum_msat: Option<u64>,
1208 /// Set of configurable parameters that affect channel operation.
1210 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1211 pub config: Option<ChannelConfig>,
1214 impl ChannelDetails {
1215 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1216 /// This should be used for providing invoice hints or in any other context where our
1217 /// counterparty will forward a payment to us.
1219 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1220 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1221 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1222 self.inbound_scid_alias.or(self.short_channel_id)
1225 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1226 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1227 /// we're sending or forwarding a payment outbound over this channel.
1229 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1230 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1231 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1232 self.short_channel_id.or(self.outbound_scid_alias)
1236 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
1237 /// Err() type describing which state the payment is in, see the description of individual enum
1238 /// states for more.
1239 #[derive(Clone, Debug)]
1240 pub enum PaymentSendFailure {
1241 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
1242 /// send the payment at all.
1244 /// You can freely resend the payment in full (with the parameter error fixed).
1246 /// Because the payment failed outright, no payment tracking is done, you do not need to call
1247 /// [`ChannelManager::abandon_payment`] and [`ChannelManager::retry_payment`] will *not* work
1248 /// for this payment.
1249 ParameterError(APIError),
1250 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
1251 /// from attempting to send the payment at all.
1253 /// You can freely resend the payment in full (with the parameter error fixed).
1255 /// The results here are ordered the same as the paths in the route object which was passed to
1258 /// Because the payment failed outright, no payment tracking is done, you do not need to call
1259 /// [`ChannelManager::abandon_payment`] and [`ChannelManager::retry_payment`] will *not* work
1260 /// for this payment.
1261 PathParameterError(Vec<Result<(), APIError>>),
1262 /// All paths which were attempted failed to send, with no channel state change taking place.
1263 /// You can freely resend the payment in full (though you probably want to do so over different
1264 /// paths than the ones selected).
1266 /// Because the payment failed outright, no payment tracking is done, you do not need to call
1267 /// [`ChannelManager::abandon_payment`] and [`ChannelManager::retry_payment`] will *not* work
1268 /// for this payment.
1269 AllFailedResendSafe(Vec<APIError>),
1270 /// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not
1271 /// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via
1272 /// [`ChannelManager::abandon_payment`]).
1274 /// [`Event::PaymentSent`]: events::Event::PaymentSent
1276 /// Some paths which were attempted failed to send, though possibly not all. At least some
1277 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
1278 /// in over-/re-payment.
1280 /// The results here are ordered the same as the paths in the route object which was passed to
1281 /// send_payment, and any `Err`s which are not [`APIError::MonitorUpdateInProgress`] can be
1282 /// safely retried via [`ChannelManager::retry_payment`].
1284 /// Any entries which contain `Err(APIError::MonitorUpdateInprogress)` or `Ok(())` MUST NOT be
1285 /// retried as they will result in over-/re-payment. These HTLCs all either successfully sent
1286 /// (in the case of `Ok(())`) or will send once a [`MonitorEvent::Completed`] is provided for
1287 /// the next-hop channel with the latest update_id.
1289 /// The errors themselves, in the same order as the route hops.
1290 results: Vec<Result<(), APIError>>,
1291 /// If some paths failed without irrevocably committing to the new HTLC(s), this will
1292 /// contain a [`RouteParameters`] object which can be used to calculate a new route that
1293 /// will pay all remaining unpaid balance.
1294 failed_paths_retry: Option<RouteParameters>,
1295 /// The payment id for the payment, which is now at least partially pending.
1296 payment_id: PaymentId,
1300 /// Route hints used in constructing invoices for [phantom node payents].
1302 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
1304 pub struct PhantomRouteHints {
1305 /// The list of channels to be included in the invoice route hints.
1306 pub channels: Vec<ChannelDetails>,
1307 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1309 pub phantom_scid: u64,
1310 /// The pubkey of the real backing node that would ultimately receive the payment.
1311 pub real_node_pubkey: PublicKey,
1314 macro_rules! handle_error {
1315 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
1318 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish }) => {
1319 #[cfg(debug_assertions)]
1321 // In testing, ensure there are no deadlocks where the lock is already held upon
1322 // entering the macro.
1323 assert!($self.channel_state.try_lock().is_ok());
1324 assert!($self.pending_events.try_lock().is_ok());
1327 let mut msg_events = Vec::with_capacity(2);
1329 if let Some((shutdown_res, update_option)) = shutdown_finish {
1330 $self.finish_force_close_channel(shutdown_res);
1331 if let Some(update) = update_option {
1332 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1336 if let Some((channel_id, user_channel_id)) = chan_id {
1337 $self.pending_events.lock().unwrap().push(events::Event::ChannelClosed {
1338 channel_id, user_channel_id,
1339 reason: ClosureReason::ProcessingError { err: err.err.clone() }
1344 log_error!($self.logger, "{}", err.err);
1345 if let msgs::ErrorAction::IgnoreError = err.action {
1347 msg_events.push(events::MessageSendEvent::HandleError {
1348 node_id: $counterparty_node_id,
1349 action: err.action.clone()
1353 if !msg_events.is_empty() {
1354 $self.channel_state.lock().unwrap().pending_msg_events.append(&mut msg_events);
1357 // Return error in case higher-API need one
1364 macro_rules! update_maps_on_chan_removal {
1365 ($self: expr, $channel: expr) => {{
1366 $self.id_to_peer.lock().unwrap().remove(&$channel.channel_id());
1367 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1368 if let Some(short_id) = $channel.get_short_channel_id() {
1369 short_to_chan_info.remove(&short_id);
1371 // If the channel was never confirmed on-chain prior to its closure, remove the
1372 // outbound SCID alias we used for it from the collision-prevention set. While we
1373 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1374 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1375 // opening a million channels with us which are closed before we ever reach the funding
1377 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel.outbound_scid_alias());
1378 debug_assert!(alias_removed);
1380 short_to_chan_info.remove(&$channel.outbound_scid_alias());
1384 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1385 macro_rules! convert_chan_err {
1386 ($self: ident, $err: expr, $channel: expr, $channel_id: expr) => {
1388 ChannelError::Warn(msg) => {
1389 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), $channel_id.clone()))
1391 ChannelError::Ignore(msg) => {
1392 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
1394 ChannelError::Close(msg) => {
1395 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
1396 update_maps_on_chan_removal!($self, $channel);
1397 let shutdown_res = $channel.force_shutdown(true);
1398 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
1399 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
1405 macro_rules! break_chan_entry {
1406 ($self: ident, $res: expr, $entry: expr) => {
1410 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1412 $entry.remove_entry();
1420 macro_rules! try_chan_entry {
1421 ($self: ident, $res: expr, $entry: expr) => {
1425 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1427 $entry.remove_entry();
1435 macro_rules! remove_channel {
1436 ($self: expr, $entry: expr) => {
1438 let channel = $entry.remove_entry().1;
1439 update_maps_on_chan_removal!($self, channel);
1445 macro_rules! handle_monitor_update_res {
1446 ($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) => {
1448 ChannelMonitorUpdateStatus::PermanentFailure => {
1449 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateStatus::PermanentFailure", log_bytes!($chan_id[..]));
1450 update_maps_on_chan_removal!($self, $chan);
1451 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
1452 // chain in a confused state! We need to move them into the ChannelMonitor which
1453 // will be responsible for failing backwards once things confirm on-chain.
1454 // It's ok that we drop $failed_forwards here - at this point we'd rather they
1455 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
1456 // us bother trying to claim it just to forward on to another peer. If we're
1457 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
1458 // given up the preimage yet, so might as well just wait until the payment is
1459 // retried, avoiding the on-chain fees.
1460 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure".to_owned(), *$chan_id, $chan.get_user_id(),
1461 $chan.force_shutdown(false), $self.get_channel_update_for_broadcast(&$chan).ok() ));
1464 ChannelMonitorUpdateStatus::InProgress => {
1465 log_info!($self.logger, "Disabling channel {} due to monitor update in progress. On restore will send {} and process {} forwards, {} fails, and {} fulfill finalizations",
1466 log_bytes!($chan_id[..]),
1467 if $resend_commitment && $resend_raa {
1468 match $action_type {
1469 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
1470 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
1472 } else if $resend_commitment { "commitment" }
1473 else if $resend_raa { "RAA" }
1475 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
1476 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len(),
1477 (&$failed_finalized_fulfills as &Vec<HTLCSource>).len());
1478 if !$resend_commitment {
1479 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
1482 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
1484 $chan.monitor_updating_paused($resend_raa, $resend_commitment, $resend_channel_ready, $failed_forwards, $failed_fails, $failed_finalized_fulfills);
1485 (Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$chan_id)), false)
1487 ChannelMonitorUpdateStatus::Completed => {
1492 ($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) => { {
1493 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());
1495 $entry.remove_entry();
1499 ($self: ident, $err: expr, $entry: expr, $action_type: path, $chan_id: expr, COMMITMENT_UPDATE_ONLY) => { {
1500 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst);
1501 handle_monitor_update_res!($self, $err, $entry, $action_type, false, true, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1503 ($self: ident, $err: expr, $entry: expr, $action_type: path, $chan_id: expr, NO_UPDATE) => {
1504 handle_monitor_update_res!($self, $err, $entry, $action_type, false, false, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1506 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_channel_ready: expr, OPTIONALLY_RESEND_FUNDING_LOCKED) => {
1507 handle_monitor_update_res!($self, $err, $entry, $action_type, false, false, $resend_channel_ready, Vec::new(), Vec::new(), Vec::new())
1509 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1510 handle_monitor_update_res!($self, $err, $entry, $action_type, $resend_raa, $resend_commitment, false, Vec::new(), Vec::new(), Vec::new())
1512 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
1513 handle_monitor_update_res!($self, $err, $entry, $action_type, $resend_raa, $resend_commitment, false, $failed_forwards, $failed_fails, Vec::new())
1517 macro_rules! send_channel_ready {
1518 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
1519 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1520 node_id: $channel.get_counterparty_node_id(),
1521 msg: $channel_ready_msg,
1523 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1524 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1525 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1526 let outbound_alias_insert = short_to_chan_info.insert($channel.outbound_scid_alias(), ($channel.get_counterparty_node_id(), $channel.channel_id()));
1527 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1528 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1529 if let Some(real_scid) = $channel.get_short_channel_id() {
1530 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.get_counterparty_node_id(), $channel.channel_id()));
1531 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1532 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1537 macro_rules! emit_channel_ready_event {
1538 ($self: expr, $channel: expr) => {
1539 if $channel.should_emit_channel_ready_event() {
1541 let mut pending_events = $self.pending_events.lock().unwrap();
1542 pending_events.push(events::Event::ChannelReady {
1543 channel_id: $channel.channel_id(),
1544 user_channel_id: $channel.get_user_id(),
1545 counterparty_node_id: $channel.get_counterparty_node_id(),
1546 channel_type: $channel.get_channel_type().clone(),
1549 $channel.set_channel_ready_event_emitted();
1554 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F, L>
1555 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
1556 T::Target: BroadcasterInterface,
1557 K::Target: KeysInterface,
1558 F::Target: FeeEstimator,
1561 /// Constructs a new ChannelManager to hold several channels and route between them.
1563 /// This is the main "logic hub" for all channel-related actions, and implements
1564 /// ChannelMessageHandler.
1566 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1568 /// Users need to notify the new ChannelManager when a new block is connected or
1569 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
1570 /// from after `params.latest_hash`.
1571 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, logger: L, keys_manager: K, config: UserConfig, params: ChainParameters) -> Self {
1572 let mut secp_ctx = Secp256k1::new();
1573 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
1574 let inbound_pmt_key_material = keys_manager.get_inbound_payment_key_material();
1575 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
1577 default_configuration: config.clone(),
1578 genesis_hash: genesis_block(params.network).header.block_hash(),
1579 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
1583 best_block: RwLock::new(params.best_block),
1585 channel_state: Mutex::new(ChannelHolder{
1586 by_id: HashMap::new(),
1587 pending_msg_events: Vec::new(),
1589 outbound_scid_aliases: Mutex::new(HashSet::new()),
1590 pending_inbound_payments: Mutex::new(HashMap::new()),
1591 pending_outbound_payments: Mutex::new(HashMap::new()),
1592 forward_htlcs: Mutex::new(HashMap::new()),
1593 claimable_htlcs: Mutex::new(HashMap::new()),
1594 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
1595 id_to_peer: Mutex::new(HashMap::new()),
1596 short_to_chan_info: FairRwLock::new(HashMap::new()),
1598 our_network_key: keys_manager.get_node_secret(Recipient::Node).unwrap(),
1599 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret(Recipient::Node).unwrap()),
1602 inbound_payment_key: expanded_inbound_key,
1603 fake_scid_rand_bytes: keys_manager.get_secure_random_bytes(),
1605 probing_cookie_secret: keys_manager.get_secure_random_bytes(),
1607 highest_seen_timestamp: AtomicUsize::new(0),
1609 per_peer_state: RwLock::new(HashMap::new()),
1611 pending_events: Mutex::new(Vec::new()),
1612 pending_background_events: Mutex::new(Vec::new()),
1613 total_consistency_lock: RwLock::new(()),
1614 persistence_notifier: Notifier::new(),
1622 /// Gets the current configuration applied to all new channels.
1623 pub fn get_current_default_configuration(&self) -> &UserConfig {
1624 &self.default_configuration
1627 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
1628 let height = self.best_block.read().unwrap().height();
1629 let mut outbound_scid_alias = 0;
1632 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
1633 outbound_scid_alias += 1;
1635 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
1637 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
1641 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"); }
1646 /// Creates a new outbound channel to the given remote node and with the given value.
1648 /// `user_channel_id` will be provided back as in
1649 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
1650 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
1651 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
1652 /// is simply copied to events and otherwise ignored.
1654 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
1655 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
1657 /// Note that we do not check if you are currently connected to the given peer. If no
1658 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
1659 /// the channel eventually being silently forgotten (dropped on reload).
1661 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
1662 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
1663 /// [`ChannelDetails::channel_id`] until after
1664 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
1665 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
1666 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
1668 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
1669 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
1670 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
1671 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> {
1672 if channel_value_satoshis < 1000 {
1673 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
1677 let per_peer_state = self.per_peer_state.read().unwrap();
1678 match per_peer_state.get(&their_network_key) {
1679 Some(peer_state) => {
1680 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
1681 let peer_state = peer_state.lock().unwrap();
1682 let their_features = &peer_state.latest_features;
1683 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
1684 match Channel::new_outbound(&self.fee_estimator, &self.keys_manager, their_network_key,
1685 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
1686 self.best_block.read().unwrap().height(), outbound_scid_alias)
1690 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
1695 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", their_network_key) }),
1698 let res = channel.get_open_channel(self.genesis_hash.clone());
1700 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1701 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
1702 debug_assert!(&self.total_consistency_lock.try_write().is_err());
1704 let temporary_channel_id = channel.channel_id();
1705 let mut channel_state = self.channel_state.lock().unwrap();
1706 match channel_state.by_id.entry(temporary_channel_id) {
1707 hash_map::Entry::Occupied(_) => {
1709 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
1711 panic!("RNG is bad???");
1714 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
1716 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
1717 node_id: their_network_key,
1720 Ok(temporary_channel_id)
1723 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<<K::Target as KeysInterface>::Signer>)) -> bool>(&self, f: Fn) -> Vec<ChannelDetails> {
1724 let mut res = Vec::new();
1726 let channel_state = self.channel_state.lock().unwrap();
1727 let best_block_height = self.best_block.read().unwrap().height();
1728 res.reserve(channel_state.by_id.len());
1729 for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
1730 let balance = channel.get_available_balances();
1731 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1732 channel.get_holder_counterparty_selected_channel_reserve_satoshis();
1733 res.push(ChannelDetails {
1734 channel_id: (*channel_id).clone(),
1735 counterparty: ChannelCounterparty {
1736 node_id: channel.get_counterparty_node_id(),
1737 features: InitFeatures::empty(),
1738 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1739 forwarding_info: channel.counterparty_forwarding_info(),
1740 // Ensures that we have actually received the `htlc_minimum_msat` value
1741 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1742 // message (as they are always the first message from the counterparty).
1743 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1744 // default `0` value set by `Channel::new_outbound`.
1745 outbound_htlc_minimum_msat: if channel.have_received_message() {
1746 Some(channel.get_counterparty_htlc_minimum_msat()) } else { None },
1747 outbound_htlc_maximum_msat: channel.get_counterparty_htlc_maximum_msat(),
1749 funding_txo: channel.get_funding_txo(),
1750 // Note that accept_channel (or open_channel) is always the first message, so
1751 // `have_received_message` indicates that type negotiation has completed.
1752 channel_type: if channel.have_received_message() { Some(channel.get_channel_type().clone()) } else { None },
1753 short_channel_id: channel.get_short_channel_id(),
1754 outbound_scid_alias: if channel.is_usable() { Some(channel.outbound_scid_alias()) } else { None },
1755 inbound_scid_alias: channel.latest_inbound_scid_alias(),
1756 channel_value_satoshis: channel.get_value_satoshis(),
1757 unspendable_punishment_reserve: to_self_reserve_satoshis,
1758 balance_msat: balance.balance_msat,
1759 inbound_capacity_msat: balance.inbound_capacity_msat,
1760 outbound_capacity_msat: balance.outbound_capacity_msat,
1761 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1762 user_channel_id: channel.get_user_id(),
1763 confirmations_required: channel.minimum_depth(),
1764 confirmations: Some(channel.get_funding_tx_confirmations(best_block_height)),
1765 force_close_spend_delay: channel.get_counterparty_selected_contest_delay(),
1766 is_outbound: channel.is_outbound(),
1767 is_channel_ready: channel.is_usable(),
1768 is_usable: channel.is_live(),
1769 is_public: channel.should_announce(),
1770 inbound_htlc_minimum_msat: Some(channel.get_holder_htlc_minimum_msat()),
1771 inbound_htlc_maximum_msat: channel.get_holder_htlc_maximum_msat(),
1772 config: Some(channel.config()),
1776 let per_peer_state = self.per_peer_state.read().unwrap();
1777 for chan in res.iter_mut() {
1778 if let Some(peer_state) = per_peer_state.get(&chan.counterparty.node_id) {
1779 chan.counterparty.features = peer_state.lock().unwrap().latest_features.clone();
1785 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
1786 /// more information.
1787 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1788 self.list_channels_with_filter(|_| true)
1791 /// Gets the list of usable channels, in random order. Useful as an argument to [`find_route`]
1792 /// to ensure non-announced channels are used.
1794 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1795 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1798 /// [`find_route`]: crate::routing::router::find_route
1799 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1800 // Note we use is_live here instead of usable which leads to somewhat confused
1801 // internal/external nomenclature, but that's ok cause that's probably what the user
1802 // really wanted anyway.
1803 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1806 /// Helper function that issues the channel close events
1807 fn issue_channel_close_events(&self, channel: &Channel<<K::Target as KeysInterface>::Signer>, closure_reason: ClosureReason) {
1808 let mut pending_events_lock = self.pending_events.lock().unwrap();
1809 match channel.unbroadcasted_funding() {
1810 Some(transaction) => {
1811 pending_events_lock.push(events::Event::DiscardFunding { channel_id: channel.channel_id(), transaction })
1815 pending_events_lock.push(events::Event::ChannelClosed {
1816 channel_id: channel.channel_id(),
1817 user_channel_id: channel.get_user_id(),
1818 reason: closure_reason
1822 fn close_channel_internal(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>) -> Result<(), APIError> {
1823 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1825 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
1826 let result: Result<(), _> = loop {
1827 let mut channel_state_lock = self.channel_state.lock().unwrap();
1828 let channel_state = &mut *channel_state_lock;
1829 match channel_state.by_id.entry(channel_id.clone()) {
1830 hash_map::Entry::Occupied(mut chan_entry) => {
1831 if *counterparty_node_id != chan_entry.get().get_counterparty_node_id(){
1832 return Err(APIError::APIMisuseError { err: "The passed counterparty_node_id doesn't match the channel's counterparty node_id".to_owned() });
1834 let (shutdown_msg, monitor_update, htlcs) = {
1835 let per_peer_state = self.per_peer_state.read().unwrap();
1836 match per_peer_state.get(&counterparty_node_id) {
1837 Some(peer_state) => {
1838 let peer_state = peer_state.lock().unwrap();
1839 let their_features = &peer_state.latest_features;
1840 chan_entry.get_mut().get_shutdown(&self.keys_manager, their_features, target_feerate_sats_per_1000_weight)?
1842 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", counterparty_node_id) }),
1845 failed_htlcs = htlcs;
1847 // Update the monitor with the shutdown script if necessary.
1848 if let Some(monitor_update) = monitor_update {
1849 let update_res = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update);
1850 let (result, is_permanent) =
1851 handle_monitor_update_res!(self, update_res, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
1853 remove_channel!(self, chan_entry);
1858 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1859 node_id: *counterparty_node_id,
1863 if chan_entry.get().is_shutdown() {
1864 let channel = remove_channel!(self, chan_entry);
1865 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
1866 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1870 self.issue_channel_close_events(&channel, ClosureReason::HolderForceClosed);
1874 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()})
1878 for htlc_source in failed_htlcs.drain(..) {
1879 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
1880 self.fail_htlc_backwards_internal(htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
1883 let _ = handle_error!(self, result, *counterparty_node_id);
1887 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1888 /// will be accepted on the given channel, and after additional timeout/the closing of all
1889 /// pending HTLCs, the channel will be closed on chain.
1891 /// * If we are the channel initiator, we will pay between our [`Background`] and
1892 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1894 /// * If our counterparty is the channel initiator, we will require a channel closing
1895 /// transaction feerate of at least our [`Background`] feerate or the feerate which
1896 /// would appear on a force-closure transaction, whichever is lower. We will allow our
1897 /// counterparty to pay as much fee as they'd like, however.
1899 /// May generate a SendShutdown message event on success, which should be relayed.
1901 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1902 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1903 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1904 pub fn close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
1905 self.close_channel_internal(channel_id, counterparty_node_id, None)
1908 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1909 /// will be accepted on the given channel, and after additional timeout/the closing of all
1910 /// pending HTLCs, the channel will be closed on chain.
1912 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
1913 /// the channel being closed or not:
1914 /// * If we are the channel initiator, we will pay at least this feerate on the closing
1915 /// transaction. The upper-bound is set by
1916 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1917 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
1918 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
1919 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
1920 /// will appear on a force-closure transaction, whichever is lower).
1922 /// May generate a SendShutdown message event on success, which should be relayed.
1924 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1925 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1926 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1927 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> {
1928 self.close_channel_internal(channel_id, counterparty_node_id, Some(target_feerate_sats_per_1000_weight))
1932 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1933 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1934 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
1935 for htlc_source in failed_htlcs.drain(..) {
1936 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
1937 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
1938 self.fail_htlc_backwards_internal(source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
1940 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1941 // There isn't anything we can do if we get an update failure - we're already
1942 // force-closing. The monitor update on the required in-memory copy should broadcast
1943 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1944 // ignore the result here.
1945 let _ = self.chain_monitor.update_channel(funding_txo, monitor_update);
1949 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
1950 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
1951 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
1952 -> Result<PublicKey, APIError> {
1954 let mut channel_state_lock = self.channel_state.lock().unwrap();
1955 let channel_state = &mut *channel_state_lock;
1956 if let hash_map::Entry::Occupied(chan) = channel_state.by_id.entry(channel_id.clone()) {
1957 if chan.get().get_counterparty_node_id() != *peer_node_id {
1958 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1960 if let Some(peer_msg) = peer_msg {
1961 self.issue_channel_close_events(chan.get(),ClosureReason::CounterpartyForceClosed { peer_msg: peer_msg.to_string() });
1963 self.issue_channel_close_events(chan.get(),ClosureReason::HolderForceClosed);
1965 remove_channel!(self, chan)
1967 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1970 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
1971 self.finish_force_close_channel(chan.force_shutdown(broadcast));
1972 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
1973 let mut channel_state = self.channel_state.lock().unwrap();
1974 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1979 Ok(chan.get_counterparty_node_id())
1982 fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
1983 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1984 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
1985 Ok(counterparty_node_id) => {
1986 self.channel_state.lock().unwrap().pending_msg_events.push(
1987 events::MessageSendEvent::HandleError {
1988 node_id: counterparty_node_id,
1989 action: msgs::ErrorAction::SendErrorMessage {
1990 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
2000 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
2001 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
2002 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
2004 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
2005 -> Result<(), APIError> {
2006 self.force_close_sending_error(channel_id, counterparty_node_id, true)
2009 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
2010 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
2011 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
2013 /// You can always get the latest local transaction(s) to broadcast from
2014 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
2015 pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
2016 -> Result<(), APIError> {
2017 self.force_close_sending_error(channel_id, counterparty_node_id, false)
2020 /// Force close all channels, immediately broadcasting the latest local commitment transaction
2021 /// for each to the chain and rejecting new HTLCs on each.
2022 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
2023 for chan in self.list_channels() {
2024 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
2028 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
2029 /// local transaction(s).
2030 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
2031 for chan in self.list_channels() {
2032 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
2036 fn construct_recv_pending_htlc_info(&self, hop_data: msgs::OnionHopData, shared_secret: [u8; 32],
2037 payment_hash: PaymentHash, amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>) -> Result<PendingHTLCInfo, ReceiveError>
2039 // final_incorrect_cltv_expiry
2040 if hop_data.outgoing_cltv_value != cltv_expiry {
2041 return Err(ReceiveError {
2042 msg: "Upstream node set CLTV to the wrong value",
2044 err_data: byte_utils::be32_to_array(cltv_expiry).to_vec()
2047 // final_expiry_too_soon
2048 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
2049 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
2050 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
2051 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
2052 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
2053 if (hop_data.outgoing_cltv_value as u64) <= self.best_block.read().unwrap().height() as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
2054 return Err(ReceiveError {
2056 err_data: Vec::new(),
2057 msg: "The final CLTV expiry is too soon to handle",
2060 if hop_data.amt_to_forward > amt_msat {
2061 return Err(ReceiveError {
2063 err_data: byte_utils::be64_to_array(amt_msat).to_vec(),
2064 msg: "Upstream node sent less than we were supposed to receive in payment",
2068 let routing = match hop_data.format {
2069 msgs::OnionHopDataFormat::NonFinalNode { .. } => {
2070 return Err(ReceiveError {
2071 err_code: 0x4000|22,
2072 err_data: Vec::new(),
2073 msg: "Got non final data with an HMAC of 0",
2076 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage } => {
2077 if payment_data.is_some() && keysend_preimage.is_some() {
2078 return Err(ReceiveError {
2079 err_code: 0x4000|22,
2080 err_data: Vec::new(),
2081 msg: "We don't support MPP keysend payments",
2083 } else if let Some(data) = payment_data {
2084 PendingHTLCRouting::Receive {
2086 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2087 phantom_shared_secret,
2089 } else if let Some(payment_preimage) = keysend_preimage {
2090 // We need to check that the sender knows the keysend preimage before processing this
2091 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
2092 // could discover the final destination of X, by probing the adjacent nodes on the route
2093 // with a keysend payment of identical payment hash to X and observing the processing
2094 // time discrepancies due to a hash collision with X.
2095 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2096 if hashed_preimage != payment_hash {
2097 return Err(ReceiveError {
2098 err_code: 0x4000|22,
2099 err_data: Vec::new(),
2100 msg: "Payment preimage didn't match payment hash",
2104 PendingHTLCRouting::ReceiveKeysend {
2106 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2109 return Err(ReceiveError {
2110 err_code: 0x4000|0x2000|3,
2111 err_data: Vec::new(),
2112 msg: "We require payment_secrets",
2117 Ok(PendingHTLCInfo {
2120 incoming_shared_secret: shared_secret,
2121 incoming_amt_msat: Some(amt_msat),
2122 outgoing_amt_msat: amt_msat,
2123 outgoing_cltv_value: hop_data.outgoing_cltv_value,
2127 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> PendingHTLCStatus {
2128 macro_rules! return_malformed_err {
2129 ($msg: expr, $err_code: expr) => {
2131 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2132 return PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
2133 channel_id: msg.channel_id,
2134 htlc_id: msg.htlc_id,
2135 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
2136 failure_code: $err_code,
2142 if let Err(_) = msg.onion_routing_packet.public_key {
2143 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2146 let shared_secret = SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key).secret_bytes();
2148 if msg.onion_routing_packet.version != 0 {
2149 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2150 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2151 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2152 //receiving node would have to brute force to figure out which version was put in the
2153 //packet by the node that send us the message, in the case of hashing the hop_data, the
2154 //node knows the HMAC matched, so they already know what is there...
2155 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2157 macro_rules! return_err {
2158 ($msg: expr, $err_code: expr, $data: expr) => {
2160 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2161 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2162 channel_id: msg.channel_id,
2163 htlc_id: msg.htlc_id,
2164 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
2170 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) {
2172 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2173 return_malformed_err!(err_msg, err_code);
2175 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2176 return_err!(err_msg, err_code, &[0; 0]);
2180 let pending_forward_info = match next_hop {
2181 onion_utils::Hop::Receive(next_hop_data) => {
2183 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash, msg.amount_msat, msg.cltv_expiry, None) {
2185 // Note that we could obviously respond immediately with an update_fulfill_htlc
2186 // message, however that would leak that we are the recipient of this payment, so
2187 // instead we stay symmetric with the forwarding case, only responding (after a
2188 // delay) once they've send us a commitment_signed!
2189 PendingHTLCStatus::Forward(info)
2191 Err(ReceiveError { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
2194 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
2195 let new_pubkey = msg.onion_routing_packet.public_key.unwrap();
2196 let outgoing_packet = msgs::OnionPacket {
2198 public_key: onion_utils::next_hop_packet_pubkey(&self.secp_ctx, new_pubkey, &shared_secret),
2199 hop_data: new_packet_bytes,
2200 hmac: next_hop_hmac.clone(),
2203 let short_channel_id = match next_hop_data.format {
2204 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
2205 msgs::OnionHopDataFormat::FinalNode { .. } => {
2206 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
2210 PendingHTLCStatus::Forward(PendingHTLCInfo {
2211 routing: PendingHTLCRouting::Forward {
2212 onion_packet: outgoing_packet,
2215 payment_hash: msg.payment_hash.clone(),
2216 incoming_shared_secret: shared_secret,
2217 incoming_amt_msat: Some(msg.amount_msat),
2218 outgoing_amt_msat: next_hop_data.amt_to_forward,
2219 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
2224 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref outgoing_amt_msat, ref outgoing_cltv_value, .. }) = &pending_forward_info {
2225 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
2226 // with a short_channel_id of 0. This is important as various things later assume
2227 // short_channel_id is non-0 in any ::Forward.
2228 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
2229 if let Some((err, code, chan_update)) = loop {
2230 let id_option = self.short_to_chan_info.read().unwrap().get(&short_channel_id).cloned();
2231 let mut channel_state = self.channel_state.lock().unwrap();
2232 let forwarding_id_opt = match id_option {
2233 None => { // unknown_next_peer
2234 // Note that this is likely a timing oracle for detecting whether an scid is a
2235 // phantom or an intercept.
2236 if (self.default_configuration.accept_intercept_htlcs &&
2237 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, *short_channel_id, &self.genesis_hash)) ||
2238 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, *short_channel_id, &self.genesis_hash)
2242 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2245 Some((_cp_id, chan_id)) => Some(chan_id.clone()),
2247 let chan_update_opt = if let Some(forwarding_id) = forwarding_id_opt {
2248 let chan = match channel_state.by_id.get_mut(&forwarding_id) {
2250 // Channel was removed. The short_to_chan_info and by_id maps have
2251 // no consistency guarantees.
2252 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2256 if !chan.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
2257 // Note that the behavior here should be identical to the above block - we
2258 // should NOT reveal the existence or non-existence of a private channel if
2259 // we don't allow forwards outbound over them.
2260 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
2262 if chan.get_channel_type().supports_scid_privacy() && *short_channel_id != chan.outbound_scid_alias() {
2263 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
2264 // "refuse to forward unless the SCID alias was used", so we pretend
2265 // we don't have the channel here.
2266 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
2268 let chan_update_opt = self.get_channel_update_for_onion(*short_channel_id, chan).ok();
2270 // Note that we could technically not return an error yet here and just hope
2271 // that the connection is reestablished or monitor updated by the time we get
2272 // around to doing the actual forward, but better to fail early if we can and
2273 // hopefully an attacker trying to path-trace payments cannot make this occur
2274 // on a small/per-node/per-channel scale.
2275 if !chan.is_live() { // channel_disabled
2276 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, chan_update_opt));
2278 if *outgoing_amt_msat < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
2279 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
2281 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, *outgoing_amt_msat, *outgoing_cltv_value) {
2282 break Some((err, code, chan_update_opt));
2286 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
2288 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
2295 let cur_height = self.best_block.read().unwrap().height() + 1;
2296 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
2297 // but we want to be robust wrt to counterparty packet sanitization (see
2298 // HTLC_FAIL_BACK_BUFFER rationale).
2299 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
2300 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
2302 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
2303 break Some(("CLTV expiry is too far in the future", 21, None));
2305 // If the HTLC expires ~now, don't bother trying to forward it to our
2306 // counterparty. They should fail it anyway, but we don't want to bother with
2307 // the round-trips or risk them deciding they definitely want the HTLC and
2308 // force-closing to ensure they get it if we're offline.
2309 // We previously had a much more aggressive check here which tried to ensure
2310 // our counterparty receives an HTLC which has *our* risk threshold met on it,
2311 // but there is no need to do that, and since we're a bit conservative with our
2312 // risk threshold it just results in failing to forward payments.
2313 if (*outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
2314 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
2320 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
2321 if let Some(chan_update) = chan_update {
2322 if code == 0x1000 | 11 || code == 0x1000 | 12 {
2323 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
2325 else if code == 0x1000 | 13 {
2326 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
2328 else if code == 0x1000 | 20 {
2329 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
2330 0u16.write(&mut res).expect("Writes cannot fail");
2332 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
2333 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
2334 chan_update.write(&mut res).expect("Writes cannot fail");
2336 return_err!(err, code, &res.0[..]);
2341 pending_forward_info
2344 /// Gets the current channel_update for the given channel. This first checks if the channel is
2345 /// public, and thus should be called whenever the result is going to be passed out in a
2346 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
2348 /// May be called with channel_state already locked!
2349 fn get_channel_update_for_broadcast(&self, chan: &Channel<<K::Target as KeysInterface>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2350 if !chan.should_announce() {
2351 return Err(LightningError {
2352 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
2353 action: msgs::ErrorAction::IgnoreError
2356 if chan.get_short_channel_id().is_none() {
2357 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
2359 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.channel_id()));
2360 self.get_channel_update_for_unicast(chan)
2363 /// Gets the current channel_update for the given channel. This does not check if the channel
2364 /// is public (only returning an Err if the channel does not yet have an assigned short_id),
2365 /// and thus MUST NOT be called unless the recipient of the resulting message has already
2366 /// provided evidence that they know about the existence of the channel.
2367 /// May be called with channel_state already locked!
2368 fn get_channel_update_for_unicast(&self, chan: &Channel<<K::Target as KeysInterface>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2369 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.channel_id()));
2370 let short_channel_id = match chan.get_short_channel_id().or(chan.latest_inbound_scid_alias()) {
2371 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
2375 self.get_channel_update_for_onion(short_channel_id, chan)
2377 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<<K::Target as KeysInterface>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2378 log_trace!(self.logger, "Generating channel update for channel {}", log_bytes!(chan.channel_id()));
2379 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
2381 let unsigned = msgs::UnsignedChannelUpdate {
2382 chain_hash: self.genesis_hash,
2384 timestamp: chan.get_update_time_counter(),
2385 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
2386 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
2387 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
2388 htlc_maximum_msat: chan.get_announced_htlc_max_msat(),
2389 fee_base_msat: chan.get_outbound_forwarding_fee_base_msat(),
2390 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
2391 excess_data: Vec::new(),
2394 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
2395 let sig = self.secp_ctx.sign_ecdsa(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
2397 Ok(msgs::ChannelUpdate {
2403 // Only public for testing, this should otherwise never be called direcly
2404 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> {
2405 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
2406 let prng_seed = self.keys_manager.get_secure_random_bytes();
2407 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
2409 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
2410 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
2411 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
2412 if onion_utils::route_size_insane(&onion_payloads) {
2413 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
2415 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
2417 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2419 let err: Result<(), _> = loop {
2420 let id = match self.short_to_chan_info.read().unwrap().get(&path.first().unwrap().short_channel_id) {
2421 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
2422 Some((_cp_id, chan_id)) => chan_id.clone(),
2425 let mut channel_lock = self.channel_state.lock().unwrap();
2426 let channel_state = &mut *channel_lock;
2427 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
2429 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
2430 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
2432 if !chan.get().is_live() {
2433 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
2435 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(
2436 htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
2438 session_priv: session_priv.clone(),
2439 first_hop_htlc_msat: htlc_msat,
2441 payment_secret: payment_secret.clone(),
2442 payment_params: payment_params.clone(),
2443 }, onion_packet, &self.logger),
2446 Some((update_add, commitment_signed, monitor_update)) => {
2447 let update_err = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update);
2448 let chan_id = chan.get().channel_id();
2450 handle_monitor_update_res!(self, update_err, chan,
2451 RAACommitmentOrder::CommitmentFirst, false, true))
2453 (ChannelMonitorUpdateStatus::PermanentFailure, Err(e)) => break Err(e),
2454 (ChannelMonitorUpdateStatus::Completed, Ok(())) => {},
2455 (ChannelMonitorUpdateStatus::InProgress, Err(_)) => {
2456 // Note that MonitorUpdateInProgress here indicates (per function
2457 // docs) that we will resend the commitment update once monitor
2458 // updating completes. Therefore, we must return an error
2459 // indicating that it is unsafe to retry the payment wholesale,
2460 // which we do in the send_payment check for
2461 // MonitorUpdateInProgress, below.
2462 return Err(APIError::MonitorUpdateInProgress);
2464 _ => unreachable!(),
2467 log_debug!(self.logger, "Sending payment along path resulted in a commitment_signed for channel {}", log_bytes!(chan_id));
2468 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2469 node_id: path.first().unwrap().pubkey,
2470 updates: msgs::CommitmentUpdate {
2471 update_add_htlcs: vec![update_add],
2472 update_fulfill_htlcs: Vec::new(),
2473 update_fail_htlcs: Vec::new(),
2474 update_fail_malformed_htlcs: Vec::new(),
2483 // The channel was likely removed after we fetched the id from the
2484 // `short_to_chan_info` map, but before we successfully locked the `by_id` map.
2485 // This can occur as no consistency guarantees exists between the two maps.
2486 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
2491 match handle_error!(self, err, path.first().unwrap().pubkey) {
2492 Ok(_) => unreachable!(),
2494 Err(APIError::ChannelUnavailable { err: e.err })
2499 /// Sends a payment along a given route.
2501 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
2502 /// fields for more info.
2504 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
2505 /// method will error with an [`APIError::RouteError`]. Note, however, that once a payment
2506 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
2507 /// [`Event::PaymentSent`]) LDK will not stop you from sending a second payment with the same
2510 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
2511 /// tracking of payments, including state to indicate once a payment has completed. Because you
2512 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
2513 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
2514 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
2516 /// May generate SendHTLCs message(s) event on success, which should be relayed (e.g. via
2517 /// [`PeerManager::process_events`]).
2519 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
2520 /// each entry matching the corresponding-index entry in the route paths, see
2521 /// PaymentSendFailure for more info.
2523 /// In general, a path may raise:
2524 /// * [`APIError::RouteError`] when an invalid route or forwarding parameter (cltv_delta, fee,
2525 /// node public key) is specified.
2526 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
2527 /// (including due to previous monitor update failure or new permanent monitor update
2529 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
2530 /// relevant updates.
2532 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
2533 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
2534 /// different route unless you intend to pay twice!
2536 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
2537 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
2538 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
2539 /// must not contain multiple paths as multi-path payments require a recipient-provided
2542 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
2543 /// bit set (either as required or as available). If multiple paths are present in the Route,
2544 /// we assume the invoice had the basic_mpp feature set.
2546 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2547 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
2548 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2549 let onion_session_privs = self.add_new_pending_payment(payment_hash, *payment_secret, payment_id, route)?;
2550 self.send_payment_internal(route, payment_hash, payment_secret, None, payment_id, None, onion_session_privs)
2554 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> {
2555 self.add_new_pending_payment(payment_hash, payment_secret, payment_id, route)
2558 fn add_new_pending_payment(&self, payment_hash: PaymentHash, payment_secret: Option<PaymentSecret>, payment_id: PaymentId, route: &Route) -> Result<Vec<[u8; 32]>, PaymentSendFailure> {
2559 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
2560 for _ in 0..route.paths.len() {
2561 onion_session_privs.push(self.keys_manager.get_secure_random_bytes());
2564 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
2565 match pending_outbounds.entry(payment_id) {
2566 hash_map::Entry::Occupied(_) => Err(PaymentSendFailure::DuplicatePayment),
2567 hash_map::Entry::Vacant(entry) => {
2568 let payment = entry.insert(PendingOutboundPayment::Retryable {
2569 session_privs: HashSet::new(),
2570 pending_amt_msat: 0,
2571 pending_fee_msat: Some(0),
2574 starting_block_height: self.best_block.read().unwrap().height(),
2575 total_msat: route.get_total_amount(),
2578 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
2579 assert!(payment.insert(*session_priv_bytes, path));
2582 Ok(onion_session_privs)
2587 fn send_payment_internal(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>, onion_session_privs: Vec<[u8; 32]>) -> Result<(), PaymentSendFailure> {
2588 if route.paths.len() < 1 {
2589 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
2591 if payment_secret.is_none() && route.paths.len() > 1 {
2592 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
2594 let mut total_value = 0;
2595 let our_node_id = self.get_our_node_id();
2596 let mut path_errs = Vec::with_capacity(route.paths.len());
2597 'path_check: for path in route.paths.iter() {
2598 if path.len() < 1 || path.len() > 20 {
2599 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
2600 continue 'path_check;
2602 for (idx, hop) in path.iter().enumerate() {
2603 if idx != path.len() - 1 && hop.pubkey == our_node_id {
2604 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
2605 continue 'path_check;
2608 total_value += path.last().unwrap().fee_msat;
2609 path_errs.push(Ok(()));
2611 if path_errs.iter().any(|e| e.is_err()) {
2612 return Err(PaymentSendFailure::PathParameterError(path_errs));
2614 if let Some(amt_msat) = recv_value_msat {
2615 debug_assert!(amt_msat >= total_value);
2616 total_value = amt_msat;
2619 let cur_height = self.best_block.read().unwrap().height() + 1;
2620 let mut results = Vec::new();
2621 debug_assert_eq!(route.paths.len(), onion_session_privs.len());
2622 for (path, session_priv) in route.paths.iter().zip(onion_session_privs.into_iter()) {
2623 let mut path_res = self.send_payment_along_path(&path, &route.payment_params, &payment_hash, payment_secret, total_value, cur_height, payment_id, &keysend_preimage, session_priv);
2626 Err(APIError::MonitorUpdateInProgress) => {
2627 // While a MonitorUpdateInProgress is an Err(_), the payment is still
2628 // considered "in flight" and we shouldn't remove it from the
2629 // PendingOutboundPayment set.
2632 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
2633 if let Some(payment) = pending_outbounds.get_mut(&payment_id) {
2634 let removed = payment.remove(&session_priv, Some(path));
2635 debug_assert!(removed, "This can't happen as the payment has an entry for this path added by callers");
2637 debug_assert!(false, "This can't happen as the payment was added by callers");
2638 path_res = Err(APIError::APIMisuseError { err: "Internal error: payment disappeared during processing. Please report this bug!".to_owned() });
2642 results.push(path_res);
2644 let mut has_ok = false;
2645 let mut has_err = false;
2646 let mut pending_amt_unsent = 0;
2647 let mut max_unsent_cltv_delta = 0;
2648 for (res, path) in results.iter().zip(route.paths.iter()) {
2649 if res.is_ok() { has_ok = true; }
2650 if res.is_err() { has_err = true; }
2651 if let &Err(APIError::MonitorUpdateInProgress) = res {
2652 // MonitorUpdateInProgress is inherently unsafe to retry, so we call it a
2656 } else if res.is_err() {
2657 pending_amt_unsent += path.last().unwrap().fee_msat;
2658 max_unsent_cltv_delta = cmp::max(max_unsent_cltv_delta, path.last().unwrap().cltv_expiry_delta);
2661 if has_err && has_ok {
2662 Err(PaymentSendFailure::PartialFailure {
2665 failed_paths_retry: if pending_amt_unsent != 0 {
2666 if let Some(payment_params) = &route.payment_params {
2667 Some(RouteParameters {
2668 payment_params: payment_params.clone(),
2669 final_value_msat: pending_amt_unsent,
2670 final_cltv_expiry_delta: max_unsent_cltv_delta,
2676 // If we failed to send any paths, we should remove the new PaymentId from the
2677 // `pending_outbound_payments` map, as the user isn't expected to `abandon_payment`.
2678 let removed = self.pending_outbound_payments.lock().unwrap().remove(&payment_id).is_some();
2679 debug_assert!(removed, "We should always have a pending payment to remove here");
2680 Err(PaymentSendFailure::AllFailedResendSafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
2686 /// Retries a payment along the given [`Route`].
2688 /// Errors returned are a superset of those returned from [`send_payment`], so see
2689 /// [`send_payment`] documentation for more details on errors. This method will also error if the
2690 /// retry amount puts the payment more than 10% over the payment's total amount, if the payment
2691 /// for the given `payment_id` cannot be found (likely due to timeout or success), or if
2692 /// further retries have been disabled with [`abandon_payment`].
2694 /// [`send_payment`]: [`ChannelManager::send_payment`]
2695 /// [`abandon_payment`]: [`ChannelManager::abandon_payment`]
2696 pub fn retry_payment(&self, route: &Route, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2697 const RETRY_OVERFLOW_PERCENTAGE: u64 = 10;
2698 for path in route.paths.iter() {
2699 if path.len() == 0 {
2700 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2701 err: "length-0 path in route".to_string()
2706 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
2707 for _ in 0..route.paths.len() {
2708 onion_session_privs.push(self.keys_manager.get_secure_random_bytes());
2711 let (total_msat, payment_hash, payment_secret) = {
2712 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
2713 match outbounds.get_mut(&payment_id) {
2715 let res = match payment {
2716 PendingOutboundPayment::Retryable {
2717 total_msat, payment_hash, payment_secret, pending_amt_msat, ..
2719 let retry_amt_msat: u64 = route.paths.iter().map(|path| path.last().unwrap().fee_msat).sum();
2720 if retry_amt_msat + *pending_amt_msat > *total_msat * (100 + RETRY_OVERFLOW_PERCENTAGE) / 100 {
2721 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2722 err: format!("retry_amt_msat of {} will put pending_amt_msat (currently: {}) more than 10% over total_payment_amt_msat of {}", retry_amt_msat, pending_amt_msat, total_msat).to_string()
2725 (*total_msat, *payment_hash, *payment_secret)
2727 PendingOutboundPayment::Legacy { .. } => {
2728 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2729 err: "Unable to retry payments that were initially sent on LDK versions prior to 0.0.102".to_string()
2732 PendingOutboundPayment::Fulfilled { .. } => {
2733 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2734 err: "Payment already completed".to_owned()
2737 PendingOutboundPayment::Abandoned { .. } => {
2738 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2739 err: "Payment already abandoned (with some HTLCs still pending)".to_owned()
2743 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
2744 assert!(payment.insert(*session_priv_bytes, path));
2749 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2750 err: format!("Payment with ID {} not found", log_bytes!(payment_id.0)),
2754 self.send_payment_internal(route, payment_hash, &payment_secret, None, payment_id, Some(total_msat), onion_session_privs)
2757 /// Signals that no further retries for the given payment will occur.
2759 /// After this method returns, any future calls to [`retry_payment`] for the given `payment_id`
2760 /// will fail with [`PaymentSendFailure::ParameterError`]. If no such event has been generated,
2761 /// an [`Event::PaymentFailed`] event will be generated as soon as there are no remaining
2762 /// pending HTLCs for this payment.
2764 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
2765 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
2766 /// determine the ultimate status of a payment.
2768 /// [`retry_payment`]: Self::retry_payment
2769 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
2770 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2771 pub fn abandon_payment(&self, payment_id: PaymentId) {
2772 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2774 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
2775 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
2776 if let Ok(()) = payment.get_mut().mark_abandoned() {
2777 if payment.get().remaining_parts() == 0 {
2778 self.pending_events.lock().unwrap().push(events::Event::PaymentFailed {
2780 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
2788 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
2789 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
2790 /// the preimage, it must be a cryptographically secure random value that no intermediate node
2791 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
2792 /// never reach the recipient.
2794 /// See [`send_payment`] documentation for more details on the return value of this function
2795 /// and idempotency guarantees provided by the [`PaymentId`] key.
2797 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
2798 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
2800 /// Note that `route` must have exactly one path.
2802 /// [`send_payment`]: Self::send_payment
2803 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
2804 let preimage = match payment_preimage {
2806 None => PaymentPreimage(self.keys_manager.get_secure_random_bytes()),
2808 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
2809 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, &route)?;
2811 match self.send_payment_internal(route, payment_hash, &None, Some(preimage), payment_id, None, onion_session_privs) {
2812 Ok(()) => Ok(payment_hash),
2817 /// Send a payment that is probing the given route for liquidity. We calculate the
2818 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
2819 /// us to easily discern them from real payments.
2820 pub fn send_probe(&self, hops: Vec<RouteHop>) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
2821 let payment_id = PaymentId(self.keys_manager.get_secure_random_bytes());
2823 let payment_hash = self.probing_cookie_from_id(&payment_id);
2826 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2827 err: "No need probing a path with less than two hops".to_string()
2831 let route = Route { paths: vec![hops], payment_params: None };
2832 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, &route)?;
2834 match self.send_payment_internal(&route, payment_hash, &None, None, payment_id, None, onion_session_privs) {
2835 Ok(()) => Ok((payment_hash, payment_id)),
2840 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
2842 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
2843 let target_payment_hash = self.probing_cookie_from_id(payment_id);
2844 target_payment_hash == *payment_hash
2847 /// Returns the 'probing cookie' for the given [`PaymentId`].
2848 fn probing_cookie_from_id(&self, payment_id: &PaymentId) -> PaymentHash {
2849 let mut preimage = [0u8; 64];
2850 preimage[..32].copy_from_slice(&self.probing_cookie_secret);
2851 preimage[32..].copy_from_slice(&payment_id.0);
2852 PaymentHash(Sha256::hash(&preimage).into_inner())
2855 /// Handles the generation of a funding transaction, optionally (for tests) with a function
2856 /// which checks the correctness of the funding transaction given the associated channel.
2857 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<<K::Target as KeysInterface>::Signer>, &Transaction) -> Result<OutPoint, APIError>>(
2858 &self, temporary_channel_id: &[u8; 32], _counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
2859 ) -> Result<(), APIError> {
2861 let (res, chan) = match self.channel_state.lock().unwrap().by_id.remove(temporary_channel_id) {
2863 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
2865 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
2866 .map_err(|e| if let ChannelError::Close(msg) = e {
2867 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.get_user_id(), chan.force_shutdown(true), None)
2868 } else { unreachable!(); })
2871 None => { return Err(APIError::ChannelUnavailable { err: "No such channel".to_owned() }) },
2873 match handle_error!(self, res, chan.get_counterparty_node_id()) {
2874 Ok(funding_msg) => {
2877 Err(_) => { return Err(APIError::ChannelUnavailable {
2878 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()
2883 let mut channel_state = self.channel_state.lock().unwrap();
2884 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
2885 node_id: chan.get_counterparty_node_id(),
2888 match channel_state.by_id.entry(chan.channel_id()) {
2889 hash_map::Entry::Occupied(_) => {
2890 panic!("Generated duplicate funding txid?");
2892 hash_map::Entry::Vacant(e) => {
2893 let mut id_to_peer = self.id_to_peer.lock().unwrap();
2894 if id_to_peer.insert(chan.channel_id(), chan.get_counterparty_node_id()).is_some() {
2895 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
2904 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> {
2905 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
2906 Ok(OutPoint { txid: tx.txid(), index: output_index })
2910 /// Call this upon creation of a funding transaction for the given channel.
2912 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
2913 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
2915 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
2916 /// across the p2p network.
2918 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
2919 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
2921 /// May panic if the output found in the funding transaction is duplicative with some other
2922 /// channel (note that this should be trivially prevented by using unique funding transaction
2923 /// keys per-channel).
2925 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
2926 /// counterparty's signature the funding transaction will automatically be broadcast via the
2927 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
2929 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
2930 /// not currently support replacing a funding transaction on an existing channel. Instead,
2931 /// create a new channel with a conflicting funding transaction.
2933 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
2934 /// the wallet software generating the funding transaction to apply anti-fee sniping as
2935 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
2936 /// for more details.
2938 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
2939 /// [`Event::ChannelClosed`]: crate::util::events::Event::ChannelClosed
2940 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
2941 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2943 for inp in funding_transaction.input.iter() {
2944 if inp.witness.is_empty() {
2945 return Err(APIError::APIMisuseError {
2946 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
2951 let height = self.best_block.read().unwrap().height();
2952 // Transactions are evaluated as final by network mempools at the next block. However, the modules
2953 // constituting our Lightning node might not have perfect sync about their blockchain views. Thus, if
2954 // the wallet module is in advance on the LDK view, allow one more block of headroom.
2955 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 {
2956 return Err(APIError::APIMisuseError {
2957 err: "Funding transaction absolute timelock is non-final".to_owned()
2961 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
2962 let mut output_index = None;
2963 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
2964 for (idx, outp) in tx.output.iter().enumerate() {
2965 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
2966 if output_index.is_some() {
2967 return Err(APIError::APIMisuseError {
2968 err: "Multiple outputs matched the expected script and value".to_owned()
2971 if idx > u16::max_value() as usize {
2972 return Err(APIError::APIMisuseError {
2973 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
2976 output_index = Some(idx as u16);
2979 if output_index.is_none() {
2980 return Err(APIError::APIMisuseError {
2981 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
2984 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
2988 /// Atomically updates the [`ChannelConfig`] for the given channels.
2990 /// Once the updates are applied, each eligible channel (advertised with a known short channel
2991 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
2992 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
2993 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
2995 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
2996 /// `counterparty_node_id` is provided.
2998 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
2999 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3001 /// If an error is returned, none of the updates should be considered applied.
3003 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3004 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3005 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3006 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3007 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3008 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3009 /// [`APIMisuseError`]: APIError::APIMisuseError
3010 pub fn update_channel_config(
3011 &self, counterparty_node_id: &PublicKey, channel_ids: &[[u8; 32]], config: &ChannelConfig,
3012 ) -> Result<(), APIError> {
3013 if config.cltv_expiry_delta < MIN_CLTV_EXPIRY_DELTA {
3014 return Err(APIError::APIMisuseError {
3015 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
3019 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(
3020 &self.total_consistency_lock, &self.persistence_notifier,
3023 let mut channel_state_lock = self.channel_state.lock().unwrap();
3024 let channel_state = &mut *channel_state_lock;
3025 for channel_id in channel_ids {
3026 let channel_counterparty_node_id = channel_state.by_id.get(channel_id)
3027 .ok_or(APIError::ChannelUnavailable {
3028 err: format!("Channel with ID {} was not found", log_bytes!(*channel_id)),
3030 .get_counterparty_node_id();
3031 if channel_counterparty_node_id != *counterparty_node_id {
3032 return Err(APIError::APIMisuseError {
3033 err: "counterparty node id mismatch".to_owned(),
3037 for channel_id in channel_ids {
3038 let channel = channel_state.by_id.get_mut(channel_id).unwrap();
3039 if !channel.update_config(config) {
3042 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
3043 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
3044 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
3045 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
3046 node_id: channel.get_counterparty_node_id(),
3055 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
3056 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
3058 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
3059 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
3061 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
3062 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
3063 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
3064 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
3065 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
3067 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
3068 /// you from forwarding more than you received.
3070 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
3073 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
3074 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
3075 // TODO: when we move to deciding the best outbound channel at forward time, only take
3076 // `next_node_id` and not `next_hop_channel_id`
3077 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> {
3078 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3080 let next_hop_scid = match self.channel_state.lock().unwrap().by_id.get(next_hop_channel_id) {
3081 Some(chan) => chan.get_short_channel_id().unwrap_or(chan.outbound_scid_alias()),
3082 None => return Err(APIError::APIMisuseError {
3083 err: format!("Channel with id {:?} not found", next_hop_channel_id)
3087 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
3088 .ok_or_else(|| APIError::APIMisuseError {
3089 err: format!("Payment with intercept id {:?} not found", intercept_id.0)
3092 let routing = match payment.forward_info.routing {
3093 PendingHTLCRouting::Forward { onion_packet, .. } => {
3094 PendingHTLCRouting::Forward { onion_packet, short_channel_id: next_hop_scid }
3096 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
3098 let pending_htlc_info = PendingHTLCInfo {
3099 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
3102 let mut per_source_pending_forward = [(
3103 payment.prev_short_channel_id,
3104 payment.prev_funding_outpoint,
3105 payment.prev_user_channel_id,
3106 vec![(pending_htlc_info, payment.prev_htlc_id)]
3108 self.forward_htlcs(&mut per_source_pending_forward);
3112 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
3113 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
3115 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
3118 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
3119 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
3120 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3122 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
3123 .ok_or_else(|| APIError::APIMisuseError {
3124 err: format!("Payment with InterceptId {:?} not found", intercept_id)
3127 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
3128 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3129 short_channel_id: payment.prev_short_channel_id,
3130 outpoint: payment.prev_funding_outpoint,
3131 htlc_id: payment.prev_htlc_id,
3132 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
3133 phantom_shared_secret: None,
3136 let failure_reason = HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() };
3137 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
3138 self.fail_htlc_backwards_internal(htlc_source, &payment.forward_info.payment_hash, failure_reason, destination);
3139 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
3144 /// Processes HTLCs which are pending waiting on random forward delay.
3146 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
3147 /// Will likely generate further events.
3148 pub fn process_pending_htlc_forwards(&self) {
3149 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3151 let mut new_events = Vec::new();
3152 let mut failed_forwards = Vec::new();
3153 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
3154 let mut handle_errors = Vec::new();
3156 let mut forward_htlcs = HashMap::new();
3157 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
3159 for (short_chan_id, mut pending_forwards) in forward_htlcs {
3160 if short_chan_id != 0 {
3161 macro_rules! forwarding_channel_not_found {
3163 for forward_info in pending_forwards.drain(..) {
3164 match forward_info {
3165 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3166 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3167 forward_info: PendingHTLCInfo {
3168 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
3169 outgoing_cltv_value, incoming_amt_msat: _
3172 macro_rules! failure_handler {
3173 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
3174 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3176 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3177 short_channel_id: prev_short_channel_id,
3178 outpoint: prev_funding_outpoint,
3179 htlc_id: prev_htlc_id,
3180 incoming_packet_shared_secret: incoming_shared_secret,
3181 phantom_shared_secret: $phantom_ss,
3184 let reason = if $next_hop_unknown {
3185 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
3187 HTLCDestination::FailedPayment{ payment_hash }
3190 failed_forwards.push((htlc_source, payment_hash,
3191 HTLCFailReason::Reason { failure_code: $err_code, data: $err_data },
3197 macro_rules! fail_forward {
3198 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3200 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
3204 macro_rules! failed_payment {
3205 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3207 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
3211 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
3212 let phantom_secret_res = self.keys_manager.get_node_secret(Recipient::PhantomNode);
3213 if phantom_secret_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.genesis_hash) {
3214 let phantom_shared_secret = SharedSecret::new(&onion_packet.public_key.unwrap(), &phantom_secret_res.unwrap()).secret_bytes();
3215 let next_hop = match onion_utils::decode_next_payment_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
3217 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
3218 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
3219 // In this scenario, the phantom would have sent us an
3220 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
3221 // if it came from us (the second-to-last hop) but contains the sha256
3223 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
3225 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3226 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
3230 onion_utils::Hop::Receive(hop_data) => {
3231 match self.construct_recv_pending_htlc_info(hop_data, incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value, Some(phantom_shared_secret)) {
3232 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
3233 Err(ReceiveError { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
3239 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3242 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3245 HTLCForwardInfo::FailHTLC { .. } => {
3246 // Channel went away before we could fail it. This implies
3247 // the channel is now on chain and our counterparty is
3248 // trying to broadcast the HTLC-Timeout, but that's their
3249 // problem, not ours.
3255 let forward_chan_id = match self.short_to_chan_info.read().unwrap().get(&short_chan_id) {
3256 Some((_cp_id, chan_id)) => chan_id.clone(),
3258 forwarding_channel_not_found!();
3262 let mut channel_state_lock = self.channel_state.lock().unwrap();
3263 let channel_state = &mut *channel_state_lock;
3264 match channel_state.by_id.entry(forward_chan_id) {
3265 hash_map::Entry::Vacant(_) => {
3266 forwarding_channel_not_found!();
3269 hash_map::Entry::Occupied(mut chan) => {
3270 let mut add_htlc_msgs = Vec::new();
3271 let mut fail_htlc_msgs = Vec::new();
3272 for forward_info in pending_forwards.drain(..) {
3273 match forward_info {
3274 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3275 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id: _,
3276 forward_info: PendingHTLCInfo {
3277 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
3278 routing: PendingHTLCRouting::Forward { onion_packet, .. }, incoming_amt_msat: _,
3281 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);
3282 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3283 short_channel_id: prev_short_channel_id,
3284 outpoint: prev_funding_outpoint,
3285 htlc_id: prev_htlc_id,
3286 incoming_packet_shared_secret: incoming_shared_secret,
3287 // Phantom payments are only PendingHTLCRouting::Receive.
3288 phantom_shared_secret: None,
3290 match chan.get_mut().send_htlc(outgoing_amt_msat, payment_hash, outgoing_cltv_value, htlc_source.clone(), onion_packet, &self.logger) {
3292 if let ChannelError::Ignore(msg) = e {
3293 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
3295 panic!("Stated return value requirements in send_htlc() were not met");
3297 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan.get());
3298 failed_forwards.push((htlc_source, payment_hash,
3299 HTLCFailReason::Reason { failure_code, data },
3300 HTLCDestination::NextHopChannel { node_id: Some(chan.get().get_counterparty_node_id()), channel_id: forward_chan_id }
3306 Some(msg) => { add_htlc_msgs.push(msg); },
3308 // Nothing to do here...we're waiting on a remote
3309 // revoke_and_ack before we can add anymore HTLCs. The Channel
3310 // will automatically handle building the update_add_htlc and
3311 // commitment_signed messages when we can.
3312 // TODO: Do some kind of timer to set the channel as !is_live()
3313 // as we don't really want others relying on us relaying through
3314 // this channel currently :/.
3320 HTLCForwardInfo::AddHTLC { .. } => {
3321 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
3323 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
3324 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
3325 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet, &self.logger) {
3327 if let ChannelError::Ignore(msg) = e {
3328 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
3330 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
3332 // fail-backs are best-effort, we probably already have one
3333 // pending, and if not that's OK, if not, the channel is on
3334 // the chain and sending the HTLC-Timeout is their problem.
3337 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
3339 // Nothing to do here...we're waiting on a remote
3340 // revoke_and_ack before we can update the commitment
3341 // transaction. The Channel will automatically handle
3342 // building the update_fail_htlc and commitment_signed
3343 // messages when we can.
3344 // We don't need any kind of timer here as they should fail
3345 // the channel onto the chain if they can't get our
3346 // update_fail_htlc in time, it's not our problem.
3353 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
3354 let (commitment_msg, monitor_update) = match chan.get_mut().send_commitment(&self.logger) {
3357 // We surely failed send_commitment due to bad keys, in that case
3358 // close channel and then send error message to peer.
3359 let counterparty_node_id = chan.get().get_counterparty_node_id();
3360 let err: Result<(), _> = match e {
3361 ChannelError::Ignore(_) | ChannelError::Warn(_) => {
3362 panic!("Stated return value requirements in send_commitment() were not met");
3364 ChannelError::Close(msg) => {
3365 log_trace!(self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
3366 let mut channel = remove_channel!(self, chan);
3367 // ChannelClosed event is generated by handle_error for us.
3368 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel.channel_id(), channel.get_user_id(), channel.force_shutdown(true), self.get_channel_update_for_broadcast(&channel).ok()))
3371 handle_errors.push((counterparty_node_id, err));
3375 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3376 ChannelMonitorUpdateStatus::Completed => {},
3378 handle_errors.push((chan.get().get_counterparty_node_id(), handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
3382 log_debug!(self.logger, "Forwarding HTLCs resulted in a commitment update with {} HTLCs added and {} HTLCs failed for channel {}",
3383 add_htlc_msgs.len(), fail_htlc_msgs.len(), log_bytes!(chan.get().channel_id()));
3384 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3385 node_id: chan.get().get_counterparty_node_id(),
3386 updates: msgs::CommitmentUpdate {
3387 update_add_htlcs: add_htlc_msgs,
3388 update_fulfill_htlcs: Vec::new(),
3389 update_fail_htlcs: fail_htlc_msgs,
3390 update_fail_malformed_htlcs: Vec::new(),
3392 commitment_signed: commitment_msg,
3399 for forward_info in pending_forwards.drain(..) {
3400 match forward_info {
3401 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3402 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3403 forward_info: PendingHTLCInfo {
3404 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat, ..
3407 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret) = match routing {
3408 PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry, phantom_shared_secret } => {
3409 let _legacy_hop_data = Some(payment_data.clone());
3410 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data }, Some(payment_data), phantom_shared_secret)
3412 PendingHTLCRouting::ReceiveKeysend { payment_preimage, incoming_cltv_expiry } =>
3413 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage), None, None),
3415 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
3418 let claimable_htlc = ClaimableHTLC {
3419 prev_hop: HTLCPreviousHopData {
3420 short_channel_id: prev_short_channel_id,
3421 outpoint: prev_funding_outpoint,
3422 htlc_id: prev_htlc_id,
3423 incoming_packet_shared_secret: incoming_shared_secret,
3424 phantom_shared_secret,
3426 value: outgoing_amt_msat,
3428 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
3433 macro_rules! fail_htlc {
3434 ($htlc: expr, $payment_hash: expr) => {
3435 let mut htlc_msat_height_data = byte_utils::be64_to_array($htlc.value).to_vec();
3436 htlc_msat_height_data.extend_from_slice(
3437 &byte_utils::be32_to_array(self.best_block.read().unwrap().height()),
3439 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
3440 short_channel_id: $htlc.prev_hop.short_channel_id,
3441 outpoint: prev_funding_outpoint,
3442 htlc_id: $htlc.prev_hop.htlc_id,
3443 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
3444 phantom_shared_secret,
3446 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data },
3447 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
3451 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
3452 let mut receiver_node_id = self.our_network_pubkey;
3453 if phantom_shared_secret.is_some() {
3454 receiver_node_id = self.keys_manager.get_node_id(Recipient::PhantomNode)
3455 .expect("Failed to get node_id for phantom node recipient");
3458 macro_rules! check_total_value {
3459 ($payment_data: expr, $payment_preimage: expr) => {{
3460 let mut payment_received_generated = false;
3462 events::PaymentPurpose::InvoicePayment {
3463 payment_preimage: $payment_preimage,
3464 payment_secret: $payment_data.payment_secret,
3467 let mut claimable_htlcs = self.claimable_htlcs.lock().unwrap();
3468 let (_, htlcs) = claimable_htlcs.entry(payment_hash)
3469 .or_insert_with(|| (purpose(), Vec::new()));
3470 if htlcs.len() == 1 {
3471 if let OnionPayload::Spontaneous(_) = htlcs[0].onion_payload {
3472 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));
3473 fail_htlc!(claimable_htlc, payment_hash);
3477 let mut total_value = claimable_htlc.value;
3478 for htlc in htlcs.iter() {
3479 total_value += htlc.value;
3480 match &htlc.onion_payload {
3481 OnionPayload::Invoice { .. } => {
3482 if htlc.total_msat != $payment_data.total_msat {
3483 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
3484 log_bytes!(payment_hash.0), $payment_data.total_msat, htlc.total_msat);
3485 total_value = msgs::MAX_VALUE_MSAT;
3487 if total_value >= msgs::MAX_VALUE_MSAT { break; }
3489 _ => unreachable!(),
3492 if total_value >= msgs::MAX_VALUE_MSAT || total_value > $payment_data.total_msat {
3493 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
3494 log_bytes!(payment_hash.0), total_value, $payment_data.total_msat);
3495 fail_htlc!(claimable_htlc, payment_hash);
3496 } else if total_value == $payment_data.total_msat {
3497 let prev_channel_id = prev_funding_outpoint.to_channel_id();
3498 htlcs.push(claimable_htlc);
3499 new_events.push(events::Event::PaymentReceived {
3500 receiver_node_id: Some(receiver_node_id),
3503 amount_msat: total_value,
3504 via_channel_id: Some(prev_channel_id),
3505 via_user_channel_id: Some(prev_user_channel_id),
3507 payment_received_generated = true;
3509 // Nothing to do - we haven't reached the total
3510 // payment value yet, wait until we receive more
3512 htlcs.push(claimable_htlc);
3514 payment_received_generated
3518 // Check that the payment hash and secret are known. Note that we
3519 // MUST take care to handle the "unknown payment hash" and
3520 // "incorrect payment secret" cases here identically or we'd expose
3521 // that we are the ultimate recipient of the given payment hash.
3522 // Further, we must not expose whether we have any other HTLCs
3523 // associated with the same payment_hash pending or not.
3524 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
3525 match payment_secrets.entry(payment_hash) {
3526 hash_map::Entry::Vacant(_) => {
3527 match claimable_htlc.onion_payload {
3528 OnionPayload::Invoice { .. } => {
3529 let payment_data = payment_data.unwrap();
3530 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) {
3531 Ok(payment_preimage) => payment_preimage,
3533 fail_htlc!(claimable_htlc, payment_hash);
3537 check_total_value!(payment_data, payment_preimage);
3539 OnionPayload::Spontaneous(preimage) => {
3540 match self.claimable_htlcs.lock().unwrap().entry(payment_hash) {
3541 hash_map::Entry::Vacant(e) => {
3542 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
3543 e.insert((purpose.clone(), vec![claimable_htlc]));
3544 let prev_channel_id = prev_funding_outpoint.to_channel_id();
3545 new_events.push(events::Event::PaymentReceived {
3546 receiver_node_id: Some(receiver_node_id),
3548 amount_msat: outgoing_amt_msat,
3550 via_channel_id: Some(prev_channel_id),
3551 via_user_channel_id: Some(prev_user_channel_id),
3554 hash_map::Entry::Occupied(_) => {
3555 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
3556 fail_htlc!(claimable_htlc, payment_hash);
3562 hash_map::Entry::Occupied(inbound_payment) => {
3563 if payment_data.is_none() {
3564 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));
3565 fail_htlc!(claimable_htlc, payment_hash);
3568 let payment_data = payment_data.unwrap();
3569 if inbound_payment.get().payment_secret != payment_data.payment_secret {
3570 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
3571 fail_htlc!(claimable_htlc, payment_hash);
3572 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
3573 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
3574 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
3575 fail_htlc!(claimable_htlc, payment_hash);
3577 let payment_received_generated = check_total_value!(payment_data, inbound_payment.get().payment_preimage);
3578 if payment_received_generated {
3579 inbound_payment.remove_entry();
3585 HTLCForwardInfo::FailHTLC { .. } => {
3586 panic!("Got pending fail of our own HTLC");
3594 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
3595 self.fail_htlc_backwards_internal(htlc_source, &payment_hash, failure_reason, destination);
3597 self.forward_htlcs(&mut phantom_receives);
3599 for (counterparty_node_id, err) in handle_errors.drain(..) {
3600 let _ = handle_error!(self, err, counterparty_node_id);
3603 if new_events.is_empty() { return }
3604 let mut events = self.pending_events.lock().unwrap();
3605 events.append(&mut new_events);
3608 /// Free the background events, generally called from timer_tick_occurred.
3610 /// Exposed for testing to allow us to process events quickly without generating accidental
3611 /// BroadcastChannelUpdate events in timer_tick_occurred.
3613 /// Expects the caller to have a total_consistency_lock read lock.
3614 fn process_background_events(&self) -> bool {
3615 let mut background_events = Vec::new();
3616 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
3617 if background_events.is_empty() {
3621 for event in background_events.drain(..) {
3623 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
3624 // The channel has already been closed, so no use bothering to care about the
3625 // monitor updating completing.
3626 let _ = self.chain_monitor.update_channel(funding_txo, update);
3633 #[cfg(any(test, feature = "_test_utils"))]
3634 /// Process background events, for functional testing
3635 pub fn test_process_background_events(&self) {
3636 self.process_background_events();
3639 fn update_channel_fee(&self, pending_msg_events: &mut Vec<events::MessageSendEvent>, chan_id: &[u8; 32], chan: &mut Channel<<K::Target as KeysInterface>::Signer>, new_feerate: u32) -> (bool, NotifyOption, Result<(), MsgHandleErrInternal>) {
3640 if !chan.is_outbound() { return (true, NotifyOption::SkipPersist, Ok(())); }
3641 // If the feerate has decreased by less than half, don't bother
3642 if new_feerate <= chan.get_feerate() && new_feerate * 2 > chan.get_feerate() {
3643 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
3644 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3645 return (true, NotifyOption::SkipPersist, Ok(()));
3647 if !chan.is_live() {
3648 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).",
3649 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3650 return (true, NotifyOption::SkipPersist, Ok(()));
3652 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
3653 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3655 let mut retain_channel = true;
3656 let res = match chan.send_update_fee_and_commit(new_feerate, &self.logger) {
3659 let (drop, res) = convert_chan_err!(self, e, chan, chan_id);
3660 if drop { retain_channel = false; }
3664 let ret_err = match res {
3665 Ok(Some((update_fee, commitment_signed, monitor_update))) => {
3666 match self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
3667 ChannelMonitorUpdateStatus::Completed => {
3668 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3669 node_id: chan.get_counterparty_node_id(),
3670 updates: msgs::CommitmentUpdate {
3671 update_add_htlcs: Vec::new(),
3672 update_fulfill_htlcs: Vec::new(),
3673 update_fail_htlcs: Vec::new(),
3674 update_fail_malformed_htlcs: Vec::new(),
3675 update_fee: Some(update_fee),
3682 let (res, drop) = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, chan_id, COMMITMENT_UPDATE_ONLY);
3683 if drop { retain_channel = false; }
3691 (retain_channel, NotifyOption::DoPersist, ret_err)
3695 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
3696 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
3697 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
3698 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
3699 pub fn maybe_update_chan_fees(&self) {
3700 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3701 let mut should_persist = NotifyOption::SkipPersist;
3703 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3705 let mut handle_errors = Vec::new();
3707 let mut channel_state_lock = self.channel_state.lock().unwrap();
3708 let channel_state = &mut *channel_state_lock;
3709 let pending_msg_events = &mut channel_state.pending_msg_events;
3710 channel_state.by_id.retain(|chan_id, chan| {
3711 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(pending_msg_events, chan_id, chan, new_feerate);
3712 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3714 handle_errors.push(err);
3724 fn remove_stale_resolved_payments(&self) {
3725 // If an outbound payment was completed, and no pending HTLCs remain, we should remove it
3726 // from the map. However, if we did that immediately when the last payment HTLC is claimed,
3727 // this could race the user making a duplicate send_payment call and our idempotency
3728 // guarantees would be violated. Instead, we wait a few timer ticks to do the actual
3729 // removal. This should be more than sufficient to ensure the idempotency of any
3730 // `send_payment` calls that were made at the same time the `PaymentSent` event was being
3732 let mut pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
3733 let pending_events = self.pending_events.lock().unwrap();
3734 pending_outbound_payments.retain(|payment_id, payment| {
3735 if let PendingOutboundPayment::Fulfilled { session_privs, timer_ticks_without_htlcs, .. } = payment {
3736 let mut no_remaining_entries = session_privs.is_empty();
3737 if no_remaining_entries {
3738 for ev in pending_events.iter() {
3740 events::Event::PaymentSent { payment_id: Some(ev_payment_id), .. } |
3741 events::Event::PaymentPathSuccessful { payment_id: ev_payment_id, .. } |
3742 events::Event::PaymentPathFailed { payment_id: Some(ev_payment_id), .. } => {
3743 if payment_id == ev_payment_id {
3744 no_remaining_entries = false;
3752 if no_remaining_entries {
3753 *timer_ticks_without_htlcs += 1;
3754 *timer_ticks_without_htlcs <= IDEMPOTENCY_TIMEOUT_TICKS
3756 *timer_ticks_without_htlcs = 0;
3763 /// Performs actions which should happen on startup and roughly once per minute thereafter.
3765 /// This currently includes:
3766 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
3767 /// * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
3768 /// than a minute, informing the network that they should no longer attempt to route over
3770 /// * Expiring a channel's previous `ChannelConfig` if necessary to only allow forwarding HTLCs
3771 /// with the current `ChannelConfig`.
3773 /// Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
3774 /// estimate fetches.
3775 pub fn timer_tick_occurred(&self) {
3776 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3777 let mut should_persist = NotifyOption::SkipPersist;
3778 if self.process_background_events() { should_persist = NotifyOption::DoPersist; }
3780 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3782 let mut handle_errors = Vec::new();
3783 let mut timed_out_mpp_htlcs = Vec::new();
3785 let mut channel_state_lock = self.channel_state.lock().unwrap();
3786 let channel_state = &mut *channel_state_lock;
3787 let pending_msg_events = &mut channel_state.pending_msg_events;
3788 channel_state.by_id.retain(|chan_id, chan| {
3789 let counterparty_node_id = chan.get_counterparty_node_id();
3790 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(pending_msg_events, chan_id, chan, new_feerate);
3791 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3793 handle_errors.push((err, counterparty_node_id));
3795 if !retain_channel { return false; }
3797 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
3798 let (needs_close, err) = convert_chan_err!(self, e, chan, chan_id);
3799 handle_errors.push((Err(err), chan.get_counterparty_node_id()));
3800 if needs_close { return false; }
3803 match chan.channel_update_status() {
3804 ChannelUpdateStatus::Enabled if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged),
3805 ChannelUpdateStatus::Disabled if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged),
3806 ChannelUpdateStatus::DisabledStaged if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
3807 ChannelUpdateStatus::EnabledStaged if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
3808 ChannelUpdateStatus::DisabledStaged if !chan.is_live() => {
3809 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3810 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3814 should_persist = NotifyOption::DoPersist;
3815 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
3817 ChannelUpdateStatus::EnabledStaged if chan.is_live() => {
3818 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3819 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3823 should_persist = NotifyOption::DoPersist;
3824 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
3829 chan.maybe_expire_prev_config();
3835 self.claimable_htlcs.lock().unwrap().retain(|payment_hash, (_, htlcs)| {
3836 if htlcs.is_empty() {
3837 // This should be unreachable
3838 debug_assert!(false);
3841 if let OnionPayload::Invoice { .. } = htlcs[0].onion_payload {
3842 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
3843 // In this case we're not going to handle any timeouts of the parts here.
3844 if htlcs[0].total_msat == htlcs.iter().fold(0, |total, htlc| total + htlc.value) {
3846 } else if htlcs.into_iter().any(|htlc| {
3847 htlc.timer_ticks += 1;
3848 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
3850 timed_out_mpp_htlcs.extend(htlcs.drain(..).map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
3857 for htlc_source in timed_out_mpp_htlcs.drain(..) {
3858 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
3859 self.fail_htlc_backwards_internal(HTLCSource::PreviousHopData(htlc_source.0.clone()), &htlc_source.1, HTLCFailReason::Reason { failure_code: 23, data: Vec::new() }, receiver );
3862 for (err, counterparty_node_id) in handle_errors.drain(..) {
3863 let _ = handle_error!(self, err, counterparty_node_id);
3866 self.remove_stale_resolved_payments();
3872 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
3873 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
3874 /// along the path (including in our own channel on which we received it).
3876 /// Note that in some cases around unclean shutdown, it is possible the payment may have
3877 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
3878 /// second copy of) the [`events::Event::PaymentReceived`] event. Alternatively, the payment
3879 /// may have already been failed automatically by LDK if it was nearing its expiration time.
3881 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
3882 /// [`ChannelManager::claim_funds`]), you should still monitor for
3883 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
3884 /// startup during which time claims that were in-progress at shutdown may be replayed.
3885 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
3886 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3888 let removed_source = self.claimable_htlcs.lock().unwrap().remove(payment_hash);
3889 if let Some((_, mut sources)) = removed_source {
3890 for htlc in sources.drain(..) {
3891 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
3892 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
3893 self.best_block.read().unwrap().height()));
3894 self.fail_htlc_backwards_internal(
3895 HTLCSource::PreviousHopData(htlc.prev_hop), payment_hash,
3896 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data },
3897 HTLCDestination::FailedPayment { payment_hash: *payment_hash });
3902 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3903 /// that we want to return and a channel.
3905 /// This is for failures on the channel on which the HTLC was *received*, not failures
3907 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<<K::Target as KeysInterface>::Signer>) -> (u16, Vec<u8>) {
3908 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
3909 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
3910 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
3911 // an inbound SCID alias before the real SCID.
3912 let scid_pref = if chan.should_announce() {
3913 chan.get_short_channel_id().or(chan.latest_inbound_scid_alias())
3915 chan.latest_inbound_scid_alias().or(chan.get_short_channel_id())
3917 if let Some(scid) = scid_pref {
3918 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
3920 (0x4000|10, Vec::new())
3925 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3926 /// that we want to return and a channel.
3927 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<<K::Target as KeysInterface>::Signer>) -> (u16, Vec<u8>) {
3928 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
3929 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
3930 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
3931 if desired_err_code == 0x1000 | 20 {
3932 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
3933 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
3934 0u16.write(&mut enc).expect("Writes cannot fail");
3936 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
3937 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
3938 upd.write(&mut enc).expect("Writes cannot fail");
3939 (desired_err_code, enc.0)
3941 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
3942 // which means we really shouldn't have gotten a payment to be forwarded over this
3943 // channel yet, or if we did it's from a route hint. Either way, returning an error of
3944 // PERM|no_such_channel should be fine.
3945 (0x4000|10, Vec::new())
3949 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
3950 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
3951 // be surfaced to the user.
3952 fn fail_holding_cell_htlcs(
3953 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32],
3954 counterparty_node_id: &PublicKey
3956 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
3957 let (failure_code, onion_failure_data) =
3958 match self.channel_state.lock().unwrap().by_id.entry(channel_id) {
3959 hash_map::Entry::Occupied(chan_entry) => {
3960 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan_entry.get())
3962 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
3965 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
3966 self.fail_htlc_backwards_internal(htlc_src, &payment_hash, HTLCFailReason::Reason { failure_code, data: onion_failure_data }, receiver);
3970 /// Fails an HTLC backwards to the sender of it to us.
3971 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
3972 fn fail_htlc_backwards_internal(&self, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason,destination: HTLCDestination) {
3973 #[cfg(debug_assertions)]
3975 // Ensure that the `channel_state` lock is not held when calling this function.
3976 // This ensures that future code doesn't introduce a lock_order requirement for
3977 // `forward_htlcs` to be locked after the `channel_state` lock, which calling this
3978 // function with the `channel_state` locked would.
3979 assert!(self.channel_state.try_lock().is_ok());
3982 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
3983 //identify whether we sent it or not based on the (I presume) very different runtime
3984 //between the branches here. We should make this async and move it into the forward HTLCs
3987 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3988 // from block_connected which may run during initialization prior to the chain_monitor
3989 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
3991 HTLCSource::OutboundRoute { ref path, session_priv, payment_id, ref payment_params, .. } => {
3992 let mut session_priv_bytes = [0; 32];
3993 session_priv_bytes.copy_from_slice(&session_priv[..]);
3994 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
3995 let mut all_paths_failed = false;
3996 let mut full_failure_ev = None;
3997 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
3998 if !payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
3999 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
4002 if payment.get().is_fulfilled() {
4003 log_trace!(self.logger, "Received failure of HTLC with payment_hash {} after payment completion", log_bytes!(payment_hash.0));
4006 if payment.get().remaining_parts() == 0 {
4007 all_paths_failed = true;
4008 if payment.get().abandoned() {
4009 full_failure_ev = Some(events::Event::PaymentFailed {
4011 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
4017 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
4020 let mut retry = if let Some(payment_params_data) = payment_params {
4021 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
4022 Some(RouteParameters {
4023 payment_params: payment_params_data.clone(),
4024 final_value_msat: path_last_hop.fee_msat,
4025 final_cltv_expiry_delta: path_last_hop.cltv_expiry_delta,
4028 log_trace!(self.logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
4030 let path_failure = match &onion_error {
4031 &HTLCFailReason::LightningError { ref err } => {
4033 let (network_update, short_channel_id, payment_retryable, onion_error_code, onion_error_data) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
4035 let (network_update, short_channel_id, payment_retryable, _, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
4037 if self.payment_is_probe(payment_hash, &payment_id) {
4038 if !payment_retryable {
4039 events::Event::ProbeSuccessful {
4041 payment_hash: payment_hash.clone(),
4045 events::Event::ProbeFailed {
4047 payment_hash: payment_hash.clone(),
4053 // TODO: If we decided to blame ourselves (or one of our channels) in
4054 // process_onion_failure we should close that channel as it implies our
4055 // next-hop is needlessly blaming us!
4056 if let Some(scid) = short_channel_id {
4057 retry.as_mut().map(|r| r.payment_params.previously_failed_channels.push(scid));
4059 events::Event::PaymentPathFailed {
4060 payment_id: Some(payment_id),
4061 payment_hash: payment_hash.clone(),
4062 payment_failed_permanently: !payment_retryable,
4069 error_code: onion_error_code,
4071 error_data: onion_error_data
4075 &HTLCFailReason::Reason {
4081 // we get a fail_malformed_htlc from the first hop
4082 // TODO: We'd like to generate a NetworkUpdate for temporary
4083 // failures here, but that would be insufficient as find_route
4084 // generally ignores its view of our own channels as we provide them via
4086 // TODO: For non-temporary failures, we really should be closing the
4087 // channel here as we apparently can't relay through them anyway.
4088 let scid = path.first().unwrap().short_channel_id;
4089 retry.as_mut().map(|r| r.payment_params.previously_failed_channels.push(scid));
4091 if self.payment_is_probe(payment_hash, &payment_id) {
4092 events::Event::ProbeFailed {
4094 payment_hash: payment_hash.clone(),
4096 short_channel_id: Some(scid),
4099 events::Event::PaymentPathFailed {
4100 payment_id: Some(payment_id),
4101 payment_hash: payment_hash.clone(),
4102 payment_failed_permanently: false,
4103 network_update: None,
4106 short_channel_id: Some(scid),
4109 error_code: Some(*failure_code),
4111 error_data: Some(data.clone()),
4116 let mut pending_events = self.pending_events.lock().unwrap();
4117 pending_events.push(path_failure);
4118 if let Some(ev) = full_failure_ev { pending_events.push(ev); }
4120 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret, phantom_shared_secret, outpoint }) => {
4121 let err_packet = match onion_error {
4122 HTLCFailReason::Reason { failure_code, data } => {
4123 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
4124 if let Some(phantom_ss) = phantom_shared_secret {
4125 let phantom_packet = onion_utils::build_failure_packet(&phantom_ss, failure_code, &data[..]).encode();
4126 let encrypted_phantom_packet = onion_utils::encrypt_failure_packet(&phantom_ss, &phantom_packet);
4127 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &encrypted_phantom_packet.data[..])
4129 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
4130 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
4133 HTLCFailReason::LightningError { err } => {
4134 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
4135 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
4139 let mut forward_event = None;
4140 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
4141 if forward_htlcs.is_empty() {
4142 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
4144 match forward_htlcs.entry(short_channel_id) {
4145 hash_map::Entry::Occupied(mut entry) => {
4146 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
4148 hash_map::Entry::Vacant(entry) => {
4149 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
4152 mem::drop(forward_htlcs);
4153 let mut pending_events = self.pending_events.lock().unwrap();
4154 if let Some(time) = forward_event {
4155 pending_events.push(events::Event::PendingHTLCsForwardable {
4156 time_forwardable: time
4159 pending_events.push(events::Event::HTLCHandlingFailed {
4160 prev_channel_id: outpoint.to_channel_id(),
4161 failed_next_destination: destination
4167 /// Provides a payment preimage in response to [`Event::PaymentReceived`], generating any
4168 /// [`MessageSendEvent`]s needed to claim the payment.
4170 /// Note that calling this method does *not* guarantee that the payment has been claimed. You
4171 /// *must* wait for an [`Event::PaymentClaimed`] event which upon a successful claim will be
4172 /// provided to your [`EventHandler`] when [`process_pending_events`] is next called.
4174 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
4175 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
4176 /// event matches your expectation. If you fail to do so and call this method, you may provide
4177 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
4179 /// [`Event::PaymentReceived`]: crate::util::events::Event::PaymentReceived
4180 /// [`Event::PaymentClaimed`]: crate::util::events::Event::PaymentClaimed
4181 /// [`process_pending_events`]: EventsProvider::process_pending_events
4182 /// [`create_inbound_payment`]: Self::create_inbound_payment
4183 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
4184 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
4185 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
4186 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4188 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4190 let removed_source = self.claimable_htlcs.lock().unwrap().remove(&payment_hash);
4191 if let Some((payment_purpose, mut sources)) = removed_source {
4192 assert!(!sources.is_empty());
4194 // If we are claiming an MPP payment, we have to take special care to ensure that each
4195 // channel exists before claiming all of the payments (inside one lock).
4196 // Note that channel existance is sufficient as we should always get a monitor update
4197 // which will take care of the real HTLC claim enforcement.
4199 // If we find an HTLC which we would need to claim but for which we do not have a
4200 // channel, we will fail all parts of the MPP payment. While we could wait and see if
4201 // the sender retries the already-failed path(s), it should be a pretty rare case where
4202 // we got all the HTLCs and then a channel closed while we were waiting for the user to
4203 // provide the preimage, so worrying too much about the optimal handling isn't worth
4205 let mut claimable_amt_msat = 0;
4206 let mut expected_amt_msat = None;
4207 let mut valid_mpp = true;
4208 let mut errs = Vec::new();
4209 let mut claimed_any_htlcs = false;
4210 let mut channel_state_lock = self.channel_state.lock().unwrap();
4211 let channel_state = &mut *channel_state_lock;
4212 let mut receiver_node_id = Some(self.our_network_pubkey);
4213 for htlc in sources.iter() {
4214 let chan_id = match self.short_to_chan_info.read().unwrap().get(&htlc.prev_hop.short_channel_id) {
4215 Some((_cp_id, chan_id)) => chan_id.clone(),
4222 if let None = channel_state.by_id.get(&chan_id) {
4227 if expected_amt_msat.is_some() && expected_amt_msat != Some(htlc.total_msat) {
4228 log_error!(self.logger, "Somehow ended up with an MPP payment with different total amounts - this should not be reachable!");
4229 debug_assert!(false);
4233 expected_amt_msat = Some(htlc.total_msat);
4234 if let OnionPayload::Spontaneous(_) = &htlc.onion_payload {
4235 // We don't currently support MPP for spontaneous payments, so just check
4236 // that there's one payment here and move on.
4237 if sources.len() != 1 {
4238 log_error!(self.logger, "Somehow ended up with an MPP spontaneous payment - this should not be reachable!");
4239 debug_assert!(false);
4244 let phantom_shared_secret = htlc.prev_hop.phantom_shared_secret;
4245 if phantom_shared_secret.is_some() {
4246 let phantom_pubkey = self.keys_manager.get_node_id(Recipient::PhantomNode)
4247 .expect("Failed to get node_id for phantom node recipient");
4248 receiver_node_id = Some(phantom_pubkey)
4251 claimable_amt_msat += htlc.value;
4253 if sources.is_empty() || expected_amt_msat.is_none() {
4254 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
4257 if claimable_amt_msat != expected_amt_msat.unwrap() {
4258 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
4259 expected_amt_msat.unwrap(), claimable_amt_msat);
4263 for htlc in sources.drain(..) {
4264 match self.claim_funds_from_hop(&mut channel_state_lock, htlc.prev_hop, payment_preimage) {
4265 ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) => {
4266 if let msgs::ErrorAction::IgnoreError = err.err.action {
4267 // We got a temporary failure updating monitor, but will claim the
4268 // HTLC when the monitor updating is restored (or on chain).
4269 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
4270 claimed_any_htlcs = true;
4271 } else { errs.push((pk, err)); }
4273 ClaimFundsFromHop::PrevHopForceClosed => unreachable!("We already checked for channel existence, we can't fail here!"),
4274 ClaimFundsFromHop::DuplicateClaim => {
4275 // While we should never get here in most cases, if we do, it likely
4276 // indicates that the HTLC was timed out some time ago and is no longer
4277 // available to be claimed. Thus, it does not make sense to set
4278 // `claimed_any_htlcs`.
4280 ClaimFundsFromHop::Success(_) => claimed_any_htlcs = true,
4284 mem::drop(channel_state_lock);
4286 for htlc in sources.drain(..) {
4287 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
4288 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
4289 self.best_block.read().unwrap().height()));
4290 self.fail_htlc_backwards_internal(
4291 HTLCSource::PreviousHopData(htlc.prev_hop), &payment_hash,
4292 HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_height_data },
4293 HTLCDestination::FailedPayment { payment_hash } );
4297 if claimed_any_htlcs {
4298 self.pending_events.lock().unwrap().push(events::Event::PaymentClaimed {
4301 purpose: payment_purpose,
4302 amount_msat: claimable_amt_msat,
4306 // Now we can handle any errors which were generated.
4307 for (counterparty_node_id, err) in errs.drain(..) {
4308 let res: Result<(), _> = Err(err);
4309 let _ = handle_error!(self, res, counterparty_node_id);
4314 fn claim_funds_from_hop(&self, channel_state_lock: &mut MutexGuard<ChannelHolder<<K::Target as KeysInterface>::Signer>>, prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage) -> ClaimFundsFromHop {
4315 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
4317 let chan_id = prev_hop.outpoint.to_channel_id();
4318 let channel_state = &mut **channel_state_lock;
4319 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
4320 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
4321 Ok(msgs_monitor_option) => {
4322 if let UpdateFulfillCommitFetch::NewClaim { msgs, htlc_value_msat, monitor_update } = msgs_monitor_option {
4323 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
4324 ChannelMonitorUpdateStatus::Completed => {},
4326 log_given_level!(self.logger, if e == ChannelMonitorUpdateStatus::PermanentFailure { Level::Error } else { Level::Debug },
4327 "Failed to update channel monitor with preimage {:?}: {:?}",
4328 payment_preimage, e);
4329 return ClaimFundsFromHop::MonitorUpdateFail(
4330 chan.get().get_counterparty_node_id(),
4331 handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()).unwrap_err(),
4332 Some(htlc_value_msat)
4336 if let Some((msg, commitment_signed)) = msgs {
4337 log_debug!(self.logger, "Claiming funds for HTLC with preimage {} resulted in a commitment_signed for channel {}",
4338 log_bytes!(payment_preimage.0), log_bytes!(chan.get().channel_id()));
4339 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4340 node_id: chan.get().get_counterparty_node_id(),
4341 updates: msgs::CommitmentUpdate {
4342 update_add_htlcs: Vec::new(),
4343 update_fulfill_htlcs: vec![msg],
4344 update_fail_htlcs: Vec::new(),
4345 update_fail_malformed_htlcs: Vec::new(),
4351 return ClaimFundsFromHop::Success(htlc_value_msat);
4353 return ClaimFundsFromHop::DuplicateClaim;
4356 Err((e, monitor_update)) => {
4357 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
4358 ChannelMonitorUpdateStatus::Completed => {},
4360 log_given_level!(self.logger, if e == ChannelMonitorUpdateStatus::PermanentFailure { Level::Error } else { Level::Info },
4361 "Failed to update channel monitor with preimage {:?} immediately prior to force-close: {:?}",
4362 payment_preimage, e);
4365 let counterparty_node_id = chan.get().get_counterparty_node_id();
4366 let (drop, res) = convert_chan_err!(self, e, chan.get_mut(), &chan_id);
4368 chan.remove_entry();
4370 return ClaimFundsFromHop::MonitorUpdateFail(counterparty_node_id, res, None);
4373 } else { return ClaimFundsFromHop::PrevHopForceClosed }
4376 fn finalize_claims(&self, mut sources: Vec<HTLCSource>) {
4377 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
4378 let mut pending_events = self.pending_events.lock().unwrap();
4379 for source in sources.drain(..) {
4380 if let HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } = source {
4381 let mut session_priv_bytes = [0; 32];
4382 session_priv_bytes.copy_from_slice(&session_priv[..]);
4383 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
4384 assert!(payment.get().is_fulfilled());
4385 if payment.get_mut().remove(&session_priv_bytes, None) {
4386 pending_events.push(
4387 events::Event::PaymentPathSuccessful {
4389 payment_hash: payment.get().payment_hash(),
4399 fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<<K::Target as KeysInterface>::Signer>>, source: HTLCSource, payment_preimage: PaymentPreimage, forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, next_channel_id: [u8; 32]) {
4401 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
4402 mem::drop(channel_state_lock);
4403 let mut session_priv_bytes = [0; 32];
4404 session_priv_bytes.copy_from_slice(&session_priv[..]);
4405 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
4406 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
4407 let mut pending_events = self.pending_events.lock().unwrap();
4408 if !payment.get().is_fulfilled() {
4409 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4410 let fee_paid_msat = payment.get().get_pending_fee_msat();
4411 pending_events.push(
4412 events::Event::PaymentSent {
4413 payment_id: Some(payment_id),
4419 payment.get_mut().mark_fulfilled();
4423 // We currently immediately remove HTLCs which were fulfilled on-chain.
4424 // This could potentially lead to removing a pending payment too early,
4425 // with a reorg of one block causing us to re-add the fulfilled payment on
4427 // TODO: We should have a second monitor event that informs us of payments
4428 // irrevocably fulfilled.
4429 if payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
4430 let payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0).into_inner()));
4431 pending_events.push(
4432 events::Event::PaymentPathSuccessful {
4441 log_trace!(self.logger, "Received duplicative fulfill for HTLC with payment_preimage {}", log_bytes!(payment_preimage.0));
4444 HTLCSource::PreviousHopData(hop_data) => {
4445 let prev_outpoint = hop_data.outpoint;
4446 let res = self.claim_funds_from_hop(&mut channel_state_lock, hop_data, payment_preimage);
4447 let claimed_htlc = if let ClaimFundsFromHop::DuplicateClaim = res { false } else { true };
4448 let htlc_claim_value_msat = match res {
4449 ClaimFundsFromHop::MonitorUpdateFail(_, _, amt_opt) => amt_opt,
4450 ClaimFundsFromHop::Success(amt) => Some(amt),
4453 if let ClaimFundsFromHop::PrevHopForceClosed = res {
4454 let preimage_update = ChannelMonitorUpdate {
4455 update_id: CLOSED_CHANNEL_UPDATE_ID,
4456 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
4457 payment_preimage: payment_preimage.clone(),
4460 // We update the ChannelMonitor on the backward link, after
4461 // receiving an offchain preimage event from the forward link (the
4462 // event being update_fulfill_htlc).
4463 let update_res = self.chain_monitor.update_channel(prev_outpoint, preimage_update);
4464 if update_res != ChannelMonitorUpdateStatus::Completed {
4465 // TODO: This needs to be handled somehow - if we receive a monitor update
4466 // with a preimage we *must* somehow manage to propagate it to the upstream
4467 // channel, or we must have an ability to receive the same event and try
4468 // again on restart.
4469 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
4470 payment_preimage, update_res);
4472 // Note that we do *not* set `claimed_htlc` to false here. In fact, this
4473 // totally could be a duplicate claim, but we have no way of knowing
4474 // without interrogating the `ChannelMonitor` we've provided the above
4475 // update to. Instead, we simply document in `PaymentForwarded` that this
4478 mem::drop(channel_state_lock);
4479 if let ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) = res {
4480 let result: Result<(), _> = Err(err);
4481 let _ = handle_error!(self, result, pk);
4485 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
4486 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
4487 Some(claimed_htlc_value - forwarded_htlc_value)
4490 let mut pending_events = self.pending_events.lock().unwrap();
4491 let prev_channel_id = Some(prev_outpoint.to_channel_id());
4492 let next_channel_id = Some(next_channel_id);
4494 pending_events.push(events::Event::PaymentForwarded {
4496 claim_from_onchain_tx: from_onchain,
4506 /// Gets the node_id held by this ChannelManager
4507 pub fn get_our_node_id(&self) -> PublicKey {
4508 self.our_network_pubkey.clone()
4511 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
4512 /// update completion.
4513 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
4514 channel: &mut Channel<<K::Target as KeysInterface>::Signer>, raa: Option<msgs::RevokeAndACK>,
4515 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
4516 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
4517 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
4518 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
4519 let mut htlc_forwards = None;
4521 let counterparty_node_id = channel.get_counterparty_node_id();
4522 if !pending_forwards.is_empty() {
4523 htlc_forwards = Some((channel.get_short_channel_id().unwrap_or(channel.outbound_scid_alias()),
4524 channel.get_funding_txo().unwrap(), channel.get_user_id(), pending_forwards));
4527 if let Some(msg) = channel_ready {
4528 send_channel_ready!(self, pending_msg_events, channel, msg);
4530 if let Some(msg) = announcement_sigs {
4531 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4532 node_id: counterparty_node_id,
4537 emit_channel_ready_event!(self, channel);
4539 macro_rules! handle_cs { () => {
4540 if let Some(update) = commitment_update {
4541 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4542 node_id: counterparty_node_id,
4547 macro_rules! handle_raa { () => {
4548 if let Some(revoke_and_ack) = raa {
4549 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
4550 node_id: counterparty_node_id,
4551 msg: revoke_and_ack,
4556 RAACommitmentOrder::CommitmentFirst => {
4560 RAACommitmentOrder::RevokeAndACKFirst => {
4566 if let Some(tx) = funding_broadcastable {
4567 log_info!(self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
4568 self.tx_broadcaster.broadcast_transaction(&tx);
4574 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64) {
4575 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4578 let (mut pending_failures, finalized_claims, counterparty_node_id) = {
4579 let mut channel_lock = self.channel_state.lock().unwrap();
4580 let channel_state = &mut *channel_lock;
4581 let mut channel = match channel_state.by_id.entry(funding_txo.to_channel_id()) {
4582 hash_map::Entry::Occupied(chan) => chan,
4583 hash_map::Entry::Vacant(_) => return,
4585 if !channel.get().is_awaiting_monitor_update() || channel.get().get_latest_monitor_update_id() != highest_applied_update_id {
4589 let counterparty_node_id = channel.get().get_counterparty_node_id();
4590 let updates = channel.get_mut().monitor_updating_restored(&self.logger, self.get_our_node_id(), self.genesis_hash, self.best_block.read().unwrap().height());
4591 let channel_update = if updates.channel_ready.is_some() && channel.get().is_usable() {
4592 // We only send a channel_update in the case where we are just now sending a
4593 // channel_ready and the channel is in a usable state. We may re-send a
4594 // channel_update later through the announcement_signatures process for public
4595 // channels, but there's no reason not to just inform our counterparty of our fees
4597 if let Ok(msg) = self.get_channel_update_for_unicast(channel.get()) {
4598 Some(events::MessageSendEvent::SendChannelUpdate {
4599 node_id: channel.get().get_counterparty_node_id(),
4604 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);
4605 if let Some(upd) = channel_update {
4606 channel_state.pending_msg_events.push(upd);
4609 (updates.failed_htlcs, updates.finalized_claimed_htlcs, counterparty_node_id)
4611 if let Some(forwards) = htlc_forwards {
4612 self.forward_htlcs(&mut [forwards][..]);
4614 self.finalize_claims(finalized_claims);
4615 for failure in pending_failures.drain(..) {
4616 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id: funding_txo.to_channel_id() };
4617 self.fail_htlc_backwards_internal(failure.0, &failure.1, failure.2, receiver);
4621 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
4623 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
4624 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
4627 /// The `user_channel_id` parameter will be provided back in
4628 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4629 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4631 /// Note that this method will return an error and reject the channel, if it requires support
4632 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
4633 /// used to accept such channels.
4635 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4636 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4637 pub fn accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
4638 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
4641 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
4642 /// it as confirmed immediately.
4644 /// The `user_channel_id` parameter will be provided back in
4645 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4646 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4648 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
4649 /// and (if the counterparty agrees), enables forwarding of payments immediately.
4651 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
4652 /// transaction and blindly assumes that it will eventually confirm.
4654 /// If it does not confirm before we decide to close the channel, or if the funding transaction
4655 /// does not pay to the correct script the correct amount, *you will lose funds*.
4657 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4658 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4659 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> {
4660 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
4663 fn do_accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
4664 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4666 let mut channel_state_lock = self.channel_state.lock().unwrap();
4667 let channel_state = &mut *channel_state_lock;
4668 match channel_state.by_id.entry(temporary_channel_id.clone()) {
4669 hash_map::Entry::Occupied(mut channel) => {
4670 if !channel.get().inbound_is_awaiting_accept() {
4671 return Err(APIError::APIMisuseError { err: "The channel isn't currently awaiting to be accepted.".to_owned() });
4673 if *counterparty_node_id != channel.get().get_counterparty_node_id() {
4674 return Err(APIError::APIMisuseError { err: "The passed counterparty_node_id doesn't match the channel's counterparty node_id".to_owned() });
4677 channel.get_mut().set_0conf();
4678 } else if channel.get().get_channel_type().requires_zero_conf() {
4679 let send_msg_err_event = events::MessageSendEvent::HandleError {
4680 node_id: channel.get().get_counterparty_node_id(),
4681 action: msgs::ErrorAction::SendErrorMessage{
4682 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
4685 channel_state.pending_msg_events.push(send_msg_err_event);
4686 let _ = remove_channel!(self, channel);
4687 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
4690 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4691 node_id: channel.get().get_counterparty_node_id(),
4692 msg: channel.get_mut().accept_inbound_channel(user_channel_id),
4695 hash_map::Entry::Vacant(_) => {
4696 return Err(APIError::ChannelUnavailable { err: "Can't accept a channel that doesn't exist".to_owned() });
4702 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
4703 if msg.chain_hash != self.genesis_hash {
4704 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
4707 if !self.default_configuration.accept_inbound_channels {
4708 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4711 let mut random_bytes = [0u8; 16];
4712 random_bytes.copy_from_slice(&self.keys_manager.get_secure_random_bytes()[..16]);
4713 let user_channel_id = u128::from_be_bytes(random_bytes);
4715 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
4716 let mut channel = match Channel::new_from_req(&self.fee_estimator, &self.keys_manager,
4717 counterparty_node_id.clone(), &their_features, msg, user_channel_id, &self.default_configuration,
4718 self.best_block.read().unwrap().height(), &self.logger, outbound_scid_alias)
4721 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4722 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
4726 let mut channel_state_lock = self.channel_state.lock().unwrap();
4727 let channel_state = &mut *channel_state_lock;
4728 match channel_state.by_id.entry(channel.channel_id()) {
4729 hash_map::Entry::Occupied(_) => {
4730 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4731 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!".to_owned(), msg.temporary_channel_id.clone()))
4733 hash_map::Entry::Vacant(entry) => {
4734 if !self.default_configuration.manually_accept_inbound_channels {
4735 if channel.get_channel_type().requires_zero_conf() {
4736 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4738 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4739 node_id: counterparty_node_id.clone(),
4740 msg: channel.accept_inbound_channel(user_channel_id),
4743 let mut pending_events = self.pending_events.lock().unwrap();
4744 pending_events.push(
4745 events::Event::OpenChannelRequest {
4746 temporary_channel_id: msg.temporary_channel_id.clone(),
4747 counterparty_node_id: counterparty_node_id.clone(),
4748 funding_satoshis: msg.funding_satoshis,
4749 push_msat: msg.push_msat,
4750 channel_type: channel.get_channel_type().clone(),
4755 entry.insert(channel);
4761 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
4762 let (value, output_script, user_id) = {
4763 let mut channel_lock = self.channel_state.lock().unwrap();
4764 let channel_state = &mut *channel_lock;
4765 match channel_state.by_id.entry(msg.temporary_channel_id) {
4766 hash_map::Entry::Occupied(mut chan) => {
4767 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4768 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
4770 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &their_features), chan);
4771 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
4773 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
4776 let mut pending_events = self.pending_events.lock().unwrap();
4777 pending_events.push(events::Event::FundingGenerationReady {
4778 temporary_channel_id: msg.temporary_channel_id,
4779 counterparty_node_id: *counterparty_node_id,
4780 channel_value_satoshis: value,
4782 user_channel_id: user_id,
4787 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
4788 let ((funding_msg, monitor, mut channel_ready), mut chan) = {
4789 let best_block = *self.best_block.read().unwrap();
4790 let mut channel_lock = self.channel_state.lock().unwrap();
4791 let channel_state = &mut *channel_lock;
4792 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
4793 hash_map::Entry::Occupied(mut chan) => {
4794 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4795 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
4797 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.logger), chan), chan.remove())
4799 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
4802 // Because we have exclusive ownership of the channel here we can release the channel_state
4803 // lock before watch_channel
4804 match self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
4805 ChannelMonitorUpdateStatus::Completed => {},
4806 ChannelMonitorUpdateStatus::PermanentFailure => {
4807 // Note that we reply with the new channel_id in error messages if we gave up on the
4808 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
4809 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
4810 // any messages referencing a previously-closed channel anyway.
4811 // We do not propagate the monitor update to the user as it would be for a monitor
4812 // that we didn't manage to store (and that we don't care about - we don't respond
4813 // with the funding_signed so the channel can never go on chain).
4814 let (_monitor_update, failed_htlcs) = chan.force_shutdown(false);
4815 assert!(failed_htlcs.is_empty());
4816 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
4818 ChannelMonitorUpdateStatus::InProgress => {
4819 // There's no problem signing a counterparty's funding transaction if our monitor
4820 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
4821 // accepted payment from yet. We do, however, need to wait to send our channel_ready
4822 // until we have persisted our monitor.
4823 chan.monitor_updating_paused(false, false, channel_ready.is_some(), Vec::new(), Vec::new(), Vec::new());
4824 channel_ready = None; // Don't send the channel_ready now
4827 let mut channel_state_lock = self.channel_state.lock().unwrap();
4828 let channel_state = &mut *channel_state_lock;
4829 match channel_state.by_id.entry(funding_msg.channel_id) {
4830 hash_map::Entry::Occupied(_) => {
4831 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
4833 hash_map::Entry::Vacant(e) => {
4834 let mut id_to_peer = self.id_to_peer.lock().unwrap();
4835 match id_to_peer.entry(chan.channel_id()) {
4836 hash_map::Entry::Occupied(_) => {
4837 return Err(MsgHandleErrInternal::send_err_msg_no_close(
4838 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
4839 funding_msg.channel_id))
4841 hash_map::Entry::Vacant(i_e) => {
4842 i_e.insert(chan.get_counterparty_node_id());
4845 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
4846 node_id: counterparty_node_id.clone(),
4849 if let Some(msg) = channel_ready {
4850 send_channel_ready!(self, channel_state.pending_msg_events, chan, msg);
4858 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
4860 let best_block = *self.best_block.read().unwrap();
4861 let mut channel_lock = self.channel_state.lock().unwrap();
4862 let channel_state = &mut *channel_lock;
4863 match channel_state.by_id.entry(msg.channel_id) {
4864 hash_map::Entry::Occupied(mut chan) => {
4865 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4866 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4868 let (monitor, funding_tx, channel_ready) = match chan.get_mut().funding_signed(&msg, best_block, &self.logger) {
4869 Ok(update) => update,
4870 Err(e) => try_chan_entry!(self, Err(e), chan),
4872 match self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
4873 ChannelMonitorUpdateStatus::Completed => {},
4875 let mut res = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::RevokeAndACKFirst, channel_ready.is_some(), OPTIONALLY_RESEND_FUNDING_LOCKED);
4876 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
4877 // We weren't able to watch the channel to begin with, so no updates should be made on
4878 // it. Previously, full_stack_target found an (unreachable) panic when the
4879 // monitor update contained within `shutdown_finish` was applied.
4880 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
4881 shutdown_finish.0.take();
4887 if let Some(msg) = channel_ready {
4888 send_channel_ready!(self, channel_state.pending_msg_events, chan.get(), msg);
4892 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4895 log_info!(self.logger, "Broadcasting funding transaction with txid {}", funding_tx.txid());
4896 self.tx_broadcaster.broadcast_transaction(&funding_tx);
4900 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
4901 let mut channel_state_lock = self.channel_state.lock().unwrap();
4902 let channel_state = &mut *channel_state_lock;
4903 match channel_state.by_id.entry(msg.channel_id) {
4904 hash_map::Entry::Occupied(mut chan) => {
4905 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4906 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4908 let announcement_sigs_opt = try_chan_entry!(self, chan.get_mut().channel_ready(&msg, self.get_our_node_id(),
4909 self.genesis_hash.clone(), &self.best_block.read().unwrap(), &self.logger), chan);
4910 if let Some(announcement_sigs) = announcement_sigs_opt {
4911 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(chan.get().channel_id()));
4912 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4913 node_id: counterparty_node_id.clone(),
4914 msg: announcement_sigs,
4916 } else if chan.get().is_usable() {
4917 // If we're sending an announcement_signatures, we'll send the (public)
4918 // channel_update after sending a channel_announcement when we receive our
4919 // counterparty's announcement_signatures. Thus, we only bother to send a
4920 // channel_update here if the channel is not public, i.e. we're not sending an
4921 // announcement_signatures.
4922 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", log_bytes!(chan.get().channel_id()));
4923 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
4924 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4925 node_id: counterparty_node_id.clone(),
4931 emit_channel_ready_event!(self, chan.get_mut());
4935 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4939 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
4940 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
4941 let result: Result<(), _> = loop {
4942 let mut channel_state_lock = self.channel_state.lock().unwrap();
4943 let channel_state = &mut *channel_state_lock;
4945 match channel_state.by_id.entry(msg.channel_id.clone()) {
4946 hash_map::Entry::Occupied(mut chan_entry) => {
4947 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
4948 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4951 if !chan_entry.get().received_shutdown() {
4952 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
4953 log_bytes!(msg.channel_id),
4954 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
4957 let (shutdown, monitor_update, htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&self.keys_manager, &their_features, &msg), chan_entry);
4958 dropped_htlcs = htlcs;
4960 // Update the monitor with the shutdown script if necessary.
4961 if let Some(monitor_update) = monitor_update {
4962 let update_res = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update);
4963 let (result, is_permanent) =
4964 handle_monitor_update_res!(self, update_res, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
4966 remove_channel!(self, chan_entry);
4971 if let Some(msg) = shutdown {
4972 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
4973 node_id: *counterparty_node_id,
4980 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4983 for htlc_source in dropped_htlcs.drain(..) {
4984 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
4985 self.fail_htlc_backwards_internal(htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
4988 let _ = handle_error!(self, result, *counterparty_node_id);
4992 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
4993 let (tx, chan_option) = {
4994 let mut channel_state_lock = self.channel_state.lock().unwrap();
4995 let channel_state = &mut *channel_state_lock;
4996 match channel_state.by_id.entry(msg.channel_id.clone()) {
4997 hash_map::Entry::Occupied(mut chan_entry) => {
4998 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
4999 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5001 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), chan_entry);
5002 if let Some(msg) = closing_signed {
5003 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5004 node_id: counterparty_node_id.clone(),
5009 // We're done with this channel, we've got a signed closing transaction and
5010 // will send the closing_signed back to the remote peer upon return. This
5011 // also implies there are no pending HTLCs left on the channel, so we can
5012 // fully delete it from tracking (the channel monitor is still around to
5013 // watch for old state broadcasts)!
5014 (tx, Some(remove_channel!(self, chan_entry)))
5015 } else { (tx, None) }
5017 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5020 if let Some(broadcast_tx) = tx {
5021 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
5022 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
5024 if let Some(chan) = chan_option {
5025 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5026 let mut channel_state = self.channel_state.lock().unwrap();
5027 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5031 self.issue_channel_close_events(&chan, ClosureReason::CooperativeClosure);
5036 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
5037 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
5038 //determine the state of the payment based on our response/if we forward anything/the time
5039 //we take to respond. We should take care to avoid allowing such an attack.
5041 //TODO: There exists a further attack where a node may garble the onion data, forward it to
5042 //us repeatedly garbled in different ways, and compare our error messages, which are
5043 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
5044 //but we should prevent it anyway.
5046 let pending_forward_info = self.decode_update_add_htlc_onion(msg);
5047 let mut channel_state_lock = self.channel_state.lock().unwrap();
5048 let channel_state = &mut *channel_state_lock;
5050 match channel_state.by_id.entry(msg.channel_id) {
5051 hash_map::Entry::Occupied(mut chan) => {
5052 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5053 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5056 let create_pending_htlc_status = |chan: &Channel<<K::Target as KeysInterface>::Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
5057 // If the update_add is completely bogus, the call will Err and we will close,
5058 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
5059 // want to reject the new HTLC and fail it backwards instead of forwarding.
5060 match pending_forward_info {
5061 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
5062 let reason = if (error_code & 0x1000) != 0 {
5063 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
5064 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, real_code, &error_data)
5066 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, error_code, &[])
5068 let msg = msgs::UpdateFailHTLC {
5069 channel_id: msg.channel_id,
5070 htlc_id: msg.htlc_id,
5073 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
5075 _ => pending_forward_info
5078 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), chan);
5080 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5085 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
5086 let mut channel_lock = self.channel_state.lock().unwrap();
5087 let (htlc_source, forwarded_htlc_value) = {
5088 let channel_state = &mut *channel_lock;
5089 match channel_state.by_id.entry(msg.channel_id) {
5090 hash_map::Entry::Occupied(mut chan) => {
5091 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5092 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5094 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), chan)
5096 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5099 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, msg.channel_id);
5103 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
5104 let mut channel_lock = self.channel_state.lock().unwrap();
5105 let channel_state = &mut *channel_lock;
5106 match channel_state.by_id.entry(msg.channel_id) {
5107 hash_map::Entry::Occupied(mut chan) => {
5108 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5109 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5111 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), chan);
5113 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5118 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
5119 let mut channel_lock = self.channel_state.lock().unwrap();
5120 let channel_state = &mut *channel_lock;
5121 match channel_state.by_id.entry(msg.channel_id) {
5122 hash_map::Entry::Occupied(mut chan) => {
5123 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5124 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5126 if (msg.failure_code & 0x8000) == 0 {
5127 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
5128 try_chan_entry!(self, Err(chan_err), chan);
5130 try_chan_entry!(self, chan.get_mut().update_fail_malformed_htlc(&msg, HTLCFailReason::Reason { failure_code: msg.failure_code, data: Vec::new() }), chan);
5133 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5137 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
5138 let mut channel_state_lock = self.channel_state.lock().unwrap();
5139 let channel_state = &mut *channel_state_lock;
5140 match channel_state.by_id.entry(msg.channel_id) {
5141 hash_map::Entry::Occupied(mut chan) => {
5142 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5143 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5145 let (revoke_and_ack, commitment_signed, monitor_update) =
5146 match chan.get_mut().commitment_signed(&msg, &self.logger) {
5147 Err((None, e)) => try_chan_entry!(self, Err(e), chan),
5148 Err((Some(update), e)) => {
5149 assert!(chan.get().is_awaiting_monitor_update());
5150 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), update);
5151 try_chan_entry!(self, Err(e), chan);
5156 let update_res = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update);
5157 if let Err(e) = handle_monitor_update_res!(self, update_res, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some()) {
5161 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
5162 node_id: counterparty_node_id.clone(),
5163 msg: revoke_and_ack,
5165 if let Some(msg) = commitment_signed {
5166 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5167 node_id: counterparty_node_id.clone(),
5168 updates: msgs::CommitmentUpdate {
5169 update_add_htlcs: Vec::new(),
5170 update_fulfill_htlcs: Vec::new(),
5171 update_fail_htlcs: Vec::new(),
5172 update_fail_malformed_htlcs: Vec::new(),
5174 commitment_signed: msg,
5180 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5185 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
5186 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
5187 let mut forward_event = None;
5188 let mut new_intercept_events = Vec::new();
5189 let mut failed_intercept_forwards = Vec::new();
5190 if !pending_forwards.is_empty() {
5191 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
5192 let scid = match forward_info.routing {
5193 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
5194 PendingHTLCRouting::Receive { .. } => 0,
5195 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
5197 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
5198 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
5200 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
5201 let forward_htlcs_empty = forward_htlcs.is_empty();
5202 match forward_htlcs.entry(scid) {
5203 hash_map::Entry::Occupied(mut entry) => {
5204 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
5205 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
5207 hash_map::Entry::Vacant(entry) => {
5208 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
5209 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.genesis_hash)
5211 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).into_inner());
5212 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
5213 match pending_intercepts.entry(intercept_id) {
5214 hash_map::Entry::Vacant(entry) => {
5215 new_intercept_events.push(events::Event::HTLCIntercepted {
5216 requested_next_hop_scid: scid,
5217 payment_hash: forward_info.payment_hash,
5218 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
5219 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
5222 entry.insert(PendingAddHTLCInfo {
5223 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
5225 hash_map::Entry::Occupied(_) => {
5226 log_info!(self.logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
5227 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
5228 short_channel_id: prev_short_channel_id,
5229 outpoint: prev_funding_outpoint,
5230 htlc_id: prev_htlc_id,
5231 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
5232 phantom_shared_secret: None,
5235 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
5236 HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() },
5237 HTLCDestination::InvalidForward { requested_forward_scid: scid },
5242 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
5243 // payments are being processed.
5244 if forward_htlcs_empty {
5245 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
5247 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
5248 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
5255 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
5256 self.fail_htlc_backwards_internal(htlc_source, &payment_hash, failure_reason, destination);
5259 if !new_intercept_events.is_empty() {
5260 let mut events = self.pending_events.lock().unwrap();
5261 events.append(&mut new_intercept_events);
5264 match forward_event {
5266 let mut pending_events = self.pending_events.lock().unwrap();
5267 pending_events.push(events::Event::PendingHTLCsForwardable {
5268 time_forwardable: time
5276 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
5277 let mut htlcs_to_fail = Vec::new();
5279 let mut channel_state_lock = self.channel_state.lock().unwrap();
5280 let channel_state = &mut *channel_state_lock;
5281 match channel_state.by_id.entry(msg.channel_id) {
5282 hash_map::Entry::Occupied(mut chan) => {
5283 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5284 break Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5286 let was_paused_for_mon_update = chan.get().is_awaiting_monitor_update();
5287 let raa_updates = break_chan_entry!(self,
5288 chan.get_mut().revoke_and_ack(&msg, &self.logger), chan);
5289 htlcs_to_fail = raa_updates.holding_cell_failed_htlcs;
5290 let update_res = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), raa_updates.monitor_update);
5291 if was_paused_for_mon_update {
5292 assert!(update_res != ChannelMonitorUpdateStatus::Completed);
5293 assert!(raa_updates.commitment_update.is_none());
5294 assert!(raa_updates.accepted_htlcs.is_empty());
5295 assert!(raa_updates.failed_htlcs.is_empty());
5296 assert!(raa_updates.finalized_claimed_htlcs.is_empty());
5297 break Err(MsgHandleErrInternal::ignore_no_close("Existing pending monitor update prevented responses to RAA".to_owned()));
5299 if update_res != ChannelMonitorUpdateStatus::Completed {
5300 if let Err(e) = handle_monitor_update_res!(self, update_res, chan,
5301 RAACommitmentOrder::CommitmentFirst, false,
5302 raa_updates.commitment_update.is_some(), false,
5303 raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
5304 raa_updates.finalized_claimed_htlcs) {
5306 } else { unreachable!(); }
5308 if let Some(updates) = raa_updates.commitment_update {
5309 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5310 node_id: counterparty_node_id.clone(),
5314 break Ok((raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
5315 raa_updates.finalized_claimed_htlcs,
5316 chan.get().get_short_channel_id()
5317 .unwrap_or(chan.get().outbound_scid_alias()),
5318 chan.get().get_funding_txo().unwrap(),
5319 chan.get().get_user_id()))
5321 hash_map::Entry::Vacant(_) => break Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5324 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
5326 Ok((pending_forwards, mut pending_failures, finalized_claim_htlcs,
5327 short_channel_id, channel_outpoint, user_channel_id)) =>
5329 for failure in pending_failures.drain(..) {
5330 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: channel_outpoint.to_channel_id() };
5331 self.fail_htlc_backwards_internal(failure.0, &failure.1, failure.2, receiver);
5333 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, user_channel_id, pending_forwards)]);
5334 self.finalize_claims(finalized_claim_htlcs);
5341 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
5342 let mut channel_lock = self.channel_state.lock().unwrap();
5343 let channel_state = &mut *channel_lock;
5344 match channel_state.by_id.entry(msg.channel_id) {
5345 hash_map::Entry::Occupied(mut chan) => {
5346 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5347 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5349 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg, &self.logger), chan);
5351 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5356 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
5357 let mut channel_state_lock = self.channel_state.lock().unwrap();
5358 let channel_state = &mut *channel_state_lock;
5360 match channel_state.by_id.entry(msg.channel_id) {
5361 hash_map::Entry::Occupied(mut chan) => {
5362 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5363 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5365 if !chan.get().is_usable() {
5366 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
5369 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5370 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(
5371 self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height(), msg), chan),
5372 // Note that announcement_signatures fails if the channel cannot be announced,
5373 // so get_channel_update_for_broadcast will never fail by the time we get here.
5374 update_msg: self.get_channel_update_for_broadcast(chan.get()).unwrap(),
5377 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5382 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
5383 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
5384 let chan_id = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
5385 Some((_cp_id, chan_id)) => chan_id.clone(),
5387 // It's not a local channel
5388 return Ok(NotifyOption::SkipPersist)
5391 let mut channel_state_lock = self.channel_state.lock().unwrap();
5392 let channel_state = &mut *channel_state_lock;
5393 match channel_state.by_id.entry(chan_id) {
5394 hash_map::Entry::Occupied(mut chan) => {
5395 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5396 if chan.get().should_announce() {
5397 // If the announcement is about a channel of ours which is public, some
5398 // other peer may simply be forwarding all its gossip to us. Don't provide
5399 // a scary-looking error message and return Ok instead.
5400 return Ok(NotifyOption::SkipPersist);
5402 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));
5404 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().get_counterparty_node_id().serialize()[..];
5405 let msg_from_node_one = msg.contents.flags & 1 == 0;
5406 if were_node_one == msg_from_node_one {
5407 return Ok(NotifyOption::SkipPersist);
5409 log_debug!(self.logger, "Received channel_update for channel {}.", log_bytes!(chan_id));
5410 try_chan_entry!(self, chan.get_mut().channel_update(&msg), chan);
5413 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersist)
5415 Ok(NotifyOption::DoPersist)
5418 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
5420 let need_lnd_workaround = {
5421 let mut channel_state_lock = self.channel_state.lock().unwrap();
5422 let channel_state = &mut *channel_state_lock;
5424 match channel_state.by_id.entry(msg.channel_id) {
5425 hash_map::Entry::Occupied(mut chan) => {
5426 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5427 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5429 // Currently, we expect all holding cell update_adds to be dropped on peer
5430 // disconnect, so Channel's reestablish will never hand us any holding cell
5431 // freed HTLCs to fail backwards. If in the future we no longer drop pending
5432 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
5433 let responses = try_chan_entry!(self, chan.get_mut().channel_reestablish(
5434 msg, &self.logger, self.our_network_pubkey.clone(), self.genesis_hash,
5435 &*self.best_block.read().unwrap()), chan);
5436 let mut channel_update = None;
5437 if let Some(msg) = responses.shutdown_msg {
5438 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5439 node_id: counterparty_node_id.clone(),
5442 } else if chan.get().is_usable() {
5443 // If the channel is in a usable state (ie the channel is not being shut
5444 // down), send a unicast channel_update to our counterparty to make sure
5445 // they have the latest channel parameters.
5446 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
5447 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
5448 node_id: chan.get().get_counterparty_node_id(),
5453 let need_lnd_workaround = chan.get_mut().workaround_lnd_bug_4006.take();
5454 htlc_forwards = self.handle_channel_resumption(
5455 &mut channel_state.pending_msg_events, chan.get_mut(), responses.raa, responses.commitment_update, responses.order,
5456 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
5457 if let Some(upd) = channel_update {
5458 channel_state.pending_msg_events.push(upd);
5462 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5466 if let Some(forwards) = htlc_forwards {
5467 self.forward_htlcs(&mut [forwards][..]);
5470 if let Some(channel_ready_msg) = need_lnd_workaround {
5471 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
5476 /// Process pending events from the `chain::Watch`, returning whether any events were processed.
5477 fn process_pending_monitor_events(&self) -> bool {
5478 let mut failed_channels = Vec::new();
5479 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
5480 let has_pending_monitor_events = !pending_monitor_events.is_empty();
5481 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
5482 for monitor_event in monitor_events.drain(..) {
5483 match monitor_event {
5484 MonitorEvent::HTLCEvent(htlc_update) => {
5485 if let Some(preimage) = htlc_update.payment_preimage {
5486 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
5487 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());
5489 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
5490 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
5491 self.fail_htlc_backwards_internal(htlc_update.source, &htlc_update.payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
5494 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
5495 MonitorEvent::UpdateFailed(funding_outpoint) => {
5496 let mut channel_lock = self.channel_state.lock().unwrap();
5497 let channel_state = &mut *channel_lock;
5498 let by_id = &mut channel_state.by_id;
5499 let pending_msg_events = &mut channel_state.pending_msg_events;
5500 if let hash_map::Entry::Occupied(chan_entry) = by_id.entry(funding_outpoint.to_channel_id()) {
5501 let mut chan = remove_channel!(self, chan_entry);
5502 failed_channels.push(chan.force_shutdown(false));
5503 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5504 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5508 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
5509 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
5511 ClosureReason::CommitmentTxConfirmed
5513 self.issue_channel_close_events(&chan, reason);
5514 pending_msg_events.push(events::MessageSendEvent::HandleError {
5515 node_id: chan.get_counterparty_node_id(),
5516 action: msgs::ErrorAction::SendErrorMessage {
5517 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
5522 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
5523 self.channel_monitor_updated(&funding_txo, monitor_update_id);
5529 for failure in failed_channels.drain(..) {
5530 self.finish_force_close_channel(failure);
5533 has_pending_monitor_events
5536 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
5537 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
5538 /// update events as a separate process method here.
5540 pub fn process_monitor_events(&self) {
5541 self.process_pending_monitor_events();
5544 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
5545 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
5546 /// update was applied.
5548 /// This should only apply to HTLCs which were added to the holding cell because we were
5549 /// waiting on a monitor update to finish. In that case, we don't want to free the holding cell
5550 /// directly in `channel_monitor_updated` as it may introduce deadlocks calling back into user
5551 /// code to inform them of a channel monitor update.
5552 fn check_free_holding_cells(&self) -> bool {
5553 let mut has_monitor_update = false;
5554 let mut failed_htlcs = Vec::new();
5555 let mut handle_errors = Vec::new();
5557 let mut channel_state_lock = self.channel_state.lock().unwrap();
5558 let channel_state = &mut *channel_state_lock;
5559 let by_id = &mut channel_state.by_id;
5560 let pending_msg_events = &mut channel_state.pending_msg_events;
5562 by_id.retain(|channel_id, chan| {
5563 match chan.maybe_free_holding_cell_htlcs(&self.logger) {
5564 Ok((commitment_opt, holding_cell_failed_htlcs)) => {
5565 if !holding_cell_failed_htlcs.is_empty() {
5567 holding_cell_failed_htlcs,
5569 chan.get_counterparty_node_id()
5572 if let Some((commitment_update, monitor_update)) = commitment_opt {
5573 match self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
5574 ChannelMonitorUpdateStatus::Completed => {
5575 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5576 node_id: chan.get_counterparty_node_id(),
5577 updates: commitment_update,
5581 has_monitor_update = true;
5582 let (res, close_channel) = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, channel_id, COMMITMENT_UPDATE_ONLY);
5583 handle_errors.push((chan.get_counterparty_node_id(), res));
5584 if close_channel { return false; }
5591 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
5592 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5593 // ChannelClosed event is generated by handle_error for us
5600 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
5601 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
5602 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
5605 for (counterparty_node_id, err) in handle_errors.drain(..) {
5606 let _ = handle_error!(self, err, counterparty_node_id);
5612 /// Check whether any channels have finished removing all pending updates after a shutdown
5613 /// exchange and can now send a closing_signed.
5614 /// Returns whether any closing_signed messages were generated.
5615 fn maybe_generate_initial_closing_signed(&self) -> bool {
5616 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
5617 let mut has_update = false;
5619 let mut channel_state_lock = self.channel_state.lock().unwrap();
5620 let channel_state = &mut *channel_state_lock;
5621 let by_id = &mut channel_state.by_id;
5622 let pending_msg_events = &mut channel_state.pending_msg_events;
5624 by_id.retain(|channel_id, chan| {
5625 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
5626 Ok((msg_opt, tx_opt)) => {
5627 if let Some(msg) = msg_opt {
5629 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5630 node_id: chan.get_counterparty_node_id(), msg,
5633 if let Some(tx) = tx_opt {
5634 // We're done with this channel. We got a closing_signed and sent back
5635 // a closing_signed with a closing transaction to broadcast.
5636 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5637 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5642 self.issue_channel_close_events(chan, ClosureReason::CooperativeClosure);
5644 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
5645 self.tx_broadcaster.broadcast_transaction(&tx);
5646 update_maps_on_chan_removal!(self, chan);
5652 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
5653 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5660 for (counterparty_node_id, err) in handle_errors.drain(..) {
5661 let _ = handle_error!(self, err, counterparty_node_id);
5667 /// Handle a list of channel failures during a block_connected or block_disconnected call,
5668 /// pushing the channel monitor update (if any) to the background events queue and removing the
5670 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
5671 for mut failure in failed_channels.drain(..) {
5672 // Either a commitment transactions has been confirmed on-chain or
5673 // Channel::block_disconnected detected that the funding transaction has been
5674 // reorganized out of the main chain.
5675 // We cannot broadcast our latest local state via monitor update (as
5676 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
5677 // so we track the update internally and handle it when the user next calls
5678 // timer_tick_occurred, guaranteeing we're running normally.
5679 if let Some((funding_txo, update)) = failure.0.take() {
5680 assert_eq!(update.updates.len(), 1);
5681 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
5682 assert!(should_broadcast);
5683 } else { unreachable!(); }
5684 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
5686 self.finish_force_close_channel(failure);
5690 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> {
5691 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
5693 if min_value_msat.is_some() && min_value_msat.unwrap() > MAX_VALUE_MSAT {
5694 return Err(APIError::APIMisuseError { err: format!("min_value_msat of {} greater than total 21 million bitcoin supply", min_value_msat.unwrap()) });
5697 let payment_secret = PaymentSecret(self.keys_manager.get_secure_random_bytes());
5699 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5700 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5701 match payment_secrets.entry(payment_hash) {
5702 hash_map::Entry::Vacant(e) => {
5703 e.insert(PendingInboundPayment {
5704 payment_secret, min_value_msat, payment_preimage,
5705 user_payment_id: 0, // For compatibility with version 0.0.103 and earlier
5706 // We assume that highest_seen_timestamp is pretty close to the current time -
5707 // it's updated when we receive a new block with the maximum time we've seen in
5708 // a header. It should never be more than two hours in the future.
5709 // Thus, we add two hours here as a buffer to ensure we absolutely
5710 // never fail a payment too early.
5711 // Note that we assume that received blocks have reasonably up-to-date
5713 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
5716 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
5721 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
5724 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
5725 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
5727 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
5728 /// will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
5729 /// passed directly to [`claim_funds`].
5731 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
5733 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5734 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5738 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5739 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5741 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5743 /// [`claim_funds`]: Self::claim_funds
5744 /// [`PaymentReceived`]: events::Event::PaymentReceived
5745 /// [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
5746 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5747 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), ()> {
5748 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)
5751 /// Legacy version of [`create_inbound_payment`]. Use this method if you wish to share
5752 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5754 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5757 /// This method is deprecated and will be removed soon.
5759 /// [`create_inbound_payment`]: Self::create_inbound_payment
5761 pub fn create_inbound_payment_legacy(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), APIError> {
5762 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
5763 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
5764 let payment_secret = self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs)?;
5765 Ok((payment_hash, payment_secret))
5768 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
5769 /// stored external to LDK.
5771 /// A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
5772 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
5773 /// the `min_value_msat` provided here, if one is provided.
5775 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
5776 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
5779 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
5780 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
5781 /// before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
5782 /// sender "proof-of-payment" unless they have paid the required amount.
5784 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
5785 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
5786 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
5787 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
5788 /// invoices when no timeout is set.
5790 /// Note that we use block header time to time-out pending inbound payments (with some margin
5791 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
5792 /// accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
5793 /// If you need exact expiry semantics, you should enforce them upon receipt of
5794 /// [`PaymentReceived`].
5796 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
5797 /// set to at least [`MIN_FINAL_CLTV_EXPIRY`].
5799 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5800 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5804 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5805 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5807 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5809 /// [`create_inbound_payment`]: Self::create_inbound_payment
5810 /// [`PaymentReceived`]: events::Event::PaymentReceived
5811 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<PaymentSecret, ()> {
5812 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)
5815 /// Legacy version of [`create_inbound_payment_for_hash`]. Use this method if you wish to share
5816 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5818 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5821 /// This method is deprecated and will be removed soon.
5823 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5825 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> {
5826 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
5829 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
5830 /// previously returned from [`create_inbound_payment`].
5832 /// [`create_inbound_payment`]: Self::create_inbound_payment
5833 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
5834 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
5837 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
5838 /// are used when constructing the phantom invoice's route hints.
5840 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5841 pub fn get_phantom_scid(&self) -> u64 {
5842 let best_block_height = self.best_block.read().unwrap().height();
5843 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
5845 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
5846 // Ensure the generated scid doesn't conflict with a real channel.
5847 match short_to_chan_info.get(&scid_candidate) {
5848 Some(_) => continue,
5849 None => return scid_candidate
5854 /// Gets route hints for use in receiving [phantom node payments].
5856 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5857 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
5859 channels: self.list_usable_channels(),
5860 phantom_scid: self.get_phantom_scid(),
5861 real_node_pubkey: self.get_our_node_id(),
5865 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
5866 /// used when constructing the route hints for HTLCs intended to be intercepted. See
5867 /// [`ChannelManager::forward_intercepted_htlc`].
5869 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
5870 /// times to get a unique scid.
5871 pub fn get_intercept_scid(&self) -> u64 {
5872 let best_block_height = self.best_block.read().unwrap().height();
5873 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
5875 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
5876 // Ensure the generated scid doesn't conflict with a real channel.
5877 if short_to_chan_info.contains_key(&scid_candidate) { continue }
5878 return scid_candidate
5882 /// Gets inflight HTLC information by processing pending outbound payments that are in
5883 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
5884 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
5885 let mut inflight_htlcs = InFlightHtlcs::new();
5887 for chan in self.channel_state.lock().unwrap().by_id.values() {
5888 for htlc_source in chan.inflight_htlc_sources() {
5889 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
5890 inflight_htlcs.process_path(path, self.get_our_node_id());
5898 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
5899 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
5900 let events = core::cell::RefCell::new(Vec::new());
5901 let event_handler = |event: events::Event| events.borrow_mut().push(event);
5902 self.process_pending_events(&event_handler);
5907 pub fn has_pending_payments(&self) -> bool {
5908 !self.pending_outbound_payments.lock().unwrap().is_empty()
5912 pub fn clear_pending_payments(&self) {
5913 self.pending_outbound_payments.lock().unwrap().clear()
5916 /// Processes any events asynchronously in the order they were generated since the last call
5917 /// using the given event handler.
5919 /// See the trait-level documentation of [`EventsProvider`] for requirements.
5920 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
5923 // We'll acquire our total consistency lock until the returned future completes so that
5924 // we can be sure no other persists happen while processing events.
5925 let _read_guard = self.total_consistency_lock.read().unwrap();
5927 let mut result = NotifyOption::SkipPersist;
5929 // TODO: This behavior should be documented. It's unintuitive that we query
5930 // ChannelMonitors when clearing other events.
5931 if self.process_pending_monitor_events() {
5932 result = NotifyOption::DoPersist;
5935 let pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5936 if !pending_events.is_empty() {
5937 result = NotifyOption::DoPersist;
5940 for event in pending_events {
5941 handler(event).await;
5944 if result == NotifyOption::DoPersist {
5945 self.persistence_notifier.notify();
5950 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<M, T, K, F, L>
5951 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
5952 T::Target: BroadcasterInterface,
5953 K::Target: KeysInterface,
5954 F::Target: FeeEstimator,
5957 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
5958 let events = RefCell::new(Vec::new());
5959 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5960 let mut result = NotifyOption::SkipPersist;
5962 // TODO: This behavior should be documented. It's unintuitive that we query
5963 // ChannelMonitors when clearing other events.
5964 if self.process_pending_monitor_events() {
5965 result = NotifyOption::DoPersist;
5968 if self.check_free_holding_cells() {
5969 result = NotifyOption::DoPersist;
5971 if self.maybe_generate_initial_closing_signed() {
5972 result = NotifyOption::DoPersist;
5975 let mut pending_events = Vec::new();
5976 let mut channel_state = self.channel_state.lock().unwrap();
5977 mem::swap(&mut pending_events, &mut channel_state.pending_msg_events);
5979 if !pending_events.is_empty() {
5980 events.replace(pending_events);
5989 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> EventsProvider for ChannelManager<M, T, K, F, L>
5991 M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
5992 T::Target: BroadcasterInterface,
5993 K::Target: KeysInterface,
5994 F::Target: FeeEstimator,
5997 /// Processes events that must be periodically handled.
5999 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
6000 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
6001 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
6002 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
6003 let mut result = NotifyOption::SkipPersist;
6005 // TODO: This behavior should be documented. It's unintuitive that we query
6006 // ChannelMonitors when clearing other events.
6007 if self.process_pending_monitor_events() {
6008 result = NotifyOption::DoPersist;
6011 let pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
6012 if !pending_events.is_empty() {
6013 result = NotifyOption::DoPersist;
6016 for event in pending_events {
6017 handler.handle_event(event);
6025 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Listen for ChannelManager<M, T, K, F, L>
6027 M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
6028 T::Target: BroadcasterInterface,
6029 K::Target: KeysInterface,
6030 F::Target: FeeEstimator,
6033 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
6035 let best_block = self.best_block.read().unwrap();
6036 assert_eq!(best_block.block_hash(), header.prev_blockhash,
6037 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
6038 assert_eq!(best_block.height(), height - 1,
6039 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
6042 self.transactions_confirmed(header, txdata, height);
6043 self.best_block_updated(header, height);
6046 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
6047 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6048 let new_height = height - 1;
6050 let mut best_block = self.best_block.write().unwrap();
6051 assert_eq!(best_block.block_hash(), header.block_hash(),
6052 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
6053 assert_eq!(best_block.height(), height,
6054 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
6055 *best_block = BestBlock::new(header.prev_blockhash, new_height)
6058 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));
6062 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Confirm for ChannelManager<M, T, K, F, L>
6064 M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
6065 T::Target: BroadcasterInterface,
6066 K::Target: KeysInterface,
6067 F::Target: FeeEstimator,
6070 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
6071 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
6072 // during initialization prior to the chain_monitor being fully configured in some cases.
6073 // See the docs for `ChannelManagerReadArgs` for more.
6075 let block_hash = header.block_hash();
6076 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
6078 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6079 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)
6080 .map(|(a, b)| (a, Vec::new(), b)));
6082 let last_best_block_height = self.best_block.read().unwrap().height();
6083 if height < last_best_block_height {
6084 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
6085 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));
6089 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
6090 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
6091 // during initialization prior to the chain_monitor being fully configured in some cases.
6092 // See the docs for `ChannelManagerReadArgs` for more.
6094 let block_hash = header.block_hash();
6095 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
6097 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6099 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
6101 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));
6103 macro_rules! max_time {
6104 ($timestamp: expr) => {
6106 // Update $timestamp to be the max of its current value and the block
6107 // timestamp. This should keep us close to the current time without relying on
6108 // having an explicit local time source.
6109 // Just in case we end up in a race, we loop until we either successfully
6110 // update $timestamp or decide we don't need to.
6111 let old_serial = $timestamp.load(Ordering::Acquire);
6112 if old_serial >= header.time as usize { break; }
6113 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
6119 max_time!(self.highest_seen_timestamp);
6120 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
6121 payment_secrets.retain(|_, inbound_payment| {
6122 inbound_payment.expiry_time > header.time as u64
6126 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
6127 let channel_state = self.channel_state.lock().unwrap();
6128 let mut res = Vec::with_capacity(channel_state.by_id.len());
6129 for chan in channel_state.by_id.values() {
6130 if let (Some(funding_txo), block_hash) = (chan.get_funding_txo(), chan.get_funding_tx_confirmed_in()) {
6131 res.push((funding_txo.txid, block_hash));
6137 fn transaction_unconfirmed(&self, txid: &Txid) {
6138 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6139 self.do_chain_event(None, |channel| {
6140 if let Some(funding_txo) = channel.get_funding_txo() {
6141 if funding_txo.txid == *txid {
6142 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
6143 } else { Ok((None, Vec::new(), None)) }
6144 } else { Ok((None, Vec::new(), None)) }
6149 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F, L>
6151 M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
6152 T::Target: BroadcasterInterface,
6153 K::Target: KeysInterface,
6154 F::Target: FeeEstimator,
6157 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
6158 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
6160 fn do_chain_event<FN: Fn(&mut Channel<<K::Target as KeysInterface>::Signer>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
6161 (&self, height_opt: Option<u32>, f: FN) {
6162 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
6163 // during initialization prior to the chain_monitor being fully configured in some cases.
6164 // See the docs for `ChannelManagerReadArgs` for more.
6166 let mut failed_channels = Vec::new();
6167 let mut timed_out_htlcs = Vec::new();
6169 let mut channel_lock = self.channel_state.lock().unwrap();
6170 let channel_state = &mut *channel_lock;
6171 let pending_msg_events = &mut channel_state.pending_msg_events;
6172 channel_state.by_id.retain(|_, channel| {
6173 let res = f(channel);
6174 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
6175 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
6176 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
6177 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::Reason {
6179 }, HTLCDestination::NextHopChannel { node_id: Some(channel.get_counterparty_node_id()), channel_id: channel.channel_id() }));
6181 if let Some(channel_ready) = channel_ready_opt {
6182 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
6183 if channel.is_usable() {
6184 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", log_bytes!(channel.channel_id()));
6185 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
6186 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
6187 node_id: channel.get_counterparty_node_id(),
6192 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", log_bytes!(channel.channel_id()));
6196 emit_channel_ready_event!(self, channel);
6198 if let Some(announcement_sigs) = announcement_sigs {
6199 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(channel.channel_id()));
6200 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
6201 node_id: channel.get_counterparty_node_id(),
6202 msg: announcement_sigs,
6204 if let Some(height) = height_opt {
6205 if let Some(announcement) = channel.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash, height) {
6206 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
6208 // Note that announcement_signatures fails if the channel cannot be announced,
6209 // so get_channel_update_for_broadcast will never fail by the time we get here.
6210 update_msg: self.get_channel_update_for_broadcast(channel).unwrap(),
6215 if channel.is_our_channel_ready() {
6216 if let Some(real_scid) = channel.get_short_channel_id() {
6217 // If we sent a 0conf channel_ready, and now have an SCID, we add it
6218 // to the short_to_chan_info map here. Note that we check whether we
6219 // can relay using the real SCID at relay-time (i.e.
6220 // enforce option_scid_alias then), and if the funding tx is ever
6221 // un-confirmed we force-close the channel, ensuring short_to_chan_info
6222 // is always consistent.
6223 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
6224 let scid_insert = short_to_chan_info.insert(real_scid, (channel.get_counterparty_node_id(), channel.channel_id()));
6225 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.get_counterparty_node_id(), channel.channel_id()),
6226 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
6227 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
6230 } else if let Err(reason) = res {
6231 update_maps_on_chan_removal!(self, channel);
6232 // It looks like our counterparty went on-chain or funding transaction was
6233 // reorged out of the main chain. Close the channel.
6234 failed_channels.push(channel.force_shutdown(true));
6235 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
6236 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6240 let reason_message = format!("{}", reason);
6241 self.issue_channel_close_events(channel, reason);
6242 pending_msg_events.push(events::MessageSendEvent::HandleError {
6243 node_id: channel.get_counterparty_node_id(),
6244 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
6245 channel_id: channel.channel_id(),
6246 data: reason_message,
6255 if let Some(height) = height_opt {
6256 self.claimable_htlcs.lock().unwrap().retain(|payment_hash, (_, htlcs)| {
6257 htlcs.retain(|htlc| {
6258 // If height is approaching the number of blocks we think it takes us to get
6259 // our commitment transaction confirmed before the HTLC expires, plus the
6260 // number of blocks we generally consider it to take to do a commitment update,
6261 // just give up on it and fail the HTLC.
6262 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
6263 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
6264 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(height));
6265 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(), HTLCFailReason::Reason {
6266 failure_code: 0x4000 | 15,
6267 data: htlc_msat_height_data
6268 }, HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
6272 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
6275 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
6276 intercepted_htlcs.retain(|_, htlc| {
6277 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
6278 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
6279 short_channel_id: htlc.prev_short_channel_id,
6280 htlc_id: htlc.prev_htlc_id,
6281 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
6282 phantom_shared_secret: None,
6283 outpoint: htlc.prev_funding_outpoint,
6286 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
6287 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
6288 _ => unreachable!(),
6290 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
6291 HTLCFailReason::Reason { failure_code: 0x2000 | 2, data: Vec::new() },
6292 HTLCDestination::InvalidForward { requested_forward_scid }));
6293 log_trace!(self.logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
6299 self.handle_init_event_channel_failures(failed_channels);
6301 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
6302 self.fail_htlc_backwards_internal(source, &payment_hash, reason, destination);
6306 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
6307 /// indicating whether persistence is necessary. Only one listener on
6308 /// [`await_persistable_update`], [`await_persistable_update_timeout`], or a future returned by
6309 /// [`get_persistable_update_future`] is guaranteed to be woken up.
6311 /// Note that this method is not available with the `no-std` feature.
6313 /// [`await_persistable_update`]: Self::await_persistable_update
6314 /// [`await_persistable_update_timeout`]: Self::await_persistable_update_timeout
6315 /// [`get_persistable_update_future`]: Self::get_persistable_update_future
6316 #[cfg(any(test, feature = "std"))]
6317 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
6318 self.persistence_notifier.wait_timeout(max_wait)
6321 /// Blocks until ChannelManager needs to be persisted. Only one listener on
6322 /// [`await_persistable_update`], `await_persistable_update_timeout`, or a future returned by
6323 /// [`get_persistable_update_future`] is guaranteed to be woken up.
6325 /// [`await_persistable_update`]: Self::await_persistable_update
6326 /// [`get_persistable_update_future`]: Self::get_persistable_update_future
6327 pub fn await_persistable_update(&self) {
6328 self.persistence_notifier.wait()
6331 /// Gets a [`Future`] that completes when a persistable update is available. Note that
6332 /// callbacks registered on the [`Future`] MUST NOT call back into this [`ChannelManager`] and
6333 /// should instead register actions to be taken later.
6334 pub fn get_persistable_update_future(&self) -> Future {
6335 self.persistence_notifier.get_future()
6338 #[cfg(any(test, feature = "_test_utils"))]
6339 pub fn get_persistence_condvar_value(&self) -> bool {
6340 self.persistence_notifier.notify_pending()
6343 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
6344 /// [`chain::Confirm`] interfaces.
6345 pub fn current_best_block(&self) -> BestBlock {
6346 self.best_block.read().unwrap().clone()
6350 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref >
6351 ChannelMessageHandler for ChannelManager<M, T, K, F, L>
6352 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
6353 T::Target: BroadcasterInterface,
6354 K::Target: KeysInterface,
6355 F::Target: FeeEstimator,
6358 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
6359 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6360 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
6363 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
6364 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6365 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
6368 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
6369 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6370 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
6373 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
6374 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6375 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
6378 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
6379 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6380 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
6383 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) {
6384 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6385 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, their_features, msg), *counterparty_node_id);
6388 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
6389 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6390 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
6393 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
6394 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6395 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
6398 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
6399 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6400 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
6403 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
6404 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6405 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
6408 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
6409 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6410 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
6413 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
6414 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6415 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
6418 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
6419 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6420 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
6423 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
6424 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6425 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
6428 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
6429 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6430 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
6433 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
6434 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
6435 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
6438 NotifyOption::SkipPersist
6443 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
6444 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6445 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
6448 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
6449 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6450 let mut failed_channels = Vec::new();
6451 let mut no_channels_remain = true;
6453 let mut channel_state_lock = self.channel_state.lock().unwrap();
6454 let channel_state = &mut *channel_state_lock;
6455 let pending_msg_events = &mut channel_state.pending_msg_events;
6456 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates. We believe we {} make future connections to this peer.",
6457 log_pubkey!(counterparty_node_id), if no_connection_possible { "cannot" } else { "can" });
6458 channel_state.by_id.retain(|_, chan| {
6459 if chan.get_counterparty_node_id() == *counterparty_node_id {
6460 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
6461 if chan.is_shutdown() {
6462 update_maps_on_chan_removal!(self, chan);
6463 self.issue_channel_close_events(chan, ClosureReason::DisconnectedPeer);
6466 no_channels_remain = false;
6471 pending_msg_events.retain(|msg| {
6473 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != counterparty_node_id,
6474 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != counterparty_node_id,
6475 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != counterparty_node_id,
6476 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != counterparty_node_id,
6477 &events::MessageSendEvent::SendChannelReady { ref node_id, .. } => node_id != counterparty_node_id,
6478 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != counterparty_node_id,
6479 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != counterparty_node_id,
6480 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != counterparty_node_id,
6481 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != counterparty_node_id,
6482 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != counterparty_node_id,
6483 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != counterparty_node_id,
6484 &events::MessageSendEvent::SendChannelAnnouncement { ref node_id, .. } => node_id != counterparty_node_id,
6485 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
6486 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
6487 &events::MessageSendEvent::SendChannelUpdate { ref node_id, .. } => node_id != counterparty_node_id,
6488 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != counterparty_node_id,
6489 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
6490 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
6491 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
6492 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
6496 if no_channels_remain {
6497 self.per_peer_state.write().unwrap().remove(counterparty_node_id);
6500 for failure in failed_channels.drain(..) {
6501 self.finish_force_close_channel(failure);
6505 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) -> Result<(), ()> {
6506 if !init_msg.features.supports_static_remote_key() {
6507 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(counterparty_node_id));
6511 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
6513 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6516 let mut peer_state_lock = self.per_peer_state.write().unwrap();
6517 match peer_state_lock.entry(counterparty_node_id.clone()) {
6518 hash_map::Entry::Vacant(e) => {
6519 e.insert(Mutex::new(PeerState {
6520 latest_features: init_msg.features.clone(),
6523 hash_map::Entry::Occupied(e) => {
6524 e.get().lock().unwrap().latest_features = init_msg.features.clone();
6529 let mut channel_state_lock = self.channel_state.lock().unwrap();
6530 let channel_state = &mut *channel_state_lock;
6531 let pending_msg_events = &mut channel_state.pending_msg_events;
6532 channel_state.by_id.retain(|_, chan| {
6533 let retain = if chan.get_counterparty_node_id() == *counterparty_node_id {
6534 if !chan.have_received_message() {
6535 // If we created this (outbound) channel while we were disconnected from the
6536 // peer we probably failed to send the open_channel message, which is now
6537 // lost. We can't have had anything pending related to this channel, so we just
6541 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
6542 node_id: chan.get_counterparty_node_id(),
6543 msg: chan.get_channel_reestablish(&self.logger),
6548 if retain && chan.get_counterparty_node_id() != *counterparty_node_id {
6549 if let Some(msg) = chan.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height()) {
6550 if let Ok(update_msg) = self.get_channel_update_for_broadcast(chan) {
6551 pending_msg_events.push(events::MessageSendEvent::SendChannelAnnouncement {
6552 node_id: *counterparty_node_id,
6560 //TODO: Also re-broadcast announcement_signatures
6564 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
6565 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6567 if msg.channel_id == [0; 32] {
6568 for chan in self.list_channels() {
6569 if chan.counterparty.node_id == *counterparty_node_id {
6570 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6571 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data), true);
6576 // First check if we can advance the channel type and try again.
6577 let mut channel_state = self.channel_state.lock().unwrap();
6578 if let Some(chan) = channel_state.by_id.get_mut(&msg.channel_id) {
6579 if chan.get_counterparty_node_id() != *counterparty_node_id {
6582 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash) {
6583 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
6584 node_id: *counterparty_node_id,
6592 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6593 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
6597 fn provided_node_features(&self) -> NodeFeatures {
6598 provided_node_features()
6601 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
6602 provided_init_features()
6606 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
6607 /// [`ChannelManager`].
6608 pub fn provided_node_features() -> NodeFeatures {
6609 provided_init_features().to_context()
6612 /// Fetches the set of [`InvoiceFeatures`] flags which are provided by or required by
6613 /// [`ChannelManager`].
6615 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
6616 /// or not. Thus, this method is not public.
6617 #[cfg(any(feature = "_test_utils", test))]
6618 pub fn provided_invoice_features() -> InvoiceFeatures {
6619 provided_init_features().to_context()
6622 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
6623 /// [`ChannelManager`].
6624 pub fn provided_channel_features() -> ChannelFeatures {
6625 provided_init_features().to_context()
6628 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
6629 /// [`ChannelManager`].
6630 pub fn provided_init_features() -> InitFeatures {
6631 // Note that if new features are added here which other peers may (eventually) require, we
6632 // should also add the corresponding (optional) bit to the ChannelMessageHandler impl for
6633 // ErroringMessageHandler.
6634 let mut features = InitFeatures::empty();
6635 features.set_data_loss_protect_optional();
6636 features.set_upfront_shutdown_script_optional();
6637 features.set_variable_length_onion_required();
6638 features.set_static_remote_key_required();
6639 features.set_payment_secret_required();
6640 features.set_basic_mpp_optional();
6641 features.set_wumbo_optional();
6642 features.set_shutdown_any_segwit_optional();
6643 features.set_channel_type_optional();
6644 features.set_scid_privacy_optional();
6645 features.set_zero_conf_optional();
6649 const SERIALIZATION_VERSION: u8 = 1;
6650 const MIN_SERIALIZATION_VERSION: u8 = 1;
6652 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
6653 (2, fee_base_msat, required),
6654 (4, fee_proportional_millionths, required),
6655 (6, cltv_expiry_delta, required),
6658 impl_writeable_tlv_based!(ChannelCounterparty, {
6659 (2, node_id, required),
6660 (4, features, required),
6661 (6, unspendable_punishment_reserve, required),
6662 (8, forwarding_info, option),
6663 (9, outbound_htlc_minimum_msat, option),
6664 (11, outbound_htlc_maximum_msat, option),
6667 impl Writeable for ChannelDetails {
6668 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6669 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
6670 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
6671 let user_channel_id_low = self.user_channel_id as u64;
6672 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
6673 write_tlv_fields!(writer, {
6674 (1, self.inbound_scid_alias, option),
6675 (2, self.channel_id, required),
6676 (3, self.channel_type, option),
6677 (4, self.counterparty, required),
6678 (5, self.outbound_scid_alias, option),
6679 (6, self.funding_txo, option),
6680 (7, self.config, option),
6681 (8, self.short_channel_id, option),
6682 (9, self.confirmations, option),
6683 (10, self.channel_value_satoshis, required),
6684 (12, self.unspendable_punishment_reserve, option),
6685 (14, user_channel_id_low, required),
6686 (16, self.balance_msat, required),
6687 (18, self.outbound_capacity_msat, required),
6688 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6689 // filled in, so we can safely unwrap it here.
6690 (19, self.next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6691 (20, self.inbound_capacity_msat, required),
6692 (22, self.confirmations_required, option),
6693 (24, self.force_close_spend_delay, option),
6694 (26, self.is_outbound, required),
6695 (28, self.is_channel_ready, required),
6696 (30, self.is_usable, required),
6697 (32, self.is_public, required),
6698 (33, self.inbound_htlc_minimum_msat, option),
6699 (35, self.inbound_htlc_maximum_msat, option),
6700 (37, user_channel_id_high_opt, option),
6706 impl Readable for ChannelDetails {
6707 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6708 init_and_read_tlv_fields!(reader, {
6709 (1, inbound_scid_alias, option),
6710 (2, channel_id, required),
6711 (3, channel_type, option),
6712 (4, counterparty, required),
6713 (5, outbound_scid_alias, option),
6714 (6, funding_txo, option),
6715 (7, config, option),
6716 (8, short_channel_id, option),
6717 (9, confirmations, option),
6718 (10, channel_value_satoshis, required),
6719 (12, unspendable_punishment_reserve, option),
6720 (14, user_channel_id_low, required),
6721 (16, balance_msat, required),
6722 (18, outbound_capacity_msat, required),
6723 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6724 // filled in, so we can safely unwrap it here.
6725 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6726 (20, inbound_capacity_msat, required),
6727 (22, confirmations_required, option),
6728 (24, force_close_spend_delay, option),
6729 (26, is_outbound, required),
6730 (28, is_channel_ready, required),
6731 (30, is_usable, required),
6732 (32, is_public, required),
6733 (33, inbound_htlc_minimum_msat, option),
6734 (35, inbound_htlc_maximum_msat, option),
6735 (37, user_channel_id_high_opt, option),
6738 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
6739 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
6740 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
6741 let user_channel_id = user_channel_id_low as u128 +
6742 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
6746 channel_id: channel_id.0.unwrap(),
6748 counterparty: counterparty.0.unwrap(),
6749 outbound_scid_alias,
6753 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
6754 unspendable_punishment_reserve,
6756 balance_msat: balance_msat.0.unwrap(),
6757 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
6758 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
6759 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
6760 confirmations_required,
6762 force_close_spend_delay,
6763 is_outbound: is_outbound.0.unwrap(),
6764 is_channel_ready: is_channel_ready.0.unwrap(),
6765 is_usable: is_usable.0.unwrap(),
6766 is_public: is_public.0.unwrap(),
6767 inbound_htlc_minimum_msat,
6768 inbound_htlc_maximum_msat,
6773 impl_writeable_tlv_based!(PhantomRouteHints, {
6774 (2, channels, vec_type),
6775 (4, phantom_scid, required),
6776 (6, real_node_pubkey, required),
6779 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
6781 (0, onion_packet, required),
6782 (2, short_channel_id, required),
6785 (0, payment_data, required),
6786 (1, phantom_shared_secret, option),
6787 (2, incoming_cltv_expiry, required),
6789 (2, ReceiveKeysend) => {
6790 (0, payment_preimage, required),
6791 (2, incoming_cltv_expiry, required),
6795 impl_writeable_tlv_based!(PendingHTLCInfo, {
6796 (0, routing, required),
6797 (2, incoming_shared_secret, required),
6798 (4, payment_hash, required),
6799 (6, outgoing_amt_msat, required),
6800 (8, outgoing_cltv_value, required),
6801 (9, incoming_amt_msat, option),
6805 impl Writeable for HTLCFailureMsg {
6806 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6808 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
6810 channel_id.write(writer)?;
6811 htlc_id.write(writer)?;
6812 reason.write(writer)?;
6814 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6815 channel_id, htlc_id, sha256_of_onion, failure_code
6818 channel_id.write(writer)?;
6819 htlc_id.write(writer)?;
6820 sha256_of_onion.write(writer)?;
6821 failure_code.write(writer)?;
6828 impl Readable for HTLCFailureMsg {
6829 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6830 let id: u8 = Readable::read(reader)?;
6833 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
6834 channel_id: Readable::read(reader)?,
6835 htlc_id: Readable::read(reader)?,
6836 reason: Readable::read(reader)?,
6840 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6841 channel_id: Readable::read(reader)?,
6842 htlc_id: Readable::read(reader)?,
6843 sha256_of_onion: Readable::read(reader)?,
6844 failure_code: Readable::read(reader)?,
6847 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
6848 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
6849 // messages contained in the variants.
6850 // In version 0.0.101, support for reading the variants with these types was added, and
6851 // we should migrate to writing these variants when UpdateFailHTLC or
6852 // UpdateFailMalformedHTLC get TLV fields.
6854 let length: BigSize = Readable::read(reader)?;
6855 let mut s = FixedLengthReader::new(reader, length.0);
6856 let res = Readable::read(&mut s)?;
6857 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6858 Ok(HTLCFailureMsg::Relay(res))
6861 let length: BigSize = Readable::read(reader)?;
6862 let mut s = FixedLengthReader::new(reader, length.0);
6863 let res = Readable::read(&mut s)?;
6864 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6865 Ok(HTLCFailureMsg::Malformed(res))
6867 _ => Err(DecodeError::UnknownRequiredFeature),
6872 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
6877 impl_writeable_tlv_based!(HTLCPreviousHopData, {
6878 (0, short_channel_id, required),
6879 (1, phantom_shared_secret, option),
6880 (2, outpoint, required),
6881 (4, htlc_id, required),
6882 (6, incoming_packet_shared_secret, required)
6885 impl Writeable for ClaimableHTLC {
6886 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6887 let (payment_data, keysend_preimage) = match &self.onion_payload {
6888 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
6889 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
6891 write_tlv_fields!(writer, {
6892 (0, self.prev_hop, required),
6893 (1, self.total_msat, required),
6894 (2, self.value, required),
6895 (4, payment_data, option),
6896 (6, self.cltv_expiry, required),
6897 (8, keysend_preimage, option),
6903 impl Readable for ClaimableHTLC {
6904 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6905 let mut prev_hop = crate::util::ser::OptionDeserWrapper(None);
6907 let mut payment_data: Option<msgs::FinalOnionHopData> = None;
6908 let mut cltv_expiry = 0;
6909 let mut total_msat = None;
6910 let mut keysend_preimage: Option<PaymentPreimage> = None;
6911 read_tlv_fields!(reader, {
6912 (0, prev_hop, required),
6913 (1, total_msat, option),
6914 (2, value, required),
6915 (4, payment_data, option),
6916 (6, cltv_expiry, required),
6917 (8, keysend_preimage, option)
6919 let onion_payload = match keysend_preimage {
6921 if payment_data.is_some() {
6922 return Err(DecodeError::InvalidValue)
6924 if total_msat.is_none() {
6925 total_msat = Some(value);
6927 OnionPayload::Spontaneous(p)
6930 if total_msat.is_none() {
6931 if payment_data.is_none() {
6932 return Err(DecodeError::InvalidValue)
6934 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
6936 OnionPayload::Invoice { _legacy_hop_data: payment_data }
6940 prev_hop: prev_hop.0.unwrap(),
6943 total_msat: total_msat.unwrap(),
6950 impl Readable for HTLCSource {
6951 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6952 let id: u8 = Readable::read(reader)?;
6955 let mut session_priv: crate::util::ser::OptionDeserWrapper<SecretKey> = crate::util::ser::OptionDeserWrapper(None);
6956 let mut first_hop_htlc_msat: u64 = 0;
6957 let mut path = Some(Vec::new());
6958 let mut payment_id = None;
6959 let mut payment_secret = None;
6960 let mut payment_params = None;
6961 read_tlv_fields!(reader, {
6962 (0, session_priv, required),
6963 (1, payment_id, option),
6964 (2, first_hop_htlc_msat, required),
6965 (3, payment_secret, option),
6966 (4, path, vec_type),
6967 (5, payment_params, option),
6969 if payment_id.is_none() {
6970 // For backwards compat, if there was no payment_id written, use the session_priv bytes
6972 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
6974 Ok(HTLCSource::OutboundRoute {
6975 session_priv: session_priv.0.unwrap(),
6976 first_hop_htlc_msat,
6977 path: path.unwrap(),
6978 payment_id: payment_id.unwrap(),
6983 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
6984 _ => Err(DecodeError::UnknownRequiredFeature),
6989 impl Writeable for HTLCSource {
6990 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
6992 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id, payment_secret, payment_params } => {
6994 let payment_id_opt = Some(payment_id);
6995 write_tlv_fields!(writer, {
6996 (0, session_priv, required),
6997 (1, payment_id_opt, option),
6998 (2, first_hop_htlc_msat, required),
6999 (3, payment_secret, option),
7000 (4, *path, vec_type),
7001 (5, payment_params, option),
7004 HTLCSource::PreviousHopData(ref field) => {
7006 field.write(writer)?;
7013 impl_writeable_tlv_based_enum!(HTLCFailReason,
7014 (0, LightningError) => {
7018 (0, failure_code, required),
7019 (2, data, vec_type),
7023 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
7024 (0, forward_info, required),
7025 (1, prev_user_channel_id, (default_value, 0)),
7026 (2, prev_short_channel_id, required),
7027 (4, prev_htlc_id, required),
7028 (6, prev_funding_outpoint, required),
7031 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
7033 (0, htlc_id, required),
7034 (2, err_packet, required),
7039 impl_writeable_tlv_based!(PendingInboundPayment, {
7040 (0, payment_secret, required),
7041 (2, expiry_time, required),
7042 (4, user_payment_id, required),
7043 (6, payment_preimage, required),
7044 (8, min_value_msat, required),
7047 impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
7049 (0, session_privs, required),
7052 (0, session_privs, required),
7053 (1, payment_hash, option),
7054 (3, timer_ticks_without_htlcs, (default_value, 0)),
7057 (0, session_privs, required),
7058 (1, pending_fee_msat, option),
7059 (2, payment_hash, required),
7060 (4, payment_secret, option),
7061 (6, total_msat, required),
7062 (8, pending_amt_msat, required),
7063 (10, starting_block_height, required),
7066 (0, session_privs, required),
7067 (2, payment_hash, required),
7071 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Writeable for ChannelManager<M, T, K, F, L>
7072 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
7073 T::Target: BroadcasterInterface,
7074 K::Target: KeysInterface,
7075 F::Target: FeeEstimator,
7078 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
7079 let _consistency_lock = self.total_consistency_lock.write().unwrap();
7081 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
7083 self.genesis_hash.write(writer)?;
7085 let best_block = self.best_block.read().unwrap();
7086 best_block.height().write(writer)?;
7087 best_block.block_hash().write(writer)?;
7091 // Take `channel_state` lock temporarily to avoid creating a lock order that requires
7092 // that the `forward_htlcs` lock is taken after `channel_state`
7093 let channel_state = self.channel_state.lock().unwrap();
7094 let mut unfunded_channels = 0;
7095 for (_, channel) in channel_state.by_id.iter() {
7096 if !channel.is_funding_initiated() {
7097 unfunded_channels += 1;
7100 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
7101 for (_, channel) in channel_state.by_id.iter() {
7102 if channel.is_funding_initiated() {
7103 channel.write(writer)?;
7109 let forward_htlcs = self.forward_htlcs.lock().unwrap();
7110 (forward_htlcs.len() as u64).write(writer)?;
7111 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
7112 short_channel_id.write(writer)?;
7113 (pending_forwards.len() as u64).write(writer)?;
7114 for forward in pending_forwards {
7115 forward.write(writer)?;
7120 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
7121 let claimable_htlcs = self.claimable_htlcs.lock().unwrap();
7122 let pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
7124 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
7125 (claimable_htlcs.len() as u64).write(writer)?;
7126 for (payment_hash, (purpose, previous_hops)) in claimable_htlcs.iter() {
7127 payment_hash.write(writer)?;
7128 (previous_hops.len() as u64).write(writer)?;
7129 for htlc in previous_hops.iter() {
7130 htlc.write(writer)?;
7132 htlc_purposes.push(purpose);
7135 let per_peer_state = self.per_peer_state.write().unwrap();
7136 (per_peer_state.len() as u64).write(writer)?;
7137 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
7138 peer_pubkey.write(writer)?;
7139 let peer_state = peer_state_mutex.lock().unwrap();
7140 peer_state.latest_features.write(writer)?;
7143 let events = self.pending_events.lock().unwrap();
7144 (events.len() as u64).write(writer)?;
7145 for event in events.iter() {
7146 event.write(writer)?;
7149 let background_events = self.pending_background_events.lock().unwrap();
7150 (background_events.len() as u64).write(writer)?;
7151 for event in background_events.iter() {
7153 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
7155 funding_txo.write(writer)?;
7156 monitor_update.write(writer)?;
7161 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
7162 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
7163 // likely to be identical.
7164 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
7165 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
7167 (pending_inbound_payments.len() as u64).write(writer)?;
7168 for (hash, pending_payment) in pending_inbound_payments.iter() {
7169 hash.write(writer)?;
7170 pending_payment.write(writer)?;
7173 // For backwards compat, write the session privs and their total length.
7174 let mut num_pending_outbounds_compat: u64 = 0;
7175 for (_, outbound) in pending_outbound_payments.iter() {
7176 if !outbound.is_fulfilled() && !outbound.abandoned() {
7177 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
7180 num_pending_outbounds_compat.write(writer)?;
7181 for (_, outbound) in pending_outbound_payments.iter() {
7183 PendingOutboundPayment::Legacy { session_privs } |
7184 PendingOutboundPayment::Retryable { session_privs, .. } => {
7185 for session_priv in session_privs.iter() {
7186 session_priv.write(writer)?;
7189 PendingOutboundPayment::Fulfilled { .. } => {},
7190 PendingOutboundPayment::Abandoned { .. } => {},
7194 // Encode without retry info for 0.0.101 compatibility.
7195 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
7196 for (id, outbound) in pending_outbound_payments.iter() {
7198 PendingOutboundPayment::Legacy { session_privs } |
7199 PendingOutboundPayment::Retryable { session_privs, .. } => {
7200 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
7206 let mut pending_intercepted_htlcs = None;
7207 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
7208 if our_pending_intercepts.len() != 0 {
7209 pending_intercepted_htlcs = Some(our_pending_intercepts);
7211 write_tlv_fields!(writer, {
7212 (1, pending_outbound_payments_no_retry, required),
7213 (2, pending_intercepted_htlcs, option),
7214 (3, pending_outbound_payments, required),
7215 (5, self.our_network_pubkey, required),
7216 (7, self.fake_scid_rand_bytes, required),
7217 (9, htlc_purposes, vec_type),
7218 (11, self.probing_cookie_secret, required),
7225 /// Arguments for the creation of a ChannelManager that are not deserialized.
7227 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
7229 /// 1) Deserialize all stored [`ChannelMonitor`]s.
7230 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
7231 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
7232 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
7233 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
7234 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
7235 /// same way you would handle a [`chain::Filter`] call using
7236 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
7237 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
7238 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
7239 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
7240 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
7241 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
7243 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
7244 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
7246 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
7247 /// call any other methods on the newly-deserialized [`ChannelManager`].
7249 /// Note that because some channels may be closed during deserialization, it is critical that you
7250 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
7251 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
7252 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
7253 /// not force-close the same channels but consider them live), you may end up revoking a state for
7254 /// which you've already broadcasted the transaction.
7256 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
7257 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
7258 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
7259 T::Target: BroadcasterInterface,
7260 K::Target: KeysInterface,
7261 F::Target: FeeEstimator,
7264 /// The keys provider which will give us relevant keys. Some keys will be loaded during
7265 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
7267 pub keys_manager: K,
7269 /// The fee_estimator for use in the ChannelManager in the future.
7271 /// No calls to the FeeEstimator will be made during deserialization.
7272 pub fee_estimator: F,
7273 /// The chain::Watch for use in the ChannelManager in the future.
7275 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
7276 /// you have deserialized ChannelMonitors separately and will add them to your
7277 /// chain::Watch after deserializing this ChannelManager.
7278 pub chain_monitor: M,
7280 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
7281 /// used to broadcast the latest local commitment transactions of channels which must be
7282 /// force-closed during deserialization.
7283 pub tx_broadcaster: T,
7284 /// The Logger for use in the ChannelManager and which may be used to log information during
7285 /// deserialization.
7287 /// Default settings used for new channels. Any existing channels will continue to use the
7288 /// runtime settings which were stored when the ChannelManager was serialized.
7289 pub default_config: UserConfig,
7291 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
7292 /// value.get_funding_txo() should be the key).
7294 /// If a monitor is inconsistent with the channel state during deserialization the channel will
7295 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
7296 /// is true for missing channels as well. If there is a monitor missing for which we find
7297 /// channel data Err(DecodeError::InvalidValue) will be returned.
7299 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
7302 /// (C-not exported) because we have no HashMap bindings
7303 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<K::Target as KeysInterface>::Signer>>,
7306 impl<'a, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
7307 ChannelManagerReadArgs<'a, M, T, K, F, L>
7308 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
7309 T::Target: BroadcasterInterface,
7310 K::Target: KeysInterface,
7311 F::Target: FeeEstimator,
7314 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
7315 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
7316 /// populate a HashMap directly from C.
7317 pub fn new(keys_manager: K, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, logger: L, default_config: UserConfig,
7318 mut channel_monitors: Vec<&'a mut ChannelMonitor<<K::Target as KeysInterface>::Signer>>) -> Self {
7320 keys_manager, fee_estimator, chain_monitor, tx_broadcaster, logger, default_config,
7321 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
7326 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
7327 // SipmleArcChannelManager type:
7328 impl<'a, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
7329 ReadableArgs<ChannelManagerReadArgs<'a, M, T, K, F, L>> for (BlockHash, Arc<ChannelManager<M, T, K, F, L>>)
7330 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
7331 T::Target: BroadcasterInterface,
7332 K::Target: KeysInterface,
7333 F::Target: FeeEstimator,
7336 fn read<R: io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, M, T, K, F, L>) -> Result<Self, DecodeError> {
7337 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, K, F, L>)>::read(reader, args)?;
7338 Ok((blockhash, Arc::new(chan_manager)))
7342 impl<'a, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
7343 ReadableArgs<ChannelManagerReadArgs<'a, M, T, K, F, L>> for (BlockHash, ChannelManager<M, T, K, F, L>)
7344 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
7345 T::Target: BroadcasterInterface,
7346 K::Target: KeysInterface,
7347 F::Target: FeeEstimator,
7350 fn read<R: io::Read>(reader: &mut R, mut args: ChannelManagerReadArgs<'a, M, T, K, F, L>) -> Result<Self, DecodeError> {
7351 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
7353 let genesis_hash: BlockHash = Readable::read(reader)?;
7354 let best_block_height: u32 = Readable::read(reader)?;
7355 let best_block_hash: BlockHash = Readable::read(reader)?;
7357 let mut failed_htlcs = Vec::new();
7359 let channel_count: u64 = Readable::read(reader)?;
7360 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
7361 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7362 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7363 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7364 let mut channel_closures = Vec::new();
7365 for _ in 0..channel_count {
7366 let mut channel: Channel<<K::Target as KeysInterface>::Signer> = Channel::read(reader, (&args.keys_manager, best_block_height))?;
7367 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
7368 funding_txo_set.insert(funding_txo.clone());
7369 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
7370 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
7371 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
7372 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
7373 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
7374 // If the channel is ahead of the monitor, return InvalidValue:
7375 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
7376 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
7377 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
7378 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
7379 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
7380 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
7381 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");
7382 return Err(DecodeError::InvalidValue);
7383 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
7384 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
7385 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
7386 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
7387 // But if the channel is behind of the monitor, close the channel:
7388 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
7389 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
7390 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
7391 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
7392 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
7393 failed_htlcs.append(&mut new_failed_htlcs);
7394 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
7395 channel_closures.push(events::Event::ChannelClosed {
7396 channel_id: channel.channel_id(),
7397 user_channel_id: channel.get_user_id(),
7398 reason: ClosureReason::OutdatedChannelManager
7401 log_info!(args.logger, "Successfully loaded channel {}", log_bytes!(channel.channel_id()));
7402 if let Some(short_channel_id) = channel.get_short_channel_id() {
7403 short_to_chan_info.insert(short_channel_id, (channel.get_counterparty_node_id(), channel.channel_id()));
7405 if channel.is_funding_initiated() {
7406 id_to_peer.insert(channel.channel_id(), channel.get_counterparty_node_id());
7408 by_id.insert(channel.channel_id(), channel);
7410 } else if channel.is_awaiting_initial_mon_persist() {
7411 // If we were persisted and shut down while the initial ChannelMonitor persistence
7412 // was in-progress, we never broadcasted the funding transaction and can still
7413 // safely discard the channel.
7414 let _ = channel.force_shutdown(false);
7415 channel_closures.push(events::Event::ChannelClosed {
7416 channel_id: channel.channel_id(),
7417 user_channel_id: channel.get_user_id(),
7418 reason: ClosureReason::DisconnectedPeer,
7421 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.channel_id()));
7422 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
7423 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
7424 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
7425 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");
7426 return Err(DecodeError::InvalidValue);
7430 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
7431 if !funding_txo_set.contains(funding_txo) {
7432 log_info!(args.logger, "Broadcasting latest holder commitment transaction for closed channel {}", log_bytes!(funding_txo.to_channel_id()));
7433 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
7437 const MAX_ALLOC_SIZE: usize = 1024 * 64;
7438 let forward_htlcs_count: u64 = Readable::read(reader)?;
7439 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
7440 for _ in 0..forward_htlcs_count {
7441 let short_channel_id = Readable::read(reader)?;
7442 let pending_forwards_count: u64 = Readable::read(reader)?;
7443 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
7444 for _ in 0..pending_forwards_count {
7445 pending_forwards.push(Readable::read(reader)?);
7447 forward_htlcs.insert(short_channel_id, pending_forwards);
7450 let claimable_htlcs_count: u64 = Readable::read(reader)?;
7451 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
7452 for _ in 0..claimable_htlcs_count {
7453 let payment_hash = Readable::read(reader)?;
7454 let previous_hops_len: u64 = Readable::read(reader)?;
7455 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
7456 for _ in 0..previous_hops_len {
7457 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
7459 claimable_htlcs_list.push((payment_hash, previous_hops));
7462 let peer_count: u64 = Readable::read(reader)?;
7463 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState>)>()));
7464 for _ in 0..peer_count {
7465 let peer_pubkey = Readable::read(reader)?;
7466 let peer_state = PeerState {
7467 latest_features: Readable::read(reader)?,
7469 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
7472 let event_count: u64 = Readable::read(reader)?;
7473 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>()));
7474 for _ in 0..event_count {
7475 match MaybeReadable::read(reader)? {
7476 Some(event) => pending_events_read.push(event),
7480 if forward_htlcs_count > 0 {
7481 // If we have pending HTLCs to forward, assume we either dropped a
7482 // `PendingHTLCsForwardable` or the user received it but never processed it as they
7483 // shut down before the timer hit. Either way, set the time_forwardable to a small
7484 // constant as enough time has likely passed that we should simply handle the forwards
7485 // now, or at least after the user gets a chance to reconnect to our peers.
7486 pending_events_read.push(events::Event::PendingHTLCsForwardable {
7487 time_forwardable: Duration::from_secs(2),
7491 let background_event_count: u64 = Readable::read(reader)?;
7492 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>()));
7493 for _ in 0..background_event_count {
7494 match <u8 as Readable>::read(reader)? {
7495 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
7496 _ => return Err(DecodeError::InvalidValue),
7500 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
7501 let highest_seen_timestamp: u32 = Readable::read(reader)?;
7503 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
7504 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
7505 for _ in 0..pending_inbound_payment_count {
7506 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
7507 return Err(DecodeError::InvalidValue);
7511 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
7512 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
7513 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
7514 for _ in 0..pending_outbound_payments_count_compat {
7515 let session_priv = Readable::read(reader)?;
7516 let payment = PendingOutboundPayment::Legacy {
7517 session_privs: [session_priv].iter().cloned().collect()
7519 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
7520 return Err(DecodeError::InvalidValue)
7524 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
7525 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
7526 let mut pending_outbound_payments = None;
7527 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
7528 let mut received_network_pubkey: Option<PublicKey> = None;
7529 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
7530 let mut probing_cookie_secret: Option<[u8; 32]> = None;
7531 let mut claimable_htlc_purposes = None;
7532 read_tlv_fields!(reader, {
7533 (1, pending_outbound_payments_no_retry, option),
7534 (2, pending_intercepted_htlcs, option),
7535 (3, pending_outbound_payments, option),
7536 (5, received_network_pubkey, option),
7537 (7, fake_scid_rand_bytes, option),
7538 (9, claimable_htlc_purposes, vec_type),
7539 (11, probing_cookie_secret, option),
7541 if fake_scid_rand_bytes.is_none() {
7542 fake_scid_rand_bytes = Some(args.keys_manager.get_secure_random_bytes());
7545 if probing_cookie_secret.is_none() {
7546 probing_cookie_secret = Some(args.keys_manager.get_secure_random_bytes());
7549 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
7550 pending_outbound_payments = Some(pending_outbound_payments_compat);
7551 } else if pending_outbound_payments.is_none() {
7552 let mut outbounds = HashMap::new();
7553 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
7554 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
7556 pending_outbound_payments = Some(outbounds);
7558 // If we're tracking pending payments, ensure we haven't lost any by looking at the
7559 // ChannelMonitor data for any channels for which we do not have authorative state
7560 // (i.e. those for which we just force-closed above or we otherwise don't have a
7561 // corresponding `Channel` at all).
7562 // This avoids several edge-cases where we would otherwise "forget" about pending
7563 // payments which are still in-flight via their on-chain state.
7564 // We only rebuild the pending payments map if we were most recently serialized by
7566 for (_, monitor) in args.channel_monitors.iter() {
7567 if by_id.get(&monitor.get_funding_txo().0.to_channel_id()).is_none() {
7568 for (htlc_source, htlc) in monitor.get_pending_outbound_htlcs() {
7569 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, payment_secret, .. } = htlc_source {
7570 if path.is_empty() {
7571 log_error!(args.logger, "Got an empty path for a pending payment");
7572 return Err(DecodeError::InvalidValue);
7574 let path_amt = path.last().unwrap().fee_msat;
7575 let mut session_priv_bytes = [0; 32];
7576 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
7577 match pending_outbound_payments.as_mut().unwrap().entry(payment_id) {
7578 hash_map::Entry::Occupied(mut entry) => {
7579 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
7580 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
7581 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), log_bytes!(htlc.payment_hash.0));
7583 hash_map::Entry::Vacant(entry) => {
7584 let path_fee = path.get_path_fees();
7585 entry.insert(PendingOutboundPayment::Retryable {
7586 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
7587 payment_hash: htlc.payment_hash,
7589 pending_amt_msat: path_amt,
7590 pending_fee_msat: Some(path_fee),
7591 total_msat: path_amt,
7592 starting_block_height: best_block_height,
7594 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
7595 path_amt, log_bytes!(htlc.payment_hash.0), log_bytes!(session_priv_bytes));
7604 let inbound_pmt_key_material = args.keys_manager.get_inbound_payment_key_material();
7605 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
7607 let mut claimable_htlcs = HashMap::with_capacity(claimable_htlcs_list.len());
7608 if let Some(mut purposes) = claimable_htlc_purposes {
7609 if purposes.len() != claimable_htlcs_list.len() {
7610 return Err(DecodeError::InvalidValue);
7612 for (purpose, (payment_hash, previous_hops)) in purposes.drain(..).zip(claimable_htlcs_list.drain(..)) {
7613 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7616 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
7617 // include a `_legacy_hop_data` in the `OnionPayload`.
7618 for (payment_hash, previous_hops) in claimable_htlcs_list.drain(..) {
7619 if previous_hops.is_empty() {
7620 return Err(DecodeError::InvalidValue);
7622 let purpose = match &previous_hops[0].onion_payload {
7623 OnionPayload::Invoice { _legacy_hop_data } => {
7624 if let Some(hop_data) = _legacy_hop_data {
7625 events::PaymentPurpose::InvoicePayment {
7626 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
7627 Some(inbound_payment) => inbound_payment.payment_preimage,
7628 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
7629 Ok(payment_preimage) => payment_preimage,
7631 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));
7632 return Err(DecodeError::InvalidValue);
7636 payment_secret: hop_data.payment_secret,
7638 } else { return Err(DecodeError::InvalidValue); }
7640 OnionPayload::Spontaneous(payment_preimage) =>
7641 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
7643 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7647 let mut secp_ctx = Secp256k1::new();
7648 secp_ctx.seeded_randomize(&args.keys_manager.get_secure_random_bytes());
7650 if !channel_closures.is_empty() {
7651 pending_events_read.append(&mut channel_closures);
7654 let our_network_key = match args.keys_manager.get_node_secret(Recipient::Node) {
7656 Err(()) => return Err(DecodeError::InvalidValue)
7658 let our_network_pubkey = PublicKey::from_secret_key(&secp_ctx, &our_network_key);
7659 if let Some(network_pubkey) = received_network_pubkey {
7660 if network_pubkey != our_network_pubkey {
7661 log_error!(args.logger, "Key that was generated does not match the existing key.");
7662 return Err(DecodeError::InvalidValue);
7666 let mut outbound_scid_aliases = HashSet::new();
7667 for (chan_id, chan) in by_id.iter_mut() {
7668 if chan.outbound_scid_alias() == 0 {
7669 let mut outbound_scid_alias;
7671 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
7672 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.keys_manager);
7673 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
7675 chan.set_outbound_scid_alias(outbound_scid_alias);
7676 } else if !outbound_scid_aliases.insert(chan.outbound_scid_alias()) {
7677 // Note that in rare cases its possible to hit this while reading an older
7678 // channel if we just happened to pick a colliding outbound alias above.
7679 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7680 return Err(DecodeError::InvalidValue);
7682 if chan.is_usable() {
7683 if short_to_chan_info.insert(chan.outbound_scid_alias(), (chan.get_counterparty_node_id(), *chan_id)).is_some() {
7684 // Note that in rare cases its possible to hit this while reading an older
7685 // channel if we just happened to pick a colliding outbound alias above.
7686 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7687 return Err(DecodeError::InvalidValue);
7692 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
7694 for (_, monitor) in args.channel_monitors.iter() {
7695 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
7696 if let Some((payment_purpose, claimable_htlcs)) = claimable_htlcs.remove(&payment_hash) {
7697 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", log_bytes!(payment_hash.0));
7698 let mut claimable_amt_msat = 0;
7699 let mut receiver_node_id = Some(our_network_pubkey);
7700 let phantom_shared_secret = claimable_htlcs[0].prev_hop.phantom_shared_secret;
7701 if phantom_shared_secret.is_some() {
7702 let phantom_pubkey = args.keys_manager.get_node_id(Recipient::PhantomNode)
7703 .expect("Failed to get node_id for phantom node recipient");
7704 receiver_node_id = Some(phantom_pubkey)
7706 for claimable_htlc in claimable_htlcs {
7707 claimable_amt_msat += claimable_htlc.value;
7709 // Add a holding-cell claim of the payment to the Channel, which should be
7710 // applied ~immediately on peer reconnection. Because it won't generate a
7711 // new commitment transaction we can just provide the payment preimage to
7712 // the corresponding ChannelMonitor and nothing else.
7714 // We do so directly instead of via the normal ChannelMonitor update
7715 // procedure as the ChainMonitor hasn't yet been initialized, implying
7716 // we're not allowed to call it directly yet. Further, we do the update
7717 // without incrementing the ChannelMonitor update ID as there isn't any
7719 // If we were to generate a new ChannelMonitor update ID here and then
7720 // crash before the user finishes block connect we'd end up force-closing
7721 // this channel as well. On the flip side, there's no harm in restarting
7722 // without the new monitor persisted - we'll end up right back here on
7724 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
7725 if let Some(channel) = by_id.get_mut(&previous_channel_id) {
7726 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
7728 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
7729 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
7732 pending_events_read.push(events::Event::PaymentClaimed {
7735 purpose: payment_purpose,
7736 amount_msat: claimable_amt_msat,
7742 let channel_manager = ChannelManager {
7744 fee_estimator: bounded_fee_estimator,
7745 chain_monitor: args.chain_monitor,
7746 tx_broadcaster: args.tx_broadcaster,
7748 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
7750 channel_state: Mutex::new(ChannelHolder {
7752 pending_msg_events: Vec::new(),
7754 inbound_payment_key: expanded_inbound_key,
7755 pending_inbound_payments: Mutex::new(pending_inbound_payments),
7756 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
7757 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
7759 forward_htlcs: Mutex::new(forward_htlcs),
7760 claimable_htlcs: Mutex::new(claimable_htlcs),
7761 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
7762 id_to_peer: Mutex::new(id_to_peer),
7763 short_to_chan_info: FairRwLock::new(short_to_chan_info),
7764 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
7766 probing_cookie_secret: probing_cookie_secret.unwrap(),
7772 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
7774 per_peer_state: RwLock::new(per_peer_state),
7776 pending_events: Mutex::new(pending_events_read),
7777 pending_background_events: Mutex::new(pending_background_events_read),
7778 total_consistency_lock: RwLock::new(()),
7779 persistence_notifier: Notifier::new(),
7781 keys_manager: args.keys_manager,
7782 logger: args.logger,
7783 default_configuration: args.default_config,
7786 for htlc_source in failed_htlcs.drain(..) {
7787 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
7788 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
7789 channel_manager.fail_htlc_backwards_internal(source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
7792 //TODO: Broadcast channel update for closed channels, but only after we've made a
7793 //connection or two.
7795 Ok((best_block_hash.clone(), channel_manager))
7801 use bitcoin::hashes::Hash;
7802 use bitcoin::hashes::sha256::Hash as Sha256;
7803 use core::time::Duration;
7804 use core::sync::atomic::Ordering;
7805 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
7806 use crate::ln::channelmanager::{self, inbound_payment, PaymentId, PaymentSendFailure};
7807 use crate::ln::functional_test_utils::*;
7808 use crate::ln::msgs;
7809 use crate::ln::msgs::ChannelMessageHandler;
7810 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
7811 use crate::util::errors::APIError;
7812 use crate::util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
7813 use crate::util::test_utils;
7814 use crate::chain::keysinterface::KeysInterface;
7817 fn test_notify_limits() {
7818 // Check that a few cases which don't require the persistence of a new ChannelManager,
7819 // indeed, do not cause the persistence of a new ChannelManager.
7820 let chanmon_cfgs = create_chanmon_cfgs(3);
7821 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7822 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7823 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7825 // All nodes start with a persistable update pending as `create_network` connects each node
7826 // with all other nodes to make most tests simpler.
7827 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7828 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7829 assert!(nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7831 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7833 // We check that the channel info nodes have doesn't change too early, even though we try
7834 // to connect messages with new values
7835 chan.0.contents.fee_base_msat *= 2;
7836 chan.1.contents.fee_base_msat *= 2;
7837 let node_a_chan_info = nodes[0].node.list_channels()[0].clone();
7838 let node_b_chan_info = nodes[1].node.list_channels()[0].clone();
7840 // The first two nodes (which opened a channel) should now require fresh persistence
7841 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7842 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7843 // ... but the last node should not.
7844 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7845 // After persisting the first two nodes they should no longer need fresh persistence.
7846 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7847 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7849 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
7850 // about the channel.
7851 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
7852 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
7853 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7855 // The nodes which are a party to the channel should also ignore messages from unrelated
7857 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7858 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7859 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7860 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7861 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7862 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7864 // At this point the channel info given by peers should still be the same.
7865 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7866 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7868 // An earlier version of handle_channel_update didn't check the directionality of the
7869 // update message and would always update the local fee info, even if our peer was
7870 // (spuriously) forwarding us our own channel_update.
7871 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
7872 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
7873 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
7875 // First deliver each peers' own message, checking that the node doesn't need to be
7876 // persisted and that its channel info remains the same.
7877 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
7878 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
7879 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7880 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7881 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7882 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7884 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
7885 // the channel info has updated.
7886 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
7887 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
7888 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7889 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7890 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
7891 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
7895 fn test_keysend_dup_hash_partial_mpp() {
7896 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
7898 let chanmon_cfgs = create_chanmon_cfgs(2);
7899 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7900 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7901 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7902 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7904 // First, send a partial MPP payment.
7905 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
7906 let mut mpp_route = route.clone();
7907 mpp_route.paths.push(mpp_route.paths[0].clone());
7909 let payment_id = PaymentId([42; 32]);
7910 // Use the utility function send_payment_along_path to send the payment with MPP data which
7911 // indicates there are more HTLCs coming.
7912 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.
7913 let session_privs = nodes[0].node.add_new_pending_payment(our_payment_hash, Some(payment_secret), payment_id, &mpp_route).unwrap();
7914 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();
7915 check_added_monitors!(nodes[0], 1);
7916 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7917 assert_eq!(events.len(), 1);
7918 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
7920 // Next, send a keysend payment with the same payment_hash and make sure it fails.
7921 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7922 check_added_monitors!(nodes[0], 1);
7923 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7924 assert_eq!(events.len(), 1);
7925 let ev = events.drain(..).next().unwrap();
7926 let payment_event = SendEvent::from_event(ev);
7927 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7928 check_added_monitors!(nodes[1], 0);
7929 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7930 expect_pending_htlcs_forwardable!(nodes[1]);
7931 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
7932 check_added_monitors!(nodes[1], 1);
7933 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7934 assert!(updates.update_add_htlcs.is_empty());
7935 assert!(updates.update_fulfill_htlcs.is_empty());
7936 assert_eq!(updates.update_fail_htlcs.len(), 1);
7937 assert!(updates.update_fail_malformed_htlcs.is_empty());
7938 assert!(updates.update_fee.is_none());
7939 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7940 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7941 expect_payment_failed!(nodes[0], our_payment_hash, true);
7943 // Send the second half of the original MPP payment.
7944 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();
7945 check_added_monitors!(nodes[0], 1);
7946 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7947 assert_eq!(events.len(), 1);
7948 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
7950 // Claim the full MPP payment. Note that we can't use a test utility like
7951 // claim_funds_along_route because the ordering of the messages causes the second half of the
7952 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
7953 // lightning messages manually.
7954 nodes[1].node.claim_funds(payment_preimage);
7955 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
7956 check_added_monitors!(nodes[1], 2);
7958 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7959 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
7960 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
7961 check_added_monitors!(nodes[0], 1);
7962 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7963 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
7964 check_added_monitors!(nodes[1], 1);
7965 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7966 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
7967 check_added_monitors!(nodes[1], 1);
7968 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7969 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
7970 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
7971 check_added_monitors!(nodes[0], 1);
7972 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7973 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
7974 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7975 check_added_monitors!(nodes[0], 1);
7976 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
7977 check_added_monitors!(nodes[1], 1);
7978 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
7979 check_added_monitors!(nodes[1], 1);
7980 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7981 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
7982 check_added_monitors!(nodes[0], 1);
7984 // Note that successful MPP payments will generate a single PaymentSent event upon the first
7985 // path's success and a PaymentPathSuccessful event for each path's success.
7986 let events = nodes[0].node.get_and_clear_pending_events();
7987 assert_eq!(events.len(), 3);
7989 Event::PaymentSent { payment_id: ref id, payment_preimage: ref preimage, payment_hash: ref hash, .. } => {
7990 assert_eq!(Some(payment_id), *id);
7991 assert_eq!(payment_preimage, *preimage);
7992 assert_eq!(our_payment_hash, *hash);
7994 _ => panic!("Unexpected event"),
7997 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7998 assert_eq!(payment_id, *actual_payment_id);
7999 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
8000 assert_eq!(route.paths[0], *path);
8002 _ => panic!("Unexpected event"),
8005 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
8006 assert_eq!(payment_id, *actual_payment_id);
8007 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
8008 assert_eq!(route.paths[0], *path);
8010 _ => panic!("Unexpected event"),
8015 fn test_keysend_dup_payment_hash() {
8016 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
8017 // outbound regular payment fails as expected.
8018 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
8019 // fails as expected.
8020 let chanmon_cfgs = create_chanmon_cfgs(2);
8021 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8022 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8023 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8024 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
8025 let scorer = test_utils::TestScorer::with_penalty(0);
8026 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
8028 // To start (1), send a regular payment but don't claim it.
8029 let expected_route = [&nodes[1]];
8030 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
8032 // Next, attempt a keysend payment and make sure it fails.
8033 let route_params = RouteParameters {
8034 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id()),
8035 final_value_msat: 100_000,
8036 final_cltv_expiry_delta: TEST_FINAL_CLTV,
8038 let route = find_route(
8039 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
8040 None, nodes[0].logger, &scorer, &random_seed_bytes
8042 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
8043 check_added_monitors!(nodes[0], 1);
8044 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8045 assert_eq!(events.len(), 1);
8046 let ev = events.drain(..).next().unwrap();
8047 let payment_event = SendEvent::from_event(ev);
8048 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8049 check_added_monitors!(nodes[1], 0);
8050 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8051 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
8052 // fails), the second will process the resulting failure and fail the HTLC backward
8053 expect_pending_htlcs_forwardable!(nodes[1]);
8054 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
8055 check_added_monitors!(nodes[1], 1);
8056 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8057 assert!(updates.update_add_htlcs.is_empty());
8058 assert!(updates.update_fulfill_htlcs.is_empty());
8059 assert_eq!(updates.update_fail_htlcs.len(), 1);
8060 assert!(updates.update_fail_malformed_htlcs.is_empty());
8061 assert!(updates.update_fee.is_none());
8062 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
8063 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
8064 expect_payment_failed!(nodes[0], payment_hash, true);
8066 // Finally, claim the original payment.
8067 claim_payment(&nodes[0], &expected_route, payment_preimage);
8069 // To start (2), send a keysend payment but don't claim it.
8070 let payment_preimage = PaymentPreimage([42; 32]);
8071 let route = find_route(
8072 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
8073 None, nodes[0].logger, &scorer, &random_seed_bytes
8075 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
8076 check_added_monitors!(nodes[0], 1);
8077 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8078 assert_eq!(events.len(), 1);
8079 let event = events.pop().unwrap();
8080 let path = vec![&nodes[1]];
8081 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
8083 // Next, attempt a regular payment and make sure it fails.
8084 let payment_secret = PaymentSecret([43; 32]);
8085 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
8086 check_added_monitors!(nodes[0], 1);
8087 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8088 assert_eq!(events.len(), 1);
8089 let ev = events.drain(..).next().unwrap();
8090 let payment_event = SendEvent::from_event(ev);
8091 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8092 check_added_monitors!(nodes[1], 0);
8093 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8094 expect_pending_htlcs_forwardable!(nodes[1]);
8095 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
8096 check_added_monitors!(nodes[1], 1);
8097 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8098 assert!(updates.update_add_htlcs.is_empty());
8099 assert!(updates.update_fulfill_htlcs.is_empty());
8100 assert_eq!(updates.update_fail_htlcs.len(), 1);
8101 assert!(updates.update_fail_malformed_htlcs.is_empty());
8102 assert!(updates.update_fee.is_none());
8103 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
8104 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
8105 expect_payment_failed!(nodes[0], payment_hash, true);
8107 // Finally, succeed the keysend payment.
8108 claim_payment(&nodes[0], &expected_route, payment_preimage);
8112 fn test_keysend_hash_mismatch() {
8113 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
8114 // preimage doesn't match the msg's payment hash.
8115 let chanmon_cfgs = create_chanmon_cfgs(2);
8116 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8117 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8118 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8120 let payer_pubkey = nodes[0].node.get_our_node_id();
8121 let payee_pubkey = nodes[1].node.get_our_node_id();
8122 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8123 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8125 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], channelmanager::provided_init_features(), channelmanager::provided_init_features());
8126 let route_params = RouteParameters {
8127 payment_params: PaymentParameters::for_keysend(payee_pubkey),
8128 final_value_msat: 10_000,
8129 final_cltv_expiry_delta: 40,
8131 let network_graph = nodes[0].network_graph;
8132 let first_hops = nodes[0].node.list_usable_channels();
8133 let scorer = test_utils::TestScorer::with_penalty(0);
8134 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
8135 let route = find_route(
8136 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
8137 nodes[0].logger, &scorer, &random_seed_bytes
8140 let test_preimage = PaymentPreimage([42; 32]);
8141 let mismatch_payment_hash = PaymentHash([43; 32]);
8142 let session_privs = nodes[0].node.add_new_pending_payment(mismatch_payment_hash, None, PaymentId(mismatch_payment_hash.0), &route).unwrap();
8143 nodes[0].node.send_payment_internal(&route, mismatch_payment_hash, &None, Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
8144 check_added_monitors!(nodes[0], 1);
8146 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
8147 assert_eq!(updates.update_add_htlcs.len(), 1);
8148 assert!(updates.update_fulfill_htlcs.is_empty());
8149 assert!(updates.update_fail_htlcs.is_empty());
8150 assert!(updates.update_fail_malformed_htlcs.is_empty());
8151 assert!(updates.update_fee.is_none());
8152 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8154 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Payment preimage didn't match payment hash".to_string(), 1);
8158 fn test_keysend_msg_with_secret_err() {
8159 // Test that we error as expected if we receive a keysend payment that includes a payment secret.
8160 let chanmon_cfgs = create_chanmon_cfgs(2);
8161 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8162 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8163 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8165 let payer_pubkey = nodes[0].node.get_our_node_id();
8166 let payee_pubkey = nodes[1].node.get_our_node_id();
8167 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8168 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8170 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], channelmanager::provided_init_features(), channelmanager::provided_init_features());
8171 let route_params = RouteParameters {
8172 payment_params: PaymentParameters::for_keysend(payee_pubkey),
8173 final_value_msat: 10_000,
8174 final_cltv_expiry_delta: 40,
8176 let network_graph = nodes[0].network_graph;
8177 let first_hops = nodes[0].node.list_usable_channels();
8178 let scorer = test_utils::TestScorer::with_penalty(0);
8179 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
8180 let route = find_route(
8181 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
8182 nodes[0].logger, &scorer, &random_seed_bytes
8185 let test_preimage = PaymentPreimage([42; 32]);
8186 let test_secret = PaymentSecret([43; 32]);
8187 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
8188 let session_privs = nodes[0].node.add_new_pending_payment(payment_hash, Some(test_secret), PaymentId(payment_hash.0), &route).unwrap();
8189 nodes[0].node.send_payment_internal(&route, payment_hash, &Some(test_secret), Some(test_preimage), PaymentId(payment_hash.0), None, session_privs).unwrap();
8190 check_added_monitors!(nodes[0], 1);
8192 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
8193 assert_eq!(updates.update_add_htlcs.len(), 1);
8194 assert!(updates.update_fulfill_htlcs.is_empty());
8195 assert!(updates.update_fail_htlcs.is_empty());
8196 assert!(updates.update_fail_malformed_htlcs.is_empty());
8197 assert!(updates.update_fee.is_none());
8198 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8200 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "We don't support MPP keysend payments".to_string(), 1);
8204 fn test_multi_hop_missing_secret() {
8205 let chanmon_cfgs = create_chanmon_cfgs(4);
8206 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8207 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8208 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8210 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;
8211 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;
8212 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;
8213 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;
8215 // Marshall an MPP route.
8216 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
8217 let path = route.paths[0].clone();
8218 route.paths.push(path);
8219 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8220 route.paths[0][0].short_channel_id = chan_1_id;
8221 route.paths[0][1].short_channel_id = chan_3_id;
8222 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8223 route.paths[1][0].short_channel_id = chan_2_id;
8224 route.paths[1][1].short_channel_id = chan_4_id;
8226 match nodes[0].node.send_payment(&route, payment_hash, &None, PaymentId(payment_hash.0)).unwrap_err() {
8227 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
8228 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err)) },
8229 _ => panic!("unexpected error")
8234 fn bad_inbound_payment_hash() {
8235 // Add coverage for checking that a user-provided payment hash matches the payment secret.
8236 let chanmon_cfgs = create_chanmon_cfgs(2);
8237 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8238 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8239 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8241 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
8242 let payment_data = msgs::FinalOnionHopData {
8244 total_msat: 100_000,
8247 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
8248 // payment verification fails as expected.
8249 let mut bad_payment_hash = payment_hash.clone();
8250 bad_payment_hash.0[0] += 1;
8251 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) {
8252 Ok(_) => panic!("Unexpected ok"),
8254 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment".to_string(), "Failing HTLC with user-generated payment_hash".to_string(), 1);
8258 // Check that using the original payment hash succeeds.
8259 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());
8263 fn test_id_to_peer_coverage() {
8264 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
8265 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
8266 // the channel is successfully closed.
8267 let chanmon_cfgs = create_chanmon_cfgs(2);
8268 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8269 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8270 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8272 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
8273 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8274 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
8275 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8276 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
8278 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
8279 let channel_id = &tx.txid().into_inner();
8281 // Ensure that the `id_to_peer` map is empty until either party has received the
8282 // funding transaction, and have the real `channel_id`.
8283 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
8284 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8287 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
8289 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
8290 // as it has the funding transaction.
8291 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8292 assert_eq!(nodes_0_lock.len(), 1);
8293 assert!(nodes_0_lock.contains_key(channel_id));
8295 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8298 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8300 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8302 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8303 assert_eq!(nodes_0_lock.len(), 1);
8304 assert!(nodes_0_lock.contains_key(channel_id));
8306 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
8307 // as it has the funding transaction.
8308 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8309 assert_eq!(nodes_1_lock.len(), 1);
8310 assert!(nodes_1_lock.contains_key(channel_id));
8312 check_added_monitors!(nodes[1], 1);
8313 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8314 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
8315 check_added_monitors!(nodes[0], 1);
8316 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8317 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
8318 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
8320 nodes[0].node.close_channel(channel_id, &nodes[1].node.get_our_node_id()).unwrap();
8321 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()));
8322 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
8323 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &nodes_1_shutdown);
8325 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
8326 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
8328 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
8329 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
8330 // fee for the closing transaction has been negotiated and the parties has the other
8331 // party's signature for the fee negotiated closing transaction.)
8332 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8333 assert_eq!(nodes_0_lock.len(), 1);
8334 assert!(nodes_0_lock.contains_key(channel_id));
8336 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
8337 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
8338 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
8339 // kept in the `nodes[1]`'s `id_to_peer` map.
8340 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8341 assert_eq!(nodes_1_lock.len(), 1);
8342 assert!(nodes_1_lock.contains_key(channel_id));
8345 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()));
8347 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
8348 // therefore has all it needs to fully close the channel (both signatures for the
8349 // closing transaction).
8350 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
8351 // fully closed by `nodes[0]`.
8352 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
8354 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
8355 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
8356 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8357 assert_eq!(nodes_1_lock.len(), 1);
8358 assert!(nodes_1_lock.contains_key(channel_id));
8361 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
8363 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
8365 // Assert that the channel has now been removed from both parties `id_to_peer` map once
8366 // they both have everything required to fully close the channel.
8367 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8369 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
8371 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
8372 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
8376 #[cfg(all(any(test, feature = "_test_utils"), feature = "_bench_unstable"))]
8378 use crate::chain::Listen;
8379 use crate::chain::chainmonitor::{ChainMonitor, Persist};
8380 use crate::chain::keysinterface::{KeysManager, KeysInterface, InMemorySigner};
8381 use crate::ln::channelmanager::{self, BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId};
8382 use crate::ln::functional_test_utils::*;
8383 use crate::ln::msgs::{ChannelMessageHandler, Init};
8384 use crate::routing::gossip::NetworkGraph;
8385 use crate::routing::router::{PaymentParameters, get_route};
8386 use crate::util::test_utils;
8387 use crate::util::config::UserConfig;
8388 use crate::util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
8390 use bitcoin::hashes::Hash;
8391 use bitcoin::hashes::sha256::Hash as Sha256;
8392 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
8394 use crate::sync::{Arc, Mutex};
8398 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
8399 node: &'a ChannelManager<
8400 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
8401 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
8402 &'a test_utils::TestLogger, &'a P>,
8403 &'a test_utils::TestBroadcaster, &'a KeysManager,
8404 &'a test_utils::TestFeeEstimator, &'a test_utils::TestLogger>,
8409 fn bench_sends(bench: &mut Bencher) {
8410 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
8413 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
8414 // Do a simple benchmark of sending a payment back and forth between two nodes.
8415 // Note that this is unrealistic as each payment send will require at least two fsync
8417 let network = bitcoin::Network::Testnet;
8418 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
8420 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
8421 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
8423 let mut config: UserConfig = Default::default();
8424 config.channel_handshake_config.minimum_depth = 1;
8426 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
8427 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
8428 let seed_a = [1u8; 32];
8429 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
8430 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &logger_a, &keys_manager_a, config.clone(), ChainParameters {
8432 best_block: BestBlock::from_genesis(network),
8434 let node_a_holder = NodeHolder { node: &node_a };
8436 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
8437 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
8438 let seed_b = [2u8; 32];
8439 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
8440 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &logger_b, &keys_manager_b, config.clone(), ChainParameters {
8442 best_block: BestBlock::from_genesis(network),
8444 let node_b_holder = NodeHolder { node: &node_b };
8446 node_a.peer_connected(&node_b.get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8447 node_b.peer_connected(&node_a.get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8448 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
8449 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()));
8450 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()));
8453 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
8454 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
8455 value: 8_000_000, script_pubkey: output_script,
8457 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
8458 } else { panic!(); }
8460 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()));
8461 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()));
8463 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
8466 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
8469 Listen::block_connected(&node_a, &block, 1);
8470 Listen::block_connected(&node_b, &block, 1);
8472 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()));
8473 let msg_events = node_a.get_and_clear_pending_msg_events();
8474 assert_eq!(msg_events.len(), 2);
8475 match msg_events[0] {
8476 MessageSendEvent::SendChannelReady { ref msg, .. } => {
8477 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
8478 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
8482 match msg_events[1] {
8483 MessageSendEvent::SendChannelUpdate { .. } => {},
8487 let events_a = node_a.get_and_clear_pending_events();
8488 assert_eq!(events_a.len(), 1);
8490 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8491 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
8493 _ => panic!("Unexpected event"),
8496 let events_b = node_b.get_and_clear_pending_events();
8497 assert_eq!(events_b.len(), 1);
8499 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8500 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
8502 _ => panic!("Unexpected event"),
8505 let dummy_graph = NetworkGraph::new(genesis_hash, &logger_a);
8507 let mut payment_count: u64 = 0;
8508 macro_rules! send_payment {
8509 ($node_a: expr, $node_b: expr) => {
8510 let usable_channels = $node_a.list_usable_channels();
8511 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id())
8512 .with_features(channelmanager::provided_invoice_features());
8513 let scorer = test_utils::TestScorer::with_penalty(0);
8514 let seed = [3u8; 32];
8515 let keys_manager = KeysManager::new(&seed, 42, 42);
8516 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8517 let route = get_route(&$node_a.get_our_node_id(), &payment_params, &dummy_graph.read_only(),
8518 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), 10_000, TEST_FINAL_CLTV, &logger_a, &scorer, &random_seed_bytes).unwrap();
8520 let mut payment_preimage = PaymentPreimage([0; 32]);
8521 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
8523 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
8524 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200).unwrap();
8526 $node_a.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
8527 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
8528 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
8529 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
8530 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
8531 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
8532 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
8533 $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()));
8535 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
8536 expect_payment_received!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
8537 $node_b.claim_funds(payment_preimage);
8538 expect_payment_claimed!(NodeHolder { node: &$node_b }, payment_hash, 10_000);
8540 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
8541 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
8542 assert_eq!(node_id, $node_a.get_our_node_id());
8543 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8544 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
8546 _ => panic!("Failed to generate claim event"),
8549 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
8550 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
8551 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
8552 $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()));
8554 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
8559 send_payment!(node_a, node_b);
8560 send_payment!(node_b, node_a);