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::onion_utils::HTLCFailReason;
53 use crate::ln::msgs::{ChannelMessageHandler, DecodeError, LightningError, MAX_VALUE_MSAT};
54 use crate::ln::wire::Encode;
55 use crate::chain::keysinterface::{Sign, KeysInterface, KeysManager, Recipient};
56 use crate::util::config::{UserConfig, ChannelConfig};
57 use crate::util::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
58 use crate::util::events;
59 use crate::util::wakers::{Future, Notifier};
60 use crate::util::scid_utils::fake_scid;
61 use crate::util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
62 use crate::util::logger::{Level, Logger};
63 use crate::util::errors::APIError;
66 use crate::prelude::*;
68 use core::cell::RefCell;
70 use crate::sync::{Arc, Mutex, MutexGuard, RwLock, RwLockReadGuard, FairRwLock};
71 use core::sync::atomic::{AtomicUsize, Ordering};
72 use core::time::Duration;
75 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
77 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
78 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
79 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
81 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
82 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
83 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
84 // before we forward it.
86 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
87 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
88 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
89 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
90 // our payment, which we can use to decode errors or inform the user that the payment was sent.
92 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
93 pub(super) enum PendingHTLCRouting {
95 onion_packet: msgs::OnionPacket,
96 /// The SCID from the onion that we should forward to. This could be a real SCID or a fake one
97 /// generated using `get_fake_scid` from the scid_utils::fake_scid module.
98 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
101 payment_data: msgs::FinalOnionHopData,
102 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
103 phantom_shared_secret: Option<[u8; 32]>,
106 payment_preimage: PaymentPreimage,
107 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
111 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
112 pub(super) struct PendingHTLCInfo {
113 pub(super) routing: PendingHTLCRouting,
114 pub(super) incoming_shared_secret: [u8; 32],
115 payment_hash: PaymentHash,
116 pub(super) incoming_amt_msat: Option<u64>, // Added in 0.0.113
117 pub(super) outgoing_amt_msat: u64,
118 pub(super) outgoing_cltv_value: u32,
121 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
122 pub(super) enum HTLCFailureMsg {
123 Relay(msgs::UpdateFailHTLC),
124 Malformed(msgs::UpdateFailMalformedHTLC),
127 /// Stores whether we can't forward an HTLC or relevant forwarding info
128 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
129 pub(super) enum PendingHTLCStatus {
130 Forward(PendingHTLCInfo),
131 Fail(HTLCFailureMsg),
134 pub(super) struct PendingAddHTLCInfo {
135 pub(super) forward_info: PendingHTLCInfo,
137 // These fields are produced in `forward_htlcs()` and consumed in
138 // `process_pending_htlc_forwards()` for constructing the
139 // `HTLCSource::PreviousHopData` for failed and forwarded
142 // Note that this may be an outbound SCID alias for the associated channel.
143 prev_short_channel_id: u64,
145 prev_funding_outpoint: OutPoint,
146 prev_user_channel_id: u128,
149 pub(super) enum HTLCForwardInfo {
150 AddHTLC(PendingAddHTLCInfo),
153 err_packet: msgs::OnionErrorPacket,
157 /// Tracks the inbound corresponding to an outbound HTLC
158 #[derive(Clone, Hash, PartialEq, Eq)]
159 pub(crate) struct HTLCPreviousHopData {
160 // Note that this may be an outbound SCID alias for the associated channel.
161 short_channel_id: u64,
163 incoming_packet_shared_secret: [u8; 32],
164 phantom_shared_secret: Option<[u8; 32]>,
166 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
167 // channel with a preimage provided by the forward channel.
172 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
174 /// This is only here for backwards-compatibility in serialization, in the future it can be
175 /// removed, breaking clients running 0.0.106 and earlier.
176 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
178 /// Contains the payer-provided preimage.
179 Spontaneous(PaymentPreimage),
182 /// HTLCs that are to us and can be failed/claimed by the user
183 struct ClaimableHTLC {
184 prev_hop: HTLCPreviousHopData,
186 /// The amount (in msats) of this MPP part
188 onion_payload: OnionPayload,
190 /// The sum total of all MPP parts
194 /// A payment identifier used to uniquely identify a payment to LDK.
195 /// (C-not exported) as we just use [u8; 32] directly
196 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
197 pub struct PaymentId(pub [u8; 32]);
199 impl Writeable for PaymentId {
200 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
205 impl Readable for PaymentId {
206 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
207 let buf: [u8; 32] = Readable::read(r)?;
212 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
213 /// (C-not exported) as we just use [u8; 32] directly
214 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
215 pub struct InterceptId(pub [u8; 32]);
217 impl Writeable for InterceptId {
218 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
223 impl Readable for InterceptId {
224 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
225 let buf: [u8; 32] = Readable::read(r)?;
229 /// Tracks the inbound corresponding to an outbound HTLC
230 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
231 #[derive(Clone, PartialEq, Eq)]
232 pub(crate) enum HTLCSource {
233 PreviousHopData(HTLCPreviousHopData),
236 session_priv: SecretKey,
237 /// Technically we can recalculate this from the route, but we cache it here to avoid
238 /// doing a double-pass on route when we get a failure back
239 first_hop_htlc_msat: u64,
240 payment_id: PaymentId,
241 payment_secret: Option<PaymentSecret>,
242 payment_params: Option<PaymentParameters>,
245 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
246 impl core::hash::Hash for HTLCSource {
247 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
249 HTLCSource::PreviousHopData(prev_hop_data) => {
251 prev_hop_data.hash(hasher);
253 HTLCSource::OutboundRoute { path, session_priv, payment_id, payment_secret, first_hop_htlc_msat, payment_params } => {
256 session_priv[..].hash(hasher);
257 payment_id.hash(hasher);
258 payment_secret.hash(hasher);
259 first_hop_htlc_msat.hash(hasher);
260 payment_params.hash(hasher);
265 #[cfg(not(feature = "grind_signatures"))]
268 pub fn dummy() -> Self {
269 HTLCSource::OutboundRoute {
271 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
272 first_hop_htlc_msat: 0,
273 payment_id: PaymentId([2; 32]),
274 payment_secret: None,
275 payment_params: None,
280 struct ReceiveError {
286 /// Return value for claim_funds_from_hop
287 enum ClaimFundsFromHop {
289 MonitorUpdateFail(PublicKey, MsgHandleErrInternal, Option<u64>),
294 type ShutdownResult = (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash, PublicKey, [u8; 32])>);
296 /// Error type returned across the channel_state mutex boundary. When an Err is generated for a
297 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
298 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
299 /// channel_state lock. We then return the set of things that need to be done outside the lock in
300 /// this struct and call handle_error!() on it.
302 struct MsgHandleErrInternal {
303 err: msgs::LightningError,
304 chan_id: Option<([u8; 32], u128)>, // If Some a channel of ours has been closed
305 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
307 impl MsgHandleErrInternal {
309 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
311 err: LightningError {
313 action: msgs::ErrorAction::SendErrorMessage {
314 msg: msgs::ErrorMessage {
321 shutdown_finish: None,
325 fn ignore_no_close(err: String) -> Self {
327 err: LightningError {
329 action: msgs::ErrorAction::IgnoreError,
332 shutdown_finish: None,
336 fn from_no_close(err: msgs::LightningError) -> Self {
337 Self { err, chan_id: None, shutdown_finish: None }
340 fn from_finish_shutdown(err: String, channel_id: [u8; 32], user_channel_id: u128, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
342 err: LightningError {
344 action: msgs::ErrorAction::SendErrorMessage {
345 msg: msgs::ErrorMessage {
351 chan_id: Some((channel_id, user_channel_id)),
352 shutdown_finish: Some((shutdown_res, channel_update)),
356 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
359 ChannelError::Warn(msg) => LightningError {
361 action: msgs::ErrorAction::SendWarningMessage {
362 msg: msgs::WarningMessage {
366 log_level: Level::Warn,
369 ChannelError::Ignore(msg) => LightningError {
371 action: msgs::ErrorAction::IgnoreError,
373 ChannelError::Close(msg) => LightningError {
375 action: msgs::ErrorAction::SendErrorMessage {
376 msg: msgs::ErrorMessage {
384 shutdown_finish: None,
389 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
390 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
391 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
392 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
393 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
395 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
396 /// be sent in the order they appear in the return value, however sometimes the order needs to be
397 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
398 /// they were originally sent). In those cases, this enum is also returned.
399 #[derive(Clone, PartialEq)]
400 pub(super) enum RAACommitmentOrder {
401 /// Send the CommitmentUpdate messages first
403 /// Send the RevokeAndACK message first
407 // Note this is only exposed in cfg(test):
408 pub(super) struct ChannelHolder<Signer: Sign> {
409 pub(super) by_id: HashMap<[u8; 32], Channel<Signer>>,
410 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
411 /// for broadcast messages, where ordering isn't as strict).
412 pub(super) pending_msg_events: Vec<MessageSendEvent>,
415 /// Events which we process internally but cannot be procsesed immediately at the generation site
416 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
417 /// quite some time lag.
418 enum BackgroundEvent {
419 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
420 /// commitment transaction.
421 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
424 /// State we hold per-peer. In the future we should put channels in here, but for now we only hold
425 /// the latest Init features we heard from the peer.
427 latest_features: InitFeatures,
430 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
431 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
433 /// For users who don't want to bother doing their own payment preimage storage, we also store that
436 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
437 /// and instead encoding it in the payment secret.
438 struct PendingInboundPayment {
439 /// The payment secret that the sender must use for us to accept this payment
440 payment_secret: PaymentSecret,
441 /// Time at which this HTLC expires - blocks with a header time above this value will result in
442 /// this payment being removed.
444 /// Arbitrary identifier the user specifies (or not)
445 user_payment_id: u64,
446 // Other required attributes of the payment, optionally enforced:
447 payment_preimage: Option<PaymentPreimage>,
448 min_value_msat: Option<u64>,
451 /// Stores the session_priv for each part of a payment that is still pending. For versions 0.0.102
452 /// and later, also stores information for retrying the payment.
453 pub(crate) enum PendingOutboundPayment {
455 session_privs: HashSet<[u8; 32]>,
458 session_privs: HashSet<[u8; 32]>,
459 payment_hash: PaymentHash,
460 payment_secret: Option<PaymentSecret>,
461 pending_amt_msat: u64,
462 /// Used to track the fee paid. Only present if the payment was serialized on 0.0.103+.
463 pending_fee_msat: Option<u64>,
464 /// The total payment amount across all paths, used to verify that a retry is not overpaying.
466 /// Our best known block height at the time this payment was initiated.
467 starting_block_height: u32,
469 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
470 /// been resolved. This ensures we don't look up pending payments in ChannelMonitors on restart
471 /// and add a pending payment that was already fulfilled.
473 session_privs: HashSet<[u8; 32]>,
474 payment_hash: Option<PaymentHash>,
475 timer_ticks_without_htlcs: u8,
477 /// When a payer gives up trying to retry a payment, they inform us, letting us generate a
478 /// `PaymentFailed` event when all HTLCs have irrevocably failed. This avoids a number of race
479 /// conditions in MPP-aware payment retriers (1), where the possibility of multiple
480 /// `PaymentPathFailed` events with `all_paths_failed` can be pending at once, confusing a
481 /// downstream event handler as to when a payment has actually failed.
483 /// (1) https://github.com/lightningdevkit/rust-lightning/issues/1164
485 session_privs: HashSet<[u8; 32]>,
486 payment_hash: PaymentHash,
490 impl PendingOutboundPayment {
491 fn is_fulfilled(&self) -> bool {
493 PendingOutboundPayment::Fulfilled { .. } => true,
497 fn abandoned(&self) -> bool {
499 PendingOutboundPayment::Abandoned { .. } => true,
503 fn get_pending_fee_msat(&self) -> Option<u64> {
505 PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
510 fn payment_hash(&self) -> Option<PaymentHash> {
512 PendingOutboundPayment::Legacy { .. } => None,
513 PendingOutboundPayment::Retryable { payment_hash, .. } => Some(*payment_hash),
514 PendingOutboundPayment::Fulfilled { payment_hash, .. } => *payment_hash,
515 PendingOutboundPayment::Abandoned { payment_hash, .. } => Some(*payment_hash),
519 fn mark_fulfilled(&mut self) {
520 let mut session_privs = HashSet::new();
521 core::mem::swap(&mut session_privs, match self {
522 PendingOutboundPayment::Legacy { session_privs } |
523 PendingOutboundPayment::Retryable { session_privs, .. } |
524 PendingOutboundPayment::Fulfilled { session_privs, .. } |
525 PendingOutboundPayment::Abandoned { session_privs, .. }
528 let payment_hash = self.payment_hash();
529 *self = PendingOutboundPayment::Fulfilled { session_privs, payment_hash, timer_ticks_without_htlcs: 0 };
532 fn mark_abandoned(&mut self) -> Result<(), ()> {
533 let mut session_privs = HashSet::new();
534 let our_payment_hash;
535 core::mem::swap(&mut session_privs, match self {
536 PendingOutboundPayment::Legacy { .. } |
537 PendingOutboundPayment::Fulfilled { .. } =>
539 PendingOutboundPayment::Retryable { session_privs, payment_hash, .. } |
540 PendingOutboundPayment::Abandoned { session_privs, payment_hash, .. } => {
541 our_payment_hash = *payment_hash;
545 *self = PendingOutboundPayment::Abandoned { session_privs, payment_hash: our_payment_hash };
549 /// panics if path is None and !self.is_fulfilled
550 fn remove(&mut self, session_priv: &[u8; 32], path: Option<&Vec<RouteHop>>) -> bool {
551 let remove_res = match self {
552 PendingOutboundPayment::Legacy { session_privs } |
553 PendingOutboundPayment::Retryable { session_privs, .. } |
554 PendingOutboundPayment::Fulfilled { session_privs, .. } |
555 PendingOutboundPayment::Abandoned { session_privs, .. } => {
556 session_privs.remove(session_priv)
560 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
561 let path = path.expect("Fulfilling a payment should always come with a path");
562 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
563 *pending_amt_msat -= path_last_hop.fee_msat;
564 if let Some(fee_msat) = pending_fee_msat.as_mut() {
565 *fee_msat -= path.get_path_fees();
572 fn insert(&mut self, session_priv: [u8; 32], path: &Vec<RouteHop>) -> bool {
573 let insert_res = match self {
574 PendingOutboundPayment::Legacy { session_privs } |
575 PendingOutboundPayment::Retryable { session_privs, .. } => {
576 session_privs.insert(session_priv)
578 PendingOutboundPayment::Fulfilled { .. } => false,
579 PendingOutboundPayment::Abandoned { .. } => false,
582 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
583 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
584 *pending_amt_msat += path_last_hop.fee_msat;
585 if let Some(fee_msat) = pending_fee_msat.as_mut() {
586 *fee_msat += path.get_path_fees();
593 fn remaining_parts(&self) -> usize {
595 PendingOutboundPayment::Legacy { session_privs } |
596 PendingOutboundPayment::Retryable { session_privs, .. } |
597 PendingOutboundPayment::Fulfilled { session_privs, .. } |
598 PendingOutboundPayment::Abandoned { session_privs, .. } => {
605 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
606 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
607 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
608 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
609 /// issues such as overly long function definitions. Note that the ChannelManager can take any
610 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
611 /// concrete type of the KeysManager.
613 /// (C-not exported) as Arcs don't make sense in bindings
614 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<Arc<M>, Arc<T>, Arc<KeysManager>, Arc<F>, Arc<L>>;
616 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
617 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
618 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
619 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
620 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
621 /// helps with issues such as long function definitions. Note that the ChannelManager can take any
622 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
623 /// concrete type of the KeysManager.
625 /// (C-not exported) as Arcs don't make sense in bindings
626 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L> = ChannelManager<&'a M, &'b T, &'c KeysManager, &'d F, &'e L>;
628 /// Manager which keeps track of a number of channels and sends messages to the appropriate
629 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
631 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
632 /// to individual Channels.
634 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
635 /// all peers during write/read (though does not modify this instance, only the instance being
636 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
637 /// called funding_transaction_generated for outbound channels).
639 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
640 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
641 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
642 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
643 /// the serialization process). If the deserialized version is out-of-date compared to the
644 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
645 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
647 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
648 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
649 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
650 /// block_connected() to step towards your best block) upon deserialization before using the
653 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
654 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
655 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
656 /// offline for a full minute. In order to track this, you must call
657 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
659 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
660 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
661 /// essentially you should default to using a SimpleRefChannelManager, and use a
662 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
663 /// you're using lightning-net-tokio.
666 // The tree structure below illustrates the lock order requirements for the different locks of the
667 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
668 // and should then be taken in the order of the lowest to the highest level in the tree.
669 // Note that locks on different branches shall not be taken at the same time, as doing so will
670 // create a new lock order for those specific locks in the order they were taken.
674 // `total_consistency_lock`
676 // |__`forward_htlcs`
678 // | |__`pending_intercepted_htlcs`
680 // |__`pending_inbound_payments`
682 // | |__`claimable_htlcs`
684 // | |__`pending_outbound_payments`
686 // | |__`channel_state`
690 // | |__`short_to_chan_info`
692 // | |__`per_peer_state`
694 // | |__`outbound_scid_aliases`
698 // | |__`pending_events`
700 // | |__`pending_background_events`
702 pub struct ChannelManager<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
703 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
704 T::Target: BroadcasterInterface,
705 K::Target: KeysInterface,
706 F::Target: FeeEstimator,
709 default_configuration: UserConfig,
710 genesis_hash: BlockHash,
711 fee_estimator: LowerBoundedFeeEstimator<F>,
715 /// See `ChannelManager` struct-level documentation for lock order requirements.
717 pub(super) best_block: RwLock<BestBlock>,
719 best_block: RwLock<BestBlock>,
720 secp_ctx: Secp256k1<secp256k1::All>,
722 /// See `ChannelManager` struct-level documentation for lock order requirements.
723 #[cfg(any(test, feature = "_test_utils"))]
724 pub(super) channel_state: Mutex<ChannelHolder<<K::Target as KeysInterface>::Signer>>,
725 #[cfg(not(any(test, feature = "_test_utils")))]
726 channel_state: Mutex<ChannelHolder<<K::Target as KeysInterface>::Signer>>,
728 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
729 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
730 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
731 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
733 /// See `ChannelManager` struct-level documentation for lock order requirements.
734 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
736 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
737 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
738 /// (if the channel has been force-closed), however we track them here to prevent duplicative
739 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
740 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
741 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
742 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
743 /// after reloading from disk while replaying blocks against ChannelMonitors.
745 /// See `PendingOutboundPayment` documentation for more info.
747 /// See `ChannelManager` struct-level documentation for lock order requirements.
748 pending_outbound_payments: Mutex<HashMap<PaymentId, PendingOutboundPayment>>,
750 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
752 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
753 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
754 /// and via the classic SCID.
756 /// Note that no consistency guarantees are made about the existence of a channel with the
757 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
759 /// See `ChannelManager` struct-level documentation for lock order requirements.
761 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
763 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
764 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
765 /// until the user tells us what we should do with them.
767 /// See `ChannelManager` struct-level documentation for lock order requirements.
768 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
770 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
771 /// failed/claimed by the user.
773 /// Note that, no consistency guarantees are made about the channels given here actually
774 /// existing anymore by the time you go to read them!
776 /// See `ChannelManager` struct-level documentation for lock order requirements.
777 claimable_htlcs: Mutex<HashMap<PaymentHash, (events::PaymentPurpose, Vec<ClaimableHTLC>)>>,
779 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
780 /// and some closed channels which reached a usable state prior to being closed. This is used
781 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
782 /// active channel list on load.
784 /// See `ChannelManager` struct-level documentation for lock order requirements.
785 outbound_scid_aliases: Mutex<HashSet<u64>>,
787 /// `channel_id` -> `counterparty_node_id`.
789 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
790 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
791 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
793 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
794 /// the corresponding channel for the event, as we only have access to the `channel_id` during
795 /// the handling of the events.
798 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
799 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
800 /// would break backwards compatability.
801 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
802 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
803 /// required to access the channel with the `counterparty_node_id`.
805 /// See `ChannelManager` struct-level documentation for lock order requirements.
806 id_to_peer: Mutex<HashMap<[u8; 32], PublicKey>>,
808 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
810 /// Outbound SCID aliases are added here once the channel is available for normal use, with
811 /// SCIDs being added once the funding transaction is confirmed at the channel's required
812 /// confirmation depth.
814 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
815 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
816 /// channel with the `channel_id` in our other maps.
818 /// See `ChannelManager` struct-level documentation for lock order requirements.
820 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
822 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
824 our_network_key: SecretKey,
825 our_network_pubkey: PublicKey,
827 inbound_payment_key: inbound_payment::ExpandedKey,
829 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
830 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
831 /// we encrypt the namespace identifier using these bytes.
833 /// [fake scids]: crate::util::scid_utils::fake_scid
834 fake_scid_rand_bytes: [u8; 32],
836 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
837 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
838 /// keeping additional state.
839 probing_cookie_secret: [u8; 32],
841 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
842 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
843 /// very far in the past, and can only ever be up to two hours in the future.
844 highest_seen_timestamp: AtomicUsize,
846 /// The bulk of our storage will eventually be here (channels and message queues and the like).
847 /// If we are connected to a peer we always at least have an entry here, even if no channels
848 /// are currently open with that peer.
849 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
850 /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
853 /// See `ChannelManager` struct-level documentation for lock order requirements.
854 per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
856 /// See `ChannelManager` struct-level documentation for lock order requirements.
857 pending_events: Mutex<Vec<events::Event>>,
858 /// See `ChannelManager` struct-level documentation for lock order requirements.
859 pending_background_events: Mutex<Vec<BackgroundEvent>>,
860 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
861 /// Essentially just when we're serializing ourselves out.
862 /// Taken first everywhere where we are making changes before any other locks.
863 /// When acquiring this lock in read mode, rather than acquiring it directly, call
864 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
865 /// Notifier the lock contains sends out a notification when the lock is released.
866 total_consistency_lock: RwLock<()>,
868 persistence_notifier: Notifier,
875 /// Chain-related parameters used to construct a new `ChannelManager`.
877 /// Typically, the block-specific parameters are derived from the best block hash for the network,
878 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
879 /// are not needed when deserializing a previously constructed `ChannelManager`.
880 #[derive(Clone, Copy, PartialEq)]
881 pub struct ChainParameters {
882 /// The network for determining the `chain_hash` in Lightning messages.
883 pub network: Network,
885 /// The hash and height of the latest block successfully connected.
887 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
888 pub best_block: BestBlock,
891 #[derive(Copy, Clone, PartialEq)]
897 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
898 /// desirable to notify any listeners on `await_persistable_update_timeout`/
899 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
900 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
901 /// sending the aforementioned notification (since the lock being released indicates that the
902 /// updates are ready for persistence).
904 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
905 /// notify or not based on whether relevant changes have been made, providing a closure to
906 /// `optionally_notify` which returns a `NotifyOption`.
907 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
908 persistence_notifier: &'a Notifier,
910 // We hold onto this result so the lock doesn't get released immediately.
911 _read_guard: RwLockReadGuard<'a, ()>,
914 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
915 fn notify_on_drop(lock: &'a RwLock<()>, notifier: &'a Notifier) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
916 PersistenceNotifierGuard::optionally_notify(lock, notifier, || -> NotifyOption { NotifyOption::DoPersist })
919 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a Notifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
920 let read_guard = lock.read().unwrap();
922 PersistenceNotifierGuard {
923 persistence_notifier: notifier,
924 should_persist: persist_check,
925 _read_guard: read_guard,
930 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
932 if (self.should_persist)() == NotifyOption::DoPersist {
933 self.persistence_notifier.notify();
938 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
939 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
941 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
943 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
944 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
945 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
946 /// the maximum required amount in lnd as of March 2021.
947 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
949 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
950 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
952 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
954 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
955 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
956 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
957 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
958 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
959 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
960 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
961 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
962 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
963 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
964 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
965 // routing failure for any HTLC sender picking up an LDK node among the first hops.
966 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
968 /// Minimum CLTV difference between the current block height and received inbound payments.
969 /// Invoices generated for payment to us must set their `min_final_cltv_expiry` field to at least
971 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
972 // any payments to succeed. Further, we don't want payments to fail if a block was found while
973 // a payment was being routed, so we add an extra block to be safe.
974 pub const MIN_FINAL_CLTV_EXPIRY: u32 = HTLC_FAIL_BACK_BUFFER + 3;
976 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
977 // ie that if the next-hop peer fails the HTLC within
978 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
979 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
980 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
981 // LATENCY_GRACE_PERIOD_BLOCKS.
984 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;
986 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
987 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
990 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
992 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
993 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
995 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until we time-out the
996 /// idempotency of payments by [`PaymentId`]. See
997 /// [`ChannelManager::remove_stale_resolved_payments`].
998 pub(crate) const IDEMPOTENCY_TIMEOUT_TICKS: u8 = 7;
1000 /// Information needed for constructing an invoice route hint for this channel.
1001 #[derive(Clone, Debug, PartialEq)]
1002 pub struct CounterpartyForwardingInfo {
1003 /// Base routing fee in millisatoshis.
1004 pub fee_base_msat: u32,
1005 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
1006 pub fee_proportional_millionths: u32,
1007 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
1008 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
1009 /// `cltv_expiry_delta` for more details.
1010 pub cltv_expiry_delta: u16,
1013 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
1014 /// to better separate parameters.
1015 #[derive(Clone, Debug, PartialEq)]
1016 pub struct ChannelCounterparty {
1017 /// The node_id of our counterparty
1018 pub node_id: PublicKey,
1019 /// The Features the channel counterparty provided upon last connection.
1020 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
1021 /// many routing-relevant features are present in the init context.
1022 pub features: InitFeatures,
1023 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
1024 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
1025 /// claiming at least this value on chain.
1027 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
1029 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
1030 pub unspendable_punishment_reserve: u64,
1031 /// Information on the fees and requirements that the counterparty requires when forwarding
1032 /// payments to us through this channel.
1033 pub forwarding_info: Option<CounterpartyForwardingInfo>,
1034 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
1035 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
1036 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
1037 pub outbound_htlc_minimum_msat: Option<u64>,
1038 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
1039 pub outbound_htlc_maximum_msat: Option<u64>,
1042 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
1043 #[derive(Clone, Debug, PartialEq)]
1044 pub struct ChannelDetails {
1045 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
1046 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
1047 /// Note that this means this value is *not* persistent - it can change once during the
1048 /// lifetime of the channel.
1049 pub channel_id: [u8; 32],
1050 /// Parameters which apply to our counterparty. See individual fields for more information.
1051 pub counterparty: ChannelCounterparty,
1052 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
1053 /// our counterparty already.
1055 /// Note that, if this has been set, `channel_id` will be equivalent to
1056 /// `funding_txo.unwrap().to_channel_id()`.
1057 pub funding_txo: Option<OutPoint>,
1058 /// The features which this channel operates with. See individual features for more info.
1060 /// `None` until negotiation completes and the channel type is finalized.
1061 pub channel_type: Option<ChannelTypeFeatures>,
1062 /// The position of the funding transaction in the chain. None if the funding transaction has
1063 /// not yet been confirmed and the channel fully opened.
1065 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1066 /// payments instead of this. See [`get_inbound_payment_scid`].
1068 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1069 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1071 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1072 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1073 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1074 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1075 /// [`confirmations_required`]: Self::confirmations_required
1076 pub short_channel_id: Option<u64>,
1077 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1078 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1079 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1082 /// This will be `None` as long as the channel is not available for routing outbound payments.
1084 /// [`short_channel_id`]: Self::short_channel_id
1085 /// [`confirmations_required`]: Self::confirmations_required
1086 pub outbound_scid_alias: Option<u64>,
1087 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1088 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1089 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1090 /// when they see a payment to be routed to us.
1092 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1093 /// previous values for inbound payment forwarding.
1095 /// [`short_channel_id`]: Self::short_channel_id
1096 pub inbound_scid_alias: Option<u64>,
1097 /// The value, in satoshis, of this channel as appears in the funding output
1098 pub channel_value_satoshis: u64,
1099 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1100 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1101 /// this value on chain.
1103 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1105 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1107 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1108 pub unspendable_punishment_reserve: Option<u64>,
1109 /// The `user_channel_id` passed in to create_channel, or a random value if the channel was
1110 /// inbound. This may be zero for inbound channels serialized with LDK versions prior to
1112 pub user_channel_id: u128,
1113 /// Our total balance. This is the amount we would get if we close the channel.
1114 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1115 /// amount is not likely to be recoverable on close.
1117 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1118 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1119 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1120 /// This does not consider any on-chain fees.
1122 /// See also [`ChannelDetails::outbound_capacity_msat`]
1123 pub balance_msat: u64,
1124 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1125 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1126 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1127 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1129 /// See also [`ChannelDetails::balance_msat`]
1131 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1132 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1133 /// should be able to spend nearly this amount.
1134 pub outbound_capacity_msat: u64,
1135 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1136 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1137 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1138 /// to use a limit as close as possible to the HTLC limit we can currently send.
1140 /// See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
1141 pub next_outbound_htlc_limit_msat: u64,
1142 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1143 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1144 /// available for inclusion in new inbound HTLCs).
1145 /// Note that there are some corner cases not fully handled here, so the actual available
1146 /// inbound capacity may be slightly higher than this.
1148 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1149 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1150 /// However, our counterparty should be able to spend nearly this amount.
1151 pub inbound_capacity_msat: u64,
1152 /// The number of required confirmations on the funding transaction before the funding will be
1153 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1154 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1155 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1156 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1158 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1160 /// [`is_outbound`]: ChannelDetails::is_outbound
1161 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1162 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1163 pub confirmations_required: Option<u32>,
1164 /// The current number of confirmations on the funding transaction.
1166 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1167 pub confirmations: Option<u32>,
1168 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1169 /// until we can claim our funds after we force-close the channel. During this time our
1170 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1171 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1172 /// time to claim our non-HTLC-encumbered funds.
1174 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1175 pub force_close_spend_delay: Option<u16>,
1176 /// True if the channel was initiated (and thus funded) by us.
1177 pub is_outbound: bool,
1178 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1179 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1180 /// required confirmation count has been reached (and we were connected to the peer at some
1181 /// point after the funding transaction received enough confirmations). The required
1182 /// confirmation count is provided in [`confirmations_required`].
1184 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1185 pub is_channel_ready: bool,
1186 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1187 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1189 /// This is a strict superset of `is_channel_ready`.
1190 pub is_usable: bool,
1191 /// True if this channel is (or will be) publicly-announced.
1192 pub is_public: bool,
1193 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1194 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1195 pub inbound_htlc_minimum_msat: Option<u64>,
1196 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1197 pub inbound_htlc_maximum_msat: Option<u64>,
1198 /// Set of configurable parameters that affect channel operation.
1200 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1201 pub config: Option<ChannelConfig>,
1204 impl ChannelDetails {
1205 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1206 /// This should be used for providing invoice hints or in any other context where our
1207 /// counterparty will forward a payment to us.
1209 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1210 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1211 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1212 self.inbound_scid_alias.or(self.short_channel_id)
1215 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1216 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1217 /// we're sending or forwarding a payment outbound over this channel.
1219 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1220 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1221 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1222 self.short_channel_id.or(self.outbound_scid_alias)
1226 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
1227 /// Err() type describing which state the payment is in, see the description of individual enum
1228 /// states for more.
1229 #[derive(Clone, Debug)]
1230 pub enum PaymentSendFailure {
1231 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
1232 /// send the payment at all.
1234 /// You can freely resend the payment in full (with the parameter error fixed).
1236 /// Because the payment failed outright, no payment tracking is done, you do not need to call
1237 /// [`ChannelManager::abandon_payment`] and [`ChannelManager::retry_payment`] will *not* work
1238 /// for this payment.
1239 ParameterError(APIError),
1240 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
1241 /// from attempting to send the payment at all.
1243 /// You can freely resend the payment in full (with the parameter error fixed).
1245 /// The results here are ordered the same as the paths in the route object which was passed to
1248 /// Because the payment failed outright, no payment tracking is done, you do not need to call
1249 /// [`ChannelManager::abandon_payment`] and [`ChannelManager::retry_payment`] will *not* work
1250 /// for this payment.
1251 PathParameterError(Vec<Result<(), APIError>>),
1252 /// All paths which were attempted failed to send, with no channel state change taking place.
1253 /// You can freely resend the payment in full (though you probably want to do so over different
1254 /// paths than the ones selected).
1256 /// Because the payment failed outright, no payment tracking is done, you do not need to call
1257 /// [`ChannelManager::abandon_payment`] and [`ChannelManager::retry_payment`] will *not* work
1258 /// for this payment.
1259 AllFailedResendSafe(Vec<APIError>),
1260 /// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not
1261 /// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via
1262 /// [`ChannelManager::abandon_payment`]).
1264 /// [`Event::PaymentSent`]: events::Event::PaymentSent
1266 /// Some paths which were attempted failed to send, though possibly not all. At least some
1267 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
1268 /// in over-/re-payment.
1270 /// The results here are ordered the same as the paths in the route object which was passed to
1271 /// send_payment, and any `Err`s which are not [`APIError::MonitorUpdateInProgress`] can be
1272 /// safely retried via [`ChannelManager::retry_payment`].
1274 /// Any entries which contain `Err(APIError::MonitorUpdateInprogress)` or `Ok(())` MUST NOT be
1275 /// retried as they will result in over-/re-payment. These HTLCs all either successfully sent
1276 /// (in the case of `Ok(())`) or will send once a [`MonitorEvent::Completed`] is provided for
1277 /// the next-hop channel with the latest update_id.
1279 /// The errors themselves, in the same order as the route hops.
1280 results: Vec<Result<(), APIError>>,
1281 /// If some paths failed without irrevocably committing to the new HTLC(s), this will
1282 /// contain a [`RouteParameters`] object which can be used to calculate a new route that
1283 /// will pay all remaining unpaid balance.
1284 failed_paths_retry: Option<RouteParameters>,
1285 /// The payment id for the payment, which is now at least partially pending.
1286 payment_id: PaymentId,
1290 /// Route hints used in constructing invoices for [phantom node payents].
1292 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
1294 pub struct PhantomRouteHints {
1295 /// The list of channels to be included in the invoice route hints.
1296 pub channels: Vec<ChannelDetails>,
1297 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1299 pub phantom_scid: u64,
1300 /// The pubkey of the real backing node that would ultimately receive the payment.
1301 pub real_node_pubkey: PublicKey,
1304 macro_rules! handle_error {
1305 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
1308 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish }) => {
1309 #[cfg(debug_assertions)]
1311 // In testing, ensure there are no deadlocks where the lock is already held upon
1312 // entering the macro.
1313 assert!($self.channel_state.try_lock().is_ok());
1314 assert!($self.pending_events.try_lock().is_ok());
1317 let mut msg_events = Vec::with_capacity(2);
1319 if let Some((shutdown_res, update_option)) = shutdown_finish {
1320 $self.finish_force_close_channel(shutdown_res);
1321 if let Some(update) = update_option {
1322 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1326 if let Some((channel_id, user_channel_id)) = chan_id {
1327 $self.pending_events.lock().unwrap().push(events::Event::ChannelClosed {
1328 channel_id, user_channel_id,
1329 reason: ClosureReason::ProcessingError { err: err.err.clone() }
1334 log_error!($self.logger, "{}", err.err);
1335 if let msgs::ErrorAction::IgnoreError = err.action {
1337 msg_events.push(events::MessageSendEvent::HandleError {
1338 node_id: $counterparty_node_id,
1339 action: err.action.clone()
1343 if !msg_events.is_empty() {
1344 $self.channel_state.lock().unwrap().pending_msg_events.append(&mut msg_events);
1347 // Return error in case higher-API need one
1354 macro_rules! update_maps_on_chan_removal {
1355 ($self: expr, $channel: expr) => {{
1356 $self.id_to_peer.lock().unwrap().remove(&$channel.channel_id());
1357 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1358 if let Some(short_id) = $channel.get_short_channel_id() {
1359 short_to_chan_info.remove(&short_id);
1361 // If the channel was never confirmed on-chain prior to its closure, remove the
1362 // outbound SCID alias we used for it from the collision-prevention set. While we
1363 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1364 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1365 // opening a million channels with us which are closed before we ever reach the funding
1367 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel.outbound_scid_alias());
1368 debug_assert!(alias_removed);
1370 short_to_chan_info.remove(&$channel.outbound_scid_alias());
1374 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1375 macro_rules! convert_chan_err {
1376 ($self: ident, $err: expr, $channel: expr, $channel_id: expr) => {
1378 ChannelError::Warn(msg) => {
1379 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), $channel_id.clone()))
1381 ChannelError::Ignore(msg) => {
1382 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
1384 ChannelError::Close(msg) => {
1385 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
1386 update_maps_on_chan_removal!($self, $channel);
1387 let shutdown_res = $channel.force_shutdown(true);
1388 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
1389 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
1395 macro_rules! break_chan_entry {
1396 ($self: ident, $res: expr, $entry: expr) => {
1400 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1402 $entry.remove_entry();
1410 macro_rules! try_chan_entry {
1411 ($self: ident, $res: expr, $entry: expr) => {
1415 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1417 $entry.remove_entry();
1425 macro_rules! remove_channel {
1426 ($self: expr, $entry: expr) => {
1428 let channel = $entry.remove_entry().1;
1429 update_maps_on_chan_removal!($self, channel);
1435 macro_rules! handle_monitor_update_res {
1436 ($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) => {
1438 ChannelMonitorUpdateStatus::PermanentFailure => {
1439 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateStatus::PermanentFailure", log_bytes!($chan_id[..]));
1440 update_maps_on_chan_removal!($self, $chan);
1441 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
1442 // chain in a confused state! We need to move them into the ChannelMonitor which
1443 // will be responsible for failing backwards once things confirm on-chain.
1444 // It's ok that we drop $failed_forwards here - at this point we'd rather they
1445 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
1446 // us bother trying to claim it just to forward on to another peer. If we're
1447 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
1448 // given up the preimage yet, so might as well just wait until the payment is
1449 // retried, avoiding the on-chain fees.
1450 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure".to_owned(), *$chan_id, $chan.get_user_id(),
1451 $chan.force_shutdown(false), $self.get_channel_update_for_broadcast(&$chan).ok() ));
1454 ChannelMonitorUpdateStatus::InProgress => {
1455 log_info!($self.logger, "Disabling channel {} due to monitor update in progress. On restore will send {} and process {} forwards, {} fails, and {} fulfill finalizations",
1456 log_bytes!($chan_id[..]),
1457 if $resend_commitment && $resend_raa {
1458 match $action_type {
1459 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
1460 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
1462 } else if $resend_commitment { "commitment" }
1463 else if $resend_raa { "RAA" }
1465 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
1466 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len(),
1467 (&$failed_finalized_fulfills as &Vec<HTLCSource>).len());
1468 if !$resend_commitment {
1469 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
1472 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
1474 $chan.monitor_updating_paused($resend_raa, $resend_commitment, $resend_channel_ready, $failed_forwards, $failed_fails, $failed_finalized_fulfills);
1475 (Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$chan_id)), false)
1477 ChannelMonitorUpdateStatus::Completed => {
1482 ($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) => { {
1483 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());
1485 $entry.remove_entry();
1489 ($self: ident, $err: expr, $entry: expr, $action_type: path, $chan_id: expr, COMMITMENT_UPDATE_ONLY) => { {
1490 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst);
1491 handle_monitor_update_res!($self, $err, $entry, $action_type, false, true, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1493 ($self: ident, $err: expr, $entry: expr, $action_type: path, $chan_id: expr, NO_UPDATE) => {
1494 handle_monitor_update_res!($self, $err, $entry, $action_type, false, false, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1496 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_channel_ready: expr, OPTIONALLY_RESEND_FUNDING_LOCKED) => {
1497 handle_monitor_update_res!($self, $err, $entry, $action_type, false, false, $resend_channel_ready, Vec::new(), Vec::new(), Vec::new())
1499 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1500 handle_monitor_update_res!($self, $err, $entry, $action_type, $resend_raa, $resend_commitment, false, Vec::new(), Vec::new(), Vec::new())
1502 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
1503 handle_monitor_update_res!($self, $err, $entry, $action_type, $resend_raa, $resend_commitment, false, $failed_forwards, $failed_fails, Vec::new())
1507 macro_rules! send_channel_ready {
1508 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
1509 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1510 node_id: $channel.get_counterparty_node_id(),
1511 msg: $channel_ready_msg,
1513 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1514 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1515 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1516 let outbound_alias_insert = short_to_chan_info.insert($channel.outbound_scid_alias(), ($channel.get_counterparty_node_id(), $channel.channel_id()));
1517 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1518 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1519 if let Some(real_scid) = $channel.get_short_channel_id() {
1520 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.get_counterparty_node_id(), $channel.channel_id()));
1521 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1522 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1527 macro_rules! emit_channel_ready_event {
1528 ($self: expr, $channel: expr) => {
1529 if $channel.should_emit_channel_ready_event() {
1531 let mut pending_events = $self.pending_events.lock().unwrap();
1532 pending_events.push(events::Event::ChannelReady {
1533 channel_id: $channel.channel_id(),
1534 user_channel_id: $channel.get_user_id(),
1535 counterparty_node_id: $channel.get_counterparty_node_id(),
1536 channel_type: $channel.get_channel_type().clone(),
1539 $channel.set_channel_ready_event_emitted();
1544 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F, L>
1545 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
1546 T::Target: BroadcasterInterface,
1547 K::Target: KeysInterface,
1548 F::Target: FeeEstimator,
1551 /// Constructs a new ChannelManager to hold several channels and route between them.
1553 /// This is the main "logic hub" for all channel-related actions, and implements
1554 /// ChannelMessageHandler.
1556 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1558 /// Users need to notify the new ChannelManager when a new block is connected or
1559 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
1560 /// from after `params.latest_hash`.
1561 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, logger: L, keys_manager: K, config: UserConfig, params: ChainParameters) -> Self {
1562 let mut secp_ctx = Secp256k1::new();
1563 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
1564 let inbound_pmt_key_material = keys_manager.get_inbound_payment_key_material();
1565 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
1567 default_configuration: config.clone(),
1568 genesis_hash: genesis_block(params.network).header.block_hash(),
1569 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
1573 best_block: RwLock::new(params.best_block),
1575 channel_state: Mutex::new(ChannelHolder{
1576 by_id: HashMap::new(),
1577 pending_msg_events: Vec::new(),
1579 outbound_scid_aliases: Mutex::new(HashSet::new()),
1580 pending_inbound_payments: Mutex::new(HashMap::new()),
1581 pending_outbound_payments: Mutex::new(HashMap::new()),
1582 forward_htlcs: Mutex::new(HashMap::new()),
1583 claimable_htlcs: Mutex::new(HashMap::new()),
1584 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
1585 id_to_peer: Mutex::new(HashMap::new()),
1586 short_to_chan_info: FairRwLock::new(HashMap::new()),
1588 our_network_key: keys_manager.get_node_secret(Recipient::Node).unwrap(),
1589 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret(Recipient::Node).unwrap()),
1592 inbound_payment_key: expanded_inbound_key,
1593 fake_scid_rand_bytes: keys_manager.get_secure_random_bytes(),
1595 probing_cookie_secret: keys_manager.get_secure_random_bytes(),
1597 highest_seen_timestamp: AtomicUsize::new(0),
1599 per_peer_state: RwLock::new(HashMap::new()),
1601 pending_events: Mutex::new(Vec::new()),
1602 pending_background_events: Mutex::new(Vec::new()),
1603 total_consistency_lock: RwLock::new(()),
1604 persistence_notifier: Notifier::new(),
1612 /// Gets the current configuration applied to all new channels.
1613 pub fn get_current_default_configuration(&self) -> &UserConfig {
1614 &self.default_configuration
1617 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
1618 let height = self.best_block.read().unwrap().height();
1619 let mut outbound_scid_alias = 0;
1622 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
1623 outbound_scid_alias += 1;
1625 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
1627 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
1631 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"); }
1636 /// Creates a new outbound channel to the given remote node and with the given value.
1638 /// `user_channel_id` will be provided back as in
1639 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
1640 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
1641 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
1642 /// is simply copied to events and otherwise ignored.
1644 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
1645 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
1647 /// Note that we do not check if you are currently connected to the given peer. If no
1648 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
1649 /// the channel eventually being silently forgotten (dropped on reload).
1651 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
1652 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
1653 /// [`ChannelDetails::channel_id`] until after
1654 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
1655 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
1656 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
1658 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
1659 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
1660 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
1661 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> {
1662 if channel_value_satoshis < 1000 {
1663 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
1667 let per_peer_state = self.per_peer_state.read().unwrap();
1668 match per_peer_state.get(&their_network_key) {
1669 Some(peer_state) => {
1670 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
1671 let peer_state = peer_state.lock().unwrap();
1672 let their_features = &peer_state.latest_features;
1673 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
1674 match Channel::new_outbound(&self.fee_estimator, &self.keys_manager, their_network_key,
1675 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
1676 self.best_block.read().unwrap().height(), outbound_scid_alias)
1680 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
1685 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", their_network_key) }),
1688 let res = channel.get_open_channel(self.genesis_hash.clone());
1690 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1691 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
1692 debug_assert!(&self.total_consistency_lock.try_write().is_err());
1694 let temporary_channel_id = channel.channel_id();
1695 let mut channel_state = self.channel_state.lock().unwrap();
1696 match channel_state.by_id.entry(temporary_channel_id) {
1697 hash_map::Entry::Occupied(_) => {
1699 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
1701 panic!("RNG is bad???");
1704 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
1706 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
1707 node_id: their_network_key,
1710 Ok(temporary_channel_id)
1713 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<<K::Target as KeysInterface>::Signer>)) -> bool>(&self, f: Fn) -> Vec<ChannelDetails> {
1714 let mut res = Vec::new();
1716 let channel_state = self.channel_state.lock().unwrap();
1717 let best_block_height = self.best_block.read().unwrap().height();
1718 res.reserve(channel_state.by_id.len());
1719 for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
1720 let balance = channel.get_available_balances();
1721 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1722 channel.get_holder_counterparty_selected_channel_reserve_satoshis();
1723 res.push(ChannelDetails {
1724 channel_id: (*channel_id).clone(),
1725 counterparty: ChannelCounterparty {
1726 node_id: channel.get_counterparty_node_id(),
1727 features: InitFeatures::empty(),
1728 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1729 forwarding_info: channel.counterparty_forwarding_info(),
1730 // Ensures that we have actually received the `htlc_minimum_msat` value
1731 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1732 // message (as they are always the first message from the counterparty).
1733 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1734 // default `0` value set by `Channel::new_outbound`.
1735 outbound_htlc_minimum_msat: if channel.have_received_message() {
1736 Some(channel.get_counterparty_htlc_minimum_msat()) } else { None },
1737 outbound_htlc_maximum_msat: channel.get_counterparty_htlc_maximum_msat(),
1739 funding_txo: channel.get_funding_txo(),
1740 // Note that accept_channel (or open_channel) is always the first message, so
1741 // `have_received_message` indicates that type negotiation has completed.
1742 channel_type: if channel.have_received_message() { Some(channel.get_channel_type().clone()) } else { None },
1743 short_channel_id: channel.get_short_channel_id(),
1744 outbound_scid_alias: if channel.is_usable() { Some(channel.outbound_scid_alias()) } else { None },
1745 inbound_scid_alias: channel.latest_inbound_scid_alias(),
1746 channel_value_satoshis: channel.get_value_satoshis(),
1747 unspendable_punishment_reserve: to_self_reserve_satoshis,
1748 balance_msat: balance.balance_msat,
1749 inbound_capacity_msat: balance.inbound_capacity_msat,
1750 outbound_capacity_msat: balance.outbound_capacity_msat,
1751 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1752 user_channel_id: channel.get_user_id(),
1753 confirmations_required: channel.minimum_depth(),
1754 confirmations: Some(channel.get_funding_tx_confirmations(best_block_height)),
1755 force_close_spend_delay: channel.get_counterparty_selected_contest_delay(),
1756 is_outbound: channel.is_outbound(),
1757 is_channel_ready: channel.is_usable(),
1758 is_usable: channel.is_live(),
1759 is_public: channel.should_announce(),
1760 inbound_htlc_minimum_msat: Some(channel.get_holder_htlc_minimum_msat()),
1761 inbound_htlc_maximum_msat: channel.get_holder_htlc_maximum_msat(),
1762 config: Some(channel.config()),
1766 let per_peer_state = self.per_peer_state.read().unwrap();
1767 for chan in res.iter_mut() {
1768 if let Some(peer_state) = per_peer_state.get(&chan.counterparty.node_id) {
1769 chan.counterparty.features = peer_state.lock().unwrap().latest_features.clone();
1775 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
1776 /// more information.
1777 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1778 self.list_channels_with_filter(|_| true)
1781 /// Gets the list of usable channels, in random order. Useful as an argument to [`find_route`]
1782 /// to ensure non-announced channels are used.
1784 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1785 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1788 /// [`find_route`]: crate::routing::router::find_route
1789 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1790 // Note we use is_live here instead of usable which leads to somewhat confused
1791 // internal/external nomenclature, but that's ok cause that's probably what the user
1792 // really wanted anyway.
1793 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1796 /// Helper function that issues the channel close events
1797 fn issue_channel_close_events(&self, channel: &Channel<<K::Target as KeysInterface>::Signer>, closure_reason: ClosureReason) {
1798 let mut pending_events_lock = self.pending_events.lock().unwrap();
1799 match channel.unbroadcasted_funding() {
1800 Some(transaction) => {
1801 pending_events_lock.push(events::Event::DiscardFunding { channel_id: channel.channel_id(), transaction })
1805 pending_events_lock.push(events::Event::ChannelClosed {
1806 channel_id: channel.channel_id(),
1807 user_channel_id: channel.get_user_id(),
1808 reason: closure_reason
1812 fn close_channel_internal(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>) -> Result<(), APIError> {
1813 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1815 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
1816 let result: Result<(), _> = loop {
1817 let mut channel_state_lock = self.channel_state.lock().unwrap();
1818 let channel_state = &mut *channel_state_lock;
1819 match channel_state.by_id.entry(channel_id.clone()) {
1820 hash_map::Entry::Occupied(mut chan_entry) => {
1821 if *counterparty_node_id != chan_entry.get().get_counterparty_node_id(){
1822 return Err(APIError::APIMisuseError { err: "The passed counterparty_node_id doesn't match the channel's counterparty node_id".to_owned() });
1824 let (shutdown_msg, monitor_update, htlcs) = {
1825 let per_peer_state = self.per_peer_state.read().unwrap();
1826 match per_peer_state.get(&counterparty_node_id) {
1827 Some(peer_state) => {
1828 let peer_state = peer_state.lock().unwrap();
1829 let their_features = &peer_state.latest_features;
1830 chan_entry.get_mut().get_shutdown(&self.keys_manager, their_features, target_feerate_sats_per_1000_weight)?
1832 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", counterparty_node_id) }),
1835 failed_htlcs = htlcs;
1837 // Update the monitor with the shutdown script if necessary.
1838 if let Some(monitor_update) = monitor_update {
1839 let update_res = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update);
1840 let (result, is_permanent) =
1841 handle_monitor_update_res!(self, update_res, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
1843 remove_channel!(self, chan_entry);
1848 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1849 node_id: *counterparty_node_id,
1853 if chan_entry.get().is_shutdown() {
1854 let channel = remove_channel!(self, chan_entry);
1855 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
1856 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1860 self.issue_channel_close_events(&channel, ClosureReason::HolderForceClosed);
1864 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()})
1868 for htlc_source in failed_htlcs.drain(..) {
1869 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
1870 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
1871 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
1874 let _ = handle_error!(self, result, *counterparty_node_id);
1878 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1879 /// will be accepted on the given channel, and after additional timeout/the closing of all
1880 /// pending HTLCs, the channel will be closed on chain.
1882 /// * If we are the channel initiator, we will pay between our [`Background`] and
1883 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1885 /// * If our counterparty is the channel initiator, we will require a channel closing
1886 /// transaction feerate of at least our [`Background`] feerate or the feerate which
1887 /// would appear on a force-closure transaction, whichever is lower. We will allow our
1888 /// counterparty to pay as much fee as they'd like, however.
1890 /// May generate a SendShutdown message event on success, which should be relayed.
1892 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1893 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1894 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1895 pub fn close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
1896 self.close_channel_internal(channel_id, counterparty_node_id, None)
1899 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1900 /// will be accepted on the given channel, and after additional timeout/the closing of all
1901 /// pending HTLCs, the channel will be closed on chain.
1903 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
1904 /// the channel being closed or not:
1905 /// * If we are the channel initiator, we will pay at least this feerate on the closing
1906 /// transaction. The upper-bound is set by
1907 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1908 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
1909 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
1910 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
1911 /// will appear on a force-closure transaction, whichever is lower).
1913 /// May generate a SendShutdown message event on success, which should be relayed.
1915 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1916 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1917 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1918 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> {
1919 self.close_channel_internal(channel_id, counterparty_node_id, Some(target_feerate_sats_per_1000_weight))
1923 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1924 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1925 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
1926 for htlc_source in failed_htlcs.drain(..) {
1927 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
1928 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
1929 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
1930 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
1932 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1933 // There isn't anything we can do if we get an update failure - we're already
1934 // force-closing. The monitor update on the required in-memory copy should broadcast
1935 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1936 // ignore the result here.
1937 let _ = self.chain_monitor.update_channel(funding_txo, monitor_update);
1941 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
1942 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
1943 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
1944 -> Result<PublicKey, APIError> {
1946 let mut channel_state_lock = self.channel_state.lock().unwrap();
1947 let channel_state = &mut *channel_state_lock;
1948 if let hash_map::Entry::Occupied(chan) = channel_state.by_id.entry(channel_id.clone()) {
1949 if chan.get().get_counterparty_node_id() != *peer_node_id {
1950 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1952 if let Some(peer_msg) = peer_msg {
1953 self.issue_channel_close_events(chan.get(),ClosureReason::CounterpartyForceClosed { peer_msg: peer_msg.to_string() });
1955 self.issue_channel_close_events(chan.get(),ClosureReason::HolderForceClosed);
1957 remove_channel!(self, chan)
1959 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1962 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
1963 self.finish_force_close_channel(chan.force_shutdown(broadcast));
1964 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
1965 let mut channel_state = self.channel_state.lock().unwrap();
1966 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1971 Ok(chan.get_counterparty_node_id())
1974 fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
1975 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1976 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
1977 Ok(counterparty_node_id) => {
1978 self.channel_state.lock().unwrap().pending_msg_events.push(
1979 events::MessageSendEvent::HandleError {
1980 node_id: counterparty_node_id,
1981 action: msgs::ErrorAction::SendErrorMessage {
1982 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
1992 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
1993 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
1994 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
1996 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
1997 -> Result<(), APIError> {
1998 self.force_close_sending_error(channel_id, counterparty_node_id, true)
2001 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
2002 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
2003 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
2005 /// You can always get the latest local transaction(s) to broadcast from
2006 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
2007 pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
2008 -> Result<(), APIError> {
2009 self.force_close_sending_error(channel_id, counterparty_node_id, false)
2012 /// Force close all channels, immediately broadcasting the latest local commitment transaction
2013 /// for each to the chain and rejecting new HTLCs on each.
2014 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
2015 for chan in self.list_channels() {
2016 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
2020 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
2021 /// local transaction(s).
2022 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
2023 for chan in self.list_channels() {
2024 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
2028 fn construct_recv_pending_htlc_info(&self, hop_data: msgs::OnionHopData, shared_secret: [u8; 32],
2029 payment_hash: PaymentHash, amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>) -> Result<PendingHTLCInfo, ReceiveError>
2031 // final_incorrect_cltv_expiry
2032 if hop_data.outgoing_cltv_value != cltv_expiry {
2033 return Err(ReceiveError {
2034 msg: "Upstream node set CLTV to the wrong value",
2036 err_data: cltv_expiry.to_be_bytes().to_vec()
2039 // final_expiry_too_soon
2040 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
2041 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
2042 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
2043 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
2044 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
2045 let current_height: u32 = self.best_block.read().unwrap().height();
2046 if (hop_data.outgoing_cltv_value as u64) <= current_height as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
2047 let mut err_data = Vec::with_capacity(12);
2048 err_data.extend_from_slice(&amt_msat.to_be_bytes());
2049 err_data.extend_from_slice(¤t_height.to_be_bytes());
2050 return Err(ReceiveError {
2051 err_code: 0x4000 | 15, err_data,
2052 msg: "The final CLTV expiry is too soon to handle",
2055 if hop_data.amt_to_forward > amt_msat {
2056 return Err(ReceiveError {
2058 err_data: amt_msat.to_be_bytes().to_vec(),
2059 msg: "Upstream node sent less than we were supposed to receive in payment",
2063 let routing = match hop_data.format {
2064 msgs::OnionHopDataFormat::NonFinalNode { .. } => {
2065 return Err(ReceiveError {
2066 err_code: 0x4000|22,
2067 err_data: Vec::new(),
2068 msg: "Got non final data with an HMAC of 0",
2071 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage } => {
2072 if payment_data.is_some() && keysend_preimage.is_some() {
2073 return Err(ReceiveError {
2074 err_code: 0x4000|22,
2075 err_data: Vec::new(),
2076 msg: "We don't support MPP keysend payments",
2078 } else if let Some(data) = payment_data {
2079 PendingHTLCRouting::Receive {
2081 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2082 phantom_shared_secret,
2084 } else if let Some(payment_preimage) = keysend_preimage {
2085 // We need to check that the sender knows the keysend preimage before processing this
2086 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
2087 // could discover the final destination of X, by probing the adjacent nodes on the route
2088 // with a keysend payment of identical payment hash to X and observing the processing
2089 // time discrepancies due to a hash collision with X.
2090 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2091 if hashed_preimage != payment_hash {
2092 return Err(ReceiveError {
2093 err_code: 0x4000|22,
2094 err_data: Vec::new(),
2095 msg: "Payment preimage didn't match payment hash",
2099 PendingHTLCRouting::ReceiveKeysend {
2101 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2104 return Err(ReceiveError {
2105 err_code: 0x4000|0x2000|3,
2106 err_data: Vec::new(),
2107 msg: "We require payment_secrets",
2112 Ok(PendingHTLCInfo {
2115 incoming_shared_secret: shared_secret,
2116 incoming_amt_msat: Some(amt_msat),
2117 outgoing_amt_msat: amt_msat,
2118 outgoing_cltv_value: hop_data.outgoing_cltv_value,
2122 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> PendingHTLCStatus {
2123 macro_rules! return_malformed_err {
2124 ($msg: expr, $err_code: expr) => {
2126 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2127 return PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
2128 channel_id: msg.channel_id,
2129 htlc_id: msg.htlc_id,
2130 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
2131 failure_code: $err_code,
2137 if let Err(_) = msg.onion_routing_packet.public_key {
2138 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2141 let shared_secret = SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key).secret_bytes();
2143 if msg.onion_routing_packet.version != 0 {
2144 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2145 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2146 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2147 //receiving node would have to brute force to figure out which version was put in the
2148 //packet by the node that send us the message, in the case of hashing the hop_data, the
2149 //node knows the HMAC matched, so they already know what is there...
2150 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2152 macro_rules! return_err {
2153 ($msg: expr, $err_code: expr, $data: expr) => {
2155 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2156 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2157 channel_id: msg.channel_id,
2158 htlc_id: msg.htlc_id,
2159 reason: HTLCFailReason::reason($err_code, $data.to_vec())
2160 .get_encrypted_failure_packet(&shared_secret, &None),
2166 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) {
2168 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2169 return_malformed_err!(err_msg, err_code);
2171 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2172 return_err!(err_msg, err_code, &[0; 0]);
2176 let pending_forward_info = match next_hop {
2177 onion_utils::Hop::Receive(next_hop_data) => {
2179 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash, msg.amount_msat, msg.cltv_expiry, None) {
2181 // Note that we could obviously respond immediately with an update_fulfill_htlc
2182 // message, however that would leak that we are the recipient of this payment, so
2183 // instead we stay symmetric with the forwarding case, only responding (after a
2184 // delay) once they've send us a commitment_signed!
2185 PendingHTLCStatus::Forward(info)
2187 Err(ReceiveError { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
2190 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
2191 let new_pubkey = msg.onion_routing_packet.public_key.unwrap();
2192 let outgoing_packet = msgs::OnionPacket {
2194 public_key: onion_utils::next_hop_packet_pubkey(&self.secp_ctx, new_pubkey, &shared_secret),
2195 hop_data: new_packet_bytes,
2196 hmac: next_hop_hmac.clone(),
2199 let short_channel_id = match next_hop_data.format {
2200 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
2201 msgs::OnionHopDataFormat::FinalNode { .. } => {
2202 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
2206 PendingHTLCStatus::Forward(PendingHTLCInfo {
2207 routing: PendingHTLCRouting::Forward {
2208 onion_packet: outgoing_packet,
2211 payment_hash: msg.payment_hash.clone(),
2212 incoming_shared_secret: shared_secret,
2213 incoming_amt_msat: Some(msg.amount_msat),
2214 outgoing_amt_msat: next_hop_data.amt_to_forward,
2215 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
2220 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref outgoing_amt_msat, ref outgoing_cltv_value, .. }) = &pending_forward_info {
2221 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
2222 // with a short_channel_id of 0. This is important as various things later assume
2223 // short_channel_id is non-0 in any ::Forward.
2224 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
2225 if let Some((err, mut code, chan_update)) = loop {
2226 let id_option = self.short_to_chan_info.read().unwrap().get(&short_channel_id).cloned();
2227 let mut channel_state = self.channel_state.lock().unwrap();
2228 let forwarding_id_opt = match id_option {
2229 None => { // unknown_next_peer
2230 // Note that this is likely a timing oracle for detecting whether an scid is a
2231 // phantom or an intercept.
2232 if (self.default_configuration.accept_intercept_htlcs &&
2233 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, *short_channel_id, &self.genesis_hash)) ||
2234 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, *short_channel_id, &self.genesis_hash)
2238 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2241 Some((_cp_id, chan_id)) => Some(chan_id.clone()),
2243 let chan_update_opt = if let Some(forwarding_id) = forwarding_id_opt {
2244 let chan = match channel_state.by_id.get_mut(&forwarding_id) {
2246 // Channel was removed. The short_to_chan_info and by_id maps have
2247 // no consistency guarantees.
2248 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2252 if !chan.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
2253 // Note that the behavior here should be identical to the above block - we
2254 // should NOT reveal the existence or non-existence of a private channel if
2255 // we don't allow forwards outbound over them.
2256 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
2258 if chan.get_channel_type().supports_scid_privacy() && *short_channel_id != chan.outbound_scid_alias() {
2259 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
2260 // "refuse to forward unless the SCID alias was used", so we pretend
2261 // we don't have the channel here.
2262 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
2264 let chan_update_opt = self.get_channel_update_for_onion(*short_channel_id, chan).ok();
2266 // Note that we could technically not return an error yet here and just hope
2267 // that the connection is reestablished or monitor updated by the time we get
2268 // around to doing the actual forward, but better to fail early if we can and
2269 // hopefully an attacker trying to path-trace payments cannot make this occur
2270 // on a small/per-node/per-channel scale.
2271 if !chan.is_live() { // channel_disabled
2272 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, chan_update_opt));
2274 if *outgoing_amt_msat < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
2275 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
2277 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, *outgoing_amt_msat, *outgoing_cltv_value) {
2278 break Some((err, code, chan_update_opt));
2282 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 {
2283 // We really should set `incorrect_cltv_expiry` here but as we're not
2284 // forwarding over a real channel we can't generate a channel_update
2285 // for it. Instead we just return a generic temporary_node_failure.
2287 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
2294 let cur_height = self.best_block.read().unwrap().height() + 1;
2295 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
2296 // but we want to be robust wrt to counterparty packet sanitization (see
2297 // HTLC_FAIL_BACK_BUFFER rationale).
2298 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
2299 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
2301 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
2302 break Some(("CLTV expiry is too far in the future", 21, None));
2304 // If the HTLC expires ~now, don't bother trying to forward it to our
2305 // counterparty. They should fail it anyway, but we don't want to bother with
2306 // the round-trips or risk them deciding they definitely want the HTLC and
2307 // force-closing to ensure they get it if we're offline.
2308 // We previously had a much more aggressive check here which tried to ensure
2309 // our counterparty receives an HTLC which has *our* risk threshold met on it,
2310 // but there is no need to do that, and since we're a bit conservative with our
2311 // risk threshold it just results in failing to forward payments.
2312 if (*outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
2313 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
2319 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
2320 if let Some(chan_update) = chan_update {
2321 if code == 0x1000 | 11 || code == 0x1000 | 12 {
2322 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
2324 else if code == 0x1000 | 13 {
2325 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
2327 else if code == 0x1000 | 20 {
2328 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
2329 0u16.write(&mut res).expect("Writes cannot fail");
2331 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
2332 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
2333 chan_update.write(&mut res).expect("Writes cannot fail");
2334 } else if code & 0x1000 == 0x1000 {
2335 // If we're trying to return an error that requires a `channel_update` but
2336 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
2337 // generate an update), just use the generic "temporary_node_failure"
2341 return_err!(err, code, &res.0[..]);
2346 pending_forward_info
2349 /// Gets the current channel_update for the given channel. This first checks if the channel is
2350 /// public, and thus should be called whenever the result is going to be passed out in a
2351 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
2353 /// May be called with channel_state already locked!
2354 fn get_channel_update_for_broadcast(&self, chan: &Channel<<K::Target as KeysInterface>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2355 if !chan.should_announce() {
2356 return Err(LightningError {
2357 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
2358 action: msgs::ErrorAction::IgnoreError
2361 if chan.get_short_channel_id().is_none() {
2362 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
2364 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.channel_id()));
2365 self.get_channel_update_for_unicast(chan)
2368 /// Gets the current channel_update for the given channel. This does not check if the channel
2369 /// is public (only returning an Err if the channel does not yet have an assigned short_id),
2370 /// and thus MUST NOT be called unless the recipient of the resulting message has already
2371 /// provided evidence that they know about the existence of the channel.
2372 /// May be called with channel_state already locked!
2373 fn get_channel_update_for_unicast(&self, chan: &Channel<<K::Target as KeysInterface>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2374 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.channel_id()));
2375 let short_channel_id = match chan.get_short_channel_id().or(chan.latest_inbound_scid_alias()) {
2376 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
2380 self.get_channel_update_for_onion(short_channel_id, chan)
2382 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<<K::Target as KeysInterface>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2383 log_trace!(self.logger, "Generating channel update for channel {}", log_bytes!(chan.channel_id()));
2384 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
2386 let unsigned = msgs::UnsignedChannelUpdate {
2387 chain_hash: self.genesis_hash,
2389 timestamp: chan.get_update_time_counter(),
2390 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
2391 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
2392 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
2393 htlc_maximum_msat: chan.get_announced_htlc_max_msat(),
2394 fee_base_msat: chan.get_outbound_forwarding_fee_base_msat(),
2395 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
2396 excess_data: Vec::new(),
2399 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
2400 let sig = self.secp_ctx.sign_ecdsa(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
2402 Ok(msgs::ChannelUpdate {
2408 // Only public for testing, this should otherwise never be called direcly
2409 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> {
2410 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
2411 let prng_seed = self.keys_manager.get_secure_random_bytes();
2412 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
2414 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
2415 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected"})?;
2416 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
2417 if onion_utils::route_size_insane(&onion_payloads) {
2418 return Err(APIError::InvalidRoute{err: "Route size too large considering onion data"});
2420 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
2422 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2424 let err: Result<(), _> = loop {
2425 let id = match self.short_to_chan_info.read().unwrap().get(&path.first().unwrap().short_channel_id) {
2426 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
2427 Some((_cp_id, chan_id)) => chan_id.clone(),
2430 let mut channel_lock = self.channel_state.lock().unwrap();
2431 let channel_state = &mut *channel_lock;
2432 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
2434 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
2435 return Err(APIError::InvalidRoute{err: "Node ID mismatch on first hop!"});
2437 if !chan.get().is_live() {
2438 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
2440 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(
2441 htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
2443 session_priv: session_priv.clone(),
2444 first_hop_htlc_msat: htlc_msat,
2446 payment_secret: payment_secret.clone(),
2447 payment_params: payment_params.clone(),
2448 }, onion_packet, &self.logger),
2451 Some((update_add, commitment_signed, monitor_update)) => {
2452 let update_err = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update);
2453 let chan_id = chan.get().channel_id();
2455 handle_monitor_update_res!(self, update_err, chan,
2456 RAACommitmentOrder::CommitmentFirst, false, true))
2458 (ChannelMonitorUpdateStatus::PermanentFailure, Err(e)) => break Err(e),
2459 (ChannelMonitorUpdateStatus::Completed, Ok(())) => {},
2460 (ChannelMonitorUpdateStatus::InProgress, Err(_)) => {
2461 // Note that MonitorUpdateInProgress here indicates (per function
2462 // docs) that we will resend the commitment update once monitor
2463 // updating completes. Therefore, we must return an error
2464 // indicating that it is unsafe to retry the payment wholesale,
2465 // which we do in the send_payment check for
2466 // MonitorUpdateInProgress, below.
2467 return Err(APIError::MonitorUpdateInProgress);
2469 _ => unreachable!(),
2472 log_debug!(self.logger, "Sending payment along path resulted in a commitment_signed for channel {}", log_bytes!(chan_id));
2473 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2474 node_id: path.first().unwrap().pubkey,
2475 updates: msgs::CommitmentUpdate {
2476 update_add_htlcs: vec![update_add],
2477 update_fulfill_htlcs: Vec::new(),
2478 update_fail_htlcs: Vec::new(),
2479 update_fail_malformed_htlcs: Vec::new(),
2488 // The channel was likely removed after we fetched the id from the
2489 // `short_to_chan_info` map, but before we successfully locked the `by_id` map.
2490 // This can occur as no consistency guarantees exists between the two maps.
2491 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
2496 match handle_error!(self, err, path.first().unwrap().pubkey) {
2497 Ok(_) => unreachable!(),
2499 Err(APIError::ChannelUnavailable { err: e.err })
2504 /// Sends a payment along a given route.
2506 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
2507 /// fields for more info.
2509 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
2510 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
2511 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
2512 /// [`Event::PaymentSent`]) LDK will not stop you from sending a second payment with the same
2515 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
2516 /// tracking of payments, including state to indicate once a payment has completed. Because you
2517 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
2518 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
2519 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
2521 /// May generate SendHTLCs message(s) event on success, which should be relayed (e.g. via
2522 /// [`PeerManager::process_events`]).
2524 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
2525 /// each entry matching the corresponding-index entry in the route paths, see
2526 /// PaymentSendFailure for more info.
2528 /// In general, a path may raise:
2529 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
2530 /// node public key) is specified.
2531 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
2532 /// (including due to previous monitor update failure or new permanent monitor update
2534 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
2535 /// relevant updates.
2537 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
2538 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
2539 /// different route unless you intend to pay twice!
2541 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
2542 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
2543 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
2544 /// must not contain multiple paths as multi-path payments require a recipient-provided
2547 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
2548 /// bit set (either as required or as available). If multiple paths are present in the Route,
2549 /// we assume the invoice had the basic_mpp feature set.
2551 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2552 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
2553 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2554 let onion_session_privs = self.add_new_pending_payment(payment_hash, *payment_secret, payment_id, route)?;
2555 self.send_payment_internal(route, payment_hash, payment_secret, None, payment_id, None, onion_session_privs)
2559 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> {
2560 self.add_new_pending_payment(payment_hash, payment_secret, payment_id, route)
2563 fn add_new_pending_payment(&self, payment_hash: PaymentHash, payment_secret: Option<PaymentSecret>, payment_id: PaymentId, route: &Route) -> Result<Vec<[u8; 32]>, PaymentSendFailure> {
2564 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
2565 for _ in 0..route.paths.len() {
2566 onion_session_privs.push(self.keys_manager.get_secure_random_bytes());
2569 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
2570 match pending_outbounds.entry(payment_id) {
2571 hash_map::Entry::Occupied(_) => Err(PaymentSendFailure::DuplicatePayment),
2572 hash_map::Entry::Vacant(entry) => {
2573 let payment = entry.insert(PendingOutboundPayment::Retryable {
2574 session_privs: HashSet::new(),
2575 pending_amt_msat: 0,
2576 pending_fee_msat: Some(0),
2579 starting_block_height: self.best_block.read().unwrap().height(),
2580 total_msat: route.get_total_amount(),
2583 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
2584 assert!(payment.insert(*session_priv_bytes, path));
2587 Ok(onion_session_privs)
2592 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> {
2593 if route.paths.len() < 1 {
2594 return Err(PaymentSendFailure::ParameterError(APIError::InvalidRoute{err: "There must be at least one path to send over"}));
2596 if payment_secret.is_none() && route.paths.len() > 1 {
2597 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
2599 let mut total_value = 0;
2600 let our_node_id = self.get_our_node_id();
2601 let mut path_errs = Vec::with_capacity(route.paths.len());
2602 'path_check: for path in route.paths.iter() {
2603 if path.len() < 1 || path.len() > 20 {
2604 path_errs.push(Err(APIError::InvalidRoute{err: "Path didn't go anywhere/had bogus size"}));
2605 continue 'path_check;
2607 for (idx, hop) in path.iter().enumerate() {
2608 if idx != path.len() - 1 && hop.pubkey == our_node_id {
2609 path_errs.push(Err(APIError::InvalidRoute{err: "Path went through us but wasn't a simple rebalance loop to us"}));
2610 continue 'path_check;
2613 total_value += path.last().unwrap().fee_msat;
2614 path_errs.push(Ok(()));
2616 if path_errs.iter().any(|e| e.is_err()) {
2617 return Err(PaymentSendFailure::PathParameterError(path_errs));
2619 if let Some(amt_msat) = recv_value_msat {
2620 debug_assert!(amt_msat >= total_value);
2621 total_value = amt_msat;
2624 let cur_height = self.best_block.read().unwrap().height() + 1;
2625 let mut results = Vec::new();
2626 debug_assert_eq!(route.paths.len(), onion_session_privs.len());
2627 for (path, session_priv) in route.paths.iter().zip(onion_session_privs.into_iter()) {
2628 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);
2631 Err(APIError::MonitorUpdateInProgress) => {
2632 // While a MonitorUpdateInProgress is an Err(_), the payment is still
2633 // considered "in flight" and we shouldn't remove it from the
2634 // PendingOutboundPayment set.
2637 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
2638 if let Some(payment) = pending_outbounds.get_mut(&payment_id) {
2639 let removed = payment.remove(&session_priv, Some(path));
2640 debug_assert!(removed, "This can't happen as the payment has an entry for this path added by callers");
2642 debug_assert!(false, "This can't happen as the payment was added by callers");
2643 path_res = Err(APIError::APIMisuseError { err: "Internal error: payment disappeared during processing. Please report this bug!".to_owned() });
2647 results.push(path_res);
2649 let mut has_ok = false;
2650 let mut has_err = false;
2651 let mut pending_amt_unsent = 0;
2652 let mut max_unsent_cltv_delta = 0;
2653 for (res, path) in results.iter().zip(route.paths.iter()) {
2654 if res.is_ok() { has_ok = true; }
2655 if res.is_err() { has_err = true; }
2656 if let &Err(APIError::MonitorUpdateInProgress) = res {
2657 // MonitorUpdateInProgress is inherently unsafe to retry, so we call it a
2661 } else if res.is_err() {
2662 pending_amt_unsent += path.last().unwrap().fee_msat;
2663 max_unsent_cltv_delta = cmp::max(max_unsent_cltv_delta, path.last().unwrap().cltv_expiry_delta);
2666 if has_err && has_ok {
2667 Err(PaymentSendFailure::PartialFailure {
2670 failed_paths_retry: if pending_amt_unsent != 0 {
2671 if let Some(payment_params) = &route.payment_params {
2672 Some(RouteParameters {
2673 payment_params: payment_params.clone(),
2674 final_value_msat: pending_amt_unsent,
2675 final_cltv_expiry_delta: max_unsent_cltv_delta,
2681 // If we failed to send any paths, we should remove the new PaymentId from the
2682 // `pending_outbound_payments` map, as the user isn't expected to `abandon_payment`.
2683 let removed = self.pending_outbound_payments.lock().unwrap().remove(&payment_id).is_some();
2684 debug_assert!(removed, "We should always have a pending payment to remove here");
2685 Err(PaymentSendFailure::AllFailedResendSafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
2691 /// Retries a payment along the given [`Route`].
2693 /// Errors returned are a superset of those returned from [`send_payment`], so see
2694 /// [`send_payment`] documentation for more details on errors. This method will also error if the
2695 /// retry amount puts the payment more than 10% over the payment's total amount, if the payment
2696 /// for the given `payment_id` cannot be found (likely due to timeout or success), or if
2697 /// further retries have been disabled with [`abandon_payment`].
2699 /// [`send_payment`]: [`ChannelManager::send_payment`]
2700 /// [`abandon_payment`]: [`ChannelManager::abandon_payment`]
2701 pub fn retry_payment(&self, route: &Route, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2702 const RETRY_OVERFLOW_PERCENTAGE: u64 = 10;
2703 for path in route.paths.iter() {
2704 if path.len() == 0 {
2705 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2706 err: "length-0 path in route".to_string()
2711 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
2712 for _ in 0..route.paths.len() {
2713 onion_session_privs.push(self.keys_manager.get_secure_random_bytes());
2716 let (total_msat, payment_hash, payment_secret) = {
2717 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
2718 match outbounds.get_mut(&payment_id) {
2720 let res = match payment {
2721 PendingOutboundPayment::Retryable {
2722 total_msat, payment_hash, payment_secret, pending_amt_msat, ..
2724 let retry_amt_msat: u64 = route.paths.iter().map(|path| path.last().unwrap().fee_msat).sum();
2725 if retry_amt_msat + *pending_amt_msat > *total_msat * (100 + RETRY_OVERFLOW_PERCENTAGE) / 100 {
2726 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2727 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()
2730 (*total_msat, *payment_hash, *payment_secret)
2732 PendingOutboundPayment::Legacy { .. } => {
2733 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2734 err: "Unable to retry payments that were initially sent on LDK versions prior to 0.0.102".to_string()
2737 PendingOutboundPayment::Fulfilled { .. } => {
2738 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2739 err: "Payment already completed".to_owned()
2742 PendingOutboundPayment::Abandoned { .. } => {
2743 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2744 err: "Payment already abandoned (with some HTLCs still pending)".to_owned()
2748 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
2749 assert!(payment.insert(*session_priv_bytes, path));
2754 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2755 err: format!("Payment with ID {} not found", log_bytes!(payment_id.0)),
2759 self.send_payment_internal(route, payment_hash, &payment_secret, None, payment_id, Some(total_msat), onion_session_privs)
2762 /// Signals that no further retries for the given payment will occur.
2764 /// After this method returns, any future calls to [`retry_payment`] for the given `payment_id`
2765 /// will fail with [`PaymentSendFailure::ParameterError`]. If no such event has been generated,
2766 /// an [`Event::PaymentFailed`] event will be generated as soon as there are no remaining
2767 /// pending HTLCs for this payment.
2769 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
2770 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
2771 /// determine the ultimate status of a payment.
2773 /// [`retry_payment`]: Self::retry_payment
2774 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
2775 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2776 pub fn abandon_payment(&self, payment_id: PaymentId) {
2777 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2779 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
2780 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
2781 if let Ok(()) = payment.get_mut().mark_abandoned() {
2782 if payment.get().remaining_parts() == 0 {
2783 self.pending_events.lock().unwrap().push(events::Event::PaymentFailed {
2785 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
2793 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
2794 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
2795 /// the preimage, it must be a cryptographically secure random value that no intermediate node
2796 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
2797 /// never reach the recipient.
2799 /// See [`send_payment`] documentation for more details on the return value of this function
2800 /// and idempotency guarantees provided by the [`PaymentId`] key.
2802 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
2803 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
2805 /// Note that `route` must have exactly one path.
2807 /// [`send_payment`]: Self::send_payment
2808 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
2809 let preimage = match payment_preimage {
2811 None => PaymentPreimage(self.keys_manager.get_secure_random_bytes()),
2813 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
2814 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, &route)?;
2816 match self.send_payment_internal(route, payment_hash, &None, Some(preimage), payment_id, None, onion_session_privs) {
2817 Ok(()) => Ok(payment_hash),
2822 /// Send a payment that is probing the given route for liquidity. We calculate the
2823 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
2824 /// us to easily discern them from real payments.
2825 pub fn send_probe(&self, hops: Vec<RouteHop>) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
2826 let payment_id = PaymentId(self.keys_manager.get_secure_random_bytes());
2828 let payment_hash = self.probing_cookie_from_id(&payment_id);
2831 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2832 err: "No need probing a path with less than two hops".to_string()
2836 let route = Route { paths: vec![hops], payment_params: None };
2837 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, &route)?;
2839 match self.send_payment_internal(&route, payment_hash, &None, None, payment_id, None, onion_session_privs) {
2840 Ok(()) => Ok((payment_hash, payment_id)),
2845 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
2847 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
2848 let target_payment_hash = self.probing_cookie_from_id(payment_id);
2849 target_payment_hash == *payment_hash
2852 /// Returns the 'probing cookie' for the given [`PaymentId`].
2853 fn probing_cookie_from_id(&self, payment_id: &PaymentId) -> PaymentHash {
2854 let mut preimage = [0u8; 64];
2855 preimage[..32].copy_from_slice(&self.probing_cookie_secret);
2856 preimage[32..].copy_from_slice(&payment_id.0);
2857 PaymentHash(Sha256::hash(&preimage).into_inner())
2860 /// Handles the generation of a funding transaction, optionally (for tests) with a function
2861 /// which checks the correctness of the funding transaction given the associated channel.
2862 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<<K::Target as KeysInterface>::Signer>, &Transaction) -> Result<OutPoint, APIError>>(
2863 &self, temporary_channel_id: &[u8; 32], _counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
2864 ) -> Result<(), APIError> {
2866 let (res, chan) = match self.channel_state.lock().unwrap().by_id.remove(temporary_channel_id) {
2868 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
2870 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
2871 .map_err(|e| if let ChannelError::Close(msg) = e {
2872 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.get_user_id(), chan.force_shutdown(true), None)
2873 } else { unreachable!(); })
2876 None => { return Err(APIError::ChannelUnavailable { err: "No such channel".to_owned() }) },
2878 match handle_error!(self, res, chan.get_counterparty_node_id()) {
2879 Ok(funding_msg) => {
2882 Err(_) => { return Err(APIError::ChannelUnavailable {
2883 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()
2888 let mut channel_state = self.channel_state.lock().unwrap();
2889 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
2890 node_id: chan.get_counterparty_node_id(),
2893 match channel_state.by_id.entry(chan.channel_id()) {
2894 hash_map::Entry::Occupied(_) => {
2895 panic!("Generated duplicate funding txid?");
2897 hash_map::Entry::Vacant(e) => {
2898 let mut id_to_peer = self.id_to_peer.lock().unwrap();
2899 if id_to_peer.insert(chan.channel_id(), chan.get_counterparty_node_id()).is_some() {
2900 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
2909 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> {
2910 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
2911 Ok(OutPoint { txid: tx.txid(), index: output_index })
2915 /// Call this upon creation of a funding transaction for the given channel.
2917 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
2918 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
2920 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
2921 /// across the p2p network.
2923 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
2924 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
2926 /// May panic if the output found in the funding transaction is duplicative with some other
2927 /// channel (note that this should be trivially prevented by using unique funding transaction
2928 /// keys per-channel).
2930 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
2931 /// counterparty's signature the funding transaction will automatically be broadcast via the
2932 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
2934 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
2935 /// not currently support replacing a funding transaction on an existing channel. Instead,
2936 /// create a new channel with a conflicting funding transaction.
2938 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
2939 /// the wallet software generating the funding transaction to apply anti-fee sniping as
2940 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
2941 /// for more details.
2943 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
2944 /// [`Event::ChannelClosed`]: crate::util::events::Event::ChannelClosed
2945 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
2946 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2948 for inp in funding_transaction.input.iter() {
2949 if inp.witness.is_empty() {
2950 return Err(APIError::APIMisuseError {
2951 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
2956 let height = self.best_block.read().unwrap().height();
2957 // Transactions are evaluated as final by network mempools at the next block. However, the modules
2958 // constituting our Lightning node might not have perfect sync about their blockchain views. Thus, if
2959 // the wallet module is in advance on the LDK view, allow one more block of headroom.
2960 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 {
2961 return Err(APIError::APIMisuseError {
2962 err: "Funding transaction absolute timelock is non-final".to_owned()
2966 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
2967 let mut output_index = None;
2968 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
2969 for (idx, outp) in tx.output.iter().enumerate() {
2970 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
2971 if output_index.is_some() {
2972 return Err(APIError::APIMisuseError {
2973 err: "Multiple outputs matched the expected script and value".to_owned()
2976 if idx > u16::max_value() as usize {
2977 return Err(APIError::APIMisuseError {
2978 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
2981 output_index = Some(idx as u16);
2984 if output_index.is_none() {
2985 return Err(APIError::APIMisuseError {
2986 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
2989 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
2993 /// Atomically updates the [`ChannelConfig`] for the given channels.
2995 /// Once the updates are applied, each eligible channel (advertised with a known short channel
2996 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
2997 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
2998 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3000 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3001 /// `counterparty_node_id` is provided.
3003 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3004 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3006 /// If an error is returned, none of the updates should be considered applied.
3008 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3009 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3010 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3011 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3012 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3013 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3014 /// [`APIMisuseError`]: APIError::APIMisuseError
3015 pub fn update_channel_config(
3016 &self, counterparty_node_id: &PublicKey, channel_ids: &[[u8; 32]], config: &ChannelConfig,
3017 ) -> Result<(), APIError> {
3018 if config.cltv_expiry_delta < MIN_CLTV_EXPIRY_DELTA {
3019 return Err(APIError::APIMisuseError {
3020 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
3024 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(
3025 &self.total_consistency_lock, &self.persistence_notifier,
3028 let mut channel_state_lock = self.channel_state.lock().unwrap();
3029 let channel_state = &mut *channel_state_lock;
3030 for channel_id in channel_ids {
3031 let channel_counterparty_node_id = channel_state.by_id.get(channel_id)
3032 .ok_or(APIError::ChannelUnavailable {
3033 err: format!("Channel with ID {} was not found", log_bytes!(*channel_id)),
3035 .get_counterparty_node_id();
3036 if channel_counterparty_node_id != *counterparty_node_id {
3037 return Err(APIError::APIMisuseError {
3038 err: "counterparty node id mismatch".to_owned(),
3042 for channel_id in channel_ids {
3043 let channel = channel_state.by_id.get_mut(channel_id).unwrap();
3044 if !channel.update_config(config) {
3047 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
3048 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
3049 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
3050 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
3051 node_id: channel.get_counterparty_node_id(),
3060 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
3061 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
3063 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
3064 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
3066 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
3067 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
3068 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
3069 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
3070 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
3072 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
3073 /// you from forwarding more than you received.
3075 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
3078 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
3079 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
3080 // TODO: when we move to deciding the best outbound channel at forward time, only take
3081 // `next_node_id` and not `next_hop_channel_id`
3082 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> {
3083 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3085 let next_hop_scid = match self.channel_state.lock().unwrap().by_id.get(next_hop_channel_id) {
3087 if !chan.is_usable() {
3088 return Err(APIError::ChannelUnavailable {
3089 err: format!("Channel with id {} not fully established", log_bytes!(*next_hop_channel_id))
3092 chan.get_short_channel_id().unwrap_or(chan.outbound_scid_alias())
3094 None => return Err(APIError::ChannelUnavailable {
3095 err: format!("Channel with id {} not found", log_bytes!(*next_hop_channel_id))
3099 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
3100 .ok_or_else(|| APIError::APIMisuseError {
3101 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
3104 let routing = match payment.forward_info.routing {
3105 PendingHTLCRouting::Forward { onion_packet, .. } => {
3106 PendingHTLCRouting::Forward { onion_packet, short_channel_id: next_hop_scid }
3108 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
3110 let pending_htlc_info = PendingHTLCInfo {
3111 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
3114 let mut per_source_pending_forward = [(
3115 payment.prev_short_channel_id,
3116 payment.prev_funding_outpoint,
3117 payment.prev_user_channel_id,
3118 vec![(pending_htlc_info, payment.prev_htlc_id)]
3120 self.forward_htlcs(&mut per_source_pending_forward);
3124 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
3125 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
3127 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
3130 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
3131 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
3132 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3134 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
3135 .ok_or_else(|| APIError::APIMisuseError {
3136 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
3139 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
3140 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3141 short_channel_id: payment.prev_short_channel_id,
3142 outpoint: payment.prev_funding_outpoint,
3143 htlc_id: payment.prev_htlc_id,
3144 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
3145 phantom_shared_secret: None,
3148 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
3149 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
3150 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
3151 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
3156 /// Processes HTLCs which are pending waiting on random forward delay.
3158 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
3159 /// Will likely generate further events.
3160 pub fn process_pending_htlc_forwards(&self) {
3161 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3163 let mut new_events = Vec::new();
3164 let mut failed_forwards = Vec::new();
3165 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
3166 let mut handle_errors = Vec::new();
3168 let mut forward_htlcs = HashMap::new();
3169 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
3171 for (short_chan_id, mut pending_forwards) in forward_htlcs {
3172 if short_chan_id != 0 {
3173 macro_rules! forwarding_channel_not_found {
3175 for forward_info in pending_forwards.drain(..) {
3176 match forward_info {
3177 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3178 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3179 forward_info: PendingHTLCInfo {
3180 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
3181 outgoing_cltv_value, incoming_amt_msat: _
3184 macro_rules! failure_handler {
3185 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
3186 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3188 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3189 short_channel_id: prev_short_channel_id,
3190 outpoint: prev_funding_outpoint,
3191 htlc_id: prev_htlc_id,
3192 incoming_packet_shared_secret: incoming_shared_secret,
3193 phantom_shared_secret: $phantom_ss,
3196 let reason = if $next_hop_unknown {
3197 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
3199 HTLCDestination::FailedPayment{ payment_hash }
3202 failed_forwards.push((htlc_source, payment_hash,
3203 HTLCFailReason::reason($err_code, $err_data),
3209 macro_rules! fail_forward {
3210 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3212 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
3216 macro_rules! failed_payment {
3217 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3219 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
3223 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
3224 let phantom_secret_res = self.keys_manager.get_node_secret(Recipient::PhantomNode);
3225 if phantom_secret_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.genesis_hash) {
3226 let phantom_shared_secret = SharedSecret::new(&onion_packet.public_key.unwrap(), &phantom_secret_res.unwrap()).secret_bytes();
3227 let next_hop = match onion_utils::decode_next_payment_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
3229 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
3230 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
3231 // In this scenario, the phantom would have sent us an
3232 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
3233 // if it came from us (the second-to-last hop) but contains the sha256
3235 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
3237 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3238 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
3242 onion_utils::Hop::Receive(hop_data) => {
3243 match self.construct_recv_pending_htlc_info(hop_data, incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value, Some(phantom_shared_secret)) {
3244 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
3245 Err(ReceiveError { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
3251 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3254 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3257 HTLCForwardInfo::FailHTLC { .. } => {
3258 // Channel went away before we could fail it. This implies
3259 // the channel is now on chain and our counterparty is
3260 // trying to broadcast the HTLC-Timeout, but that's their
3261 // problem, not ours.
3267 let forward_chan_id = match self.short_to_chan_info.read().unwrap().get(&short_chan_id) {
3268 Some((_cp_id, chan_id)) => chan_id.clone(),
3270 forwarding_channel_not_found!();
3274 let mut channel_state_lock = self.channel_state.lock().unwrap();
3275 let channel_state = &mut *channel_state_lock;
3276 match channel_state.by_id.entry(forward_chan_id) {
3277 hash_map::Entry::Vacant(_) => {
3278 forwarding_channel_not_found!();
3281 hash_map::Entry::Occupied(mut chan) => {
3282 let mut add_htlc_msgs = Vec::new();
3283 let mut fail_htlc_msgs = Vec::new();
3284 for forward_info in pending_forwards.drain(..) {
3285 match forward_info {
3286 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3287 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id: _,
3288 forward_info: PendingHTLCInfo {
3289 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
3290 routing: PendingHTLCRouting::Forward { onion_packet, .. }, incoming_amt_msat: _,
3293 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);
3294 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3295 short_channel_id: prev_short_channel_id,
3296 outpoint: prev_funding_outpoint,
3297 htlc_id: prev_htlc_id,
3298 incoming_packet_shared_secret: incoming_shared_secret,
3299 // Phantom payments are only PendingHTLCRouting::Receive.
3300 phantom_shared_secret: None,
3302 match chan.get_mut().send_htlc(outgoing_amt_msat, payment_hash, outgoing_cltv_value, htlc_source.clone(), onion_packet, &self.logger) {
3304 if let ChannelError::Ignore(msg) = e {
3305 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
3307 panic!("Stated return value requirements in send_htlc() were not met");
3309 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan.get());
3310 failed_forwards.push((htlc_source, payment_hash,
3311 HTLCFailReason::reason(failure_code, data),
3312 HTLCDestination::NextHopChannel { node_id: Some(chan.get().get_counterparty_node_id()), channel_id: forward_chan_id }
3318 Some(msg) => { add_htlc_msgs.push(msg); },
3320 // Nothing to do here...we're waiting on a remote
3321 // revoke_and_ack before we can add anymore HTLCs. The Channel
3322 // will automatically handle building the update_add_htlc and
3323 // commitment_signed messages when we can.
3324 // TODO: Do some kind of timer to set the channel as !is_live()
3325 // as we don't really want others relying on us relaying through
3326 // this channel currently :/.
3332 HTLCForwardInfo::AddHTLC { .. } => {
3333 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
3335 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
3336 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
3337 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet, &self.logger) {
3339 if let ChannelError::Ignore(msg) = e {
3340 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
3342 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
3344 // fail-backs are best-effort, we probably already have one
3345 // pending, and if not that's OK, if not, the channel is on
3346 // the chain and sending the HTLC-Timeout is their problem.
3349 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
3351 // Nothing to do here...we're waiting on a remote
3352 // revoke_and_ack before we can update the commitment
3353 // transaction. The Channel will automatically handle
3354 // building the update_fail_htlc and commitment_signed
3355 // messages when we can.
3356 // We don't need any kind of timer here as they should fail
3357 // the channel onto the chain if they can't get our
3358 // update_fail_htlc in time, it's not our problem.
3365 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
3366 let (commitment_msg, monitor_update) = match chan.get_mut().send_commitment(&self.logger) {
3369 // We surely failed send_commitment due to bad keys, in that case
3370 // close channel and then send error message to peer.
3371 let counterparty_node_id = chan.get().get_counterparty_node_id();
3372 let err: Result<(), _> = match e {
3373 ChannelError::Ignore(_) | ChannelError::Warn(_) => {
3374 panic!("Stated return value requirements in send_commitment() were not met");
3376 ChannelError::Close(msg) => {
3377 log_trace!(self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
3378 let mut channel = remove_channel!(self, chan);
3379 // ChannelClosed event is generated by handle_error for us.
3380 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()))
3383 handle_errors.push((counterparty_node_id, err));
3387 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3388 ChannelMonitorUpdateStatus::Completed => {},
3390 handle_errors.push((chan.get().get_counterparty_node_id(), handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
3394 log_debug!(self.logger, "Forwarding HTLCs resulted in a commitment update with {} HTLCs added and {} HTLCs failed for channel {}",
3395 add_htlc_msgs.len(), fail_htlc_msgs.len(), log_bytes!(chan.get().channel_id()));
3396 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3397 node_id: chan.get().get_counterparty_node_id(),
3398 updates: msgs::CommitmentUpdate {
3399 update_add_htlcs: add_htlc_msgs,
3400 update_fulfill_htlcs: Vec::new(),
3401 update_fail_htlcs: fail_htlc_msgs,
3402 update_fail_malformed_htlcs: Vec::new(),
3404 commitment_signed: commitment_msg,
3411 for forward_info in pending_forwards.drain(..) {
3412 match forward_info {
3413 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3414 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3415 forward_info: PendingHTLCInfo {
3416 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat, ..
3419 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret) = match routing {
3420 PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry, phantom_shared_secret } => {
3421 let _legacy_hop_data = Some(payment_data.clone());
3422 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data }, Some(payment_data), phantom_shared_secret)
3424 PendingHTLCRouting::ReceiveKeysend { payment_preimage, incoming_cltv_expiry } =>
3425 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage), None, None),
3427 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
3430 let claimable_htlc = ClaimableHTLC {
3431 prev_hop: HTLCPreviousHopData {
3432 short_channel_id: prev_short_channel_id,
3433 outpoint: prev_funding_outpoint,
3434 htlc_id: prev_htlc_id,
3435 incoming_packet_shared_secret: incoming_shared_secret,
3436 phantom_shared_secret,
3438 value: outgoing_amt_msat,
3440 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
3445 macro_rules! fail_htlc {
3446 ($htlc: expr, $payment_hash: expr) => {
3447 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
3448 htlc_msat_height_data.extend_from_slice(
3449 &self.best_block.read().unwrap().height().to_be_bytes(),
3451 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
3452 short_channel_id: $htlc.prev_hop.short_channel_id,
3453 outpoint: prev_funding_outpoint,
3454 htlc_id: $htlc.prev_hop.htlc_id,
3455 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
3456 phantom_shared_secret,
3458 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
3459 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
3463 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
3464 let mut receiver_node_id = self.our_network_pubkey;
3465 if phantom_shared_secret.is_some() {
3466 receiver_node_id = self.keys_manager.get_node_id(Recipient::PhantomNode)
3467 .expect("Failed to get node_id for phantom node recipient");
3470 macro_rules! check_total_value {
3471 ($payment_data: expr, $payment_preimage: expr) => {{
3472 let mut payment_claimable_generated = false;
3474 events::PaymentPurpose::InvoicePayment {
3475 payment_preimage: $payment_preimage,
3476 payment_secret: $payment_data.payment_secret,
3479 let mut claimable_htlcs = self.claimable_htlcs.lock().unwrap();
3480 let (_, htlcs) = claimable_htlcs.entry(payment_hash)
3481 .or_insert_with(|| (purpose(), Vec::new()));
3482 if htlcs.len() == 1 {
3483 if let OnionPayload::Spontaneous(_) = htlcs[0].onion_payload {
3484 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));
3485 fail_htlc!(claimable_htlc, payment_hash);
3489 let mut total_value = claimable_htlc.value;
3490 for htlc in htlcs.iter() {
3491 total_value += htlc.value;
3492 match &htlc.onion_payload {
3493 OnionPayload::Invoice { .. } => {
3494 if htlc.total_msat != $payment_data.total_msat {
3495 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
3496 log_bytes!(payment_hash.0), $payment_data.total_msat, htlc.total_msat);
3497 total_value = msgs::MAX_VALUE_MSAT;
3499 if total_value >= msgs::MAX_VALUE_MSAT { break; }
3501 _ => unreachable!(),
3504 if total_value >= msgs::MAX_VALUE_MSAT || total_value > $payment_data.total_msat {
3505 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
3506 log_bytes!(payment_hash.0), total_value, $payment_data.total_msat);
3507 fail_htlc!(claimable_htlc, payment_hash);
3508 } else if total_value == $payment_data.total_msat {
3509 let prev_channel_id = prev_funding_outpoint.to_channel_id();
3510 htlcs.push(claimable_htlc);
3511 new_events.push(events::Event::PaymentClaimable {
3512 receiver_node_id: Some(receiver_node_id),
3515 amount_msat: total_value,
3516 via_channel_id: Some(prev_channel_id),
3517 via_user_channel_id: Some(prev_user_channel_id),
3519 payment_claimable_generated = true;
3521 // Nothing to do - we haven't reached the total
3522 // payment value yet, wait until we receive more
3524 htlcs.push(claimable_htlc);
3526 payment_claimable_generated
3530 // Check that the payment hash and secret are known. Note that we
3531 // MUST take care to handle the "unknown payment hash" and
3532 // "incorrect payment secret" cases here identically or we'd expose
3533 // that we are the ultimate recipient of the given payment hash.
3534 // Further, we must not expose whether we have any other HTLCs
3535 // associated with the same payment_hash pending or not.
3536 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
3537 match payment_secrets.entry(payment_hash) {
3538 hash_map::Entry::Vacant(_) => {
3539 match claimable_htlc.onion_payload {
3540 OnionPayload::Invoice { .. } => {
3541 let payment_data = payment_data.unwrap();
3542 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) {
3543 Ok(payment_preimage) => payment_preimage,
3545 fail_htlc!(claimable_htlc, payment_hash);
3549 check_total_value!(payment_data, payment_preimage);
3551 OnionPayload::Spontaneous(preimage) => {
3552 match self.claimable_htlcs.lock().unwrap().entry(payment_hash) {
3553 hash_map::Entry::Vacant(e) => {
3554 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
3555 e.insert((purpose.clone(), vec![claimable_htlc]));
3556 let prev_channel_id = prev_funding_outpoint.to_channel_id();
3557 new_events.push(events::Event::PaymentClaimable {
3558 receiver_node_id: Some(receiver_node_id),
3560 amount_msat: outgoing_amt_msat,
3562 via_channel_id: Some(prev_channel_id),
3563 via_user_channel_id: Some(prev_user_channel_id),
3566 hash_map::Entry::Occupied(_) => {
3567 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
3568 fail_htlc!(claimable_htlc, payment_hash);
3574 hash_map::Entry::Occupied(inbound_payment) => {
3575 if payment_data.is_none() {
3576 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));
3577 fail_htlc!(claimable_htlc, payment_hash);
3580 let payment_data = payment_data.unwrap();
3581 if inbound_payment.get().payment_secret != payment_data.payment_secret {
3582 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
3583 fail_htlc!(claimable_htlc, payment_hash);
3584 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
3585 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
3586 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
3587 fail_htlc!(claimable_htlc, payment_hash);
3589 let payment_claimable_generated = check_total_value!(payment_data, inbound_payment.get().payment_preimage);
3590 if payment_claimable_generated {
3591 inbound_payment.remove_entry();
3597 HTLCForwardInfo::FailHTLC { .. } => {
3598 panic!("Got pending fail of our own HTLC");
3606 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
3607 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
3609 self.forward_htlcs(&mut phantom_receives);
3611 for (counterparty_node_id, err) in handle_errors.drain(..) {
3612 let _ = handle_error!(self, err, counterparty_node_id);
3615 if new_events.is_empty() { return }
3616 let mut events = self.pending_events.lock().unwrap();
3617 events.append(&mut new_events);
3620 /// Free the background events, generally called from timer_tick_occurred.
3622 /// Exposed for testing to allow us to process events quickly without generating accidental
3623 /// BroadcastChannelUpdate events in timer_tick_occurred.
3625 /// Expects the caller to have a total_consistency_lock read lock.
3626 fn process_background_events(&self) -> bool {
3627 let mut background_events = Vec::new();
3628 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
3629 if background_events.is_empty() {
3633 for event in background_events.drain(..) {
3635 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
3636 // The channel has already been closed, so no use bothering to care about the
3637 // monitor updating completing.
3638 let _ = self.chain_monitor.update_channel(funding_txo, update);
3645 #[cfg(any(test, feature = "_test_utils"))]
3646 /// Process background events, for functional testing
3647 pub fn test_process_background_events(&self) {
3648 self.process_background_events();
3651 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>) {
3652 if !chan.is_outbound() { return (true, NotifyOption::SkipPersist, Ok(())); }
3653 // If the feerate has decreased by less than half, don't bother
3654 if new_feerate <= chan.get_feerate() && new_feerate * 2 > chan.get_feerate() {
3655 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
3656 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3657 return (true, NotifyOption::SkipPersist, Ok(()));
3659 if !chan.is_live() {
3660 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).",
3661 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3662 return (true, NotifyOption::SkipPersist, Ok(()));
3664 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
3665 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3667 let mut retain_channel = true;
3668 let res = match chan.send_update_fee_and_commit(new_feerate, &self.logger) {
3671 let (drop, res) = convert_chan_err!(self, e, chan, chan_id);
3672 if drop { retain_channel = false; }
3676 let ret_err = match res {
3677 Ok(Some((update_fee, commitment_signed, monitor_update))) => {
3678 match self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
3679 ChannelMonitorUpdateStatus::Completed => {
3680 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3681 node_id: chan.get_counterparty_node_id(),
3682 updates: msgs::CommitmentUpdate {
3683 update_add_htlcs: Vec::new(),
3684 update_fulfill_htlcs: Vec::new(),
3685 update_fail_htlcs: Vec::new(),
3686 update_fail_malformed_htlcs: Vec::new(),
3687 update_fee: Some(update_fee),
3694 let (res, drop) = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, chan_id, COMMITMENT_UPDATE_ONLY);
3695 if drop { retain_channel = false; }
3703 (retain_channel, NotifyOption::DoPersist, ret_err)
3707 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
3708 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
3709 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
3710 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
3711 pub fn maybe_update_chan_fees(&self) {
3712 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3713 let mut should_persist = NotifyOption::SkipPersist;
3715 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3717 let mut handle_errors = Vec::new();
3719 let mut channel_state_lock = self.channel_state.lock().unwrap();
3720 let channel_state = &mut *channel_state_lock;
3721 let pending_msg_events = &mut channel_state.pending_msg_events;
3722 channel_state.by_id.retain(|chan_id, chan| {
3723 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(pending_msg_events, chan_id, chan, new_feerate);
3724 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3726 handle_errors.push(err);
3736 fn remove_stale_resolved_payments(&self) {
3737 // If an outbound payment was completed, and no pending HTLCs remain, we should remove it
3738 // from the map. However, if we did that immediately when the last payment HTLC is claimed,
3739 // this could race the user making a duplicate send_payment call and our idempotency
3740 // guarantees would be violated. Instead, we wait a few timer ticks to do the actual
3741 // removal. This should be more than sufficient to ensure the idempotency of any
3742 // `send_payment` calls that were made at the same time the `PaymentSent` event was being
3744 let mut pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
3745 let pending_events = self.pending_events.lock().unwrap();
3746 pending_outbound_payments.retain(|payment_id, payment| {
3747 if let PendingOutboundPayment::Fulfilled { session_privs, timer_ticks_without_htlcs, .. } = payment {
3748 let mut no_remaining_entries = session_privs.is_empty();
3749 if no_remaining_entries {
3750 for ev in pending_events.iter() {
3752 events::Event::PaymentSent { payment_id: Some(ev_payment_id), .. } |
3753 events::Event::PaymentPathSuccessful { payment_id: ev_payment_id, .. } |
3754 events::Event::PaymentPathFailed { payment_id: Some(ev_payment_id), .. } => {
3755 if payment_id == ev_payment_id {
3756 no_remaining_entries = false;
3764 if no_remaining_entries {
3765 *timer_ticks_without_htlcs += 1;
3766 *timer_ticks_without_htlcs <= IDEMPOTENCY_TIMEOUT_TICKS
3768 *timer_ticks_without_htlcs = 0;
3775 /// Performs actions which should happen on startup and roughly once per minute thereafter.
3777 /// This currently includes:
3778 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
3779 /// * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
3780 /// than a minute, informing the network that they should no longer attempt to route over
3782 /// * Expiring a channel's previous `ChannelConfig` if necessary to only allow forwarding HTLCs
3783 /// with the current `ChannelConfig`.
3785 /// Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
3786 /// estimate fetches.
3787 pub fn timer_tick_occurred(&self) {
3788 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3789 let mut should_persist = NotifyOption::SkipPersist;
3790 if self.process_background_events() { should_persist = NotifyOption::DoPersist; }
3792 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3794 let mut handle_errors = Vec::new();
3795 let mut timed_out_mpp_htlcs = Vec::new();
3797 let mut channel_state_lock = self.channel_state.lock().unwrap();
3798 let channel_state = &mut *channel_state_lock;
3799 let pending_msg_events = &mut channel_state.pending_msg_events;
3800 channel_state.by_id.retain(|chan_id, chan| {
3801 let counterparty_node_id = chan.get_counterparty_node_id();
3802 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(pending_msg_events, chan_id, chan, new_feerate);
3803 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3805 handle_errors.push((err, counterparty_node_id));
3807 if !retain_channel { return false; }
3809 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
3810 let (needs_close, err) = convert_chan_err!(self, e, chan, chan_id);
3811 handle_errors.push((Err(err), chan.get_counterparty_node_id()));
3812 if needs_close { return false; }
3815 match chan.channel_update_status() {
3816 ChannelUpdateStatus::Enabled if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged),
3817 ChannelUpdateStatus::Disabled if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged),
3818 ChannelUpdateStatus::DisabledStaged if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
3819 ChannelUpdateStatus::EnabledStaged if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
3820 ChannelUpdateStatus::DisabledStaged if !chan.is_live() => {
3821 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3822 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3826 should_persist = NotifyOption::DoPersist;
3827 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
3829 ChannelUpdateStatus::EnabledStaged if chan.is_live() => {
3830 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3831 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3835 should_persist = NotifyOption::DoPersist;
3836 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
3841 chan.maybe_expire_prev_config();
3847 self.claimable_htlcs.lock().unwrap().retain(|payment_hash, (_, htlcs)| {
3848 if htlcs.is_empty() {
3849 // This should be unreachable
3850 debug_assert!(false);
3853 if let OnionPayload::Invoice { .. } = htlcs[0].onion_payload {
3854 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
3855 // In this case we're not going to handle any timeouts of the parts here.
3856 if htlcs[0].total_msat == htlcs.iter().fold(0, |total, htlc| total + htlc.value) {
3858 } else if htlcs.into_iter().any(|htlc| {
3859 htlc.timer_ticks += 1;
3860 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
3862 timed_out_mpp_htlcs.extend(htlcs.drain(..).map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
3869 for htlc_source in timed_out_mpp_htlcs.drain(..) {
3870 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
3871 let reason = HTLCFailReason::from_failure_code(23);
3872 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
3873 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
3876 for (err, counterparty_node_id) in handle_errors.drain(..) {
3877 let _ = handle_error!(self, err, counterparty_node_id);
3880 self.remove_stale_resolved_payments();
3886 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
3887 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
3888 /// along the path (including in our own channel on which we received it).
3890 /// Note that in some cases around unclean shutdown, it is possible the payment may have
3891 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
3892 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
3893 /// may have already been failed automatically by LDK if it was nearing its expiration time.
3895 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
3896 /// [`ChannelManager::claim_funds`]), you should still monitor for
3897 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
3898 /// startup during which time claims that were in-progress at shutdown may be replayed.
3899 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
3900 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3902 let removed_source = self.claimable_htlcs.lock().unwrap().remove(payment_hash);
3903 if let Some((_, mut sources)) = removed_source {
3904 for htlc in sources.drain(..) {
3905 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
3906 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
3907 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
3908 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
3909 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
3910 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
3915 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3916 /// that we want to return and a channel.
3918 /// This is for failures on the channel on which the HTLC was *received*, not failures
3920 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<<K::Target as KeysInterface>::Signer>) -> (u16, Vec<u8>) {
3921 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
3922 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
3923 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
3924 // an inbound SCID alias before the real SCID.
3925 let scid_pref = if chan.should_announce() {
3926 chan.get_short_channel_id().or(chan.latest_inbound_scid_alias())
3928 chan.latest_inbound_scid_alias().or(chan.get_short_channel_id())
3930 if let Some(scid) = scid_pref {
3931 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
3933 (0x4000|10, Vec::new())
3938 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3939 /// that we want to return and a channel.
3940 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>) {
3941 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
3942 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
3943 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
3944 if desired_err_code == 0x1000 | 20 {
3945 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
3946 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
3947 0u16.write(&mut enc).expect("Writes cannot fail");
3949 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
3950 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
3951 upd.write(&mut enc).expect("Writes cannot fail");
3952 (desired_err_code, enc.0)
3954 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
3955 // which means we really shouldn't have gotten a payment to be forwarded over this
3956 // channel yet, or if we did it's from a route hint. Either way, returning an error of
3957 // PERM|no_such_channel should be fine.
3958 (0x4000|10, Vec::new())
3962 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
3963 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
3964 // be surfaced to the user.
3965 fn fail_holding_cell_htlcs(
3966 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32],
3967 counterparty_node_id: &PublicKey
3969 let (failure_code, onion_failure_data) =
3970 match self.channel_state.lock().unwrap().by_id.entry(channel_id) {
3971 hash_map::Entry::Occupied(chan_entry) => {
3972 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan_entry.get())
3974 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
3977 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
3978 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
3979 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
3980 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
3984 /// Fails an HTLC backwards to the sender of it to us.
3985 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
3986 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
3987 #[cfg(debug_assertions)]
3989 // Ensure that the `channel_state` lock is not held when calling this function.
3990 // This ensures that future code doesn't introduce a lock_order requirement for
3991 // `forward_htlcs` to be locked after the `channel_state` lock, which calling this
3992 // function with the `channel_state` locked would.
3993 assert!(self.channel_state.try_lock().is_ok());
3996 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
3997 //identify whether we sent it or not based on the (I presume) very different runtime
3998 //between the branches here. We should make this async and move it into the forward HTLCs
4001 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4002 // from block_connected which may run during initialization prior to the chain_monitor
4003 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
4005 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, ref payment_params, .. } => {
4006 let mut session_priv_bytes = [0; 32];
4007 session_priv_bytes.copy_from_slice(&session_priv[..]);
4008 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
4009 let mut all_paths_failed = false;
4010 let mut full_failure_ev = None;
4011 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(*payment_id) {
4012 if !payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
4013 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
4016 if payment.get().is_fulfilled() {
4017 log_trace!(self.logger, "Received failure of HTLC with payment_hash {} after payment completion", log_bytes!(payment_hash.0));
4020 if payment.get().remaining_parts() == 0 {
4021 all_paths_failed = true;
4022 if payment.get().abandoned() {
4023 full_failure_ev = Some(events::Event::PaymentFailed {
4024 payment_id: *payment_id,
4025 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
4031 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
4034 let mut retry = if let Some(payment_params_data) = payment_params {
4035 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
4036 Some(RouteParameters {
4037 payment_params: payment_params_data.clone(),
4038 final_value_msat: path_last_hop.fee_msat,
4039 final_cltv_expiry_delta: path_last_hop.cltv_expiry_delta,
4042 log_trace!(self.logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
4044 let path_failure = {
4046 let (network_update, short_channel_id, payment_retryable, onion_error_code, onion_error_data) = onion_error.decode_onion_failure(&self.secp_ctx, &self.logger, &source);
4048 let (network_update, short_channel_id, payment_retryable, _, _) = onion_error.decode_onion_failure(&self.secp_ctx, &self.logger, &source);
4050 if self.payment_is_probe(payment_hash, &payment_id) {
4051 if !payment_retryable {
4052 events::Event::ProbeSuccessful {
4053 payment_id: *payment_id,
4054 payment_hash: payment_hash.clone(),
4058 events::Event::ProbeFailed {
4059 payment_id: *payment_id,
4060 payment_hash: payment_hash.clone(),
4066 // TODO: If we decided to blame ourselves (or one of our channels) in
4067 // process_onion_failure we should close that channel as it implies our
4068 // next-hop is needlessly blaming us!
4069 if let Some(scid) = short_channel_id {
4070 retry.as_mut().map(|r| r.payment_params.previously_failed_channels.push(scid));
4072 events::Event::PaymentPathFailed {
4073 payment_id: Some(*payment_id),
4074 payment_hash: payment_hash.clone(),
4075 payment_failed_permanently: !payment_retryable,
4082 error_code: onion_error_code,
4084 error_data: onion_error_data
4088 let mut pending_events = self.pending_events.lock().unwrap();
4089 pending_events.push(path_failure);
4090 if let Some(ev) = full_failure_ev { pending_events.push(ev); }
4092 HTLCSource::PreviousHopData(HTLCPreviousHopData { ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret, ref phantom_shared_secret, ref outpoint }) => {
4093 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with {:?}", log_bytes!(payment_hash.0), onion_error);
4094 let err_packet = onion_error.get_encrypted_failure_packet(incoming_packet_shared_secret, phantom_shared_secret);
4096 let mut forward_event = None;
4097 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
4098 if forward_htlcs.is_empty() {
4099 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
4101 match forward_htlcs.entry(*short_channel_id) {
4102 hash_map::Entry::Occupied(mut entry) => {
4103 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet });
4105 hash_map::Entry::Vacant(entry) => {
4106 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }));
4109 mem::drop(forward_htlcs);
4110 let mut pending_events = self.pending_events.lock().unwrap();
4111 if let Some(time) = forward_event {
4112 pending_events.push(events::Event::PendingHTLCsForwardable {
4113 time_forwardable: time
4116 pending_events.push(events::Event::HTLCHandlingFailed {
4117 prev_channel_id: outpoint.to_channel_id(),
4118 failed_next_destination: destination,
4124 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
4125 /// [`MessageSendEvent`]s needed to claim the payment.
4127 /// Note that calling this method does *not* guarantee that the payment has been claimed. You
4128 /// *must* wait for an [`Event::PaymentClaimed`] event which upon a successful claim will be
4129 /// provided to your [`EventHandler`] when [`process_pending_events`] is next called.
4131 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
4132 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
4133 /// event matches your expectation. If you fail to do so and call this method, you may provide
4134 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
4136 /// [`Event::PaymentClaimable`]: crate::util::events::Event::PaymentClaimable
4137 /// [`Event::PaymentClaimed`]: crate::util::events::Event::PaymentClaimed
4138 /// [`process_pending_events`]: EventsProvider::process_pending_events
4139 /// [`create_inbound_payment`]: Self::create_inbound_payment
4140 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
4141 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
4142 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
4143 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4145 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4147 let removed_source = self.claimable_htlcs.lock().unwrap().remove(&payment_hash);
4148 if let Some((payment_purpose, mut sources)) = removed_source {
4149 assert!(!sources.is_empty());
4151 // If we are claiming an MPP payment, we have to take special care to ensure that each
4152 // channel exists before claiming all of the payments (inside one lock).
4153 // Note that channel existance is sufficient as we should always get a monitor update
4154 // which will take care of the real HTLC claim enforcement.
4156 // If we find an HTLC which we would need to claim but for which we do not have a
4157 // channel, we will fail all parts of the MPP payment. While we could wait and see if
4158 // the sender retries the already-failed path(s), it should be a pretty rare case where
4159 // we got all the HTLCs and then a channel closed while we were waiting for the user to
4160 // provide the preimage, so worrying too much about the optimal handling isn't worth
4162 let mut claimable_amt_msat = 0;
4163 let mut expected_amt_msat = None;
4164 let mut valid_mpp = true;
4165 let mut errs = Vec::new();
4166 let mut claimed_any_htlcs = false;
4167 let mut channel_state_lock = self.channel_state.lock().unwrap();
4168 let channel_state = &mut *channel_state_lock;
4169 let mut receiver_node_id = Some(self.our_network_pubkey);
4170 for htlc in sources.iter() {
4171 let chan_id = match self.short_to_chan_info.read().unwrap().get(&htlc.prev_hop.short_channel_id) {
4172 Some((_cp_id, chan_id)) => chan_id.clone(),
4179 if let None = channel_state.by_id.get(&chan_id) {
4184 if expected_amt_msat.is_some() && expected_amt_msat != Some(htlc.total_msat) {
4185 log_error!(self.logger, "Somehow ended up with an MPP payment with different total amounts - this should not be reachable!");
4186 debug_assert!(false);
4190 expected_amt_msat = Some(htlc.total_msat);
4191 if let OnionPayload::Spontaneous(_) = &htlc.onion_payload {
4192 // We don't currently support MPP for spontaneous payments, so just check
4193 // that there's one payment here and move on.
4194 if sources.len() != 1 {
4195 log_error!(self.logger, "Somehow ended up with an MPP spontaneous payment - this should not be reachable!");
4196 debug_assert!(false);
4201 let phantom_shared_secret = htlc.prev_hop.phantom_shared_secret;
4202 if phantom_shared_secret.is_some() {
4203 let phantom_pubkey = self.keys_manager.get_node_id(Recipient::PhantomNode)
4204 .expect("Failed to get node_id for phantom node recipient");
4205 receiver_node_id = Some(phantom_pubkey)
4208 claimable_amt_msat += htlc.value;
4210 if sources.is_empty() || expected_amt_msat.is_none() {
4211 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
4214 if claimable_amt_msat != expected_amt_msat.unwrap() {
4215 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
4216 expected_amt_msat.unwrap(), claimable_amt_msat);
4220 for htlc in sources.drain(..) {
4221 match self.claim_funds_from_hop(&mut channel_state_lock, htlc.prev_hop, payment_preimage) {
4222 ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) => {
4223 if let msgs::ErrorAction::IgnoreError = err.err.action {
4224 // We got a temporary failure updating monitor, but will claim the
4225 // HTLC when the monitor updating is restored (or on chain).
4226 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
4227 claimed_any_htlcs = true;
4228 } else { errs.push((pk, err)); }
4230 ClaimFundsFromHop::PrevHopForceClosed => unreachable!("We already checked for channel existence, we can't fail here!"),
4231 ClaimFundsFromHop::DuplicateClaim => {
4232 // While we should never get here in most cases, if we do, it likely
4233 // indicates that the HTLC was timed out some time ago and is no longer
4234 // available to be claimed. Thus, it does not make sense to set
4235 // `claimed_any_htlcs`.
4237 ClaimFundsFromHop::Success(_) => claimed_any_htlcs = true,
4241 mem::drop(channel_state_lock);
4243 for htlc in sources.drain(..) {
4244 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
4245 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
4246 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
4247 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
4248 let receiver = HTLCDestination::FailedPayment { payment_hash };
4249 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
4253 if claimed_any_htlcs {
4254 self.pending_events.lock().unwrap().push(events::Event::PaymentClaimed {
4257 purpose: payment_purpose,
4258 amount_msat: claimable_amt_msat,
4262 // Now we can handle any errors which were generated.
4263 for (counterparty_node_id, err) in errs.drain(..) {
4264 let res: Result<(), _> = Err(err);
4265 let _ = handle_error!(self, res, counterparty_node_id);
4270 fn claim_funds_from_hop(&self, channel_state_lock: &mut MutexGuard<ChannelHolder<<K::Target as KeysInterface>::Signer>>, prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage) -> ClaimFundsFromHop {
4271 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
4273 let chan_id = prev_hop.outpoint.to_channel_id();
4274 let channel_state = &mut **channel_state_lock;
4275 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
4276 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
4277 Ok(msgs_monitor_option) => {
4278 if let UpdateFulfillCommitFetch::NewClaim { msgs, htlc_value_msat, monitor_update } = msgs_monitor_option {
4279 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
4280 ChannelMonitorUpdateStatus::Completed => {},
4282 log_given_level!(self.logger, if e == ChannelMonitorUpdateStatus::PermanentFailure { Level::Error } else { Level::Debug },
4283 "Failed to update channel monitor with preimage {:?}: {:?}",
4284 payment_preimage, e);
4285 return ClaimFundsFromHop::MonitorUpdateFail(
4286 chan.get().get_counterparty_node_id(),
4287 handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()).unwrap_err(),
4288 Some(htlc_value_msat)
4292 if let Some((msg, commitment_signed)) = msgs {
4293 log_debug!(self.logger, "Claiming funds for HTLC with preimage {} resulted in a commitment_signed for channel {}",
4294 log_bytes!(payment_preimage.0), log_bytes!(chan.get().channel_id()));
4295 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4296 node_id: chan.get().get_counterparty_node_id(),
4297 updates: msgs::CommitmentUpdate {
4298 update_add_htlcs: Vec::new(),
4299 update_fulfill_htlcs: vec![msg],
4300 update_fail_htlcs: Vec::new(),
4301 update_fail_malformed_htlcs: Vec::new(),
4307 return ClaimFundsFromHop::Success(htlc_value_msat);
4309 return ClaimFundsFromHop::DuplicateClaim;
4312 Err((e, monitor_update)) => {
4313 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
4314 ChannelMonitorUpdateStatus::Completed => {},
4316 log_given_level!(self.logger, if e == ChannelMonitorUpdateStatus::PermanentFailure { Level::Error } else { Level::Info },
4317 "Failed to update channel monitor with preimage {:?} immediately prior to force-close: {:?}",
4318 payment_preimage, e);
4321 let counterparty_node_id = chan.get().get_counterparty_node_id();
4322 let (drop, res) = convert_chan_err!(self, e, chan.get_mut(), &chan_id);
4324 chan.remove_entry();
4326 return ClaimFundsFromHop::MonitorUpdateFail(counterparty_node_id, res, None);
4329 } else { return ClaimFundsFromHop::PrevHopForceClosed }
4332 fn finalize_claims(&self, mut sources: Vec<HTLCSource>) {
4333 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
4334 let mut pending_events = self.pending_events.lock().unwrap();
4335 for source in sources.drain(..) {
4336 if let HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } = source {
4337 let mut session_priv_bytes = [0; 32];
4338 session_priv_bytes.copy_from_slice(&session_priv[..]);
4339 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
4340 assert!(payment.get().is_fulfilled());
4341 if payment.get_mut().remove(&session_priv_bytes, None) {
4342 pending_events.push(
4343 events::Event::PaymentPathSuccessful {
4345 payment_hash: payment.get().payment_hash(),
4355 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]) {
4357 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
4358 mem::drop(channel_state_lock);
4359 let mut session_priv_bytes = [0; 32];
4360 session_priv_bytes.copy_from_slice(&session_priv[..]);
4361 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
4362 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
4363 let mut pending_events = self.pending_events.lock().unwrap();
4364 if !payment.get().is_fulfilled() {
4365 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4366 let fee_paid_msat = payment.get().get_pending_fee_msat();
4367 pending_events.push(
4368 events::Event::PaymentSent {
4369 payment_id: Some(payment_id),
4375 payment.get_mut().mark_fulfilled();
4379 // We currently immediately remove HTLCs which were fulfilled on-chain.
4380 // This could potentially lead to removing a pending payment too early,
4381 // with a reorg of one block causing us to re-add the fulfilled payment on
4383 // TODO: We should have a second monitor event that informs us of payments
4384 // irrevocably fulfilled.
4385 if payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
4386 let payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0).into_inner()));
4387 pending_events.push(
4388 events::Event::PaymentPathSuccessful {
4397 log_trace!(self.logger, "Received duplicative fulfill for HTLC with payment_preimage {}", log_bytes!(payment_preimage.0));
4400 HTLCSource::PreviousHopData(hop_data) => {
4401 let prev_outpoint = hop_data.outpoint;
4402 let res = self.claim_funds_from_hop(&mut channel_state_lock, hop_data, payment_preimage);
4403 let claimed_htlc = if let ClaimFundsFromHop::DuplicateClaim = res { false } else { true };
4404 let htlc_claim_value_msat = match res {
4405 ClaimFundsFromHop::MonitorUpdateFail(_, _, amt_opt) => amt_opt,
4406 ClaimFundsFromHop::Success(amt) => Some(amt),
4409 if let ClaimFundsFromHop::PrevHopForceClosed = res {
4410 let preimage_update = ChannelMonitorUpdate {
4411 update_id: CLOSED_CHANNEL_UPDATE_ID,
4412 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
4413 payment_preimage: payment_preimage.clone(),
4416 // We update the ChannelMonitor on the backward link, after
4417 // receiving an offchain preimage event from the forward link (the
4418 // event being update_fulfill_htlc).
4419 let update_res = self.chain_monitor.update_channel(prev_outpoint, preimage_update);
4420 if update_res != ChannelMonitorUpdateStatus::Completed {
4421 // TODO: This needs to be handled somehow - if we receive a monitor update
4422 // with a preimage we *must* somehow manage to propagate it to the upstream
4423 // channel, or we must have an ability to receive the same event and try
4424 // again on restart.
4425 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
4426 payment_preimage, update_res);
4428 // Note that we do *not* set `claimed_htlc` to false here. In fact, this
4429 // totally could be a duplicate claim, but we have no way of knowing
4430 // without interrogating the `ChannelMonitor` we've provided the above
4431 // update to. Instead, we simply document in `PaymentForwarded` that this
4434 mem::drop(channel_state_lock);
4435 if let ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) = res {
4436 let result: Result<(), _> = Err(err);
4437 let _ = handle_error!(self, result, pk);
4441 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
4442 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
4443 Some(claimed_htlc_value - forwarded_htlc_value)
4446 let mut pending_events = self.pending_events.lock().unwrap();
4447 let prev_channel_id = Some(prev_outpoint.to_channel_id());
4448 let next_channel_id = Some(next_channel_id);
4450 pending_events.push(events::Event::PaymentForwarded {
4452 claim_from_onchain_tx: from_onchain,
4462 /// Gets the node_id held by this ChannelManager
4463 pub fn get_our_node_id(&self) -> PublicKey {
4464 self.our_network_pubkey.clone()
4467 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
4468 /// update completion.
4469 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
4470 channel: &mut Channel<<K::Target as KeysInterface>::Signer>, raa: Option<msgs::RevokeAndACK>,
4471 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
4472 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
4473 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
4474 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
4475 let mut htlc_forwards = None;
4477 let counterparty_node_id = channel.get_counterparty_node_id();
4478 if !pending_forwards.is_empty() {
4479 htlc_forwards = Some((channel.get_short_channel_id().unwrap_or(channel.outbound_scid_alias()),
4480 channel.get_funding_txo().unwrap(), channel.get_user_id(), pending_forwards));
4483 if let Some(msg) = channel_ready {
4484 send_channel_ready!(self, pending_msg_events, channel, msg);
4486 if let Some(msg) = announcement_sigs {
4487 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4488 node_id: counterparty_node_id,
4493 emit_channel_ready_event!(self, channel);
4495 macro_rules! handle_cs { () => {
4496 if let Some(update) = commitment_update {
4497 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4498 node_id: counterparty_node_id,
4503 macro_rules! handle_raa { () => {
4504 if let Some(revoke_and_ack) = raa {
4505 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
4506 node_id: counterparty_node_id,
4507 msg: revoke_and_ack,
4512 RAACommitmentOrder::CommitmentFirst => {
4516 RAACommitmentOrder::RevokeAndACKFirst => {
4522 if let Some(tx) = funding_broadcastable {
4523 log_info!(self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
4524 self.tx_broadcaster.broadcast_transaction(&tx);
4530 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64) {
4531 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4534 let (mut pending_failures, finalized_claims, counterparty_node_id) = {
4535 let mut channel_lock = self.channel_state.lock().unwrap();
4536 let channel_state = &mut *channel_lock;
4537 let mut channel = match channel_state.by_id.entry(funding_txo.to_channel_id()) {
4538 hash_map::Entry::Occupied(chan) => chan,
4539 hash_map::Entry::Vacant(_) => return,
4541 if !channel.get().is_awaiting_monitor_update() || channel.get().get_latest_monitor_update_id() != highest_applied_update_id {
4545 let counterparty_node_id = channel.get().get_counterparty_node_id();
4546 let updates = channel.get_mut().monitor_updating_restored(&self.logger, self.get_our_node_id(), self.genesis_hash, self.best_block.read().unwrap().height());
4547 let channel_update = if updates.channel_ready.is_some() && channel.get().is_usable() {
4548 // We only send a channel_update in the case where we are just now sending a
4549 // channel_ready and the channel is in a usable state. We may re-send a
4550 // channel_update later through the announcement_signatures process for public
4551 // channels, but there's no reason not to just inform our counterparty of our fees
4553 if let Ok(msg) = self.get_channel_update_for_unicast(channel.get()) {
4554 Some(events::MessageSendEvent::SendChannelUpdate {
4555 node_id: channel.get().get_counterparty_node_id(),
4560 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);
4561 if let Some(upd) = channel_update {
4562 channel_state.pending_msg_events.push(upd);
4565 (updates.failed_htlcs, updates.finalized_claimed_htlcs, counterparty_node_id)
4567 if let Some(forwards) = htlc_forwards {
4568 self.forward_htlcs(&mut [forwards][..]);
4570 self.finalize_claims(finalized_claims);
4571 for failure in pending_failures.drain(..) {
4572 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id: funding_txo.to_channel_id() };
4573 self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
4577 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
4579 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
4580 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
4583 /// The `user_channel_id` parameter will be provided back in
4584 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4585 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4587 /// Note that this method will return an error and reject the channel, if it requires support
4588 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
4589 /// used to accept such channels.
4591 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4592 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4593 pub fn accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
4594 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
4597 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
4598 /// it as confirmed immediately.
4600 /// The `user_channel_id` parameter will be provided back in
4601 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4602 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4604 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
4605 /// and (if the counterparty agrees), enables forwarding of payments immediately.
4607 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
4608 /// transaction and blindly assumes that it will eventually confirm.
4610 /// If it does not confirm before we decide to close the channel, or if the funding transaction
4611 /// does not pay to the correct script the correct amount, *you will lose funds*.
4613 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4614 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4615 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> {
4616 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
4619 fn do_accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
4620 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4622 let mut channel_state_lock = self.channel_state.lock().unwrap();
4623 let channel_state = &mut *channel_state_lock;
4624 match channel_state.by_id.entry(temporary_channel_id.clone()) {
4625 hash_map::Entry::Occupied(mut channel) => {
4626 if !channel.get().inbound_is_awaiting_accept() {
4627 return Err(APIError::APIMisuseError { err: "The channel isn't currently awaiting to be accepted.".to_owned() });
4629 if *counterparty_node_id != channel.get().get_counterparty_node_id() {
4630 return Err(APIError::APIMisuseError { err: "The passed counterparty_node_id doesn't match the channel's counterparty node_id".to_owned() });
4633 channel.get_mut().set_0conf();
4634 } else if channel.get().get_channel_type().requires_zero_conf() {
4635 let send_msg_err_event = events::MessageSendEvent::HandleError {
4636 node_id: channel.get().get_counterparty_node_id(),
4637 action: msgs::ErrorAction::SendErrorMessage{
4638 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
4641 channel_state.pending_msg_events.push(send_msg_err_event);
4642 let _ = remove_channel!(self, channel);
4643 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
4646 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4647 node_id: channel.get().get_counterparty_node_id(),
4648 msg: channel.get_mut().accept_inbound_channel(user_channel_id),
4651 hash_map::Entry::Vacant(_) => {
4652 return Err(APIError::ChannelUnavailable { err: "Can't accept a channel that doesn't exist".to_owned() });
4658 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
4659 if msg.chain_hash != self.genesis_hash {
4660 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
4663 if !self.default_configuration.accept_inbound_channels {
4664 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4667 let mut random_bytes = [0u8; 16];
4668 random_bytes.copy_from_slice(&self.keys_manager.get_secure_random_bytes()[..16]);
4669 let user_channel_id = u128::from_be_bytes(random_bytes);
4671 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
4672 let mut channel = match Channel::new_from_req(&self.fee_estimator, &self.keys_manager,
4673 counterparty_node_id.clone(), &their_features, msg, user_channel_id, &self.default_configuration,
4674 self.best_block.read().unwrap().height(), &self.logger, outbound_scid_alias)
4677 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4678 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
4682 let mut channel_state_lock = self.channel_state.lock().unwrap();
4683 let channel_state = &mut *channel_state_lock;
4684 match channel_state.by_id.entry(channel.channel_id()) {
4685 hash_map::Entry::Occupied(_) => {
4686 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4687 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!".to_owned(), msg.temporary_channel_id.clone()))
4689 hash_map::Entry::Vacant(entry) => {
4690 if !self.default_configuration.manually_accept_inbound_channels {
4691 if channel.get_channel_type().requires_zero_conf() {
4692 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4694 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4695 node_id: counterparty_node_id.clone(),
4696 msg: channel.accept_inbound_channel(user_channel_id),
4699 let mut pending_events = self.pending_events.lock().unwrap();
4700 pending_events.push(
4701 events::Event::OpenChannelRequest {
4702 temporary_channel_id: msg.temporary_channel_id.clone(),
4703 counterparty_node_id: counterparty_node_id.clone(),
4704 funding_satoshis: msg.funding_satoshis,
4705 push_msat: msg.push_msat,
4706 channel_type: channel.get_channel_type().clone(),
4711 entry.insert(channel);
4717 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
4718 let (value, output_script, user_id) = {
4719 let mut channel_lock = self.channel_state.lock().unwrap();
4720 let channel_state = &mut *channel_lock;
4721 match channel_state.by_id.entry(msg.temporary_channel_id) {
4722 hash_map::Entry::Occupied(mut chan) => {
4723 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4724 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
4726 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &their_features), chan);
4727 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
4729 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
4732 let mut pending_events = self.pending_events.lock().unwrap();
4733 pending_events.push(events::Event::FundingGenerationReady {
4734 temporary_channel_id: msg.temporary_channel_id,
4735 counterparty_node_id: *counterparty_node_id,
4736 channel_value_satoshis: value,
4738 user_channel_id: user_id,
4743 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
4744 let ((funding_msg, monitor, mut channel_ready), mut chan) = {
4745 let best_block = *self.best_block.read().unwrap();
4746 let mut channel_lock = self.channel_state.lock().unwrap();
4747 let channel_state = &mut *channel_lock;
4748 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
4749 hash_map::Entry::Occupied(mut chan) => {
4750 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4751 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
4753 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.keys_manager, &self.logger), chan), chan.remove())
4755 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
4758 // Because we have exclusive ownership of the channel here we can release the channel_state
4759 // lock before watch_channel
4760 match self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
4761 ChannelMonitorUpdateStatus::Completed => {},
4762 ChannelMonitorUpdateStatus::PermanentFailure => {
4763 // Note that we reply with the new channel_id in error messages if we gave up on the
4764 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
4765 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
4766 // any messages referencing a previously-closed channel anyway.
4767 // We do not propagate the monitor update to the user as it would be for a monitor
4768 // that we didn't manage to store (and that we don't care about - we don't respond
4769 // with the funding_signed so the channel can never go on chain).
4770 let (_monitor_update, failed_htlcs) = chan.force_shutdown(false);
4771 assert!(failed_htlcs.is_empty());
4772 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
4774 ChannelMonitorUpdateStatus::InProgress => {
4775 // There's no problem signing a counterparty's funding transaction if our monitor
4776 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
4777 // accepted payment from yet. We do, however, need to wait to send our channel_ready
4778 // until we have persisted our monitor.
4779 chan.monitor_updating_paused(false, false, channel_ready.is_some(), Vec::new(), Vec::new(), Vec::new());
4780 channel_ready = None; // Don't send the channel_ready now
4783 let mut channel_state_lock = self.channel_state.lock().unwrap();
4784 let channel_state = &mut *channel_state_lock;
4785 match channel_state.by_id.entry(funding_msg.channel_id) {
4786 hash_map::Entry::Occupied(_) => {
4787 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
4789 hash_map::Entry::Vacant(e) => {
4790 let mut id_to_peer = self.id_to_peer.lock().unwrap();
4791 match id_to_peer.entry(chan.channel_id()) {
4792 hash_map::Entry::Occupied(_) => {
4793 return Err(MsgHandleErrInternal::send_err_msg_no_close(
4794 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
4795 funding_msg.channel_id))
4797 hash_map::Entry::Vacant(i_e) => {
4798 i_e.insert(chan.get_counterparty_node_id());
4801 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
4802 node_id: counterparty_node_id.clone(),
4805 if let Some(msg) = channel_ready {
4806 send_channel_ready!(self, channel_state.pending_msg_events, chan, msg);
4814 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
4816 let best_block = *self.best_block.read().unwrap();
4817 let mut channel_lock = self.channel_state.lock().unwrap();
4818 let channel_state = &mut *channel_lock;
4819 match channel_state.by_id.entry(msg.channel_id) {
4820 hash_map::Entry::Occupied(mut chan) => {
4821 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4822 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4824 let (monitor, funding_tx, channel_ready) = match chan.get_mut().funding_signed(&msg, best_block, &self.keys_manager, &self.logger) {
4825 Ok(update) => update,
4826 Err(e) => try_chan_entry!(self, Err(e), chan),
4828 match self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
4829 ChannelMonitorUpdateStatus::Completed => {},
4831 let mut res = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::RevokeAndACKFirst, channel_ready.is_some(), OPTIONALLY_RESEND_FUNDING_LOCKED);
4832 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
4833 // We weren't able to watch the channel to begin with, so no updates should be made on
4834 // it. Previously, full_stack_target found an (unreachable) panic when the
4835 // monitor update contained within `shutdown_finish` was applied.
4836 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
4837 shutdown_finish.0.take();
4843 if let Some(msg) = channel_ready {
4844 send_channel_ready!(self, channel_state.pending_msg_events, chan.get(), msg);
4848 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4851 log_info!(self.logger, "Broadcasting funding transaction with txid {}", funding_tx.txid());
4852 self.tx_broadcaster.broadcast_transaction(&funding_tx);
4856 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
4857 let mut channel_state_lock = self.channel_state.lock().unwrap();
4858 let channel_state = &mut *channel_state_lock;
4859 match channel_state.by_id.entry(msg.channel_id) {
4860 hash_map::Entry::Occupied(mut chan) => {
4861 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4862 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4864 let announcement_sigs_opt = try_chan_entry!(self, chan.get_mut().channel_ready(&msg, self.get_our_node_id(),
4865 self.genesis_hash.clone(), &self.best_block.read().unwrap(), &self.logger), chan);
4866 if let Some(announcement_sigs) = announcement_sigs_opt {
4867 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(chan.get().channel_id()));
4868 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4869 node_id: counterparty_node_id.clone(),
4870 msg: announcement_sigs,
4872 } else if chan.get().is_usable() {
4873 // If we're sending an announcement_signatures, we'll send the (public)
4874 // channel_update after sending a channel_announcement when we receive our
4875 // counterparty's announcement_signatures. Thus, we only bother to send a
4876 // channel_update here if the channel is not public, i.e. we're not sending an
4877 // announcement_signatures.
4878 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", log_bytes!(chan.get().channel_id()));
4879 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
4880 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4881 node_id: counterparty_node_id.clone(),
4887 emit_channel_ready_event!(self, chan.get_mut());
4891 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4895 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
4896 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
4897 let result: Result<(), _> = loop {
4898 let mut channel_state_lock = self.channel_state.lock().unwrap();
4899 let channel_state = &mut *channel_state_lock;
4901 match channel_state.by_id.entry(msg.channel_id.clone()) {
4902 hash_map::Entry::Occupied(mut chan_entry) => {
4903 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
4904 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4907 if !chan_entry.get().received_shutdown() {
4908 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
4909 log_bytes!(msg.channel_id),
4910 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
4913 let (shutdown, monitor_update, htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&self.keys_manager, &their_features, &msg), chan_entry);
4914 dropped_htlcs = htlcs;
4916 // Update the monitor with the shutdown script if necessary.
4917 if let Some(monitor_update) = monitor_update {
4918 let update_res = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update);
4919 let (result, is_permanent) =
4920 handle_monitor_update_res!(self, update_res, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
4922 remove_channel!(self, chan_entry);
4927 if let Some(msg) = shutdown {
4928 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
4929 node_id: *counterparty_node_id,
4936 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4939 for htlc_source in dropped_htlcs.drain(..) {
4940 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
4941 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
4942 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
4945 let _ = handle_error!(self, result, *counterparty_node_id);
4949 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
4950 let (tx, chan_option) = {
4951 let mut channel_state_lock = self.channel_state.lock().unwrap();
4952 let channel_state = &mut *channel_state_lock;
4953 match channel_state.by_id.entry(msg.channel_id.clone()) {
4954 hash_map::Entry::Occupied(mut chan_entry) => {
4955 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
4956 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4958 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), chan_entry);
4959 if let Some(msg) = closing_signed {
4960 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
4961 node_id: counterparty_node_id.clone(),
4966 // We're done with this channel, we've got a signed closing transaction and
4967 // will send the closing_signed back to the remote peer upon return. This
4968 // also implies there are no pending HTLCs left on the channel, so we can
4969 // fully delete it from tracking (the channel monitor is still around to
4970 // watch for old state broadcasts)!
4971 (tx, Some(remove_channel!(self, chan_entry)))
4972 } else { (tx, None) }
4974 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4977 if let Some(broadcast_tx) = tx {
4978 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
4979 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
4981 if let Some(chan) = chan_option {
4982 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4983 let mut channel_state = self.channel_state.lock().unwrap();
4984 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4988 self.issue_channel_close_events(&chan, ClosureReason::CooperativeClosure);
4993 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
4994 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
4995 //determine the state of the payment based on our response/if we forward anything/the time
4996 //we take to respond. We should take care to avoid allowing such an attack.
4998 //TODO: There exists a further attack where a node may garble the onion data, forward it to
4999 //us repeatedly garbled in different ways, and compare our error messages, which are
5000 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
5001 //but we should prevent it anyway.
5003 let pending_forward_info = self.decode_update_add_htlc_onion(msg);
5004 let mut channel_state_lock = self.channel_state.lock().unwrap();
5005 let channel_state = &mut *channel_state_lock;
5007 match channel_state.by_id.entry(msg.channel_id) {
5008 hash_map::Entry::Occupied(mut chan) => {
5009 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5010 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5013 let create_pending_htlc_status = |chan: &Channel<<K::Target as KeysInterface>::Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
5014 // If the update_add is completely bogus, the call will Err and we will close,
5015 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
5016 // want to reject the new HTLC and fail it backwards instead of forwarding.
5017 match pending_forward_info {
5018 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
5019 let reason = if (error_code & 0x1000) != 0 {
5020 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
5021 HTLCFailReason::reason(real_code, error_data)
5023 HTLCFailReason::from_failure_code(error_code)
5024 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
5025 let msg = msgs::UpdateFailHTLC {
5026 channel_id: msg.channel_id,
5027 htlc_id: msg.htlc_id,
5030 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
5032 _ => pending_forward_info
5035 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), chan);
5037 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5042 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
5043 let mut channel_lock = self.channel_state.lock().unwrap();
5044 let (htlc_source, forwarded_htlc_value) = {
5045 let channel_state = &mut *channel_lock;
5046 match channel_state.by_id.entry(msg.channel_id) {
5047 hash_map::Entry::Occupied(mut chan) => {
5048 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5049 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5051 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), chan)
5053 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5056 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, msg.channel_id);
5060 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
5061 let mut channel_lock = self.channel_state.lock().unwrap();
5062 let channel_state = &mut *channel_lock;
5063 match channel_state.by_id.entry(msg.channel_id) {
5064 hash_map::Entry::Occupied(mut chan) => {
5065 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5066 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5068 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan);
5070 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5075 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
5076 let mut channel_lock = self.channel_state.lock().unwrap();
5077 let channel_state = &mut *channel_lock;
5078 match channel_state.by_id.entry(msg.channel_id) {
5079 hash_map::Entry::Occupied(mut chan) => {
5080 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5081 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5083 if (msg.failure_code & 0x8000) == 0 {
5084 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
5085 try_chan_entry!(self, Err(chan_err), chan);
5087 try_chan_entry!(self, chan.get_mut().update_fail_malformed_htlc(&msg, HTLCFailReason::reason(msg.failure_code, msg.sha256_of_onion.to_vec())), chan);
5090 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5094 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
5095 let mut channel_state_lock = self.channel_state.lock().unwrap();
5096 let channel_state = &mut *channel_state_lock;
5097 match channel_state.by_id.entry(msg.channel_id) {
5098 hash_map::Entry::Occupied(mut chan) => {
5099 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5100 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5102 let (revoke_and_ack, commitment_signed, monitor_update) =
5103 match chan.get_mut().commitment_signed(&msg, &self.logger) {
5104 Err((None, e)) => try_chan_entry!(self, Err(e), chan),
5105 Err((Some(update), e)) => {
5106 assert!(chan.get().is_awaiting_monitor_update());
5107 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), update);
5108 try_chan_entry!(self, Err(e), chan);
5113 let update_res = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update);
5114 if let Err(e) = handle_monitor_update_res!(self, update_res, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some()) {
5118 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
5119 node_id: counterparty_node_id.clone(),
5120 msg: revoke_and_ack,
5122 if let Some(msg) = commitment_signed {
5123 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5124 node_id: counterparty_node_id.clone(),
5125 updates: msgs::CommitmentUpdate {
5126 update_add_htlcs: Vec::new(),
5127 update_fulfill_htlcs: Vec::new(),
5128 update_fail_htlcs: Vec::new(),
5129 update_fail_malformed_htlcs: Vec::new(),
5131 commitment_signed: msg,
5137 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5142 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
5143 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
5144 let mut forward_event = None;
5145 let mut new_intercept_events = Vec::new();
5146 let mut failed_intercept_forwards = Vec::new();
5147 if !pending_forwards.is_empty() {
5148 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
5149 let scid = match forward_info.routing {
5150 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
5151 PendingHTLCRouting::Receive { .. } => 0,
5152 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
5154 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
5155 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
5157 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
5158 let forward_htlcs_empty = forward_htlcs.is_empty();
5159 match forward_htlcs.entry(scid) {
5160 hash_map::Entry::Occupied(mut entry) => {
5161 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
5162 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
5164 hash_map::Entry::Vacant(entry) => {
5165 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
5166 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.genesis_hash)
5168 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).into_inner());
5169 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
5170 match pending_intercepts.entry(intercept_id) {
5171 hash_map::Entry::Vacant(entry) => {
5172 new_intercept_events.push(events::Event::HTLCIntercepted {
5173 requested_next_hop_scid: scid,
5174 payment_hash: forward_info.payment_hash,
5175 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
5176 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
5179 entry.insert(PendingAddHTLCInfo {
5180 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
5182 hash_map::Entry::Occupied(_) => {
5183 log_info!(self.logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
5184 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
5185 short_channel_id: prev_short_channel_id,
5186 outpoint: prev_funding_outpoint,
5187 htlc_id: prev_htlc_id,
5188 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
5189 phantom_shared_secret: None,
5192 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
5193 HTLCFailReason::from_failure_code(0x4000 | 10),
5194 HTLCDestination::InvalidForward { requested_forward_scid: scid },
5199 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
5200 // payments are being processed.
5201 if forward_htlcs_empty {
5202 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
5204 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
5205 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
5212 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
5213 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
5216 if !new_intercept_events.is_empty() {
5217 let mut events = self.pending_events.lock().unwrap();
5218 events.append(&mut new_intercept_events);
5221 match forward_event {
5223 let mut pending_events = self.pending_events.lock().unwrap();
5224 pending_events.push(events::Event::PendingHTLCsForwardable {
5225 time_forwardable: time
5233 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
5234 let mut htlcs_to_fail = Vec::new();
5236 let mut channel_state_lock = self.channel_state.lock().unwrap();
5237 let channel_state = &mut *channel_state_lock;
5238 match channel_state.by_id.entry(msg.channel_id) {
5239 hash_map::Entry::Occupied(mut chan) => {
5240 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5241 break Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5243 let was_paused_for_mon_update = chan.get().is_awaiting_monitor_update();
5244 let raa_updates = break_chan_entry!(self,
5245 chan.get_mut().revoke_and_ack(&msg, &self.logger), chan);
5246 htlcs_to_fail = raa_updates.holding_cell_failed_htlcs;
5247 let update_res = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), raa_updates.monitor_update);
5248 if was_paused_for_mon_update {
5249 assert!(update_res != ChannelMonitorUpdateStatus::Completed);
5250 assert!(raa_updates.commitment_update.is_none());
5251 assert!(raa_updates.accepted_htlcs.is_empty());
5252 assert!(raa_updates.failed_htlcs.is_empty());
5253 assert!(raa_updates.finalized_claimed_htlcs.is_empty());
5254 break Err(MsgHandleErrInternal::ignore_no_close("Existing pending monitor update prevented responses to RAA".to_owned()));
5256 if update_res != ChannelMonitorUpdateStatus::Completed {
5257 if let Err(e) = handle_monitor_update_res!(self, update_res, chan,
5258 RAACommitmentOrder::CommitmentFirst, false,
5259 raa_updates.commitment_update.is_some(), false,
5260 raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
5261 raa_updates.finalized_claimed_htlcs) {
5263 } else { unreachable!(); }
5265 if let Some(updates) = raa_updates.commitment_update {
5266 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5267 node_id: counterparty_node_id.clone(),
5271 break Ok((raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
5272 raa_updates.finalized_claimed_htlcs,
5273 chan.get().get_short_channel_id()
5274 .unwrap_or(chan.get().outbound_scid_alias()),
5275 chan.get().get_funding_txo().unwrap(),
5276 chan.get().get_user_id()))
5278 hash_map::Entry::Vacant(_) => break Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5281 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
5283 Ok((pending_forwards, mut pending_failures, finalized_claim_htlcs,
5284 short_channel_id, channel_outpoint, user_channel_id)) =>
5286 for failure in pending_failures.drain(..) {
5287 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: channel_outpoint.to_channel_id() };
5288 self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
5290 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, user_channel_id, pending_forwards)]);
5291 self.finalize_claims(finalized_claim_htlcs);
5298 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
5299 let mut channel_lock = self.channel_state.lock().unwrap();
5300 let channel_state = &mut *channel_lock;
5301 match channel_state.by_id.entry(msg.channel_id) {
5302 hash_map::Entry::Occupied(mut chan) => {
5303 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5304 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5306 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg, &self.logger), chan);
5308 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5313 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
5314 let mut channel_state_lock = self.channel_state.lock().unwrap();
5315 let channel_state = &mut *channel_state_lock;
5317 match channel_state.by_id.entry(msg.channel_id) {
5318 hash_map::Entry::Occupied(mut chan) => {
5319 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5320 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5322 if !chan.get().is_usable() {
5323 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
5326 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5327 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(
5328 self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height(), msg), chan),
5329 // Note that announcement_signatures fails if the channel cannot be announced,
5330 // so get_channel_update_for_broadcast will never fail by the time we get here.
5331 update_msg: self.get_channel_update_for_broadcast(chan.get()).unwrap(),
5334 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5339 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
5340 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
5341 let chan_id = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
5342 Some((_cp_id, chan_id)) => chan_id.clone(),
5344 // It's not a local channel
5345 return Ok(NotifyOption::SkipPersist)
5348 let mut channel_state_lock = self.channel_state.lock().unwrap();
5349 let channel_state = &mut *channel_state_lock;
5350 match channel_state.by_id.entry(chan_id) {
5351 hash_map::Entry::Occupied(mut chan) => {
5352 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5353 if chan.get().should_announce() {
5354 // If the announcement is about a channel of ours which is public, some
5355 // other peer may simply be forwarding all its gossip to us. Don't provide
5356 // a scary-looking error message and return Ok instead.
5357 return Ok(NotifyOption::SkipPersist);
5359 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));
5361 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().get_counterparty_node_id().serialize()[..];
5362 let msg_from_node_one = msg.contents.flags & 1 == 0;
5363 if were_node_one == msg_from_node_one {
5364 return Ok(NotifyOption::SkipPersist);
5366 log_debug!(self.logger, "Received channel_update for channel {}.", log_bytes!(chan_id));
5367 try_chan_entry!(self, chan.get_mut().channel_update(&msg), chan);
5370 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersist)
5372 Ok(NotifyOption::DoPersist)
5375 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
5377 let need_lnd_workaround = {
5378 let mut channel_state_lock = self.channel_state.lock().unwrap();
5379 let channel_state = &mut *channel_state_lock;
5381 match channel_state.by_id.entry(msg.channel_id) {
5382 hash_map::Entry::Occupied(mut chan) => {
5383 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5384 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5386 // Currently, we expect all holding cell update_adds to be dropped on peer
5387 // disconnect, so Channel's reestablish will never hand us any holding cell
5388 // freed HTLCs to fail backwards. If in the future we no longer drop pending
5389 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
5390 let responses = try_chan_entry!(self, chan.get_mut().channel_reestablish(
5391 msg, &self.logger, self.our_network_pubkey.clone(), self.genesis_hash,
5392 &*self.best_block.read().unwrap()), chan);
5393 let mut channel_update = None;
5394 if let Some(msg) = responses.shutdown_msg {
5395 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5396 node_id: counterparty_node_id.clone(),
5399 } else if chan.get().is_usable() {
5400 // If the channel is in a usable state (ie the channel is not being shut
5401 // down), send a unicast channel_update to our counterparty to make sure
5402 // they have the latest channel parameters.
5403 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
5404 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
5405 node_id: chan.get().get_counterparty_node_id(),
5410 let need_lnd_workaround = chan.get_mut().workaround_lnd_bug_4006.take();
5411 htlc_forwards = self.handle_channel_resumption(
5412 &mut channel_state.pending_msg_events, chan.get_mut(), responses.raa, responses.commitment_update, responses.order,
5413 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
5414 if let Some(upd) = channel_update {
5415 channel_state.pending_msg_events.push(upd);
5419 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5423 if let Some(forwards) = htlc_forwards {
5424 self.forward_htlcs(&mut [forwards][..]);
5427 if let Some(channel_ready_msg) = need_lnd_workaround {
5428 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
5433 /// Process pending events from the `chain::Watch`, returning whether any events were processed.
5434 fn process_pending_monitor_events(&self) -> bool {
5435 let mut failed_channels = Vec::new();
5436 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
5437 let has_pending_monitor_events = !pending_monitor_events.is_empty();
5438 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
5439 for monitor_event in monitor_events.drain(..) {
5440 match monitor_event {
5441 MonitorEvent::HTLCEvent(htlc_update) => {
5442 if let Some(preimage) = htlc_update.payment_preimage {
5443 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
5444 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());
5446 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
5447 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
5448 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
5449 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
5452 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
5453 MonitorEvent::UpdateFailed(funding_outpoint) => {
5454 let mut channel_lock = self.channel_state.lock().unwrap();
5455 let channel_state = &mut *channel_lock;
5456 let by_id = &mut channel_state.by_id;
5457 let pending_msg_events = &mut channel_state.pending_msg_events;
5458 if let hash_map::Entry::Occupied(chan_entry) = by_id.entry(funding_outpoint.to_channel_id()) {
5459 let mut chan = remove_channel!(self, chan_entry);
5460 failed_channels.push(chan.force_shutdown(false));
5461 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5462 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5466 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
5467 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
5469 ClosureReason::CommitmentTxConfirmed
5471 self.issue_channel_close_events(&chan, reason);
5472 pending_msg_events.push(events::MessageSendEvent::HandleError {
5473 node_id: chan.get_counterparty_node_id(),
5474 action: msgs::ErrorAction::SendErrorMessage {
5475 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
5480 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
5481 self.channel_monitor_updated(&funding_txo, monitor_update_id);
5487 for failure in failed_channels.drain(..) {
5488 self.finish_force_close_channel(failure);
5491 has_pending_monitor_events
5494 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
5495 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
5496 /// update events as a separate process method here.
5498 pub fn process_monitor_events(&self) {
5499 self.process_pending_monitor_events();
5502 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
5503 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
5504 /// update was applied.
5506 /// This should only apply to HTLCs which were added to the holding cell because we were
5507 /// waiting on a monitor update to finish. In that case, we don't want to free the holding cell
5508 /// directly in `channel_monitor_updated` as it may introduce deadlocks calling back into user
5509 /// code to inform them of a channel monitor update.
5510 fn check_free_holding_cells(&self) -> bool {
5511 let mut has_monitor_update = false;
5512 let mut failed_htlcs = Vec::new();
5513 let mut handle_errors = Vec::new();
5515 let mut channel_state_lock = self.channel_state.lock().unwrap();
5516 let channel_state = &mut *channel_state_lock;
5517 let by_id = &mut channel_state.by_id;
5518 let pending_msg_events = &mut channel_state.pending_msg_events;
5520 by_id.retain(|channel_id, chan| {
5521 match chan.maybe_free_holding_cell_htlcs(&self.logger) {
5522 Ok((commitment_opt, holding_cell_failed_htlcs)) => {
5523 if !holding_cell_failed_htlcs.is_empty() {
5525 holding_cell_failed_htlcs,
5527 chan.get_counterparty_node_id()
5530 if let Some((commitment_update, monitor_update)) = commitment_opt {
5531 match self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
5532 ChannelMonitorUpdateStatus::Completed => {
5533 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5534 node_id: chan.get_counterparty_node_id(),
5535 updates: commitment_update,
5539 has_monitor_update = true;
5540 let (res, close_channel) = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, channel_id, COMMITMENT_UPDATE_ONLY);
5541 handle_errors.push((chan.get_counterparty_node_id(), res));
5542 if close_channel { return false; }
5549 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
5550 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5551 // ChannelClosed event is generated by handle_error for us
5558 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
5559 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
5560 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
5563 for (counterparty_node_id, err) in handle_errors.drain(..) {
5564 let _ = handle_error!(self, err, counterparty_node_id);
5570 /// Check whether any channels have finished removing all pending updates after a shutdown
5571 /// exchange and can now send a closing_signed.
5572 /// Returns whether any closing_signed messages were generated.
5573 fn maybe_generate_initial_closing_signed(&self) -> bool {
5574 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
5575 let mut has_update = false;
5577 let mut channel_state_lock = self.channel_state.lock().unwrap();
5578 let channel_state = &mut *channel_state_lock;
5579 let by_id = &mut channel_state.by_id;
5580 let pending_msg_events = &mut channel_state.pending_msg_events;
5582 by_id.retain(|channel_id, chan| {
5583 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
5584 Ok((msg_opt, tx_opt)) => {
5585 if let Some(msg) = msg_opt {
5587 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5588 node_id: chan.get_counterparty_node_id(), msg,
5591 if let Some(tx) = tx_opt {
5592 // We're done with this channel. We got a closing_signed and sent back
5593 // a closing_signed with a closing transaction to broadcast.
5594 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5595 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5600 self.issue_channel_close_events(chan, ClosureReason::CooperativeClosure);
5602 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
5603 self.tx_broadcaster.broadcast_transaction(&tx);
5604 update_maps_on_chan_removal!(self, chan);
5610 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
5611 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5618 for (counterparty_node_id, err) in handle_errors.drain(..) {
5619 let _ = handle_error!(self, err, counterparty_node_id);
5625 /// Handle a list of channel failures during a block_connected or block_disconnected call,
5626 /// pushing the channel monitor update (if any) to the background events queue and removing the
5628 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
5629 for mut failure in failed_channels.drain(..) {
5630 // Either a commitment transactions has been confirmed on-chain or
5631 // Channel::block_disconnected detected that the funding transaction has been
5632 // reorganized out of the main chain.
5633 // We cannot broadcast our latest local state via monitor update (as
5634 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
5635 // so we track the update internally and handle it when the user next calls
5636 // timer_tick_occurred, guaranteeing we're running normally.
5637 if let Some((funding_txo, update)) = failure.0.take() {
5638 assert_eq!(update.updates.len(), 1);
5639 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
5640 assert!(should_broadcast);
5641 } else { unreachable!(); }
5642 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
5644 self.finish_force_close_channel(failure);
5648 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> {
5649 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
5651 if min_value_msat.is_some() && min_value_msat.unwrap() > MAX_VALUE_MSAT {
5652 return Err(APIError::APIMisuseError { err: format!("min_value_msat of {} greater than total 21 million bitcoin supply", min_value_msat.unwrap()) });
5655 let payment_secret = PaymentSecret(self.keys_manager.get_secure_random_bytes());
5657 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5658 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5659 match payment_secrets.entry(payment_hash) {
5660 hash_map::Entry::Vacant(e) => {
5661 e.insert(PendingInboundPayment {
5662 payment_secret, min_value_msat, payment_preimage,
5663 user_payment_id: 0, // For compatibility with version 0.0.103 and earlier
5664 // We assume that highest_seen_timestamp is pretty close to the current time -
5665 // it's updated when we receive a new block with the maximum time we've seen in
5666 // a header. It should never be more than two hours in the future.
5667 // Thus, we add two hours here as a buffer to ensure we absolutely
5668 // never fail a payment too early.
5669 // Note that we assume that received blocks have reasonably up-to-date
5671 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
5674 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
5679 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
5682 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
5683 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
5685 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
5686 /// will have the [`PaymentClaimable::payment_preimage`] field filled in. That should then be
5687 /// passed directly to [`claim_funds`].
5689 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
5691 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5692 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5696 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5697 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5699 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5701 /// [`claim_funds`]: Self::claim_funds
5702 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
5703 /// [`PaymentClaimable::payment_preimage`]: events::Event::PaymentClaimable::payment_preimage
5704 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5705 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), ()> {
5706 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)
5709 /// Legacy version of [`create_inbound_payment`]. Use this method if you wish to share
5710 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5712 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5715 /// This method is deprecated and will be removed soon.
5717 /// [`create_inbound_payment`]: Self::create_inbound_payment
5719 pub fn create_inbound_payment_legacy(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), APIError> {
5720 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
5721 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
5722 let payment_secret = self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs)?;
5723 Ok((payment_hash, payment_secret))
5726 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
5727 /// stored external to LDK.
5729 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
5730 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
5731 /// the `min_value_msat` provided here, if one is provided.
5733 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
5734 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
5737 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
5738 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
5739 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
5740 /// sender "proof-of-payment" unless they have paid the required amount.
5742 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
5743 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
5744 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
5745 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
5746 /// invoices when no timeout is set.
5748 /// Note that we use block header time to time-out pending inbound payments (with some margin
5749 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
5750 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
5751 /// If you need exact expiry semantics, you should enforce them upon receipt of
5752 /// [`PaymentClaimable`].
5754 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
5755 /// set to at least [`MIN_FINAL_CLTV_EXPIRY`].
5757 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5758 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5762 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5763 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5765 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5767 /// [`create_inbound_payment`]: Self::create_inbound_payment
5768 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
5769 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<PaymentSecret, ()> {
5770 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)
5773 /// Legacy version of [`create_inbound_payment_for_hash`]. Use this method if you wish to share
5774 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5776 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5779 /// This method is deprecated and will be removed soon.
5781 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5783 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> {
5784 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
5787 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
5788 /// previously returned from [`create_inbound_payment`].
5790 /// [`create_inbound_payment`]: Self::create_inbound_payment
5791 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
5792 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
5795 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
5796 /// are used when constructing the phantom invoice's route hints.
5798 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5799 pub fn get_phantom_scid(&self) -> u64 {
5800 let best_block_height = self.best_block.read().unwrap().height();
5801 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
5803 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
5804 // Ensure the generated scid doesn't conflict with a real channel.
5805 match short_to_chan_info.get(&scid_candidate) {
5806 Some(_) => continue,
5807 None => return scid_candidate
5812 /// Gets route hints for use in receiving [phantom node payments].
5814 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5815 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
5817 channels: self.list_usable_channels(),
5818 phantom_scid: self.get_phantom_scid(),
5819 real_node_pubkey: self.get_our_node_id(),
5823 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
5824 /// used when constructing the route hints for HTLCs intended to be intercepted. See
5825 /// [`ChannelManager::forward_intercepted_htlc`].
5827 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
5828 /// times to get a unique scid.
5829 pub fn get_intercept_scid(&self) -> u64 {
5830 let best_block_height = self.best_block.read().unwrap().height();
5831 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
5833 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
5834 // Ensure the generated scid doesn't conflict with a real channel.
5835 if short_to_chan_info.contains_key(&scid_candidate) { continue }
5836 return scid_candidate
5840 /// Gets inflight HTLC information by processing pending outbound payments that are in
5841 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
5842 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
5843 let mut inflight_htlcs = InFlightHtlcs::new();
5845 for chan in self.channel_state.lock().unwrap().by_id.values() {
5846 for (htlc_source, _) in chan.inflight_htlc_sources() {
5847 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
5848 inflight_htlcs.process_path(path, self.get_our_node_id());
5856 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
5857 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
5858 let events = core::cell::RefCell::new(Vec::new());
5859 let event_handler = |event: events::Event| events.borrow_mut().push(event);
5860 self.process_pending_events(&event_handler);
5865 pub fn pop_pending_event(&self) -> Option<events::Event> {
5866 let mut events = self.pending_events.lock().unwrap();
5867 if events.is_empty() { None } else { Some(events.remove(0)) }
5871 pub fn has_pending_payments(&self) -> bool {
5872 !self.pending_outbound_payments.lock().unwrap().is_empty()
5876 pub fn clear_pending_payments(&self) {
5877 self.pending_outbound_payments.lock().unwrap().clear()
5880 /// Processes any events asynchronously in the order they were generated since the last call
5881 /// using the given event handler.
5883 /// See the trait-level documentation of [`EventsProvider`] for requirements.
5884 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
5887 // We'll acquire our total consistency lock until the returned future completes so that
5888 // we can be sure no other persists happen while processing events.
5889 let _read_guard = self.total_consistency_lock.read().unwrap();
5891 let mut result = NotifyOption::SkipPersist;
5893 // TODO: This behavior should be documented. It's unintuitive that we query
5894 // ChannelMonitors when clearing other events.
5895 if self.process_pending_monitor_events() {
5896 result = NotifyOption::DoPersist;
5899 let pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5900 if !pending_events.is_empty() {
5901 result = NotifyOption::DoPersist;
5904 for event in pending_events {
5905 handler(event).await;
5908 if result == NotifyOption::DoPersist {
5909 self.persistence_notifier.notify();
5914 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<M, T, K, F, L>
5915 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
5916 T::Target: BroadcasterInterface,
5917 K::Target: KeysInterface,
5918 F::Target: FeeEstimator,
5921 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
5922 let events = RefCell::new(Vec::new());
5923 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5924 let mut result = NotifyOption::SkipPersist;
5926 // TODO: This behavior should be documented. It's unintuitive that we query
5927 // ChannelMonitors when clearing other events.
5928 if self.process_pending_monitor_events() {
5929 result = NotifyOption::DoPersist;
5932 if self.check_free_holding_cells() {
5933 result = NotifyOption::DoPersist;
5935 if self.maybe_generate_initial_closing_signed() {
5936 result = NotifyOption::DoPersist;
5939 let mut pending_events = Vec::new();
5940 let mut channel_state = self.channel_state.lock().unwrap();
5941 mem::swap(&mut pending_events, &mut channel_state.pending_msg_events);
5943 if !pending_events.is_empty() {
5944 events.replace(pending_events);
5953 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> EventsProvider for ChannelManager<M, T, K, F, L>
5955 M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
5956 T::Target: BroadcasterInterface,
5957 K::Target: KeysInterface,
5958 F::Target: FeeEstimator,
5961 /// Processes events that must be periodically handled.
5963 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
5964 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
5965 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
5966 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5967 let mut result = NotifyOption::SkipPersist;
5969 // TODO: This behavior should be documented. It's unintuitive that we query
5970 // ChannelMonitors when clearing other events.
5971 if self.process_pending_monitor_events() {
5972 result = NotifyOption::DoPersist;
5975 let pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5976 if !pending_events.is_empty() {
5977 result = NotifyOption::DoPersist;
5980 for event in pending_events {
5981 handler.handle_event(event);
5989 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Listen 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 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5999 let best_block = self.best_block.read().unwrap();
6000 assert_eq!(best_block.block_hash(), header.prev_blockhash,
6001 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
6002 assert_eq!(best_block.height(), height - 1,
6003 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
6006 self.transactions_confirmed(header, txdata, height);
6007 self.best_block_updated(header, height);
6010 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
6011 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6012 let new_height = height - 1;
6014 let mut best_block = self.best_block.write().unwrap();
6015 assert_eq!(best_block.block_hash(), header.block_hash(),
6016 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
6017 assert_eq!(best_block.height(), height,
6018 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
6019 *best_block = BestBlock::new(header.prev_blockhash, new_height)
6022 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));
6026 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Confirm for ChannelManager<M, T, K, F, L>
6028 M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
6029 T::Target: BroadcasterInterface,
6030 K::Target: KeysInterface,
6031 F::Target: FeeEstimator,
6034 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
6035 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
6036 // during initialization prior to the chain_monitor being fully configured in some cases.
6037 // See the docs for `ChannelManagerReadArgs` for more.
6039 let block_hash = header.block_hash();
6040 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
6042 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6043 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)
6044 .map(|(a, b)| (a, Vec::new(), b)));
6046 let last_best_block_height = self.best_block.read().unwrap().height();
6047 if height < last_best_block_height {
6048 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
6049 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));
6053 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
6054 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
6055 // during initialization prior to the chain_monitor being fully configured in some cases.
6056 // See the docs for `ChannelManagerReadArgs` for more.
6058 let block_hash = header.block_hash();
6059 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
6061 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6063 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
6065 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));
6067 macro_rules! max_time {
6068 ($timestamp: expr) => {
6070 // Update $timestamp to be the max of its current value and the block
6071 // timestamp. This should keep us close to the current time without relying on
6072 // having an explicit local time source.
6073 // Just in case we end up in a race, we loop until we either successfully
6074 // update $timestamp or decide we don't need to.
6075 let old_serial = $timestamp.load(Ordering::Acquire);
6076 if old_serial >= header.time as usize { break; }
6077 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
6083 max_time!(self.highest_seen_timestamp);
6084 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
6085 payment_secrets.retain(|_, inbound_payment| {
6086 inbound_payment.expiry_time > header.time as u64
6090 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
6091 let channel_state = self.channel_state.lock().unwrap();
6092 let mut res = Vec::with_capacity(channel_state.by_id.len());
6093 for chan in channel_state.by_id.values() {
6094 if let (Some(funding_txo), block_hash) = (chan.get_funding_txo(), chan.get_funding_tx_confirmed_in()) {
6095 res.push((funding_txo.txid, block_hash));
6101 fn transaction_unconfirmed(&self, txid: &Txid) {
6102 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6103 self.do_chain_event(None, |channel| {
6104 if let Some(funding_txo) = channel.get_funding_txo() {
6105 if funding_txo.txid == *txid {
6106 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
6107 } else { Ok((None, Vec::new(), None)) }
6108 } else { Ok((None, Vec::new(), None)) }
6113 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F, L>
6115 M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
6116 T::Target: BroadcasterInterface,
6117 K::Target: KeysInterface,
6118 F::Target: FeeEstimator,
6121 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
6122 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
6124 fn do_chain_event<FN: Fn(&mut Channel<<K::Target as KeysInterface>::Signer>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
6125 (&self, height_opt: Option<u32>, f: FN) {
6126 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
6127 // during initialization prior to the chain_monitor being fully configured in some cases.
6128 // See the docs for `ChannelManagerReadArgs` for more.
6130 let mut failed_channels = Vec::new();
6131 let mut timed_out_htlcs = Vec::new();
6133 let mut channel_lock = self.channel_state.lock().unwrap();
6134 let channel_state = &mut *channel_lock;
6135 let pending_msg_events = &mut channel_state.pending_msg_events;
6136 channel_state.by_id.retain(|_, channel| {
6137 let res = f(channel);
6138 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
6139 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
6140 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
6141 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
6142 HTLCDestination::NextHopChannel { node_id: Some(channel.get_counterparty_node_id()), channel_id: channel.channel_id() }));
6144 if let Some(channel_ready) = channel_ready_opt {
6145 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
6146 if channel.is_usable() {
6147 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", log_bytes!(channel.channel_id()));
6148 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
6149 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
6150 node_id: channel.get_counterparty_node_id(),
6155 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", log_bytes!(channel.channel_id()));
6159 emit_channel_ready_event!(self, channel);
6161 if let Some(announcement_sigs) = announcement_sigs {
6162 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(channel.channel_id()));
6163 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
6164 node_id: channel.get_counterparty_node_id(),
6165 msg: announcement_sigs,
6167 if let Some(height) = height_opt {
6168 if let Some(announcement) = channel.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash, height) {
6169 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
6171 // Note that announcement_signatures fails if the channel cannot be announced,
6172 // so get_channel_update_for_broadcast will never fail by the time we get here.
6173 update_msg: self.get_channel_update_for_broadcast(channel).unwrap(),
6178 if channel.is_our_channel_ready() {
6179 if let Some(real_scid) = channel.get_short_channel_id() {
6180 // If we sent a 0conf channel_ready, and now have an SCID, we add it
6181 // to the short_to_chan_info map here. Note that we check whether we
6182 // can relay using the real SCID at relay-time (i.e.
6183 // enforce option_scid_alias then), and if the funding tx is ever
6184 // un-confirmed we force-close the channel, ensuring short_to_chan_info
6185 // is always consistent.
6186 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
6187 let scid_insert = short_to_chan_info.insert(real_scid, (channel.get_counterparty_node_id(), channel.channel_id()));
6188 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.get_counterparty_node_id(), channel.channel_id()),
6189 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
6190 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
6193 } else if let Err(reason) = res {
6194 update_maps_on_chan_removal!(self, channel);
6195 // It looks like our counterparty went on-chain or funding transaction was
6196 // reorged out of the main chain. Close the channel.
6197 failed_channels.push(channel.force_shutdown(true));
6198 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
6199 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
6203 let reason_message = format!("{}", reason);
6204 self.issue_channel_close_events(channel, reason);
6205 pending_msg_events.push(events::MessageSendEvent::HandleError {
6206 node_id: channel.get_counterparty_node_id(),
6207 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
6208 channel_id: channel.channel_id(),
6209 data: reason_message,
6218 if let Some(height) = height_opt {
6219 self.claimable_htlcs.lock().unwrap().retain(|payment_hash, (_, htlcs)| {
6220 htlcs.retain(|htlc| {
6221 // If height is approaching the number of blocks we think it takes us to get
6222 // our commitment transaction confirmed before the HTLC expires, plus the
6223 // number of blocks we generally consider it to take to do a commitment update,
6224 // just give up on it and fail the HTLC.
6225 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
6226 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
6227 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
6229 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
6230 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
6231 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
6235 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
6238 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
6239 intercepted_htlcs.retain(|_, htlc| {
6240 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
6241 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
6242 short_channel_id: htlc.prev_short_channel_id,
6243 htlc_id: htlc.prev_htlc_id,
6244 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
6245 phantom_shared_secret: None,
6246 outpoint: htlc.prev_funding_outpoint,
6249 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
6250 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
6251 _ => unreachable!(),
6253 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
6254 HTLCFailReason::from_failure_code(0x2000 | 2),
6255 HTLCDestination::InvalidForward { requested_forward_scid }));
6256 log_trace!(self.logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
6262 self.handle_init_event_channel_failures(failed_channels);
6264 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
6265 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
6269 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
6270 /// indicating whether persistence is necessary. Only one listener on
6271 /// [`await_persistable_update`], [`await_persistable_update_timeout`], or a future returned by
6272 /// [`get_persistable_update_future`] is guaranteed to be woken up.
6274 /// Note that this method is not available with the `no-std` feature.
6276 /// [`await_persistable_update`]: Self::await_persistable_update
6277 /// [`await_persistable_update_timeout`]: Self::await_persistable_update_timeout
6278 /// [`get_persistable_update_future`]: Self::get_persistable_update_future
6279 #[cfg(any(test, feature = "std"))]
6280 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
6281 self.persistence_notifier.wait_timeout(max_wait)
6284 /// Blocks until ChannelManager needs to be persisted. Only one listener on
6285 /// [`await_persistable_update`], `await_persistable_update_timeout`, or a future returned by
6286 /// [`get_persistable_update_future`] is guaranteed to be woken up.
6288 /// [`await_persistable_update`]: Self::await_persistable_update
6289 /// [`get_persistable_update_future`]: Self::get_persistable_update_future
6290 pub fn await_persistable_update(&self) {
6291 self.persistence_notifier.wait()
6294 /// Gets a [`Future`] that completes when a persistable update is available. Note that
6295 /// callbacks registered on the [`Future`] MUST NOT call back into this [`ChannelManager`] and
6296 /// should instead register actions to be taken later.
6297 pub fn get_persistable_update_future(&self) -> Future {
6298 self.persistence_notifier.get_future()
6301 #[cfg(any(test, feature = "_test_utils"))]
6302 pub fn get_persistence_condvar_value(&self) -> bool {
6303 self.persistence_notifier.notify_pending()
6306 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
6307 /// [`chain::Confirm`] interfaces.
6308 pub fn current_best_block(&self) -> BestBlock {
6309 self.best_block.read().unwrap().clone()
6313 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref >
6314 ChannelMessageHandler for ChannelManager<M, T, K, F, L>
6315 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
6316 T::Target: BroadcasterInterface,
6317 K::Target: KeysInterface,
6318 F::Target: FeeEstimator,
6321 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
6322 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6323 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
6326 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
6327 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6328 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
6331 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
6332 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6333 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
6336 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
6337 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6338 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
6341 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
6342 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6343 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
6346 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) {
6347 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6348 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, their_features, msg), *counterparty_node_id);
6351 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
6352 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6353 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
6356 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
6357 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6358 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
6361 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
6362 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6363 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
6366 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
6367 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6368 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
6371 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
6372 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6373 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
6376 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
6377 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6378 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
6381 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
6382 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6383 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
6386 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
6387 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6388 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
6391 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
6392 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6393 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
6396 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
6397 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
6398 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
6401 NotifyOption::SkipPersist
6406 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
6407 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6408 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
6411 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
6412 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6413 let mut failed_channels = Vec::new();
6414 let mut no_channels_remain = true;
6416 let mut channel_state_lock = self.channel_state.lock().unwrap();
6417 let channel_state = &mut *channel_state_lock;
6418 let pending_msg_events = &mut channel_state.pending_msg_events;
6419 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates. We believe we {} make future connections to this peer.",
6420 log_pubkey!(counterparty_node_id), if no_connection_possible { "cannot" } else { "can" });
6421 channel_state.by_id.retain(|_, chan| {
6422 if chan.get_counterparty_node_id() == *counterparty_node_id {
6423 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
6424 if chan.is_shutdown() {
6425 update_maps_on_chan_removal!(self, chan);
6426 self.issue_channel_close_events(chan, ClosureReason::DisconnectedPeer);
6429 no_channels_remain = false;
6434 pending_msg_events.retain(|msg| {
6436 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != counterparty_node_id,
6437 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != counterparty_node_id,
6438 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != counterparty_node_id,
6439 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != counterparty_node_id,
6440 &events::MessageSendEvent::SendChannelReady { ref node_id, .. } => node_id != counterparty_node_id,
6441 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != counterparty_node_id,
6442 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != counterparty_node_id,
6443 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != counterparty_node_id,
6444 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != counterparty_node_id,
6445 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != counterparty_node_id,
6446 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != counterparty_node_id,
6447 &events::MessageSendEvent::SendChannelAnnouncement { ref node_id, .. } => node_id != counterparty_node_id,
6448 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
6449 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
6450 &events::MessageSendEvent::SendChannelUpdate { ref node_id, .. } => node_id != counterparty_node_id,
6451 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != counterparty_node_id,
6452 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
6453 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
6454 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
6455 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
6459 if no_channels_remain {
6460 self.per_peer_state.write().unwrap().remove(counterparty_node_id);
6463 for failure in failed_channels.drain(..) {
6464 self.finish_force_close_channel(failure);
6468 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) -> Result<(), ()> {
6469 if !init_msg.features.supports_static_remote_key() {
6470 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(counterparty_node_id));
6474 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
6476 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6479 let mut peer_state_lock = self.per_peer_state.write().unwrap();
6480 match peer_state_lock.entry(counterparty_node_id.clone()) {
6481 hash_map::Entry::Vacant(e) => {
6482 e.insert(Mutex::new(PeerState {
6483 latest_features: init_msg.features.clone(),
6486 hash_map::Entry::Occupied(e) => {
6487 e.get().lock().unwrap().latest_features = init_msg.features.clone();
6492 let mut channel_state_lock = self.channel_state.lock().unwrap();
6493 let channel_state = &mut *channel_state_lock;
6494 let pending_msg_events = &mut channel_state.pending_msg_events;
6495 channel_state.by_id.retain(|_, chan| {
6496 let retain = if chan.get_counterparty_node_id() == *counterparty_node_id {
6497 if !chan.have_received_message() {
6498 // If we created this (outbound) channel while we were disconnected from the
6499 // peer we probably failed to send the open_channel message, which is now
6500 // lost. We can't have had anything pending related to this channel, so we just
6504 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
6505 node_id: chan.get_counterparty_node_id(),
6506 msg: chan.get_channel_reestablish(&self.logger),
6511 if retain && chan.get_counterparty_node_id() != *counterparty_node_id {
6512 if let Some(msg) = chan.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height()) {
6513 if let Ok(update_msg) = self.get_channel_update_for_broadcast(chan) {
6514 pending_msg_events.push(events::MessageSendEvent::SendChannelAnnouncement {
6515 node_id: *counterparty_node_id,
6523 //TODO: Also re-broadcast announcement_signatures
6527 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
6528 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6530 if msg.channel_id == [0; 32] {
6531 for chan in self.list_channels() {
6532 if chan.counterparty.node_id == *counterparty_node_id {
6533 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6534 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data), true);
6539 // First check if we can advance the channel type and try again.
6540 let mut channel_state = self.channel_state.lock().unwrap();
6541 if let Some(chan) = channel_state.by_id.get_mut(&msg.channel_id) {
6542 if chan.get_counterparty_node_id() != *counterparty_node_id {
6545 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash) {
6546 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
6547 node_id: *counterparty_node_id,
6555 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6556 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
6560 fn provided_node_features(&self) -> NodeFeatures {
6561 provided_node_features()
6564 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
6565 provided_init_features()
6569 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
6570 /// [`ChannelManager`].
6571 pub fn provided_node_features() -> NodeFeatures {
6572 provided_init_features().to_context()
6575 /// Fetches the set of [`InvoiceFeatures`] flags which are provided by or required by
6576 /// [`ChannelManager`].
6578 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
6579 /// or not. Thus, this method is not public.
6580 #[cfg(any(feature = "_test_utils", test))]
6581 pub fn provided_invoice_features() -> InvoiceFeatures {
6582 provided_init_features().to_context()
6585 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
6586 /// [`ChannelManager`].
6587 pub fn provided_channel_features() -> ChannelFeatures {
6588 provided_init_features().to_context()
6591 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
6592 /// [`ChannelManager`].
6593 pub fn provided_init_features() -> InitFeatures {
6594 // Note that if new features are added here which other peers may (eventually) require, we
6595 // should also add the corresponding (optional) bit to the ChannelMessageHandler impl for
6596 // ErroringMessageHandler.
6597 let mut features = InitFeatures::empty();
6598 features.set_data_loss_protect_optional();
6599 features.set_upfront_shutdown_script_optional();
6600 features.set_variable_length_onion_required();
6601 features.set_static_remote_key_required();
6602 features.set_payment_secret_required();
6603 features.set_basic_mpp_optional();
6604 features.set_wumbo_optional();
6605 features.set_shutdown_any_segwit_optional();
6606 features.set_channel_type_optional();
6607 features.set_scid_privacy_optional();
6608 features.set_zero_conf_optional();
6612 const SERIALIZATION_VERSION: u8 = 1;
6613 const MIN_SERIALIZATION_VERSION: u8 = 1;
6615 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
6616 (2, fee_base_msat, required),
6617 (4, fee_proportional_millionths, required),
6618 (6, cltv_expiry_delta, required),
6621 impl_writeable_tlv_based!(ChannelCounterparty, {
6622 (2, node_id, required),
6623 (4, features, required),
6624 (6, unspendable_punishment_reserve, required),
6625 (8, forwarding_info, option),
6626 (9, outbound_htlc_minimum_msat, option),
6627 (11, outbound_htlc_maximum_msat, option),
6630 impl Writeable for ChannelDetails {
6631 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6632 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
6633 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
6634 let user_channel_id_low = self.user_channel_id as u64;
6635 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
6636 write_tlv_fields!(writer, {
6637 (1, self.inbound_scid_alias, option),
6638 (2, self.channel_id, required),
6639 (3, self.channel_type, option),
6640 (4, self.counterparty, required),
6641 (5, self.outbound_scid_alias, option),
6642 (6, self.funding_txo, option),
6643 (7, self.config, option),
6644 (8, self.short_channel_id, option),
6645 (9, self.confirmations, option),
6646 (10, self.channel_value_satoshis, required),
6647 (12, self.unspendable_punishment_reserve, option),
6648 (14, user_channel_id_low, required),
6649 (16, self.balance_msat, required),
6650 (18, self.outbound_capacity_msat, required),
6651 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6652 // filled in, so we can safely unwrap it here.
6653 (19, self.next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6654 (20, self.inbound_capacity_msat, required),
6655 (22, self.confirmations_required, option),
6656 (24, self.force_close_spend_delay, option),
6657 (26, self.is_outbound, required),
6658 (28, self.is_channel_ready, required),
6659 (30, self.is_usable, required),
6660 (32, self.is_public, required),
6661 (33, self.inbound_htlc_minimum_msat, option),
6662 (35, self.inbound_htlc_maximum_msat, option),
6663 (37, user_channel_id_high_opt, option),
6669 impl Readable for ChannelDetails {
6670 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6671 init_and_read_tlv_fields!(reader, {
6672 (1, inbound_scid_alias, option),
6673 (2, channel_id, required),
6674 (3, channel_type, option),
6675 (4, counterparty, required),
6676 (5, outbound_scid_alias, option),
6677 (6, funding_txo, option),
6678 (7, config, option),
6679 (8, short_channel_id, option),
6680 (9, confirmations, option),
6681 (10, channel_value_satoshis, required),
6682 (12, unspendable_punishment_reserve, option),
6683 (14, user_channel_id_low, required),
6684 (16, balance_msat, required),
6685 (18, outbound_capacity_msat, required),
6686 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6687 // filled in, so we can safely unwrap it here.
6688 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6689 (20, inbound_capacity_msat, required),
6690 (22, confirmations_required, option),
6691 (24, force_close_spend_delay, option),
6692 (26, is_outbound, required),
6693 (28, is_channel_ready, required),
6694 (30, is_usable, required),
6695 (32, is_public, required),
6696 (33, inbound_htlc_minimum_msat, option),
6697 (35, inbound_htlc_maximum_msat, option),
6698 (37, user_channel_id_high_opt, option),
6701 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
6702 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
6703 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
6704 let user_channel_id = user_channel_id_low as u128 +
6705 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
6709 channel_id: channel_id.0.unwrap(),
6711 counterparty: counterparty.0.unwrap(),
6712 outbound_scid_alias,
6716 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
6717 unspendable_punishment_reserve,
6719 balance_msat: balance_msat.0.unwrap(),
6720 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
6721 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
6722 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
6723 confirmations_required,
6725 force_close_spend_delay,
6726 is_outbound: is_outbound.0.unwrap(),
6727 is_channel_ready: is_channel_ready.0.unwrap(),
6728 is_usable: is_usable.0.unwrap(),
6729 is_public: is_public.0.unwrap(),
6730 inbound_htlc_minimum_msat,
6731 inbound_htlc_maximum_msat,
6736 impl_writeable_tlv_based!(PhantomRouteHints, {
6737 (2, channels, vec_type),
6738 (4, phantom_scid, required),
6739 (6, real_node_pubkey, required),
6742 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
6744 (0, onion_packet, required),
6745 (2, short_channel_id, required),
6748 (0, payment_data, required),
6749 (1, phantom_shared_secret, option),
6750 (2, incoming_cltv_expiry, required),
6752 (2, ReceiveKeysend) => {
6753 (0, payment_preimage, required),
6754 (2, incoming_cltv_expiry, required),
6758 impl_writeable_tlv_based!(PendingHTLCInfo, {
6759 (0, routing, required),
6760 (2, incoming_shared_secret, required),
6761 (4, payment_hash, required),
6762 (6, outgoing_amt_msat, required),
6763 (8, outgoing_cltv_value, required),
6764 (9, incoming_amt_msat, option),
6768 impl Writeable for HTLCFailureMsg {
6769 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6771 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
6773 channel_id.write(writer)?;
6774 htlc_id.write(writer)?;
6775 reason.write(writer)?;
6777 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6778 channel_id, htlc_id, sha256_of_onion, failure_code
6781 channel_id.write(writer)?;
6782 htlc_id.write(writer)?;
6783 sha256_of_onion.write(writer)?;
6784 failure_code.write(writer)?;
6791 impl Readable for HTLCFailureMsg {
6792 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6793 let id: u8 = Readable::read(reader)?;
6796 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
6797 channel_id: Readable::read(reader)?,
6798 htlc_id: Readable::read(reader)?,
6799 reason: Readable::read(reader)?,
6803 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6804 channel_id: Readable::read(reader)?,
6805 htlc_id: Readable::read(reader)?,
6806 sha256_of_onion: Readable::read(reader)?,
6807 failure_code: Readable::read(reader)?,
6810 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
6811 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
6812 // messages contained in the variants.
6813 // In version 0.0.101, support for reading the variants with these types was added, and
6814 // we should migrate to writing these variants when UpdateFailHTLC or
6815 // UpdateFailMalformedHTLC get TLV fields.
6817 let length: BigSize = Readable::read(reader)?;
6818 let mut s = FixedLengthReader::new(reader, length.0);
6819 let res = Readable::read(&mut s)?;
6820 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6821 Ok(HTLCFailureMsg::Relay(res))
6824 let length: BigSize = Readable::read(reader)?;
6825 let mut s = FixedLengthReader::new(reader, length.0);
6826 let res = Readable::read(&mut s)?;
6827 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6828 Ok(HTLCFailureMsg::Malformed(res))
6830 _ => Err(DecodeError::UnknownRequiredFeature),
6835 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
6840 impl_writeable_tlv_based!(HTLCPreviousHopData, {
6841 (0, short_channel_id, required),
6842 (1, phantom_shared_secret, option),
6843 (2, outpoint, required),
6844 (4, htlc_id, required),
6845 (6, incoming_packet_shared_secret, required)
6848 impl Writeable for ClaimableHTLC {
6849 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6850 let (payment_data, keysend_preimage) = match &self.onion_payload {
6851 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
6852 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
6854 write_tlv_fields!(writer, {
6855 (0, self.prev_hop, required),
6856 (1, self.total_msat, required),
6857 (2, self.value, required),
6858 (4, payment_data, option),
6859 (6, self.cltv_expiry, required),
6860 (8, keysend_preimage, option),
6866 impl Readable for ClaimableHTLC {
6867 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6868 let mut prev_hop = crate::util::ser::OptionDeserWrapper(None);
6870 let mut payment_data: Option<msgs::FinalOnionHopData> = None;
6871 let mut cltv_expiry = 0;
6872 let mut total_msat = None;
6873 let mut keysend_preimage: Option<PaymentPreimage> = None;
6874 read_tlv_fields!(reader, {
6875 (0, prev_hop, required),
6876 (1, total_msat, option),
6877 (2, value, required),
6878 (4, payment_data, option),
6879 (6, cltv_expiry, required),
6880 (8, keysend_preimage, option)
6882 let onion_payload = match keysend_preimage {
6884 if payment_data.is_some() {
6885 return Err(DecodeError::InvalidValue)
6887 if total_msat.is_none() {
6888 total_msat = Some(value);
6890 OnionPayload::Spontaneous(p)
6893 if total_msat.is_none() {
6894 if payment_data.is_none() {
6895 return Err(DecodeError::InvalidValue)
6897 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
6899 OnionPayload::Invoice { _legacy_hop_data: payment_data }
6903 prev_hop: prev_hop.0.unwrap(),
6906 total_msat: total_msat.unwrap(),
6913 impl Readable for HTLCSource {
6914 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6915 let id: u8 = Readable::read(reader)?;
6918 let mut session_priv: crate::util::ser::OptionDeserWrapper<SecretKey> = crate::util::ser::OptionDeserWrapper(None);
6919 let mut first_hop_htlc_msat: u64 = 0;
6920 let mut path = Some(Vec::new());
6921 let mut payment_id = None;
6922 let mut payment_secret = None;
6923 let mut payment_params = None;
6924 read_tlv_fields!(reader, {
6925 (0, session_priv, required),
6926 (1, payment_id, option),
6927 (2, first_hop_htlc_msat, required),
6928 (3, payment_secret, option),
6929 (4, path, vec_type),
6930 (5, payment_params, option),
6932 if payment_id.is_none() {
6933 // For backwards compat, if there was no payment_id written, use the session_priv bytes
6935 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
6937 Ok(HTLCSource::OutboundRoute {
6938 session_priv: session_priv.0.unwrap(),
6939 first_hop_htlc_msat,
6940 path: path.unwrap(),
6941 payment_id: payment_id.unwrap(),
6946 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
6947 _ => Err(DecodeError::UnknownRequiredFeature),
6952 impl Writeable for HTLCSource {
6953 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
6955 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id, payment_secret, payment_params } => {
6957 let payment_id_opt = Some(payment_id);
6958 write_tlv_fields!(writer, {
6959 (0, session_priv, required),
6960 (1, payment_id_opt, option),
6961 (2, first_hop_htlc_msat, required),
6962 (3, payment_secret, option),
6963 (4, *path, vec_type),
6964 (5, payment_params, option),
6967 HTLCSource::PreviousHopData(ref field) => {
6969 field.write(writer)?;
6976 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
6977 (0, forward_info, required),
6978 (1, prev_user_channel_id, (default_value, 0)),
6979 (2, prev_short_channel_id, required),
6980 (4, prev_htlc_id, required),
6981 (6, prev_funding_outpoint, required),
6984 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
6986 (0, htlc_id, required),
6987 (2, err_packet, required),
6992 impl_writeable_tlv_based!(PendingInboundPayment, {
6993 (0, payment_secret, required),
6994 (2, expiry_time, required),
6995 (4, user_payment_id, required),
6996 (6, payment_preimage, required),
6997 (8, min_value_msat, required),
7000 impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
7002 (0, session_privs, required),
7005 (0, session_privs, required),
7006 (1, payment_hash, option),
7007 (3, timer_ticks_without_htlcs, (default_value, 0)),
7010 (0, session_privs, required),
7011 (1, pending_fee_msat, option),
7012 (2, payment_hash, required),
7013 (4, payment_secret, option),
7014 (6, total_msat, required),
7015 (8, pending_amt_msat, required),
7016 (10, starting_block_height, required),
7019 (0, session_privs, required),
7020 (2, payment_hash, required),
7024 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Writeable for ChannelManager<M, T, K, F, L>
7025 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
7026 T::Target: BroadcasterInterface,
7027 K::Target: KeysInterface,
7028 F::Target: FeeEstimator,
7031 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
7032 let _consistency_lock = self.total_consistency_lock.write().unwrap();
7034 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
7036 self.genesis_hash.write(writer)?;
7038 let best_block = self.best_block.read().unwrap();
7039 best_block.height().write(writer)?;
7040 best_block.block_hash().write(writer)?;
7044 // Take `channel_state` lock temporarily to avoid creating a lock order that requires
7045 // that the `forward_htlcs` lock is taken after `channel_state`
7046 let channel_state = self.channel_state.lock().unwrap();
7047 let mut unfunded_channels = 0;
7048 for (_, channel) in channel_state.by_id.iter() {
7049 if !channel.is_funding_initiated() {
7050 unfunded_channels += 1;
7053 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
7054 for (_, channel) in channel_state.by_id.iter() {
7055 if channel.is_funding_initiated() {
7056 channel.write(writer)?;
7062 let forward_htlcs = self.forward_htlcs.lock().unwrap();
7063 (forward_htlcs.len() as u64).write(writer)?;
7064 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
7065 short_channel_id.write(writer)?;
7066 (pending_forwards.len() as u64).write(writer)?;
7067 for forward in pending_forwards {
7068 forward.write(writer)?;
7073 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
7074 let claimable_htlcs = self.claimable_htlcs.lock().unwrap();
7075 let pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
7077 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
7078 (claimable_htlcs.len() as u64).write(writer)?;
7079 for (payment_hash, (purpose, previous_hops)) in claimable_htlcs.iter() {
7080 payment_hash.write(writer)?;
7081 (previous_hops.len() as u64).write(writer)?;
7082 for htlc in previous_hops.iter() {
7083 htlc.write(writer)?;
7085 htlc_purposes.push(purpose);
7088 let per_peer_state = self.per_peer_state.write().unwrap();
7089 (per_peer_state.len() as u64).write(writer)?;
7090 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
7091 peer_pubkey.write(writer)?;
7092 let peer_state = peer_state_mutex.lock().unwrap();
7093 peer_state.latest_features.write(writer)?;
7096 let events = self.pending_events.lock().unwrap();
7097 (events.len() as u64).write(writer)?;
7098 for event in events.iter() {
7099 event.write(writer)?;
7102 let background_events = self.pending_background_events.lock().unwrap();
7103 (background_events.len() as u64).write(writer)?;
7104 for event in background_events.iter() {
7106 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
7108 funding_txo.write(writer)?;
7109 monitor_update.write(writer)?;
7114 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
7115 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
7116 // likely to be identical.
7117 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
7118 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
7120 (pending_inbound_payments.len() as u64).write(writer)?;
7121 for (hash, pending_payment) in pending_inbound_payments.iter() {
7122 hash.write(writer)?;
7123 pending_payment.write(writer)?;
7126 // For backwards compat, write the session privs and their total length.
7127 let mut num_pending_outbounds_compat: u64 = 0;
7128 for (_, outbound) in pending_outbound_payments.iter() {
7129 if !outbound.is_fulfilled() && !outbound.abandoned() {
7130 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
7133 num_pending_outbounds_compat.write(writer)?;
7134 for (_, outbound) in pending_outbound_payments.iter() {
7136 PendingOutboundPayment::Legacy { session_privs } |
7137 PendingOutboundPayment::Retryable { session_privs, .. } => {
7138 for session_priv in session_privs.iter() {
7139 session_priv.write(writer)?;
7142 PendingOutboundPayment::Fulfilled { .. } => {},
7143 PendingOutboundPayment::Abandoned { .. } => {},
7147 // Encode without retry info for 0.0.101 compatibility.
7148 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
7149 for (id, outbound) in pending_outbound_payments.iter() {
7151 PendingOutboundPayment::Legacy { session_privs } |
7152 PendingOutboundPayment::Retryable { session_privs, .. } => {
7153 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
7159 let mut pending_intercepted_htlcs = None;
7160 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
7161 if our_pending_intercepts.len() != 0 {
7162 pending_intercepted_htlcs = Some(our_pending_intercepts);
7164 write_tlv_fields!(writer, {
7165 (1, pending_outbound_payments_no_retry, required),
7166 (2, pending_intercepted_htlcs, option),
7167 (3, pending_outbound_payments, required),
7168 (5, self.our_network_pubkey, required),
7169 (7, self.fake_scid_rand_bytes, required),
7170 (9, htlc_purposes, vec_type),
7171 (11, self.probing_cookie_secret, required),
7178 /// Arguments for the creation of a ChannelManager that are not deserialized.
7180 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
7182 /// 1) Deserialize all stored [`ChannelMonitor`]s.
7183 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
7184 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
7185 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
7186 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
7187 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
7188 /// same way you would handle a [`chain::Filter`] call using
7189 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
7190 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
7191 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
7192 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
7193 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
7194 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
7196 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
7197 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
7199 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
7200 /// call any other methods on the newly-deserialized [`ChannelManager`].
7202 /// Note that because some channels may be closed during deserialization, it is critical that you
7203 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
7204 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
7205 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
7206 /// not force-close the same channels but consider them live), you may end up revoking a state for
7207 /// which you've already broadcasted the transaction.
7209 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
7210 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
7211 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
7212 T::Target: BroadcasterInterface,
7213 K::Target: KeysInterface,
7214 F::Target: FeeEstimator,
7217 /// The keys provider which will give us relevant keys. Some keys will be loaded during
7218 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
7220 pub keys_manager: K,
7222 /// The fee_estimator for use in the ChannelManager in the future.
7224 /// No calls to the FeeEstimator will be made during deserialization.
7225 pub fee_estimator: F,
7226 /// The chain::Watch for use in the ChannelManager in the future.
7228 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
7229 /// you have deserialized ChannelMonitors separately and will add them to your
7230 /// chain::Watch after deserializing this ChannelManager.
7231 pub chain_monitor: M,
7233 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
7234 /// used to broadcast the latest local commitment transactions of channels which must be
7235 /// force-closed during deserialization.
7236 pub tx_broadcaster: T,
7237 /// The Logger for use in the ChannelManager and which may be used to log information during
7238 /// deserialization.
7240 /// Default settings used for new channels. Any existing channels will continue to use the
7241 /// runtime settings which were stored when the ChannelManager was serialized.
7242 pub default_config: UserConfig,
7244 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
7245 /// value.get_funding_txo() should be the key).
7247 /// If a monitor is inconsistent with the channel state during deserialization the channel will
7248 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
7249 /// is true for missing channels as well. If there is a monitor missing for which we find
7250 /// channel data Err(DecodeError::InvalidValue) will be returned.
7252 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
7255 /// (C-not exported) because we have no HashMap bindings
7256 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<K::Target as KeysInterface>::Signer>>,
7259 impl<'a, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
7260 ChannelManagerReadArgs<'a, M, T, K, F, L>
7261 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
7262 T::Target: BroadcasterInterface,
7263 K::Target: KeysInterface,
7264 F::Target: FeeEstimator,
7267 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
7268 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
7269 /// populate a HashMap directly from C.
7270 pub fn new(keys_manager: K, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, logger: L, default_config: UserConfig,
7271 mut channel_monitors: Vec<&'a mut ChannelMonitor<<K::Target as KeysInterface>::Signer>>) -> Self {
7273 keys_manager, fee_estimator, chain_monitor, tx_broadcaster, logger, default_config,
7274 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
7279 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
7280 // SipmleArcChannelManager type:
7281 impl<'a, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
7282 ReadableArgs<ChannelManagerReadArgs<'a, M, T, K, F, L>> for (BlockHash, Arc<ChannelManager<M, T, K, F, L>>)
7283 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
7284 T::Target: BroadcasterInterface,
7285 K::Target: KeysInterface,
7286 F::Target: FeeEstimator,
7289 fn read<R: io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, M, T, K, F, L>) -> Result<Self, DecodeError> {
7290 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, K, F, L>)>::read(reader, args)?;
7291 Ok((blockhash, Arc::new(chan_manager)))
7295 impl<'a, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
7296 ReadableArgs<ChannelManagerReadArgs<'a, M, T, K, F, L>> for (BlockHash, ChannelManager<M, T, K, F, L>)
7297 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
7298 T::Target: BroadcasterInterface,
7299 K::Target: KeysInterface,
7300 F::Target: FeeEstimator,
7303 fn read<R: io::Read>(reader: &mut R, mut args: ChannelManagerReadArgs<'a, M, T, K, F, L>) -> Result<Self, DecodeError> {
7304 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
7306 let genesis_hash: BlockHash = Readable::read(reader)?;
7307 let best_block_height: u32 = Readable::read(reader)?;
7308 let best_block_hash: BlockHash = Readable::read(reader)?;
7310 let mut failed_htlcs = Vec::new();
7312 let channel_count: u64 = Readable::read(reader)?;
7313 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
7314 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7315 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7316 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7317 let mut channel_closures = Vec::new();
7318 for _ in 0..channel_count {
7319 let mut channel: Channel<<K::Target as KeysInterface>::Signer> = Channel::read(reader, (&args.keys_manager, best_block_height))?;
7320 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
7321 funding_txo_set.insert(funding_txo.clone());
7322 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
7323 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
7324 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
7325 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
7326 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
7327 // If the channel is ahead of the monitor, return InvalidValue:
7328 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
7329 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
7330 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
7331 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
7332 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
7333 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
7334 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");
7335 return Err(DecodeError::InvalidValue);
7336 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
7337 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
7338 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
7339 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
7340 // But if the channel is behind of the monitor, close the channel:
7341 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
7342 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
7343 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
7344 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
7345 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
7346 failed_htlcs.append(&mut new_failed_htlcs);
7347 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
7348 channel_closures.push(events::Event::ChannelClosed {
7349 channel_id: channel.channel_id(),
7350 user_channel_id: channel.get_user_id(),
7351 reason: ClosureReason::OutdatedChannelManager
7353 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
7354 let mut found_htlc = false;
7355 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
7356 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
7359 // If we have some HTLCs in the channel which are not present in the newer
7360 // ChannelMonitor, they have been removed and should be failed back to
7361 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
7362 // were actually claimed we'd have generated and ensured the previous-hop
7363 // claim update ChannelMonitor updates were persisted prior to persising
7364 // the ChannelMonitor update for the forward leg, so attempting to fail the
7365 // backwards leg of the HTLC will simply be rejected.
7366 log_info!(args.logger,
7367 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
7368 log_bytes!(channel.channel_id()), log_bytes!(payment_hash.0));
7369 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.get_counterparty_node_id(), channel.channel_id()));
7373 log_info!(args.logger, "Successfully loaded channel {}", log_bytes!(channel.channel_id()));
7374 if let Some(short_channel_id) = channel.get_short_channel_id() {
7375 short_to_chan_info.insert(short_channel_id, (channel.get_counterparty_node_id(), channel.channel_id()));
7377 if channel.is_funding_initiated() {
7378 id_to_peer.insert(channel.channel_id(), channel.get_counterparty_node_id());
7380 by_id.insert(channel.channel_id(), channel);
7382 } else if channel.is_awaiting_initial_mon_persist() {
7383 // If we were persisted and shut down while the initial ChannelMonitor persistence
7384 // was in-progress, we never broadcasted the funding transaction and can still
7385 // safely discard the channel.
7386 let _ = channel.force_shutdown(false);
7387 channel_closures.push(events::Event::ChannelClosed {
7388 channel_id: channel.channel_id(),
7389 user_channel_id: channel.get_user_id(),
7390 reason: ClosureReason::DisconnectedPeer,
7393 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.channel_id()));
7394 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
7395 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
7396 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
7397 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");
7398 return Err(DecodeError::InvalidValue);
7402 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
7403 if !funding_txo_set.contains(funding_txo) {
7404 log_info!(args.logger, "Broadcasting latest holder commitment transaction for closed channel {}", log_bytes!(funding_txo.to_channel_id()));
7405 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
7409 const MAX_ALLOC_SIZE: usize = 1024 * 64;
7410 let forward_htlcs_count: u64 = Readable::read(reader)?;
7411 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
7412 for _ in 0..forward_htlcs_count {
7413 let short_channel_id = Readable::read(reader)?;
7414 let pending_forwards_count: u64 = Readable::read(reader)?;
7415 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
7416 for _ in 0..pending_forwards_count {
7417 pending_forwards.push(Readable::read(reader)?);
7419 forward_htlcs.insert(short_channel_id, pending_forwards);
7422 let claimable_htlcs_count: u64 = Readable::read(reader)?;
7423 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
7424 for _ in 0..claimable_htlcs_count {
7425 let payment_hash = Readable::read(reader)?;
7426 let previous_hops_len: u64 = Readable::read(reader)?;
7427 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
7428 for _ in 0..previous_hops_len {
7429 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
7431 claimable_htlcs_list.push((payment_hash, previous_hops));
7434 let peer_count: u64 = Readable::read(reader)?;
7435 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState>)>()));
7436 for _ in 0..peer_count {
7437 let peer_pubkey = Readable::read(reader)?;
7438 let peer_state = PeerState {
7439 latest_features: Readable::read(reader)?,
7441 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
7444 let event_count: u64 = Readable::read(reader)?;
7445 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>()));
7446 for _ in 0..event_count {
7447 match MaybeReadable::read(reader)? {
7448 Some(event) => pending_events_read.push(event),
7453 let background_event_count: u64 = Readable::read(reader)?;
7454 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>()));
7455 for _ in 0..background_event_count {
7456 match <u8 as Readable>::read(reader)? {
7457 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
7458 _ => return Err(DecodeError::InvalidValue),
7462 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
7463 let highest_seen_timestamp: u32 = Readable::read(reader)?;
7465 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
7466 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
7467 for _ in 0..pending_inbound_payment_count {
7468 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
7469 return Err(DecodeError::InvalidValue);
7473 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
7474 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
7475 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
7476 for _ in 0..pending_outbound_payments_count_compat {
7477 let session_priv = Readable::read(reader)?;
7478 let payment = PendingOutboundPayment::Legacy {
7479 session_privs: [session_priv].iter().cloned().collect()
7481 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
7482 return Err(DecodeError::InvalidValue)
7486 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
7487 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
7488 let mut pending_outbound_payments = None;
7489 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
7490 let mut received_network_pubkey: Option<PublicKey> = None;
7491 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
7492 let mut probing_cookie_secret: Option<[u8; 32]> = None;
7493 let mut claimable_htlc_purposes = None;
7494 read_tlv_fields!(reader, {
7495 (1, pending_outbound_payments_no_retry, option),
7496 (2, pending_intercepted_htlcs, option),
7497 (3, pending_outbound_payments, option),
7498 (5, received_network_pubkey, option),
7499 (7, fake_scid_rand_bytes, option),
7500 (9, claimable_htlc_purposes, vec_type),
7501 (11, probing_cookie_secret, option),
7503 if fake_scid_rand_bytes.is_none() {
7504 fake_scid_rand_bytes = Some(args.keys_manager.get_secure_random_bytes());
7507 if probing_cookie_secret.is_none() {
7508 probing_cookie_secret = Some(args.keys_manager.get_secure_random_bytes());
7511 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
7512 pending_outbound_payments = Some(pending_outbound_payments_compat);
7513 } else if pending_outbound_payments.is_none() {
7514 let mut outbounds = HashMap::new();
7515 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
7516 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
7518 pending_outbound_payments = Some(outbounds);
7520 // If we're tracking pending payments, ensure we haven't lost any by looking at the
7521 // ChannelMonitor data for any channels for which we do not have authorative state
7522 // (i.e. those for which we just force-closed above or we otherwise don't have a
7523 // corresponding `Channel` at all).
7524 // This avoids several edge-cases where we would otherwise "forget" about pending
7525 // payments which are still in-flight via their on-chain state.
7526 // We only rebuild the pending payments map if we were most recently serialized by
7528 for (_, monitor) in args.channel_monitors.iter() {
7529 if by_id.get(&monitor.get_funding_txo().0.to_channel_id()).is_none() {
7530 for (htlc_source, htlc) in monitor.get_pending_outbound_htlcs() {
7531 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, payment_secret, .. } = htlc_source {
7532 if path.is_empty() {
7533 log_error!(args.logger, "Got an empty path for a pending payment");
7534 return Err(DecodeError::InvalidValue);
7536 let path_amt = path.last().unwrap().fee_msat;
7537 let mut session_priv_bytes = [0; 32];
7538 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
7539 match pending_outbound_payments.as_mut().unwrap().entry(payment_id) {
7540 hash_map::Entry::Occupied(mut entry) => {
7541 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
7542 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
7543 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), log_bytes!(htlc.payment_hash.0));
7545 hash_map::Entry::Vacant(entry) => {
7546 let path_fee = path.get_path_fees();
7547 entry.insert(PendingOutboundPayment::Retryable {
7548 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
7549 payment_hash: htlc.payment_hash,
7551 pending_amt_msat: path_amt,
7552 pending_fee_msat: Some(path_fee),
7553 total_msat: path_amt,
7554 starting_block_height: best_block_height,
7556 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
7557 path_amt, log_bytes!(htlc.payment_hash.0), log_bytes!(session_priv_bytes));
7562 for (htlc_source, htlc) in monitor.get_all_current_outbound_htlcs() {
7563 if let HTLCSource::PreviousHopData(prev_hop_data) = htlc_source {
7564 // The ChannelMonitor is now responsible for this HTLC's
7565 // failure/success and will let us know what its outcome is. If we
7566 // still have an entry for this HTLC in `forward_htlcs`, we were
7567 // apparently not persisted after the monitor was when forwarding
7569 forward_htlcs.retain(|_, forwards| {
7570 forwards.retain(|forward| {
7571 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
7572 if htlc_info.prev_short_channel_id == prev_hop_data.short_channel_id &&
7573 htlc_info.prev_htlc_id == prev_hop_data.htlc_id
7575 log_info!(args.logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
7576 log_bytes!(htlc.payment_hash.0), log_bytes!(monitor.get_funding_txo().0.to_channel_id()));
7581 !forwards.is_empty()
7589 if !forward_htlcs.is_empty() {
7590 // If we have pending HTLCs to forward, assume we either dropped a
7591 // `PendingHTLCsForwardable` or the user received it but never processed it as they
7592 // shut down before the timer hit. Either way, set the time_forwardable to a small
7593 // constant as enough time has likely passed that we should simply handle the forwards
7594 // now, or at least after the user gets a chance to reconnect to our peers.
7595 pending_events_read.push(events::Event::PendingHTLCsForwardable {
7596 time_forwardable: Duration::from_secs(2),
7600 let inbound_pmt_key_material = args.keys_manager.get_inbound_payment_key_material();
7601 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
7603 let mut claimable_htlcs = HashMap::with_capacity(claimable_htlcs_list.len());
7604 if let Some(mut purposes) = claimable_htlc_purposes {
7605 if purposes.len() != claimable_htlcs_list.len() {
7606 return Err(DecodeError::InvalidValue);
7608 for (purpose, (payment_hash, previous_hops)) in purposes.drain(..).zip(claimable_htlcs_list.drain(..)) {
7609 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7612 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
7613 // include a `_legacy_hop_data` in the `OnionPayload`.
7614 for (payment_hash, previous_hops) in claimable_htlcs_list.drain(..) {
7615 if previous_hops.is_empty() {
7616 return Err(DecodeError::InvalidValue);
7618 let purpose = match &previous_hops[0].onion_payload {
7619 OnionPayload::Invoice { _legacy_hop_data } => {
7620 if let Some(hop_data) = _legacy_hop_data {
7621 events::PaymentPurpose::InvoicePayment {
7622 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
7623 Some(inbound_payment) => inbound_payment.payment_preimage,
7624 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
7625 Ok(payment_preimage) => payment_preimage,
7627 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));
7628 return Err(DecodeError::InvalidValue);
7632 payment_secret: hop_data.payment_secret,
7634 } else { return Err(DecodeError::InvalidValue); }
7636 OnionPayload::Spontaneous(payment_preimage) =>
7637 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
7639 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7643 let mut secp_ctx = Secp256k1::new();
7644 secp_ctx.seeded_randomize(&args.keys_manager.get_secure_random_bytes());
7646 if !channel_closures.is_empty() {
7647 pending_events_read.append(&mut channel_closures);
7650 let our_network_key = match args.keys_manager.get_node_secret(Recipient::Node) {
7652 Err(()) => return Err(DecodeError::InvalidValue)
7654 let our_network_pubkey = PublicKey::from_secret_key(&secp_ctx, &our_network_key);
7655 if let Some(network_pubkey) = received_network_pubkey {
7656 if network_pubkey != our_network_pubkey {
7657 log_error!(args.logger, "Key that was generated does not match the existing key.");
7658 return Err(DecodeError::InvalidValue);
7662 let mut outbound_scid_aliases = HashSet::new();
7663 for (chan_id, chan) in by_id.iter_mut() {
7664 if chan.outbound_scid_alias() == 0 {
7665 let mut outbound_scid_alias;
7667 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
7668 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.keys_manager);
7669 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
7671 chan.set_outbound_scid_alias(outbound_scid_alias);
7672 } else if !outbound_scid_aliases.insert(chan.outbound_scid_alias()) {
7673 // Note that in rare cases its possible to hit this while reading an older
7674 // channel if we just happened to pick a colliding outbound alias above.
7675 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7676 return Err(DecodeError::InvalidValue);
7678 if chan.is_usable() {
7679 if short_to_chan_info.insert(chan.outbound_scid_alias(), (chan.get_counterparty_node_id(), *chan_id)).is_some() {
7680 // Note that in rare cases its possible to hit this while reading an older
7681 // channel if we just happened to pick a colliding outbound alias above.
7682 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7683 return Err(DecodeError::InvalidValue);
7688 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
7690 for (_, monitor) in args.channel_monitors.iter() {
7691 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
7692 if let Some((payment_purpose, claimable_htlcs)) = claimable_htlcs.remove(&payment_hash) {
7693 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", log_bytes!(payment_hash.0));
7694 let mut claimable_amt_msat = 0;
7695 let mut receiver_node_id = Some(our_network_pubkey);
7696 let phantom_shared_secret = claimable_htlcs[0].prev_hop.phantom_shared_secret;
7697 if phantom_shared_secret.is_some() {
7698 let phantom_pubkey = args.keys_manager.get_node_id(Recipient::PhantomNode)
7699 .expect("Failed to get node_id for phantom node recipient");
7700 receiver_node_id = Some(phantom_pubkey)
7702 for claimable_htlc in claimable_htlcs {
7703 claimable_amt_msat += claimable_htlc.value;
7705 // Add a holding-cell claim of the payment to the Channel, which should be
7706 // applied ~immediately on peer reconnection. Because it won't generate a
7707 // new commitment transaction we can just provide the payment preimage to
7708 // the corresponding ChannelMonitor and nothing else.
7710 // We do so directly instead of via the normal ChannelMonitor update
7711 // procedure as the ChainMonitor hasn't yet been initialized, implying
7712 // we're not allowed to call it directly yet. Further, we do the update
7713 // without incrementing the ChannelMonitor update ID as there isn't any
7715 // If we were to generate a new ChannelMonitor update ID here and then
7716 // crash before the user finishes block connect we'd end up force-closing
7717 // this channel as well. On the flip side, there's no harm in restarting
7718 // without the new monitor persisted - we'll end up right back here on
7720 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
7721 if let Some(channel) = by_id.get_mut(&previous_channel_id) {
7722 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
7724 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
7725 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
7728 pending_events_read.push(events::Event::PaymentClaimed {
7731 purpose: payment_purpose,
7732 amount_msat: claimable_amt_msat,
7738 let channel_manager = ChannelManager {
7740 fee_estimator: bounded_fee_estimator,
7741 chain_monitor: args.chain_monitor,
7742 tx_broadcaster: args.tx_broadcaster,
7744 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
7746 channel_state: Mutex::new(ChannelHolder {
7748 pending_msg_events: Vec::new(),
7750 inbound_payment_key: expanded_inbound_key,
7751 pending_inbound_payments: Mutex::new(pending_inbound_payments),
7752 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
7753 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
7755 forward_htlcs: Mutex::new(forward_htlcs),
7756 claimable_htlcs: Mutex::new(claimable_htlcs),
7757 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
7758 id_to_peer: Mutex::new(id_to_peer),
7759 short_to_chan_info: FairRwLock::new(short_to_chan_info),
7760 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
7762 probing_cookie_secret: probing_cookie_secret.unwrap(),
7768 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
7770 per_peer_state: RwLock::new(per_peer_state),
7772 pending_events: Mutex::new(pending_events_read),
7773 pending_background_events: Mutex::new(pending_background_events_read),
7774 total_consistency_lock: RwLock::new(()),
7775 persistence_notifier: Notifier::new(),
7777 keys_manager: args.keys_manager,
7778 logger: args.logger,
7779 default_configuration: args.default_config,
7782 for htlc_source in failed_htlcs.drain(..) {
7783 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
7784 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
7785 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
7786 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
7789 //TODO: Broadcast channel update for closed channels, but only after we've made a
7790 //connection or two.
7792 Ok((best_block_hash.clone(), channel_manager))
7798 use bitcoin::hashes::Hash;
7799 use bitcoin::hashes::sha256::Hash as Sha256;
7800 use core::time::Duration;
7801 use core::sync::atomic::Ordering;
7802 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
7803 use crate::ln::channelmanager::{self, inbound_payment, PaymentId, PaymentSendFailure};
7804 use crate::ln::functional_test_utils::*;
7805 use crate::ln::msgs;
7806 use crate::ln::msgs::ChannelMessageHandler;
7807 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
7808 use crate::util::errors::APIError;
7809 use crate::util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
7810 use crate::util::test_utils;
7811 use crate::chain::keysinterface::KeysInterface;
7814 fn test_notify_limits() {
7815 // Check that a few cases which don't require the persistence of a new ChannelManager,
7816 // indeed, do not cause the persistence of a new ChannelManager.
7817 let chanmon_cfgs = create_chanmon_cfgs(3);
7818 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7819 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7820 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7822 // All nodes start with a persistable update pending as `create_network` connects each node
7823 // with all other nodes to make most tests simpler.
7824 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7825 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7826 assert!(nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7828 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7830 // We check that the channel info nodes have doesn't change too early, even though we try
7831 // to connect messages with new values
7832 chan.0.contents.fee_base_msat *= 2;
7833 chan.1.contents.fee_base_msat *= 2;
7834 let node_a_chan_info = nodes[0].node.list_channels()[0].clone();
7835 let node_b_chan_info = nodes[1].node.list_channels()[0].clone();
7837 // The first two nodes (which opened a channel) should now require fresh persistence
7838 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7839 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7840 // ... but the last node should not.
7841 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7842 // After persisting the first two nodes they should no longer need fresh persistence.
7843 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7844 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7846 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
7847 // about the channel.
7848 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
7849 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
7850 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7852 // The nodes which are a party to the channel should also ignore messages from unrelated
7854 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7855 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7856 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7857 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7858 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7859 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7861 // At this point the channel info given by peers should still be the same.
7862 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7863 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7865 // An earlier version of handle_channel_update didn't check the directionality of the
7866 // update message and would always update the local fee info, even if our peer was
7867 // (spuriously) forwarding us our own channel_update.
7868 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
7869 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
7870 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
7872 // First deliver each peers' own message, checking that the node doesn't need to be
7873 // persisted and that its channel info remains the same.
7874 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
7875 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
7876 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7877 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7878 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7879 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7881 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
7882 // the channel info has updated.
7883 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
7884 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
7885 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7886 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7887 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
7888 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
7892 fn test_keysend_dup_hash_partial_mpp() {
7893 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
7895 let chanmon_cfgs = create_chanmon_cfgs(2);
7896 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7897 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7898 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7899 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7901 // First, send a partial MPP payment.
7902 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
7903 let mut mpp_route = route.clone();
7904 mpp_route.paths.push(mpp_route.paths[0].clone());
7906 let payment_id = PaymentId([42; 32]);
7907 // Use the utility function send_payment_along_path to send the payment with MPP data which
7908 // indicates there are more HTLCs coming.
7909 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.
7910 let session_privs = nodes[0].node.add_new_pending_payment(our_payment_hash, Some(payment_secret), payment_id, &mpp_route).unwrap();
7911 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();
7912 check_added_monitors!(nodes[0], 1);
7913 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7914 assert_eq!(events.len(), 1);
7915 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
7917 // Next, send a keysend payment with the same payment_hash and make sure it fails.
7918 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7919 check_added_monitors!(nodes[0], 1);
7920 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7921 assert_eq!(events.len(), 1);
7922 let ev = events.drain(..).next().unwrap();
7923 let payment_event = SendEvent::from_event(ev);
7924 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7925 check_added_monitors!(nodes[1], 0);
7926 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7927 expect_pending_htlcs_forwardable!(nodes[1]);
7928 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
7929 check_added_monitors!(nodes[1], 1);
7930 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7931 assert!(updates.update_add_htlcs.is_empty());
7932 assert!(updates.update_fulfill_htlcs.is_empty());
7933 assert_eq!(updates.update_fail_htlcs.len(), 1);
7934 assert!(updates.update_fail_malformed_htlcs.is_empty());
7935 assert!(updates.update_fee.is_none());
7936 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7937 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7938 expect_payment_failed!(nodes[0], our_payment_hash, true);
7940 // Send the second half of the original MPP payment.
7941 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();
7942 check_added_monitors!(nodes[0], 1);
7943 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7944 assert_eq!(events.len(), 1);
7945 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
7947 // Claim the full MPP payment. Note that we can't use a test utility like
7948 // claim_funds_along_route because the ordering of the messages causes the second half of the
7949 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
7950 // lightning messages manually.
7951 nodes[1].node.claim_funds(payment_preimage);
7952 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
7953 check_added_monitors!(nodes[1], 2);
7955 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7956 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
7957 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
7958 check_added_monitors!(nodes[0], 1);
7959 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7960 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
7961 check_added_monitors!(nodes[1], 1);
7962 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7963 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
7964 check_added_monitors!(nodes[1], 1);
7965 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7966 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
7967 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
7968 check_added_monitors!(nodes[0], 1);
7969 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7970 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
7971 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7972 check_added_monitors!(nodes[0], 1);
7973 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
7974 check_added_monitors!(nodes[1], 1);
7975 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
7976 check_added_monitors!(nodes[1], 1);
7977 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7978 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
7979 check_added_monitors!(nodes[0], 1);
7981 // Note that successful MPP payments will generate a single PaymentSent event upon the first
7982 // path's success and a PaymentPathSuccessful event for each path's success.
7983 let events = nodes[0].node.get_and_clear_pending_events();
7984 assert_eq!(events.len(), 3);
7986 Event::PaymentSent { payment_id: ref id, payment_preimage: ref preimage, payment_hash: ref hash, .. } => {
7987 assert_eq!(Some(payment_id), *id);
7988 assert_eq!(payment_preimage, *preimage);
7989 assert_eq!(our_payment_hash, *hash);
7991 _ => panic!("Unexpected event"),
7994 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7995 assert_eq!(payment_id, *actual_payment_id);
7996 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7997 assert_eq!(route.paths[0], *path);
7999 _ => panic!("Unexpected event"),
8002 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
8003 assert_eq!(payment_id, *actual_payment_id);
8004 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
8005 assert_eq!(route.paths[0], *path);
8007 _ => panic!("Unexpected event"),
8012 fn test_keysend_dup_payment_hash() {
8013 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
8014 // outbound regular payment fails as expected.
8015 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
8016 // fails as expected.
8017 let chanmon_cfgs = create_chanmon_cfgs(2);
8018 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8019 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8020 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8021 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
8022 let scorer = test_utils::TestScorer::with_penalty(0);
8023 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
8025 // To start (1), send a regular payment but don't claim it.
8026 let expected_route = [&nodes[1]];
8027 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
8029 // Next, attempt a keysend payment and make sure it fails.
8030 let route_params = RouteParameters {
8031 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id()),
8032 final_value_msat: 100_000,
8033 final_cltv_expiry_delta: TEST_FINAL_CLTV,
8035 let route = find_route(
8036 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
8037 None, nodes[0].logger, &scorer, &random_seed_bytes
8039 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
8040 check_added_monitors!(nodes[0], 1);
8041 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8042 assert_eq!(events.len(), 1);
8043 let ev = events.drain(..).next().unwrap();
8044 let payment_event = SendEvent::from_event(ev);
8045 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8046 check_added_monitors!(nodes[1], 0);
8047 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8048 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
8049 // fails), the second will process the resulting failure and fail the HTLC backward
8050 expect_pending_htlcs_forwardable!(nodes[1]);
8051 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
8052 check_added_monitors!(nodes[1], 1);
8053 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8054 assert!(updates.update_add_htlcs.is_empty());
8055 assert!(updates.update_fulfill_htlcs.is_empty());
8056 assert_eq!(updates.update_fail_htlcs.len(), 1);
8057 assert!(updates.update_fail_malformed_htlcs.is_empty());
8058 assert!(updates.update_fee.is_none());
8059 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
8060 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
8061 expect_payment_failed!(nodes[0], payment_hash, true);
8063 // Finally, claim the original payment.
8064 claim_payment(&nodes[0], &expected_route, payment_preimage);
8066 // To start (2), send a keysend payment but don't claim it.
8067 let payment_preimage = PaymentPreimage([42; 32]);
8068 let route = find_route(
8069 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
8070 None, nodes[0].logger, &scorer, &random_seed_bytes
8072 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
8073 check_added_monitors!(nodes[0], 1);
8074 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8075 assert_eq!(events.len(), 1);
8076 let event = events.pop().unwrap();
8077 let path = vec![&nodes[1]];
8078 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
8080 // Next, attempt a regular payment and make sure it fails.
8081 let payment_secret = PaymentSecret([43; 32]);
8082 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
8083 check_added_monitors!(nodes[0], 1);
8084 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8085 assert_eq!(events.len(), 1);
8086 let ev = events.drain(..).next().unwrap();
8087 let payment_event = SendEvent::from_event(ev);
8088 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8089 check_added_monitors!(nodes[1], 0);
8090 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8091 expect_pending_htlcs_forwardable!(nodes[1]);
8092 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
8093 check_added_monitors!(nodes[1], 1);
8094 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8095 assert!(updates.update_add_htlcs.is_empty());
8096 assert!(updates.update_fulfill_htlcs.is_empty());
8097 assert_eq!(updates.update_fail_htlcs.len(), 1);
8098 assert!(updates.update_fail_malformed_htlcs.is_empty());
8099 assert!(updates.update_fee.is_none());
8100 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
8101 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
8102 expect_payment_failed!(nodes[0], payment_hash, true);
8104 // Finally, succeed the keysend payment.
8105 claim_payment(&nodes[0], &expected_route, payment_preimage);
8109 fn test_keysend_hash_mismatch() {
8110 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
8111 // preimage doesn't match the msg's payment hash.
8112 let chanmon_cfgs = create_chanmon_cfgs(2);
8113 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8114 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8115 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8117 let payer_pubkey = nodes[0].node.get_our_node_id();
8118 let payee_pubkey = nodes[1].node.get_our_node_id();
8119 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8120 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8122 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], channelmanager::provided_init_features(), channelmanager::provided_init_features());
8123 let route_params = RouteParameters {
8124 payment_params: PaymentParameters::for_keysend(payee_pubkey),
8125 final_value_msat: 10_000,
8126 final_cltv_expiry_delta: 40,
8128 let network_graph = nodes[0].network_graph;
8129 let first_hops = nodes[0].node.list_usable_channels();
8130 let scorer = test_utils::TestScorer::with_penalty(0);
8131 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
8132 let route = find_route(
8133 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
8134 nodes[0].logger, &scorer, &random_seed_bytes
8137 let test_preimage = PaymentPreimage([42; 32]);
8138 let mismatch_payment_hash = PaymentHash([43; 32]);
8139 let session_privs = nodes[0].node.add_new_pending_payment(mismatch_payment_hash, None, PaymentId(mismatch_payment_hash.0), &route).unwrap();
8140 nodes[0].node.send_payment_internal(&route, mismatch_payment_hash, &None, Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
8141 check_added_monitors!(nodes[0], 1);
8143 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
8144 assert_eq!(updates.update_add_htlcs.len(), 1);
8145 assert!(updates.update_fulfill_htlcs.is_empty());
8146 assert!(updates.update_fail_htlcs.is_empty());
8147 assert!(updates.update_fail_malformed_htlcs.is_empty());
8148 assert!(updates.update_fee.is_none());
8149 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8151 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Payment preimage didn't match payment hash".to_string(), 1);
8155 fn test_keysend_msg_with_secret_err() {
8156 // Test that we error as expected if we receive a keysend payment that includes a payment secret.
8157 let chanmon_cfgs = create_chanmon_cfgs(2);
8158 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8159 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8160 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8162 let payer_pubkey = nodes[0].node.get_our_node_id();
8163 let payee_pubkey = nodes[1].node.get_our_node_id();
8164 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8165 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8167 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], channelmanager::provided_init_features(), channelmanager::provided_init_features());
8168 let route_params = RouteParameters {
8169 payment_params: PaymentParameters::for_keysend(payee_pubkey),
8170 final_value_msat: 10_000,
8171 final_cltv_expiry_delta: 40,
8173 let network_graph = nodes[0].network_graph;
8174 let first_hops = nodes[0].node.list_usable_channels();
8175 let scorer = test_utils::TestScorer::with_penalty(0);
8176 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
8177 let route = find_route(
8178 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
8179 nodes[0].logger, &scorer, &random_seed_bytes
8182 let test_preimage = PaymentPreimage([42; 32]);
8183 let test_secret = PaymentSecret([43; 32]);
8184 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
8185 let session_privs = nodes[0].node.add_new_pending_payment(payment_hash, Some(test_secret), PaymentId(payment_hash.0), &route).unwrap();
8186 nodes[0].node.send_payment_internal(&route, payment_hash, &Some(test_secret), Some(test_preimage), PaymentId(payment_hash.0), None, session_privs).unwrap();
8187 check_added_monitors!(nodes[0], 1);
8189 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
8190 assert_eq!(updates.update_add_htlcs.len(), 1);
8191 assert!(updates.update_fulfill_htlcs.is_empty());
8192 assert!(updates.update_fail_htlcs.is_empty());
8193 assert!(updates.update_fail_malformed_htlcs.is_empty());
8194 assert!(updates.update_fee.is_none());
8195 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8197 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "We don't support MPP keysend payments".to_string(), 1);
8201 fn test_multi_hop_missing_secret() {
8202 let chanmon_cfgs = create_chanmon_cfgs(4);
8203 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8204 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8205 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8207 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;
8208 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;
8209 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;
8210 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;
8212 // Marshall an MPP route.
8213 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
8214 let path = route.paths[0].clone();
8215 route.paths.push(path);
8216 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8217 route.paths[0][0].short_channel_id = chan_1_id;
8218 route.paths[0][1].short_channel_id = chan_3_id;
8219 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8220 route.paths[1][0].short_channel_id = chan_2_id;
8221 route.paths[1][1].short_channel_id = chan_4_id;
8223 match nodes[0].node.send_payment(&route, payment_hash, &None, PaymentId(payment_hash.0)).unwrap_err() {
8224 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
8225 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err)) },
8226 _ => panic!("unexpected error")
8231 fn bad_inbound_payment_hash() {
8232 // Add coverage for checking that a user-provided payment hash matches the payment secret.
8233 let chanmon_cfgs = create_chanmon_cfgs(2);
8234 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8235 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8236 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8238 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
8239 let payment_data = msgs::FinalOnionHopData {
8241 total_msat: 100_000,
8244 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
8245 // payment verification fails as expected.
8246 let mut bad_payment_hash = payment_hash.clone();
8247 bad_payment_hash.0[0] += 1;
8248 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) {
8249 Ok(_) => panic!("Unexpected ok"),
8251 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment".to_string(), "Failing HTLC with user-generated payment_hash".to_string(), 1);
8255 // Check that using the original payment hash succeeds.
8256 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());
8260 fn test_id_to_peer_coverage() {
8261 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
8262 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
8263 // the channel is successfully closed.
8264 let chanmon_cfgs = create_chanmon_cfgs(2);
8265 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8266 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8267 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8269 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
8270 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8271 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
8272 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8273 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
8275 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
8276 let channel_id = &tx.txid().into_inner();
8278 // Ensure that the `id_to_peer` map is empty until either party has received the
8279 // funding transaction, and have the real `channel_id`.
8280 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
8281 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8284 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
8286 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
8287 // as it has the funding transaction.
8288 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8289 assert_eq!(nodes_0_lock.len(), 1);
8290 assert!(nodes_0_lock.contains_key(channel_id));
8292 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8295 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8297 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8299 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8300 assert_eq!(nodes_0_lock.len(), 1);
8301 assert!(nodes_0_lock.contains_key(channel_id));
8303 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
8304 // as it has the funding transaction.
8305 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8306 assert_eq!(nodes_1_lock.len(), 1);
8307 assert!(nodes_1_lock.contains_key(channel_id));
8309 check_added_monitors!(nodes[1], 1);
8310 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8311 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
8312 check_added_monitors!(nodes[0], 1);
8313 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8314 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
8315 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
8317 nodes[0].node.close_channel(channel_id, &nodes[1].node.get_our_node_id()).unwrap();
8318 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()));
8319 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
8320 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &nodes_1_shutdown);
8322 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
8323 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
8325 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
8326 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
8327 // fee for the closing transaction has been negotiated and the parties has the other
8328 // party's signature for the fee negotiated closing transaction.)
8329 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8330 assert_eq!(nodes_0_lock.len(), 1);
8331 assert!(nodes_0_lock.contains_key(channel_id));
8333 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
8334 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
8335 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
8336 // kept in the `nodes[1]`'s `id_to_peer` map.
8337 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8338 assert_eq!(nodes_1_lock.len(), 1);
8339 assert!(nodes_1_lock.contains_key(channel_id));
8342 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()));
8344 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
8345 // therefore has all it needs to fully close the channel (both signatures for the
8346 // closing transaction).
8347 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
8348 // fully closed by `nodes[0]`.
8349 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
8351 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
8352 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
8353 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8354 assert_eq!(nodes_1_lock.len(), 1);
8355 assert!(nodes_1_lock.contains_key(channel_id));
8358 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
8360 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
8362 // Assert that the channel has now been removed from both parties `id_to_peer` map once
8363 // they both have everything required to fully close the channel.
8364 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8366 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
8368 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
8369 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
8373 #[cfg(all(any(test, feature = "_test_utils"), feature = "_bench_unstable"))]
8375 use crate::chain::Listen;
8376 use crate::chain::chainmonitor::{ChainMonitor, Persist};
8377 use crate::chain::keysinterface::{KeysManager, KeysInterface, InMemorySigner};
8378 use crate::ln::channelmanager::{self, BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId};
8379 use crate::ln::functional_test_utils::*;
8380 use crate::ln::msgs::{ChannelMessageHandler, Init};
8381 use crate::routing::gossip::NetworkGraph;
8382 use crate::routing::router::{PaymentParameters, get_route};
8383 use crate::util::test_utils;
8384 use crate::util::config::UserConfig;
8385 use crate::util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
8387 use bitcoin::hashes::Hash;
8388 use bitcoin::hashes::sha256::Hash as Sha256;
8389 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
8391 use crate::sync::{Arc, Mutex};
8395 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
8396 node: &'a ChannelManager<
8397 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
8398 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
8399 &'a test_utils::TestLogger, &'a P>,
8400 &'a test_utils::TestBroadcaster, &'a KeysManager,
8401 &'a test_utils::TestFeeEstimator, &'a test_utils::TestLogger>,
8406 fn bench_sends(bench: &mut Bencher) {
8407 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
8410 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
8411 // Do a simple benchmark of sending a payment back and forth between two nodes.
8412 // Note that this is unrealistic as each payment send will require at least two fsync
8414 let network = bitcoin::Network::Testnet;
8415 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
8417 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
8418 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
8420 let mut config: UserConfig = Default::default();
8421 config.channel_handshake_config.minimum_depth = 1;
8423 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
8424 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
8425 let seed_a = [1u8; 32];
8426 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
8427 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &logger_a, &keys_manager_a, config.clone(), ChainParameters {
8429 best_block: BestBlock::from_genesis(network),
8431 let node_a_holder = NodeHolder { node: &node_a };
8433 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
8434 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
8435 let seed_b = [2u8; 32];
8436 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
8437 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &logger_b, &keys_manager_b, config.clone(), ChainParameters {
8439 best_block: BestBlock::from_genesis(network),
8441 let node_b_holder = NodeHolder { node: &node_b };
8443 node_a.peer_connected(&node_b.get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8444 node_b.peer_connected(&node_a.get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8445 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
8446 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()));
8447 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()));
8450 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
8451 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
8452 value: 8_000_000, script_pubkey: output_script,
8454 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
8455 } else { panic!(); }
8457 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()));
8458 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()));
8460 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
8463 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
8466 Listen::block_connected(&node_a, &block, 1);
8467 Listen::block_connected(&node_b, &block, 1);
8469 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()));
8470 let msg_events = node_a.get_and_clear_pending_msg_events();
8471 assert_eq!(msg_events.len(), 2);
8472 match msg_events[0] {
8473 MessageSendEvent::SendChannelReady { ref msg, .. } => {
8474 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
8475 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
8479 match msg_events[1] {
8480 MessageSendEvent::SendChannelUpdate { .. } => {},
8484 let events_a = node_a.get_and_clear_pending_events();
8485 assert_eq!(events_a.len(), 1);
8487 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8488 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
8490 _ => panic!("Unexpected event"),
8493 let events_b = node_b.get_and_clear_pending_events();
8494 assert_eq!(events_b.len(), 1);
8496 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8497 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
8499 _ => panic!("Unexpected event"),
8502 let dummy_graph = NetworkGraph::new(genesis_hash, &logger_a);
8504 let mut payment_count: u64 = 0;
8505 macro_rules! send_payment {
8506 ($node_a: expr, $node_b: expr) => {
8507 let usable_channels = $node_a.list_usable_channels();
8508 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id())
8509 .with_features(channelmanager::provided_invoice_features());
8510 let scorer = test_utils::TestScorer::with_penalty(0);
8511 let seed = [3u8; 32];
8512 let keys_manager = KeysManager::new(&seed, 42, 42);
8513 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8514 let route = get_route(&$node_a.get_our_node_id(), &payment_params, &dummy_graph.read_only(),
8515 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), 10_000, TEST_FINAL_CLTV, &logger_a, &scorer, &random_seed_bytes).unwrap();
8517 let mut payment_preimage = PaymentPreimage([0; 32]);
8518 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
8520 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
8521 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200).unwrap();
8523 $node_a.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
8524 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
8525 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
8526 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
8527 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
8528 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
8529 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
8530 $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()));
8532 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
8533 expect_payment_claimable!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
8534 $node_b.claim_funds(payment_preimage);
8535 expect_payment_claimed!(NodeHolder { node: &$node_b }, payment_hash, 10_000);
8537 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
8538 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
8539 assert_eq!(node_id, $node_a.get_our_node_id());
8540 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8541 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
8543 _ => panic!("Failed to generate claim event"),
8546 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
8547 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
8548 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
8549 $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()));
8551 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
8556 send_payment!(node_a, node_b);
8557 send_payment!(node_b, node_a);