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::{PaymentParameters, Route, RouteHop, RoutePath, RouteParameters};
51 use crate::ln::onion_utils;
52 use crate::ln::msgs::{ChannelMessageHandler, DecodeError, LightningError, MAX_VALUE_MSAT};
53 use crate::ln::wire::Encode;
54 use crate::chain::keysinterface::{Sign, KeysInterface, KeysManager, Recipient};
55 use crate::util::config::{UserConfig, ChannelConfig};
56 use crate::util::events::{EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
57 use crate::util::{byte_utils, events};
58 use crate::util::wakers::{Future, Notifier};
59 use crate::util::scid_utils::fake_scid;
60 use crate::util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
61 use crate::util::logger::{Level, Logger};
62 use crate::util::errors::APIError;
65 use crate::prelude::*;
67 use core::cell::RefCell;
69 use crate::sync::{Arc, Mutex, MutexGuard, RwLock, RwLockReadGuard};
70 use core::sync::atomic::{AtomicUsize, Ordering};
71 use core::time::Duration;
74 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
76 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
77 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
78 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
80 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
81 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
82 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
83 // before we forward it.
85 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
86 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
87 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
88 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
89 // our payment, which we can use to decode errors or inform the user that the payment was sent.
91 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
92 pub(super) enum PendingHTLCRouting {
94 onion_packet: msgs::OnionPacket,
95 /// The SCID from the onion that we should forward to. This could be a "real" SCID, an
96 /// outbound SCID alias, or a phantom node SCID.
97 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
100 payment_data: msgs::FinalOnionHopData,
101 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
102 phantom_shared_secret: Option<[u8; 32]>,
105 payment_preimage: PaymentPreimage,
106 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
110 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
111 pub(super) struct PendingHTLCInfo {
112 pub(super) routing: PendingHTLCRouting,
113 pub(super) incoming_shared_secret: [u8; 32],
114 payment_hash: PaymentHash,
115 pub(super) amt_to_forward: u64,
116 pub(super) outgoing_cltv_value: u32,
119 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
120 pub(super) enum HTLCFailureMsg {
121 Relay(msgs::UpdateFailHTLC),
122 Malformed(msgs::UpdateFailMalformedHTLC),
125 /// Stores whether we can't forward an HTLC or relevant forwarding info
126 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
127 pub(super) enum PendingHTLCStatus {
128 Forward(PendingHTLCInfo),
129 Fail(HTLCFailureMsg),
132 pub(super) enum HTLCForwardInfo {
134 forward_info: PendingHTLCInfo,
136 // These fields are produced in `forward_htlcs()` and consumed in
137 // `process_pending_htlc_forwards()` for constructing the
138 // `HTLCSource::PreviousHopData` for failed and forwarded
141 // Note that this may be an outbound SCID alias for the associated channel.
142 prev_short_channel_id: u64,
144 prev_funding_outpoint: OutPoint,
148 err_packet: msgs::OnionErrorPacket,
152 /// Tracks the inbound corresponding to an outbound HTLC
153 #[derive(Clone, Hash, PartialEq, Eq)]
154 pub(crate) struct HTLCPreviousHopData {
155 // Note that this may be an outbound SCID alias for the associated channel.
156 short_channel_id: u64,
158 incoming_packet_shared_secret: [u8; 32],
159 phantom_shared_secret: Option<[u8; 32]>,
161 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
162 // channel with a preimage provided by the forward channel.
167 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
169 /// This is only here for backwards-compatibility in serialization, in the future it can be
170 /// removed, breaking clients running 0.0.106 and earlier.
171 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
173 /// Contains the payer-provided preimage.
174 Spontaneous(PaymentPreimage),
177 /// HTLCs that are to us and can be failed/claimed by the user
178 struct ClaimableHTLC {
179 prev_hop: HTLCPreviousHopData,
181 /// The amount (in msats) of this MPP part
183 onion_payload: OnionPayload,
185 /// The sum total of all MPP parts
189 /// A payment identifier used to uniquely identify a payment to LDK.
190 /// (C-not exported) as we just use [u8; 32] directly
191 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
192 pub struct PaymentId(pub [u8; 32]);
194 impl Writeable for PaymentId {
195 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
200 impl Readable for PaymentId {
201 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
202 let buf: [u8; 32] = Readable::read(r)?;
206 /// Tracks the inbound corresponding to an outbound HTLC
207 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
208 #[derive(Clone, PartialEq, Eq)]
209 pub(crate) enum HTLCSource {
210 PreviousHopData(HTLCPreviousHopData),
213 session_priv: SecretKey,
214 /// Technically we can recalculate this from the route, but we cache it here to avoid
215 /// doing a double-pass on route when we get a failure back
216 first_hop_htlc_msat: u64,
217 payment_id: PaymentId,
218 payment_secret: Option<PaymentSecret>,
219 payment_params: Option<PaymentParameters>,
222 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
223 impl core::hash::Hash for HTLCSource {
224 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
226 HTLCSource::PreviousHopData(prev_hop_data) => {
228 prev_hop_data.hash(hasher);
230 HTLCSource::OutboundRoute { path, session_priv, payment_id, payment_secret, first_hop_htlc_msat, payment_params } => {
233 session_priv[..].hash(hasher);
234 payment_id.hash(hasher);
235 payment_secret.hash(hasher);
236 first_hop_htlc_msat.hash(hasher);
237 payment_params.hash(hasher);
242 #[cfg(not(feature = "grind_signatures"))]
245 pub fn dummy() -> Self {
246 HTLCSource::OutboundRoute {
248 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
249 first_hop_htlc_msat: 0,
250 payment_id: PaymentId([2; 32]),
251 payment_secret: None,
252 payment_params: None,
257 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
258 pub(super) enum HTLCFailReason {
260 err: msgs::OnionErrorPacket,
268 struct ReceiveError {
274 /// Return value for claim_funds_from_hop
275 enum ClaimFundsFromHop {
277 MonitorUpdateFail(PublicKey, MsgHandleErrInternal, Option<u64>),
282 type ShutdownResult = (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash, PublicKey, [u8; 32])>);
284 /// Error type returned across the channel_state mutex boundary. When an Err is generated for a
285 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
286 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
287 /// channel_state lock. We then return the set of things that need to be done outside the lock in
288 /// this struct and call handle_error!() on it.
290 struct MsgHandleErrInternal {
291 err: msgs::LightningError,
292 chan_id: Option<([u8; 32], u64)>, // If Some a channel of ours has been closed
293 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
295 impl MsgHandleErrInternal {
297 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
299 err: LightningError {
301 action: msgs::ErrorAction::SendErrorMessage {
302 msg: msgs::ErrorMessage {
309 shutdown_finish: None,
313 fn ignore_no_close(err: String) -> Self {
315 err: LightningError {
317 action: msgs::ErrorAction::IgnoreError,
320 shutdown_finish: None,
324 fn from_no_close(err: msgs::LightningError) -> Self {
325 Self { err, chan_id: None, shutdown_finish: None }
328 fn from_finish_shutdown(err: String, channel_id: [u8; 32], user_channel_id: u64, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
330 err: LightningError {
332 action: msgs::ErrorAction::SendErrorMessage {
333 msg: msgs::ErrorMessage {
339 chan_id: Some((channel_id, user_channel_id)),
340 shutdown_finish: Some((shutdown_res, channel_update)),
344 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
347 ChannelError::Warn(msg) => LightningError {
349 action: msgs::ErrorAction::SendWarningMessage {
350 msg: msgs::WarningMessage {
354 log_level: Level::Warn,
357 ChannelError::Ignore(msg) => LightningError {
359 action: msgs::ErrorAction::IgnoreError,
361 ChannelError::Close(msg) => LightningError {
363 action: msgs::ErrorAction::SendErrorMessage {
364 msg: msgs::ErrorMessage {
372 shutdown_finish: None,
377 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
378 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
379 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
380 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
381 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
383 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
384 /// be sent in the order they appear in the return value, however sometimes the order needs to be
385 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
386 /// they were originally sent). In those cases, this enum is also returned.
387 #[derive(Clone, PartialEq)]
388 pub(super) enum RAACommitmentOrder {
389 /// Send the CommitmentUpdate messages first
391 /// Send the RevokeAndACK message first
395 // Note this is only exposed in cfg(test):
396 pub(super) struct ChannelHolder<Signer: Sign> {
397 pub(super) by_id: HashMap<[u8; 32], Channel<Signer>>,
398 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
400 /// Outbound SCID aliases are added here once the channel is available for normal use, with
401 /// SCIDs being added once the funding transaction is confirmed at the channel's required
402 /// confirmation depth.
403 pub(super) short_to_chan_info: HashMap<u64, (PublicKey, [u8; 32])>,
404 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
405 /// failed/claimed by the user.
407 /// Note that while this is held in the same mutex as the channels themselves, no consistency
408 /// guarantees are made about the channels given here actually existing anymore by the time you
410 claimable_htlcs: HashMap<PaymentHash, (events::PaymentPurpose, Vec<ClaimableHTLC>)>,
411 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
412 /// for broadcast messages, where ordering isn't as strict).
413 pub(super) pending_msg_events: Vec<MessageSendEvent>,
416 /// Events which we process internally but cannot be procsesed immediately at the generation site
417 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
418 /// quite some time lag.
419 enum BackgroundEvent {
420 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
421 /// commitment transaction.
422 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
425 /// State we hold per-peer. In the future we should put channels in here, but for now we only hold
426 /// the latest Init features we heard from the peer.
428 latest_features: InitFeatures,
431 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
432 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
434 /// For users who don't want to bother doing their own payment preimage storage, we also store that
437 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
438 /// and instead encoding it in the payment secret.
439 struct PendingInboundPayment {
440 /// The payment secret that the sender must use for us to accept this payment
441 payment_secret: PaymentSecret,
442 /// Time at which this HTLC expires - blocks with a header time above this value will result in
443 /// this payment being removed.
445 /// Arbitrary identifier the user specifies (or not)
446 user_payment_id: u64,
447 // Other required attributes of the payment, optionally enforced:
448 payment_preimage: Option<PaymentPreimage>,
449 min_value_msat: Option<u64>,
452 /// Stores the session_priv for each part of a payment that is still pending. For versions 0.0.102
453 /// and later, also stores information for retrying the payment.
454 pub(crate) enum PendingOutboundPayment {
456 session_privs: HashSet<[u8; 32]>,
459 session_privs: HashSet<[u8; 32]>,
460 payment_hash: PaymentHash,
461 payment_secret: Option<PaymentSecret>,
462 pending_amt_msat: u64,
463 /// Used to track the fee paid. Only present if the payment was serialized on 0.0.103+.
464 pending_fee_msat: Option<u64>,
465 /// The total payment amount across all paths, used to verify that a retry is not overpaying.
467 /// Our best known block height at the time this payment was initiated.
468 starting_block_height: u32,
470 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
471 /// been resolved. This ensures we don't look up pending payments in ChannelMonitors on restart
472 /// and add a pending payment that was already fulfilled.
474 session_privs: HashSet<[u8; 32]>,
475 payment_hash: Option<PaymentHash>,
476 timer_ticks_without_htlcs: u8,
478 /// When a payer gives up trying to retry a payment, they inform us, letting us generate a
479 /// `PaymentFailed` event when all HTLCs have irrevocably failed. This avoids a number of race
480 /// conditions in MPP-aware payment retriers (1), where the possibility of multiple
481 /// `PaymentPathFailed` events with `all_paths_failed` can be pending at once, confusing a
482 /// downstream event handler as to when a payment has actually failed.
484 /// (1) https://github.com/lightningdevkit/rust-lightning/issues/1164
486 session_privs: HashSet<[u8; 32]>,
487 payment_hash: PaymentHash,
491 impl PendingOutboundPayment {
492 fn is_fulfilled(&self) -> bool {
494 PendingOutboundPayment::Fulfilled { .. } => true,
498 fn abandoned(&self) -> bool {
500 PendingOutboundPayment::Abandoned { .. } => true,
504 fn get_pending_fee_msat(&self) -> Option<u64> {
506 PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
511 fn payment_hash(&self) -> Option<PaymentHash> {
513 PendingOutboundPayment::Legacy { .. } => None,
514 PendingOutboundPayment::Retryable { payment_hash, .. } => Some(*payment_hash),
515 PendingOutboundPayment::Fulfilled { payment_hash, .. } => *payment_hash,
516 PendingOutboundPayment::Abandoned { payment_hash, .. } => Some(*payment_hash),
520 fn mark_fulfilled(&mut self) {
521 let mut session_privs = HashSet::new();
522 core::mem::swap(&mut session_privs, match self {
523 PendingOutboundPayment::Legacy { session_privs } |
524 PendingOutboundPayment::Retryable { session_privs, .. } |
525 PendingOutboundPayment::Fulfilled { session_privs, .. } |
526 PendingOutboundPayment::Abandoned { session_privs, .. }
529 let payment_hash = self.payment_hash();
530 *self = PendingOutboundPayment::Fulfilled { session_privs, payment_hash, timer_ticks_without_htlcs: 0 };
533 fn mark_abandoned(&mut self) -> Result<(), ()> {
534 let mut session_privs = HashSet::new();
535 let our_payment_hash;
536 core::mem::swap(&mut session_privs, match self {
537 PendingOutboundPayment::Legacy { .. } |
538 PendingOutboundPayment::Fulfilled { .. } =>
540 PendingOutboundPayment::Retryable { session_privs, payment_hash, .. } |
541 PendingOutboundPayment::Abandoned { session_privs, payment_hash, .. } => {
542 our_payment_hash = *payment_hash;
546 *self = PendingOutboundPayment::Abandoned { session_privs, payment_hash: our_payment_hash };
550 /// panics if path is None and !self.is_fulfilled
551 fn remove(&mut self, session_priv: &[u8; 32], path: Option<&Vec<RouteHop>>) -> bool {
552 let remove_res = match self {
553 PendingOutboundPayment::Legacy { session_privs } |
554 PendingOutboundPayment::Retryable { session_privs, .. } |
555 PendingOutboundPayment::Fulfilled { session_privs, .. } |
556 PendingOutboundPayment::Abandoned { session_privs, .. } => {
557 session_privs.remove(session_priv)
561 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
562 let path = path.expect("Fulfilling a payment should always come with a path");
563 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
564 *pending_amt_msat -= path_last_hop.fee_msat;
565 if let Some(fee_msat) = pending_fee_msat.as_mut() {
566 *fee_msat -= path.get_path_fees();
573 fn insert(&mut self, session_priv: [u8; 32], path: &Vec<RouteHop>) -> bool {
574 let insert_res = match self {
575 PendingOutboundPayment::Legacy { session_privs } |
576 PendingOutboundPayment::Retryable { session_privs, .. } => {
577 session_privs.insert(session_priv)
579 PendingOutboundPayment::Fulfilled { .. } => false,
580 PendingOutboundPayment::Abandoned { .. } => false,
583 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
584 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
585 *pending_amt_msat += path_last_hop.fee_msat;
586 if let Some(fee_msat) = pending_fee_msat.as_mut() {
587 *fee_msat += path.get_path_fees();
594 fn remaining_parts(&self) -> usize {
596 PendingOutboundPayment::Legacy { session_privs } |
597 PendingOutboundPayment::Retryable { session_privs, .. } |
598 PendingOutboundPayment::Fulfilled { session_privs, .. } |
599 PendingOutboundPayment::Abandoned { session_privs, .. } => {
606 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
607 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
608 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
609 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
610 /// issues such as overly long function definitions. Note that the ChannelManager can take any
611 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
612 /// concrete type of the KeysManager.
614 /// (C-not exported) as Arcs don't make sense in bindings
615 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<Arc<M>, Arc<T>, Arc<KeysManager>, Arc<F>, Arc<L>>;
617 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
618 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
619 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
620 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
621 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
622 /// helps with issues such as long function definitions. Note that the ChannelManager can take any
623 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
624 /// concrete type of the KeysManager.
626 /// (C-not exported) as Arcs don't make sense in bindings
627 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L> = ChannelManager<&'a M, &'b T, &'c KeysManager, &'d F, &'e L>;
629 /// Manager which keeps track of a number of channels and sends messages to the appropriate
630 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
632 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
633 /// to individual Channels.
635 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
636 /// all peers during write/read (though does not modify this instance, only the instance being
637 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
638 /// called funding_transaction_generated for outbound channels).
640 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
641 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
642 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
643 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
644 /// the serialization process). If the deserialized version is out-of-date compared to the
645 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
646 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
648 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
649 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
650 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
651 /// block_connected() to step towards your best block) upon deserialization before using the
654 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
655 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
656 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
657 /// offline for a full minute. In order to track this, you must call
658 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
660 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
661 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
662 /// essentially you should default to using a SimpleRefChannelManager, and use a
663 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
664 /// you're using lightning-net-tokio.
667 // The tree structure below illustrates the lock order requirements for the different locks of the
668 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
669 // and should then be taken in the order of the lowest to the highest level in the tree.
670 // Note that locks on different branches shall not be taken at the same time, as doing so will
671 // create a new lock order for those specific locks in the order they were taken.
675 // `total_consistency_lock`
677 // |__`forward_htlcs`
679 // |__`channel_state`
683 // | |__`per_peer_state`
685 // | |__`outbound_scid_aliases`
687 // | |__`pending_inbound_payments`
689 // | |__`pending_outbound_payments`
693 // | |__`pending_events`
695 // | |__`pending_background_events`
697 pub struct ChannelManager<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
698 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
699 T::Target: BroadcasterInterface,
700 K::Target: KeysInterface,
701 F::Target: FeeEstimator,
704 default_configuration: UserConfig,
705 genesis_hash: BlockHash,
706 fee_estimator: LowerBoundedFeeEstimator<F>,
710 /// See `ChannelManager` struct-level documentation for lock order requirements.
712 pub(super) best_block: RwLock<BestBlock>,
714 best_block: RwLock<BestBlock>,
715 secp_ctx: Secp256k1<secp256k1::All>,
717 /// See `ChannelManager` struct-level documentation for lock order requirements.
718 #[cfg(any(test, feature = "_test_utils"))]
719 pub(super) channel_state: Mutex<ChannelHolder<<K::Target as KeysInterface>::Signer>>,
720 #[cfg(not(any(test, feature = "_test_utils")))]
721 channel_state: Mutex<ChannelHolder<<K::Target as KeysInterface>::Signer>>,
723 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
724 /// expose them to users via a PaymentReceived event. HTLCs which do not meet the requirements
725 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
726 /// after we generate a PaymentReceived upon receipt of all MPP parts or when they time out.
728 /// See `ChannelManager` struct-level documentation for lock order requirements.
729 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
731 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
732 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
733 /// (if the channel has been force-closed), however we track them here to prevent duplicative
734 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
735 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
736 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
737 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
738 /// after reloading from disk while replaying blocks against ChannelMonitors.
740 /// See `PendingOutboundPayment` documentation for more info.
742 /// See `ChannelManager` struct-level documentation for lock order requirements.
743 pending_outbound_payments: Mutex<HashMap<PaymentId, PendingOutboundPayment>>,
745 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
747 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
748 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
749 /// and via the classic SCID.
751 /// Note that no consistency guarantees are made about the existence of a channel with the
752 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
754 /// See `ChannelManager` struct-level documentation for lock order requirements.
756 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
758 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
760 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
761 /// and some closed channels which reached a usable state prior to being closed. This is used
762 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
763 /// active channel list on load.
765 /// See `ChannelManager` struct-level documentation for lock order requirements.
766 outbound_scid_aliases: Mutex<HashSet<u64>>,
768 /// `channel_id` -> `counterparty_node_id`.
770 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
771 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
772 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
774 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
775 /// the corresponding channel for the event, as we only have access to the `channel_id` during
776 /// the handling of the events.
779 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
780 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
781 /// would break backwards compatability.
782 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
783 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
784 /// required to access the channel with the `counterparty_node_id`.
786 /// See `ChannelManager` struct-level documentation for lock order requirements.
787 id_to_peer: Mutex<HashMap<[u8; 32], PublicKey>>,
789 our_network_key: SecretKey,
790 our_network_pubkey: PublicKey,
792 inbound_payment_key: inbound_payment::ExpandedKey,
794 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
795 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
796 /// we encrypt the namespace identifier using these bytes.
798 /// [fake scids]: crate::util::scid_utils::fake_scid
799 fake_scid_rand_bytes: [u8; 32],
801 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
802 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
803 /// keeping additional state.
804 probing_cookie_secret: [u8; 32],
806 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
807 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
808 /// very far in the past, and can only ever be up to two hours in the future.
809 highest_seen_timestamp: AtomicUsize,
811 /// The bulk of our storage will eventually be here (channels and message queues and the like).
812 /// If we are connected to a peer we always at least have an entry here, even if no channels
813 /// are currently open with that peer.
814 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
815 /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
818 /// See `ChannelManager` struct-level documentation for lock order requirements.
819 per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
821 /// See `ChannelManager` struct-level documentation for lock order requirements.
822 pending_events: Mutex<Vec<events::Event>>,
823 /// See `ChannelManager` struct-level documentation for lock order requirements.
824 pending_background_events: Mutex<Vec<BackgroundEvent>>,
825 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
826 /// Essentially just when we're serializing ourselves out.
827 /// Taken first everywhere where we are making changes before any other locks.
828 /// When acquiring this lock in read mode, rather than acquiring it directly, call
829 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
830 /// Notifier the lock contains sends out a notification when the lock is released.
831 total_consistency_lock: RwLock<()>,
833 persistence_notifier: Notifier,
840 /// Chain-related parameters used to construct a new `ChannelManager`.
842 /// Typically, the block-specific parameters are derived from the best block hash for the network,
843 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
844 /// are not needed when deserializing a previously constructed `ChannelManager`.
845 #[derive(Clone, Copy, PartialEq)]
846 pub struct ChainParameters {
847 /// The network for determining the `chain_hash` in Lightning messages.
848 pub network: Network,
850 /// The hash and height of the latest block successfully connected.
852 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
853 pub best_block: BestBlock,
856 #[derive(Copy, Clone, PartialEq)]
862 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
863 /// desirable to notify any listeners on `await_persistable_update_timeout`/
864 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
865 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
866 /// sending the aforementioned notification (since the lock being released indicates that the
867 /// updates are ready for persistence).
869 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
870 /// notify or not based on whether relevant changes have been made, providing a closure to
871 /// `optionally_notify` which returns a `NotifyOption`.
872 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
873 persistence_notifier: &'a Notifier,
875 // We hold onto this result so the lock doesn't get released immediately.
876 _read_guard: RwLockReadGuard<'a, ()>,
879 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
880 fn notify_on_drop(lock: &'a RwLock<()>, notifier: &'a Notifier) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
881 PersistenceNotifierGuard::optionally_notify(lock, notifier, || -> NotifyOption { NotifyOption::DoPersist })
884 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a Notifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
885 let read_guard = lock.read().unwrap();
887 PersistenceNotifierGuard {
888 persistence_notifier: notifier,
889 should_persist: persist_check,
890 _read_guard: read_guard,
895 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
897 if (self.should_persist)() == NotifyOption::DoPersist {
898 self.persistence_notifier.notify();
903 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
904 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
906 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
908 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
909 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
910 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
911 /// the maximum required amount in lnd as of March 2021.
912 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
914 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
915 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
917 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
919 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
920 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
921 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
922 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
923 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
924 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
925 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
926 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
927 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
928 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
929 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
930 // routing failure for any HTLC sender picking up an LDK node among the first hops.
931 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
933 /// Minimum CLTV difference between the current block height and received inbound payments.
934 /// Invoices generated for payment to us must set their `min_final_cltv_expiry` field to at least
936 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
937 // any payments to succeed. Further, we don't want payments to fail if a block was found while
938 // a payment was being routed, so we add an extra block to be safe.
939 pub const MIN_FINAL_CLTV_EXPIRY: u32 = HTLC_FAIL_BACK_BUFFER + 3;
941 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
942 // ie that if the next-hop peer fails the HTLC within
943 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
944 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
945 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
946 // LATENCY_GRACE_PERIOD_BLOCKS.
949 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;
951 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
952 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
955 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
957 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
958 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
960 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until we time-out the
961 /// idempotency of payments by [`PaymentId`]. See
962 /// [`ChannelManager::remove_stale_resolved_payments`].
963 pub(crate) const IDEMPOTENCY_TIMEOUT_TICKS: u8 = 7;
965 /// Information needed for constructing an invoice route hint for this channel.
966 #[derive(Clone, Debug, PartialEq)]
967 pub struct CounterpartyForwardingInfo {
968 /// Base routing fee in millisatoshis.
969 pub fee_base_msat: u32,
970 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
971 pub fee_proportional_millionths: u32,
972 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
973 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
974 /// `cltv_expiry_delta` for more details.
975 pub cltv_expiry_delta: u16,
978 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
979 /// to better separate parameters.
980 #[derive(Clone, Debug, PartialEq)]
981 pub struct ChannelCounterparty {
982 /// The node_id of our counterparty
983 pub node_id: PublicKey,
984 /// The Features the channel counterparty provided upon last connection.
985 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
986 /// many routing-relevant features are present in the init context.
987 pub features: InitFeatures,
988 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
989 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
990 /// claiming at least this value on chain.
992 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
994 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
995 pub unspendable_punishment_reserve: u64,
996 /// Information on the fees and requirements that the counterparty requires when forwarding
997 /// payments to us through this channel.
998 pub forwarding_info: Option<CounterpartyForwardingInfo>,
999 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
1000 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
1001 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
1002 pub outbound_htlc_minimum_msat: Option<u64>,
1003 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
1004 pub outbound_htlc_maximum_msat: Option<u64>,
1007 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
1008 #[derive(Clone, Debug, PartialEq)]
1009 pub struct ChannelDetails {
1010 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
1011 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
1012 /// Note that this means this value is *not* persistent - it can change once during the
1013 /// lifetime of the channel.
1014 pub channel_id: [u8; 32],
1015 /// Parameters which apply to our counterparty. See individual fields for more information.
1016 pub counterparty: ChannelCounterparty,
1017 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
1018 /// our counterparty already.
1020 /// Note that, if this has been set, `channel_id` will be equivalent to
1021 /// `funding_txo.unwrap().to_channel_id()`.
1022 pub funding_txo: Option<OutPoint>,
1023 /// The features which this channel operates with. See individual features for more info.
1025 /// `None` until negotiation completes and the channel type is finalized.
1026 pub channel_type: Option<ChannelTypeFeatures>,
1027 /// The position of the funding transaction in the chain. None if the funding transaction has
1028 /// not yet been confirmed and the channel fully opened.
1030 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1031 /// payments instead of this. See [`get_inbound_payment_scid`].
1033 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1034 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1036 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1037 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1038 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1039 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1040 /// [`confirmations_required`]: Self::confirmations_required
1041 pub short_channel_id: Option<u64>,
1042 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1043 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1044 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1047 /// This will be `None` as long as the channel is not available for routing outbound payments.
1049 /// [`short_channel_id`]: Self::short_channel_id
1050 /// [`confirmations_required`]: Self::confirmations_required
1051 pub outbound_scid_alias: Option<u64>,
1052 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1053 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1054 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1055 /// when they see a payment to be routed to us.
1057 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1058 /// previous values for inbound payment forwarding.
1060 /// [`short_channel_id`]: Self::short_channel_id
1061 pub inbound_scid_alias: Option<u64>,
1062 /// The value, in satoshis, of this channel as appears in the funding output
1063 pub channel_value_satoshis: u64,
1064 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1065 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1066 /// this value on chain.
1068 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1070 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1072 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1073 pub unspendable_punishment_reserve: Option<u64>,
1074 /// The `user_channel_id` passed in to create_channel, or 0 if the channel was inbound.
1075 pub user_channel_id: u64,
1076 /// Our total balance. This is the amount we would get if we close the channel.
1077 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1078 /// amount is not likely to be recoverable on close.
1080 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1081 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1082 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1083 /// This does not consider any on-chain fees.
1085 /// See also [`ChannelDetails::outbound_capacity_msat`]
1086 pub balance_msat: u64,
1087 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1088 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1089 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1090 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1092 /// See also [`ChannelDetails::balance_msat`]
1094 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1095 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1096 /// should be able to spend nearly this amount.
1097 pub outbound_capacity_msat: u64,
1098 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1099 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1100 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1101 /// to use a limit as close as possible to the HTLC limit we can currently send.
1103 /// See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
1104 pub next_outbound_htlc_limit_msat: u64,
1105 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1106 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1107 /// available for inclusion in new inbound HTLCs).
1108 /// Note that there are some corner cases not fully handled here, so the actual available
1109 /// inbound capacity may be slightly higher than this.
1111 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1112 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1113 /// However, our counterparty should be able to spend nearly this amount.
1114 pub inbound_capacity_msat: u64,
1115 /// The number of required confirmations on the funding transaction before the funding will be
1116 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1117 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1118 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1119 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1121 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1123 /// [`is_outbound`]: ChannelDetails::is_outbound
1124 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1125 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1126 pub confirmations_required: Option<u32>,
1127 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1128 /// until we can claim our funds after we force-close the channel. During this time our
1129 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1130 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1131 /// time to claim our non-HTLC-encumbered funds.
1133 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1134 pub force_close_spend_delay: Option<u16>,
1135 /// True if the channel was initiated (and thus funded) by us.
1136 pub is_outbound: bool,
1137 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1138 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1139 /// required confirmation count has been reached (and we were connected to the peer at some
1140 /// point after the funding transaction received enough confirmations). The required
1141 /// confirmation count is provided in [`confirmations_required`].
1143 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1144 pub is_channel_ready: bool,
1145 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1146 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1148 /// This is a strict superset of `is_channel_ready`.
1149 pub is_usable: bool,
1150 /// True if this channel is (or will be) publicly-announced.
1151 pub is_public: bool,
1152 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1153 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1154 pub inbound_htlc_minimum_msat: Option<u64>,
1155 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1156 pub inbound_htlc_maximum_msat: Option<u64>,
1157 /// Set of configurable parameters that affect channel operation.
1159 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1160 pub config: Option<ChannelConfig>,
1163 impl ChannelDetails {
1164 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1165 /// This should be used for providing invoice hints or in any other context where our
1166 /// counterparty will forward a payment to us.
1168 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1169 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1170 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1171 self.inbound_scid_alias.or(self.short_channel_id)
1174 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1175 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1176 /// we're sending or forwarding a payment outbound over this channel.
1178 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1179 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1180 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1181 self.short_channel_id.or(self.outbound_scid_alias)
1185 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
1186 /// Err() type describing which state the payment is in, see the description of individual enum
1187 /// states for more.
1188 #[derive(Clone, Debug)]
1189 pub enum PaymentSendFailure {
1190 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
1191 /// send the payment at all.
1193 /// You can freely resend the payment in full (with the parameter error fixed).
1195 /// Because the payment failed outright, no payment tracking is done, you do not need to call
1196 /// [`ChannelManager::abandon_payment`] and [`ChannelManager::retry_payment`] will *not* work
1197 /// for this payment.
1198 ParameterError(APIError),
1199 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
1200 /// from attempting to send the payment at all.
1202 /// You can freely resend the payment in full (with the parameter error fixed).
1204 /// The results here are ordered the same as the paths in the route object which was passed to
1207 /// Because the payment failed outright, no payment tracking is done, you do not need to call
1208 /// [`ChannelManager::abandon_payment`] and [`ChannelManager::retry_payment`] will *not* work
1209 /// for this payment.
1210 PathParameterError(Vec<Result<(), APIError>>),
1211 /// All paths which were attempted failed to send, with no channel state change taking place.
1212 /// You can freely resend the payment in full (though you probably want to do so over different
1213 /// paths than the ones selected).
1215 /// Because the payment failed outright, no payment tracking is done, you do not need to call
1216 /// [`ChannelManager::abandon_payment`] and [`ChannelManager::retry_payment`] will *not* work
1217 /// for this payment.
1218 AllFailedResendSafe(Vec<APIError>),
1219 /// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not
1220 /// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via
1221 /// [`ChannelManager::abandon_payment`]).
1223 /// [`Event::PaymentSent`]: events::Event::PaymentSent
1225 /// Some paths which were attempted failed to send, though possibly not all. At least some
1226 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
1227 /// in over-/re-payment.
1229 /// The results here are ordered the same as the paths in the route object which was passed to
1230 /// send_payment, and any `Err`s which are not [`APIError::MonitorUpdateInProgress`] can be
1231 /// safely retried via [`ChannelManager::retry_payment`].
1233 /// Any entries which contain `Err(APIError::MonitorUpdateInprogress)` or `Ok(())` MUST NOT be
1234 /// retried as they will result in over-/re-payment. These HTLCs all either successfully sent
1235 /// (in the case of `Ok(())`) or will send once a [`MonitorEvent::Completed`] is provided for
1236 /// the next-hop channel with the latest update_id.
1238 /// The errors themselves, in the same order as the route hops.
1239 results: Vec<Result<(), APIError>>,
1240 /// If some paths failed without irrevocably committing to the new HTLC(s), this will
1241 /// contain a [`RouteParameters`] object which can be used to calculate a new route that
1242 /// will pay all remaining unpaid balance.
1243 failed_paths_retry: Option<RouteParameters>,
1244 /// The payment id for the payment, which is now at least partially pending.
1245 payment_id: PaymentId,
1249 /// Route hints used in constructing invoices for [phantom node payents].
1251 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
1253 pub struct PhantomRouteHints {
1254 /// The list of channels to be included in the invoice route hints.
1255 pub channels: Vec<ChannelDetails>,
1256 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1258 pub phantom_scid: u64,
1259 /// The pubkey of the real backing node that would ultimately receive the payment.
1260 pub real_node_pubkey: PublicKey,
1263 macro_rules! handle_error {
1264 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
1267 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish }) => {
1268 #[cfg(debug_assertions)]
1270 // In testing, ensure there are no deadlocks where the lock is already held upon
1271 // entering the macro.
1272 assert!($self.channel_state.try_lock().is_ok());
1273 assert!($self.pending_events.try_lock().is_ok());
1276 let mut msg_events = Vec::with_capacity(2);
1278 if let Some((shutdown_res, update_option)) = shutdown_finish {
1279 $self.finish_force_close_channel(shutdown_res);
1280 if let Some(update) = update_option {
1281 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1285 if let Some((channel_id, user_channel_id)) = chan_id {
1286 $self.pending_events.lock().unwrap().push(events::Event::ChannelClosed {
1287 channel_id, user_channel_id,
1288 reason: ClosureReason::ProcessingError { err: err.err.clone() }
1293 log_error!($self.logger, "{}", err.err);
1294 if let msgs::ErrorAction::IgnoreError = err.action {
1296 msg_events.push(events::MessageSendEvent::HandleError {
1297 node_id: $counterparty_node_id,
1298 action: err.action.clone()
1302 if !msg_events.is_empty() {
1303 $self.channel_state.lock().unwrap().pending_msg_events.append(&mut msg_events);
1306 // Return error in case higher-API need one
1313 macro_rules! update_maps_on_chan_removal {
1314 ($self: expr, $short_to_chan_info: expr, $channel: expr) => {
1315 if let Some(short_id) = $channel.get_short_channel_id() {
1316 $short_to_chan_info.remove(&short_id);
1318 // If the channel was never confirmed on-chain prior to its closure, remove the
1319 // outbound SCID alias we used for it from the collision-prevention set. While we
1320 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1321 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1322 // opening a million channels with us which are closed before we ever reach the funding
1324 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel.outbound_scid_alias());
1325 debug_assert!(alias_removed);
1327 $self.id_to_peer.lock().unwrap().remove(&$channel.channel_id());
1328 $short_to_chan_info.remove(&$channel.outbound_scid_alias());
1332 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1333 macro_rules! convert_chan_err {
1334 ($self: ident, $err: expr, $short_to_chan_info: expr, $channel: expr, $channel_id: expr) => {
1336 ChannelError::Warn(msg) => {
1337 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), $channel_id.clone()))
1339 ChannelError::Ignore(msg) => {
1340 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
1342 ChannelError::Close(msg) => {
1343 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
1344 update_maps_on_chan_removal!($self, $short_to_chan_info, $channel);
1345 let shutdown_res = $channel.force_shutdown(true);
1346 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
1347 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
1353 macro_rules! break_chan_entry {
1354 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
1358 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_chan_info, $entry.get_mut(), $entry.key());
1360 $entry.remove_entry();
1368 macro_rules! try_chan_entry {
1369 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
1373 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_chan_info, $entry.get_mut(), $entry.key());
1375 $entry.remove_entry();
1383 macro_rules! remove_channel {
1384 ($self: expr, $channel_state: expr, $entry: expr) => {
1386 let channel = $entry.remove_entry().1;
1387 update_maps_on_chan_removal!($self, $channel_state.short_to_chan_info, channel);
1393 macro_rules! handle_monitor_update_res {
1394 ($self: ident, $err: expr, $short_to_chan_info: 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) => {
1396 ChannelMonitorUpdateStatus::PermanentFailure => {
1397 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateStatus::PermanentFailure", log_bytes!($chan_id[..]));
1398 update_maps_on_chan_removal!($self, $short_to_chan_info, $chan);
1399 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
1400 // chain in a confused state! We need to move them into the ChannelMonitor which
1401 // will be responsible for failing backwards once things confirm on-chain.
1402 // It's ok that we drop $failed_forwards here - at this point we'd rather they
1403 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
1404 // us bother trying to claim it just to forward on to another peer. If we're
1405 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
1406 // given up the preimage yet, so might as well just wait until the payment is
1407 // retried, avoiding the on-chain fees.
1408 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure".to_owned(), *$chan_id, $chan.get_user_id(),
1409 $chan.force_shutdown(false), $self.get_channel_update_for_broadcast(&$chan).ok() ));
1412 ChannelMonitorUpdateStatus::InProgress => {
1413 log_info!($self.logger, "Disabling channel {} due to monitor update in progress. On restore will send {} and process {} forwards, {} fails, and {} fulfill finalizations",
1414 log_bytes!($chan_id[..]),
1415 if $resend_commitment && $resend_raa {
1416 match $action_type {
1417 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
1418 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
1420 } else if $resend_commitment { "commitment" }
1421 else if $resend_raa { "RAA" }
1423 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
1424 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len(),
1425 (&$failed_finalized_fulfills as &Vec<HTLCSource>).len());
1426 if !$resend_commitment {
1427 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
1430 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
1432 $chan.monitor_updating_paused($resend_raa, $resend_commitment, $resend_channel_ready, $failed_forwards, $failed_fails, $failed_finalized_fulfills);
1433 (Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$chan_id)), false)
1435 ChannelMonitorUpdateStatus::Completed => {
1440 ($self: ident, $err: expr, $channel_state: 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) => { {
1441 let (res, drop) = handle_monitor_update_res!($self, $err, $channel_state.short_to_chan_info, $entry.get_mut(), $action_type, $resend_raa, $resend_commitment, $resend_channel_ready, $failed_forwards, $failed_fails, $failed_finalized_fulfills, $entry.key());
1443 $entry.remove_entry();
1447 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $chan_id: expr, COMMITMENT_UPDATE_ONLY) => { {
1448 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst);
1449 handle_monitor_update_res!($self, $err, $channel_state, $entry, $action_type, false, true, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1451 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $chan_id: expr, NO_UPDATE) => {
1452 handle_monitor_update_res!($self, $err, $channel_state, $entry, $action_type, false, false, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1454 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_channel_ready: expr, OPTIONALLY_RESEND_FUNDING_LOCKED) => {
1455 handle_monitor_update_res!($self, $err, $channel_state, $entry, $action_type, false, false, $resend_channel_ready, Vec::new(), Vec::new(), Vec::new())
1457 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1458 handle_monitor_update_res!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, false, Vec::new(), Vec::new(), Vec::new())
1460 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
1461 handle_monitor_update_res!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, false, $failed_forwards, $failed_fails, Vec::new())
1465 macro_rules! send_channel_ready {
1466 ($short_to_chan_info: expr, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {
1467 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1468 node_id: $channel.get_counterparty_node_id(),
1469 msg: $channel_ready_msg,
1471 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1472 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1473 let outbound_alias_insert = $short_to_chan_info.insert($channel.outbound_scid_alias(), ($channel.get_counterparty_node_id(), $channel.channel_id()));
1474 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1475 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1476 if let Some(real_scid) = $channel.get_short_channel_id() {
1477 let scid_insert = $short_to_chan_info.insert(real_scid, ($channel.get_counterparty_node_id(), $channel.channel_id()));
1478 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1479 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1484 macro_rules! emit_channel_ready_event {
1485 ($self: expr, $channel: expr) => {
1486 if $channel.should_emit_channel_ready_event() {
1488 let mut pending_events = $self.pending_events.lock().unwrap();
1489 pending_events.push(events::Event::ChannelReady {
1490 channel_id: $channel.channel_id(),
1491 user_channel_id: $channel.get_user_id(),
1492 counterparty_node_id: $channel.get_counterparty_node_id(),
1493 channel_type: $channel.get_channel_type().clone(),
1496 $channel.set_channel_ready_event_emitted();
1501 macro_rules! handle_chan_restoration_locked {
1502 ($self: ident, $channel_lock: expr, $channel_state: expr, $channel_entry: expr,
1503 $raa: expr, $commitment_update: expr, $order: expr, $chanmon_update: expr,
1504 $pending_forwards: expr, $funding_broadcastable: expr, $channel_ready: expr, $announcement_sigs: expr) => { {
1505 let mut htlc_forwards = None;
1507 let chanmon_update: Option<ChannelMonitorUpdate> = $chanmon_update; // Force type-checking to resolve
1508 let chanmon_update_is_none = chanmon_update.is_none();
1509 let counterparty_node_id = $channel_entry.get().get_counterparty_node_id();
1511 let forwards: Vec<(PendingHTLCInfo, u64)> = $pending_forwards; // Force type-checking to resolve
1512 if !forwards.is_empty() {
1513 htlc_forwards = Some(($channel_entry.get().get_short_channel_id().unwrap_or($channel_entry.get().outbound_scid_alias()),
1514 $channel_entry.get().get_funding_txo().unwrap(), forwards));
1517 if chanmon_update.is_some() {
1518 // On reconnect, we, by definition, only resend a channel_ready if there have been
1519 // no commitment updates, so the only channel monitor update which could also be
1520 // associated with a channel_ready would be the funding_created/funding_signed
1521 // monitor update. That monitor update failing implies that we won't send
1522 // channel_ready until it's been updated, so we can't have a channel_ready and a
1523 // monitor update here (so we don't bother to handle it correctly below).
1524 assert!($channel_ready.is_none());
1525 // A channel monitor update makes no sense without either a channel_ready or a
1526 // commitment update to process after it. Since we can't have a channel_ready, we
1527 // only bother to handle the monitor-update + commitment_update case below.
1528 assert!($commitment_update.is_some());
1531 if let Some(msg) = $channel_ready {
1532 // Similar to the above, this implies that we're letting the channel_ready fly
1533 // before it should be allowed to.
1534 assert!(chanmon_update.is_none());
1535 send_channel_ready!($channel_state.short_to_chan_info, $channel_state.pending_msg_events, $channel_entry.get(), msg);
1537 if let Some(msg) = $announcement_sigs {
1538 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1539 node_id: counterparty_node_id,
1544 emit_channel_ready_event!($self, $channel_entry.get_mut());
1546 let funding_broadcastable: Option<Transaction> = $funding_broadcastable; // Force type-checking to resolve
1547 if let Some(monitor_update) = chanmon_update {
1548 // We only ever broadcast a funding transaction in response to a funding_signed
1549 // message and the resulting monitor update. Thus, on channel_reestablish
1550 // message handling we can't have a funding transaction to broadcast. When
1551 // processing a monitor update finishing resulting in a funding broadcast, we
1552 // cannot have a second monitor update, thus this case would indicate a bug.
1553 assert!(funding_broadcastable.is_none());
1554 // Given we were just reconnected or finished updating a channel monitor, the
1555 // only case where we can get a new ChannelMonitorUpdate would be if we also
1556 // have some commitment updates to send as well.
1557 assert!($commitment_update.is_some());
1558 match $self.chain_monitor.update_channel($channel_entry.get().get_funding_txo().unwrap(), monitor_update) {
1559 ChannelMonitorUpdateStatus::Completed => {},
1561 // channel_reestablish doesn't guarantee the order it returns is sensical
1562 // for the messages it returns, but if we're setting what messages to
1563 // re-transmit on monitor update success, we need to make sure it is sane.
1564 let mut order = $order;
1566 order = RAACommitmentOrder::CommitmentFirst;
1568 break handle_monitor_update_res!($self, e, $channel_state, $channel_entry, order, $raa.is_some(), true);
1573 macro_rules! handle_cs { () => {
1574 if let Some(update) = $commitment_update {
1575 $channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1576 node_id: counterparty_node_id,
1581 macro_rules! handle_raa { () => {
1582 if let Some(revoke_and_ack) = $raa {
1583 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1584 node_id: counterparty_node_id,
1585 msg: revoke_and_ack,
1590 RAACommitmentOrder::CommitmentFirst => {
1594 RAACommitmentOrder::RevokeAndACKFirst => {
1599 if let Some(tx) = funding_broadcastable {
1600 log_info!($self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
1601 $self.tx_broadcaster.broadcast_transaction(&tx);
1606 if chanmon_update_is_none {
1607 // If there was no ChannelMonitorUpdate, we should never generate an Err in the res loop
1608 // above. Doing so would imply calling handle_err!() from channel_monitor_updated() which
1609 // should *never* end up calling back to `chain_monitor.update_channel()`.
1610 assert!(res.is_ok());
1613 (htlc_forwards, res, counterparty_node_id)
1617 macro_rules! post_handle_chan_restoration {
1618 ($self: ident, $locked_res: expr) => { {
1619 let (htlc_forwards, res, counterparty_node_id) = $locked_res;
1621 let _ = handle_error!($self, res, counterparty_node_id);
1623 if let Some(forwards) = htlc_forwards {
1624 $self.forward_htlcs(&mut [forwards][..]);
1629 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F, L>
1630 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
1631 T::Target: BroadcasterInterface,
1632 K::Target: KeysInterface,
1633 F::Target: FeeEstimator,
1636 /// Constructs a new ChannelManager to hold several channels and route between them.
1638 /// This is the main "logic hub" for all channel-related actions, and implements
1639 /// ChannelMessageHandler.
1641 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1643 /// Users need to notify the new ChannelManager when a new block is connected or
1644 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
1645 /// from after `params.latest_hash`.
1646 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, logger: L, keys_manager: K, config: UserConfig, params: ChainParameters) -> Self {
1647 let mut secp_ctx = Secp256k1::new();
1648 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
1649 let inbound_pmt_key_material = keys_manager.get_inbound_payment_key_material();
1650 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
1652 default_configuration: config.clone(),
1653 genesis_hash: genesis_block(params.network).header.block_hash(),
1654 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
1658 best_block: RwLock::new(params.best_block),
1660 channel_state: Mutex::new(ChannelHolder{
1661 by_id: HashMap::new(),
1662 short_to_chan_info: HashMap::new(),
1663 claimable_htlcs: HashMap::new(),
1664 pending_msg_events: Vec::new(),
1666 outbound_scid_aliases: Mutex::new(HashSet::new()),
1667 pending_inbound_payments: Mutex::new(HashMap::new()),
1668 pending_outbound_payments: Mutex::new(HashMap::new()),
1669 forward_htlcs: Mutex::new(HashMap::new()),
1670 id_to_peer: Mutex::new(HashMap::new()),
1672 our_network_key: keys_manager.get_node_secret(Recipient::Node).unwrap(),
1673 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret(Recipient::Node).unwrap()),
1676 inbound_payment_key: expanded_inbound_key,
1677 fake_scid_rand_bytes: keys_manager.get_secure_random_bytes(),
1679 probing_cookie_secret: keys_manager.get_secure_random_bytes(),
1681 highest_seen_timestamp: AtomicUsize::new(0),
1683 per_peer_state: RwLock::new(HashMap::new()),
1685 pending_events: Mutex::new(Vec::new()),
1686 pending_background_events: Mutex::new(Vec::new()),
1687 total_consistency_lock: RwLock::new(()),
1688 persistence_notifier: Notifier::new(),
1696 /// Gets the current configuration applied to all new channels.
1697 pub fn get_current_default_configuration(&self) -> &UserConfig {
1698 &self.default_configuration
1701 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
1702 let height = self.best_block.read().unwrap().height();
1703 let mut outbound_scid_alias = 0;
1706 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
1707 outbound_scid_alias += 1;
1709 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
1711 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
1715 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"); }
1720 /// Creates a new outbound channel to the given remote node and with the given value.
1722 /// `user_channel_id` will be provided back as in
1723 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
1724 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to 0
1725 /// for inbound channels, so you may wish to avoid using 0 for `user_channel_id` here.
1726 /// `user_channel_id` has no meaning inside of LDK, it is simply copied to events and otherwise
1729 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
1730 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
1732 /// Note that we do not check if you are currently connected to the given peer. If no
1733 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
1734 /// the channel eventually being silently forgotten (dropped on reload).
1736 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
1737 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
1738 /// [`ChannelDetails::channel_id`] until after
1739 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
1740 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
1741 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
1743 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
1744 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
1745 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
1746 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_channel_id: u64, override_config: Option<UserConfig>) -> Result<[u8; 32], APIError> {
1747 if channel_value_satoshis < 1000 {
1748 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
1752 let per_peer_state = self.per_peer_state.read().unwrap();
1753 match per_peer_state.get(&their_network_key) {
1754 Some(peer_state) => {
1755 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
1756 let peer_state = peer_state.lock().unwrap();
1757 let their_features = &peer_state.latest_features;
1758 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
1759 match Channel::new_outbound(&self.fee_estimator, &self.keys_manager, their_network_key,
1760 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
1761 self.best_block.read().unwrap().height(), outbound_scid_alias)
1765 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
1770 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", their_network_key) }),
1773 let res = channel.get_open_channel(self.genesis_hash.clone());
1775 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1776 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
1777 debug_assert!(&self.total_consistency_lock.try_write().is_err());
1779 let temporary_channel_id = channel.channel_id();
1780 let mut channel_state = self.channel_state.lock().unwrap();
1781 match channel_state.by_id.entry(temporary_channel_id) {
1782 hash_map::Entry::Occupied(_) => {
1784 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
1786 panic!("RNG is bad???");
1789 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
1791 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
1792 node_id: their_network_key,
1795 Ok(temporary_channel_id)
1798 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<<K::Target as KeysInterface>::Signer>)) -> bool>(&self, f: Fn) -> Vec<ChannelDetails> {
1799 let mut res = Vec::new();
1801 let channel_state = self.channel_state.lock().unwrap();
1802 res.reserve(channel_state.by_id.len());
1803 for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
1804 let balance = channel.get_available_balances();
1805 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1806 channel.get_holder_counterparty_selected_channel_reserve_satoshis();
1807 res.push(ChannelDetails {
1808 channel_id: (*channel_id).clone(),
1809 counterparty: ChannelCounterparty {
1810 node_id: channel.get_counterparty_node_id(),
1811 features: InitFeatures::empty(),
1812 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1813 forwarding_info: channel.counterparty_forwarding_info(),
1814 // Ensures that we have actually received the `htlc_minimum_msat` value
1815 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1816 // message (as they are always the first message from the counterparty).
1817 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1818 // default `0` value set by `Channel::new_outbound`.
1819 outbound_htlc_minimum_msat: if channel.have_received_message() {
1820 Some(channel.get_counterparty_htlc_minimum_msat()) } else { None },
1821 outbound_htlc_maximum_msat: channel.get_counterparty_htlc_maximum_msat(),
1823 funding_txo: channel.get_funding_txo(),
1824 // Note that accept_channel (or open_channel) is always the first message, so
1825 // `have_received_message` indicates that type negotiation has completed.
1826 channel_type: if channel.have_received_message() { Some(channel.get_channel_type().clone()) } else { None },
1827 short_channel_id: channel.get_short_channel_id(),
1828 outbound_scid_alias: if channel.is_usable() { Some(channel.outbound_scid_alias()) } else { None },
1829 inbound_scid_alias: channel.latest_inbound_scid_alias(),
1830 channel_value_satoshis: channel.get_value_satoshis(),
1831 unspendable_punishment_reserve: to_self_reserve_satoshis,
1832 balance_msat: balance.balance_msat,
1833 inbound_capacity_msat: balance.inbound_capacity_msat,
1834 outbound_capacity_msat: balance.outbound_capacity_msat,
1835 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1836 user_channel_id: channel.get_user_id(),
1837 confirmations_required: channel.minimum_depth(),
1838 force_close_spend_delay: channel.get_counterparty_selected_contest_delay(),
1839 is_outbound: channel.is_outbound(),
1840 is_channel_ready: channel.is_usable(),
1841 is_usable: channel.is_live(),
1842 is_public: channel.should_announce(),
1843 inbound_htlc_minimum_msat: Some(channel.get_holder_htlc_minimum_msat()),
1844 inbound_htlc_maximum_msat: channel.get_holder_htlc_maximum_msat(),
1845 config: Some(channel.config()),
1849 let per_peer_state = self.per_peer_state.read().unwrap();
1850 for chan in res.iter_mut() {
1851 if let Some(peer_state) = per_peer_state.get(&chan.counterparty.node_id) {
1852 chan.counterparty.features = peer_state.lock().unwrap().latest_features.clone();
1858 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
1859 /// more information.
1860 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1861 self.list_channels_with_filter(|_| true)
1864 /// Gets the list of usable channels, in random order. Useful as an argument to [`find_route`]
1865 /// to ensure non-announced channels are used.
1867 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1868 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1871 /// [`find_route`]: crate::routing::router::find_route
1872 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1873 // Note we use is_live here instead of usable which leads to somewhat confused
1874 // internal/external nomenclature, but that's ok cause that's probably what the user
1875 // really wanted anyway.
1876 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1879 /// Helper function that issues the channel close events
1880 fn issue_channel_close_events(&self, channel: &Channel<<K::Target as KeysInterface>::Signer>, closure_reason: ClosureReason) {
1881 let mut pending_events_lock = self.pending_events.lock().unwrap();
1882 match channel.unbroadcasted_funding() {
1883 Some(transaction) => {
1884 pending_events_lock.push(events::Event::DiscardFunding { channel_id: channel.channel_id(), transaction })
1888 pending_events_lock.push(events::Event::ChannelClosed {
1889 channel_id: channel.channel_id(),
1890 user_channel_id: channel.get_user_id(),
1891 reason: closure_reason
1895 fn close_channel_internal(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>) -> Result<(), APIError> {
1896 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1898 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
1899 let result: Result<(), _> = loop {
1900 let mut channel_state_lock = self.channel_state.lock().unwrap();
1901 let channel_state = &mut *channel_state_lock;
1902 match channel_state.by_id.entry(channel_id.clone()) {
1903 hash_map::Entry::Occupied(mut chan_entry) => {
1904 if *counterparty_node_id != chan_entry.get().get_counterparty_node_id(){
1905 return Err(APIError::APIMisuseError { err: "The passed counterparty_node_id doesn't match the channel's counterparty node_id".to_owned() });
1907 let per_peer_state = self.per_peer_state.read().unwrap();
1908 let (shutdown_msg, monitor_update, htlcs) = match per_peer_state.get(&counterparty_node_id) {
1909 Some(peer_state) => {
1910 let peer_state = peer_state.lock().unwrap();
1911 let their_features = &peer_state.latest_features;
1912 chan_entry.get_mut().get_shutdown(&self.keys_manager, their_features, target_feerate_sats_per_1000_weight)?
1914 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", counterparty_node_id) }),
1916 failed_htlcs = htlcs;
1918 // Update the monitor with the shutdown script if necessary.
1919 if let Some(monitor_update) = monitor_update {
1920 let update_res = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update);
1921 let (result, is_permanent) =
1922 handle_monitor_update_res!(self, update_res, channel_state.short_to_chan_info, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
1924 remove_channel!(self, channel_state, chan_entry);
1929 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1930 node_id: *counterparty_node_id,
1934 if chan_entry.get().is_shutdown() {
1935 let channel = remove_channel!(self, channel_state, chan_entry);
1936 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
1937 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1941 self.issue_channel_close_events(&channel, ClosureReason::HolderForceClosed);
1945 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()})
1949 for htlc_source in failed_htlcs.drain(..) {
1950 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
1951 self.fail_htlc_backwards_internal(htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
1954 let _ = handle_error!(self, result, *counterparty_node_id);
1958 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1959 /// will be accepted on the given channel, and after additional timeout/the closing of all
1960 /// pending HTLCs, the channel will be closed on chain.
1962 /// * If we are the channel initiator, we will pay between our [`Background`] and
1963 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1965 /// * If our counterparty is the channel initiator, we will require a channel closing
1966 /// transaction feerate of at least our [`Background`] feerate or the feerate which
1967 /// would appear on a force-closure transaction, whichever is lower. We will allow our
1968 /// counterparty to pay as much fee as they'd like, however.
1970 /// May generate a SendShutdown message event on success, which should be relayed.
1972 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1973 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1974 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1975 pub fn close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
1976 self.close_channel_internal(channel_id, counterparty_node_id, None)
1979 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1980 /// will be accepted on the given channel, and after additional timeout/the closing of all
1981 /// pending HTLCs, the channel will be closed on chain.
1983 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
1984 /// the channel being closed or not:
1985 /// * If we are the channel initiator, we will pay at least this feerate on the closing
1986 /// transaction. The upper-bound is set by
1987 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1988 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
1989 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
1990 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
1991 /// will appear on a force-closure transaction, whichever is lower).
1993 /// May generate a SendShutdown message event on success, which should be relayed.
1995 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1996 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1997 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1998 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> {
1999 self.close_channel_internal(channel_id, counterparty_node_id, Some(target_feerate_sats_per_1000_weight))
2003 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
2004 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
2005 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
2006 for htlc_source in failed_htlcs.drain(..) {
2007 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
2008 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
2009 self.fail_htlc_backwards_internal(source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
2011 if let Some((funding_txo, monitor_update)) = monitor_update_option {
2012 // There isn't anything we can do if we get an update failure - we're already
2013 // force-closing. The monitor update on the required in-memory copy should broadcast
2014 // the latest local state, which is the best we can do anyway. Thus, it is safe to
2015 // ignore the result here.
2016 let _ = self.chain_monitor.update_channel(funding_txo, monitor_update);
2020 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
2021 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
2022 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
2023 -> Result<PublicKey, APIError> {
2025 let mut channel_state_lock = self.channel_state.lock().unwrap();
2026 let channel_state = &mut *channel_state_lock;
2027 if let hash_map::Entry::Occupied(chan) = channel_state.by_id.entry(channel_id.clone()) {
2028 if chan.get().get_counterparty_node_id() != *peer_node_id {
2029 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
2031 if let Some(peer_msg) = peer_msg {
2032 self.issue_channel_close_events(chan.get(),ClosureReason::CounterpartyForceClosed { peer_msg: peer_msg.to_string() });
2034 self.issue_channel_close_events(chan.get(),ClosureReason::HolderForceClosed);
2036 remove_channel!(self, channel_state, chan)
2038 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
2041 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
2042 self.finish_force_close_channel(chan.force_shutdown(broadcast));
2043 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
2044 let mut channel_state = self.channel_state.lock().unwrap();
2045 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2050 Ok(chan.get_counterparty_node_id())
2053 fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
2054 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2055 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
2056 Ok(counterparty_node_id) => {
2057 self.channel_state.lock().unwrap().pending_msg_events.push(
2058 events::MessageSendEvent::HandleError {
2059 node_id: counterparty_node_id,
2060 action: msgs::ErrorAction::SendErrorMessage {
2061 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
2071 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
2072 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
2073 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
2075 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
2076 -> Result<(), APIError> {
2077 self.force_close_sending_error(channel_id, counterparty_node_id, true)
2080 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
2081 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
2082 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
2084 /// You can always get the latest local transaction(s) to broadcast from
2085 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
2086 pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
2087 -> Result<(), APIError> {
2088 self.force_close_sending_error(channel_id, counterparty_node_id, false)
2091 /// Force close all channels, immediately broadcasting the latest local commitment transaction
2092 /// for each to the chain and rejecting new HTLCs on each.
2093 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
2094 for chan in self.list_channels() {
2095 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
2099 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
2100 /// local transaction(s).
2101 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
2102 for chan in self.list_channels() {
2103 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
2107 fn construct_recv_pending_htlc_info(&self, hop_data: msgs::OnionHopData, shared_secret: [u8; 32],
2108 payment_hash: PaymentHash, amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>) -> Result<PendingHTLCInfo, ReceiveError>
2110 // final_incorrect_cltv_expiry
2111 if hop_data.outgoing_cltv_value != cltv_expiry {
2112 return Err(ReceiveError {
2113 msg: "Upstream node set CLTV to the wrong value",
2115 err_data: byte_utils::be32_to_array(cltv_expiry).to_vec()
2118 // final_expiry_too_soon
2119 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
2120 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
2121 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
2122 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
2123 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
2124 if (hop_data.outgoing_cltv_value as u64) <= self.best_block.read().unwrap().height() as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
2125 return Err(ReceiveError {
2127 err_data: Vec::new(),
2128 msg: "The final CLTV expiry is too soon to handle",
2131 if hop_data.amt_to_forward > amt_msat {
2132 return Err(ReceiveError {
2134 err_data: byte_utils::be64_to_array(amt_msat).to_vec(),
2135 msg: "Upstream node sent less than we were supposed to receive in payment",
2139 let routing = match hop_data.format {
2140 msgs::OnionHopDataFormat::Legacy { .. } => {
2141 return Err(ReceiveError {
2142 err_code: 0x4000|0x2000|3,
2143 err_data: Vec::new(),
2144 msg: "We require payment_secrets",
2147 msgs::OnionHopDataFormat::NonFinalNode { .. } => {
2148 return Err(ReceiveError {
2149 err_code: 0x4000|22,
2150 err_data: Vec::new(),
2151 msg: "Got non final data with an HMAC of 0",
2154 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage } => {
2155 if payment_data.is_some() && keysend_preimage.is_some() {
2156 return Err(ReceiveError {
2157 err_code: 0x4000|22,
2158 err_data: Vec::new(),
2159 msg: "We don't support MPP keysend payments",
2161 } else if let Some(data) = payment_data {
2162 PendingHTLCRouting::Receive {
2164 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2165 phantom_shared_secret,
2167 } else if let Some(payment_preimage) = keysend_preimage {
2168 // We need to check that the sender knows the keysend preimage before processing this
2169 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
2170 // could discover the final destination of X, by probing the adjacent nodes on the route
2171 // with a keysend payment of identical payment hash to X and observing the processing
2172 // time discrepancies due to a hash collision with X.
2173 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2174 if hashed_preimage != payment_hash {
2175 return Err(ReceiveError {
2176 err_code: 0x4000|22,
2177 err_data: Vec::new(),
2178 msg: "Payment preimage didn't match payment hash",
2182 PendingHTLCRouting::ReceiveKeysend {
2184 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2187 return Err(ReceiveError {
2188 err_code: 0x4000|0x2000|3,
2189 err_data: Vec::new(),
2190 msg: "We require payment_secrets",
2195 Ok(PendingHTLCInfo {
2198 incoming_shared_secret: shared_secret,
2199 amt_to_forward: amt_msat,
2200 outgoing_cltv_value: hop_data.outgoing_cltv_value,
2204 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> PendingHTLCStatus {
2205 macro_rules! return_malformed_err {
2206 ($msg: expr, $err_code: expr) => {
2208 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2209 return PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
2210 channel_id: msg.channel_id,
2211 htlc_id: msg.htlc_id,
2212 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
2213 failure_code: $err_code,
2219 if let Err(_) = msg.onion_routing_packet.public_key {
2220 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2223 let shared_secret = SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key).secret_bytes();
2225 if msg.onion_routing_packet.version != 0 {
2226 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2227 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2228 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2229 //receiving node would have to brute force to figure out which version was put in the
2230 //packet by the node that send us the message, in the case of hashing the hop_data, the
2231 //node knows the HMAC matched, so they already know what is there...
2232 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2234 macro_rules! return_err {
2235 ($msg: expr, $err_code: expr, $data: expr) => {
2237 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2238 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2239 channel_id: msg.channel_id,
2240 htlc_id: msg.htlc_id,
2241 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
2247 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) {
2249 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2250 return_malformed_err!(err_msg, err_code);
2252 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2253 return_err!(err_msg, err_code, &[0; 0]);
2257 let pending_forward_info = match next_hop {
2258 onion_utils::Hop::Receive(next_hop_data) => {
2260 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash, msg.amount_msat, msg.cltv_expiry, None) {
2262 // Note that we could obviously respond immediately with an update_fulfill_htlc
2263 // message, however that would leak that we are the recipient of this payment, so
2264 // instead we stay symmetric with the forwarding case, only responding (after a
2265 // delay) once they've send us a commitment_signed!
2266 PendingHTLCStatus::Forward(info)
2268 Err(ReceiveError { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
2271 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
2272 let new_pubkey = msg.onion_routing_packet.public_key.unwrap();
2273 let outgoing_packet = msgs::OnionPacket {
2275 public_key: onion_utils::next_hop_packet_pubkey(&self.secp_ctx, new_pubkey, &shared_secret),
2276 hop_data: new_packet_bytes,
2277 hmac: next_hop_hmac.clone(),
2280 let short_channel_id = match next_hop_data.format {
2281 msgs::OnionHopDataFormat::Legacy { short_channel_id } => short_channel_id,
2282 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
2283 msgs::OnionHopDataFormat::FinalNode { .. } => {
2284 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
2288 PendingHTLCStatus::Forward(PendingHTLCInfo {
2289 routing: PendingHTLCRouting::Forward {
2290 onion_packet: outgoing_packet,
2293 payment_hash: msg.payment_hash.clone(),
2294 incoming_shared_secret: shared_secret,
2295 amt_to_forward: next_hop_data.amt_to_forward,
2296 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
2301 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
2302 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
2303 // with a short_channel_id of 0. This is important as various things later assume
2304 // short_channel_id is non-0 in any ::Forward.
2305 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
2306 if let Some((err, code, chan_update)) = loop {
2307 let mut channel_state = self.channel_state.lock().unwrap();
2308 let id_option = channel_state.short_to_chan_info.get(&short_channel_id).cloned();
2309 let forwarding_id_opt = match id_option {
2310 None => { // unknown_next_peer
2311 // Note that this is likely a timing oracle for detecting whether an scid is a
2313 if fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, *short_channel_id) {
2316 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2319 Some((_cp_id, chan_id)) => Some(chan_id.clone()),
2321 let chan_update_opt = if let Some(forwarding_id) = forwarding_id_opt {
2322 let chan = channel_state.by_id.get_mut(&forwarding_id).unwrap();
2323 if !chan.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
2324 // Note that the behavior here should be identical to the above block - we
2325 // should NOT reveal the existence or non-existence of a private channel if
2326 // we don't allow forwards outbound over them.
2327 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
2329 if chan.get_channel_type().supports_scid_privacy() && *short_channel_id != chan.outbound_scid_alias() {
2330 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
2331 // "refuse to forward unless the SCID alias was used", so we pretend
2332 // we don't have the channel here.
2333 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
2335 let chan_update_opt = self.get_channel_update_for_onion(*short_channel_id, chan).ok();
2337 // Note that we could technically not return an error yet here and just hope
2338 // that the connection is reestablished or monitor updated by the time we get
2339 // around to doing the actual forward, but better to fail early if we can and
2340 // hopefully an attacker trying to path-trace payments cannot make this occur
2341 // on a small/per-node/per-channel scale.
2342 if !chan.is_live() { // channel_disabled
2343 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, chan_update_opt));
2345 if *amt_to_forward < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
2346 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
2348 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, *amt_to_forward, *outgoing_cltv_value) {
2349 break Some((err, code, chan_update_opt));
2353 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
2355 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
2362 let cur_height = self.best_block.read().unwrap().height() + 1;
2363 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
2364 // but we want to be robust wrt to counterparty packet sanitization (see
2365 // HTLC_FAIL_BACK_BUFFER rationale).
2366 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
2367 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
2369 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
2370 break Some(("CLTV expiry is too far in the future", 21, None));
2372 // If the HTLC expires ~now, don't bother trying to forward it to our
2373 // counterparty. They should fail it anyway, but we don't want to bother with
2374 // the round-trips or risk them deciding they definitely want the HTLC and
2375 // force-closing to ensure they get it if we're offline.
2376 // We previously had a much more aggressive check here which tried to ensure
2377 // our counterparty receives an HTLC which has *our* risk threshold met on it,
2378 // but there is no need to do that, and since we're a bit conservative with our
2379 // risk threshold it just results in failing to forward payments.
2380 if (*outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
2381 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
2387 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
2388 if let Some(chan_update) = chan_update {
2389 if code == 0x1000 | 11 || code == 0x1000 | 12 {
2390 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
2392 else if code == 0x1000 | 13 {
2393 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
2395 else if code == 0x1000 | 20 {
2396 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
2397 0u16.write(&mut res).expect("Writes cannot fail");
2399 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
2400 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
2401 chan_update.write(&mut res).expect("Writes cannot fail");
2403 return_err!(err, code, &res.0[..]);
2408 pending_forward_info
2411 /// Gets the current channel_update for the given channel. This first checks if the channel is
2412 /// public, and thus should be called whenever the result is going to be passed out in a
2413 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
2415 /// May be called with channel_state already locked!
2416 fn get_channel_update_for_broadcast(&self, chan: &Channel<<K::Target as KeysInterface>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2417 if !chan.should_announce() {
2418 return Err(LightningError {
2419 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
2420 action: msgs::ErrorAction::IgnoreError
2423 if chan.get_short_channel_id().is_none() {
2424 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
2426 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.channel_id()));
2427 self.get_channel_update_for_unicast(chan)
2430 /// Gets the current channel_update for the given channel. This does not check if the channel
2431 /// is public (only returning an Err if the channel does not yet have an assigned short_id),
2432 /// and thus MUST NOT be called unless the recipient of the resulting message has already
2433 /// provided evidence that they know about the existence of the channel.
2434 /// May be called with channel_state already locked!
2435 fn get_channel_update_for_unicast(&self, chan: &Channel<<K::Target as KeysInterface>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2436 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.channel_id()));
2437 let short_channel_id = match chan.get_short_channel_id().or(chan.latest_inbound_scid_alias()) {
2438 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
2442 self.get_channel_update_for_onion(short_channel_id, chan)
2444 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<<K::Target as KeysInterface>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2445 log_trace!(self.logger, "Generating channel update for channel {}", log_bytes!(chan.channel_id()));
2446 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
2448 let unsigned = msgs::UnsignedChannelUpdate {
2449 chain_hash: self.genesis_hash,
2451 timestamp: chan.get_update_time_counter(),
2452 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
2453 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
2454 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
2455 htlc_maximum_msat: chan.get_announced_htlc_max_msat(),
2456 fee_base_msat: chan.get_outbound_forwarding_fee_base_msat(),
2457 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
2458 excess_data: Vec::new(),
2461 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
2462 let sig = self.secp_ctx.sign_ecdsa(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
2464 Ok(msgs::ChannelUpdate {
2470 // Only public for testing, this should otherwise never be called direcly
2471 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> {
2472 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
2473 let prng_seed = self.keys_manager.get_secure_random_bytes();
2474 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
2476 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
2477 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
2478 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
2479 if onion_utils::route_size_insane(&onion_payloads) {
2480 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
2482 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
2484 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2486 let err: Result<(), _> = loop {
2487 let mut channel_lock = self.channel_state.lock().unwrap();
2489 let id = match channel_lock.short_to_chan_info.get(&path.first().unwrap().short_channel_id) {
2490 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
2491 Some((_cp_id, chan_id)) => chan_id.clone(),
2494 let channel_state = &mut *channel_lock;
2495 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
2497 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
2498 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
2500 if !chan.get().is_live() {
2501 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
2503 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(
2504 htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
2506 session_priv: session_priv.clone(),
2507 first_hop_htlc_msat: htlc_msat,
2509 payment_secret: payment_secret.clone(),
2510 payment_params: payment_params.clone(),
2511 }, onion_packet, &self.logger),
2512 channel_state, chan)
2514 Some((update_add, commitment_signed, monitor_update)) => {
2515 let update_err = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update);
2516 let chan_id = chan.get().channel_id();
2518 handle_monitor_update_res!(self, update_err, channel_state, chan,
2519 RAACommitmentOrder::CommitmentFirst, false, true))
2521 (ChannelMonitorUpdateStatus::PermanentFailure, Err(e)) => break Err(e),
2522 (ChannelMonitorUpdateStatus::Completed, Ok(())) => {},
2523 (ChannelMonitorUpdateStatus::InProgress, Err(_)) => {
2524 // Note that MonitorUpdateInProgress here indicates (per function
2525 // docs) that we will resend the commitment update once monitor
2526 // updating completes. Therefore, we must return an error
2527 // indicating that it is unsafe to retry the payment wholesale,
2528 // which we do in the send_payment check for
2529 // MonitorUpdateInProgress, below.
2530 return Err(APIError::MonitorUpdateInProgress);
2532 _ => unreachable!(),
2535 log_debug!(self.logger, "Sending payment along path resulted in a commitment_signed for channel {}", log_bytes!(chan_id));
2536 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2537 node_id: path.first().unwrap().pubkey,
2538 updates: msgs::CommitmentUpdate {
2539 update_add_htlcs: vec![update_add],
2540 update_fulfill_htlcs: Vec::new(),
2541 update_fail_htlcs: Vec::new(),
2542 update_fail_malformed_htlcs: Vec::new(),
2550 } else { unreachable!(); }
2554 match handle_error!(self, err, path.first().unwrap().pubkey) {
2555 Ok(_) => unreachable!(),
2557 Err(APIError::ChannelUnavailable { err: e.err })
2562 /// Sends a payment along a given route.
2564 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
2565 /// fields for more info.
2567 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
2568 /// method will error with an [`APIError::RouteError`]. Note, however, that once a payment
2569 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
2570 /// [`Event::PaymentSent`]) LDK will not stop you from sending a second payment with the same
2573 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
2574 /// tracking of payments, including state to indicate once a payment has completed. Because you
2575 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
2576 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
2577 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
2579 /// May generate SendHTLCs message(s) event on success, which should be relayed (e.g. via
2580 /// [`PeerManager::process_events`]).
2582 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
2583 /// each entry matching the corresponding-index entry in the route paths, see
2584 /// PaymentSendFailure for more info.
2586 /// In general, a path may raise:
2587 /// * [`APIError::RouteError`] when an invalid route or forwarding parameter (cltv_delta, fee,
2588 /// node public key) is specified.
2589 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
2590 /// (including due to previous monitor update failure or new permanent monitor update
2592 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
2593 /// relevant updates.
2595 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
2596 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
2597 /// different route unless you intend to pay twice!
2599 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
2600 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
2601 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
2602 /// must not contain multiple paths as multi-path payments require a recipient-provided
2605 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
2606 /// bit set (either as required or as available). If multiple paths are present in the Route,
2607 /// we assume the invoice had the basic_mpp feature set.
2609 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2610 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
2611 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2612 let onion_session_privs = self.add_new_pending_payment(payment_hash, *payment_secret, payment_id, route)?;
2613 self.send_payment_internal(route, payment_hash, payment_secret, None, payment_id, None, onion_session_privs)
2617 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> {
2618 self.add_new_pending_payment(payment_hash, payment_secret, payment_id, route)
2621 fn add_new_pending_payment(&self, payment_hash: PaymentHash, payment_secret: Option<PaymentSecret>, payment_id: PaymentId, route: &Route) -> Result<Vec<[u8; 32]>, PaymentSendFailure> {
2622 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
2623 for _ in 0..route.paths.len() {
2624 onion_session_privs.push(self.keys_manager.get_secure_random_bytes());
2627 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
2628 match pending_outbounds.entry(payment_id) {
2629 hash_map::Entry::Occupied(_) => Err(PaymentSendFailure::DuplicatePayment),
2630 hash_map::Entry::Vacant(entry) => {
2631 let payment = entry.insert(PendingOutboundPayment::Retryable {
2632 session_privs: HashSet::new(),
2633 pending_amt_msat: 0,
2634 pending_fee_msat: Some(0),
2637 starting_block_height: self.best_block.read().unwrap().height(),
2638 total_msat: route.get_total_amount(),
2641 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
2642 assert!(payment.insert(*session_priv_bytes, path));
2645 Ok(onion_session_privs)
2650 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> {
2651 if route.paths.len() < 1 {
2652 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
2654 if payment_secret.is_none() && route.paths.len() > 1 {
2655 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
2657 let mut total_value = 0;
2658 let our_node_id = self.get_our_node_id();
2659 let mut path_errs = Vec::with_capacity(route.paths.len());
2660 'path_check: for path in route.paths.iter() {
2661 if path.len() < 1 || path.len() > 20 {
2662 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
2663 continue 'path_check;
2665 for (idx, hop) in path.iter().enumerate() {
2666 if idx != path.len() - 1 && hop.pubkey == our_node_id {
2667 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
2668 continue 'path_check;
2671 total_value += path.last().unwrap().fee_msat;
2672 path_errs.push(Ok(()));
2674 if path_errs.iter().any(|e| e.is_err()) {
2675 return Err(PaymentSendFailure::PathParameterError(path_errs));
2677 if let Some(amt_msat) = recv_value_msat {
2678 debug_assert!(amt_msat >= total_value);
2679 total_value = amt_msat;
2682 let cur_height = self.best_block.read().unwrap().height() + 1;
2683 let mut results = Vec::new();
2684 debug_assert_eq!(route.paths.len(), onion_session_privs.len());
2685 for (path, session_priv) in route.paths.iter().zip(onion_session_privs.into_iter()) {
2686 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);
2689 Err(APIError::MonitorUpdateInProgress) => {
2690 // While a MonitorUpdateInProgress is an Err(_), the payment is still
2691 // considered "in flight" and we shouldn't remove it from the
2692 // PendingOutboundPayment set.
2695 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
2696 if let Some(payment) = pending_outbounds.get_mut(&payment_id) {
2697 let removed = payment.remove(&session_priv, Some(path));
2698 debug_assert!(removed, "This can't happen as the payment has an entry for this path added by callers");
2700 debug_assert!(false, "This can't happen as the payment was added by callers");
2701 path_res = Err(APIError::APIMisuseError { err: "Internal error: payment disappeared during processing. Please report this bug!".to_owned() });
2705 results.push(path_res);
2707 let mut has_ok = false;
2708 let mut has_err = false;
2709 let mut pending_amt_unsent = 0;
2710 let mut max_unsent_cltv_delta = 0;
2711 for (res, path) in results.iter().zip(route.paths.iter()) {
2712 if res.is_ok() { has_ok = true; }
2713 if res.is_err() { has_err = true; }
2714 if let &Err(APIError::MonitorUpdateInProgress) = res {
2715 // MonitorUpdateInProgress is inherently unsafe to retry, so we call it a
2719 } else if res.is_err() {
2720 pending_amt_unsent += path.last().unwrap().fee_msat;
2721 max_unsent_cltv_delta = cmp::max(max_unsent_cltv_delta, path.last().unwrap().cltv_expiry_delta);
2724 if has_err && has_ok {
2725 Err(PaymentSendFailure::PartialFailure {
2728 failed_paths_retry: if pending_amt_unsent != 0 {
2729 if let Some(payment_params) = &route.payment_params {
2730 Some(RouteParameters {
2731 payment_params: payment_params.clone(),
2732 final_value_msat: pending_amt_unsent,
2733 final_cltv_expiry_delta: max_unsent_cltv_delta,
2739 // If we failed to send any paths, we should remove the new PaymentId from the
2740 // `pending_outbound_payments` map, as the user isn't expected to `abandon_payment`.
2741 let removed = self.pending_outbound_payments.lock().unwrap().remove(&payment_id).is_some();
2742 debug_assert!(removed, "We should always have a pending payment to remove here");
2743 Err(PaymentSendFailure::AllFailedResendSafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
2749 /// Retries a payment along the given [`Route`].
2751 /// Errors returned are a superset of those returned from [`send_payment`], so see
2752 /// [`send_payment`] documentation for more details on errors. This method will also error if the
2753 /// retry amount puts the payment more than 10% over the payment's total amount, if the payment
2754 /// for the given `payment_id` cannot be found (likely due to timeout or success), or if
2755 /// further retries have been disabled with [`abandon_payment`].
2757 /// [`send_payment`]: [`ChannelManager::send_payment`]
2758 /// [`abandon_payment`]: [`ChannelManager::abandon_payment`]
2759 pub fn retry_payment(&self, route: &Route, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2760 const RETRY_OVERFLOW_PERCENTAGE: u64 = 10;
2761 for path in route.paths.iter() {
2762 if path.len() == 0 {
2763 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2764 err: "length-0 path in route".to_string()
2769 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
2770 for _ in 0..route.paths.len() {
2771 onion_session_privs.push(self.keys_manager.get_secure_random_bytes());
2774 let (total_msat, payment_hash, payment_secret) = {
2775 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
2776 match outbounds.get_mut(&payment_id) {
2778 let res = match payment {
2779 PendingOutboundPayment::Retryable {
2780 total_msat, payment_hash, payment_secret, pending_amt_msat, ..
2782 let retry_amt_msat: u64 = route.paths.iter().map(|path| path.last().unwrap().fee_msat).sum();
2783 if retry_amt_msat + *pending_amt_msat > *total_msat * (100 + RETRY_OVERFLOW_PERCENTAGE) / 100 {
2784 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2785 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()
2788 (*total_msat, *payment_hash, *payment_secret)
2790 PendingOutboundPayment::Legacy { .. } => {
2791 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2792 err: "Unable to retry payments that were initially sent on LDK versions prior to 0.0.102".to_string()
2795 PendingOutboundPayment::Fulfilled { .. } => {
2796 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2797 err: "Payment already completed".to_owned()
2800 PendingOutboundPayment::Abandoned { .. } => {
2801 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2802 err: "Payment already abandoned (with some HTLCs still pending)".to_owned()
2806 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
2807 assert!(payment.insert(*session_priv_bytes, path));
2812 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2813 err: format!("Payment with ID {} not found", log_bytes!(payment_id.0)),
2817 self.send_payment_internal(route, payment_hash, &payment_secret, None, payment_id, Some(total_msat), onion_session_privs)
2820 /// Signals that no further retries for the given payment will occur.
2822 /// After this method returns, any future calls to [`retry_payment`] for the given `payment_id`
2823 /// will fail with [`PaymentSendFailure::ParameterError`]. If no such event has been generated,
2824 /// an [`Event::PaymentFailed`] event will be generated as soon as there are no remaining
2825 /// pending HTLCs for this payment.
2827 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
2828 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
2829 /// determine the ultimate status of a payment.
2831 /// [`retry_payment`]: Self::retry_payment
2832 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
2833 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2834 pub fn abandon_payment(&self, payment_id: PaymentId) {
2835 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2837 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
2838 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
2839 if let Ok(()) = payment.get_mut().mark_abandoned() {
2840 if payment.get().remaining_parts() == 0 {
2841 self.pending_events.lock().unwrap().push(events::Event::PaymentFailed {
2843 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
2851 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
2852 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
2853 /// the preimage, it must be a cryptographically secure random value that no intermediate node
2854 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
2855 /// never reach the recipient.
2857 /// See [`send_payment`] documentation for more details on the return value of this function
2858 /// and idempotency guarantees provided by the [`PaymentId`] key.
2860 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
2861 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
2863 /// Note that `route` must have exactly one path.
2865 /// [`send_payment`]: Self::send_payment
2866 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
2867 let preimage = match payment_preimage {
2869 None => PaymentPreimage(self.keys_manager.get_secure_random_bytes()),
2871 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
2872 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, &route)?;
2874 match self.send_payment_internal(route, payment_hash, &None, Some(preimage), payment_id, None, onion_session_privs) {
2875 Ok(()) => Ok(payment_hash),
2880 /// Send a payment that is probing the given route for liquidity. We calculate the
2881 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
2882 /// us to easily discern them from real payments.
2883 pub fn send_probe(&self, hops: Vec<RouteHop>) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
2884 let payment_id = PaymentId(self.keys_manager.get_secure_random_bytes());
2886 let payment_hash = self.probing_cookie_from_id(&payment_id);
2889 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2890 err: "No need probing a path with less than two hops".to_string()
2894 let route = Route { paths: vec![hops], payment_params: None };
2895 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, &route)?;
2897 match self.send_payment_internal(&route, payment_hash, &None, None, payment_id, None, onion_session_privs) {
2898 Ok(()) => Ok((payment_hash, payment_id)),
2903 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
2905 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
2906 let target_payment_hash = self.probing_cookie_from_id(payment_id);
2907 target_payment_hash == *payment_hash
2910 /// Returns the 'probing cookie' for the given [`PaymentId`].
2911 fn probing_cookie_from_id(&self, payment_id: &PaymentId) -> PaymentHash {
2912 let mut preimage = [0u8; 64];
2913 preimage[..32].copy_from_slice(&self.probing_cookie_secret);
2914 preimage[32..].copy_from_slice(&payment_id.0);
2915 PaymentHash(Sha256::hash(&preimage).into_inner())
2918 /// Handles the generation of a funding transaction, optionally (for tests) with a function
2919 /// which checks the correctness of the funding transaction given the associated channel.
2920 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<<K::Target as KeysInterface>::Signer>, &Transaction) -> Result<OutPoint, APIError>>(
2921 &self, temporary_channel_id: &[u8; 32], _counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
2922 ) -> Result<(), APIError> {
2924 let (res, chan) = match self.channel_state.lock().unwrap().by_id.remove(temporary_channel_id) {
2926 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
2928 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
2929 .map_err(|e| if let ChannelError::Close(msg) = e {
2930 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.get_user_id(), chan.force_shutdown(true), None)
2931 } else { unreachable!(); })
2934 None => { return Err(APIError::ChannelUnavailable { err: "No such channel".to_owned() }) },
2936 match handle_error!(self, res, chan.get_counterparty_node_id()) {
2937 Ok(funding_msg) => {
2940 Err(_) => { return Err(APIError::ChannelUnavailable {
2941 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()
2946 let mut channel_state = self.channel_state.lock().unwrap();
2947 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
2948 node_id: chan.get_counterparty_node_id(),
2951 match channel_state.by_id.entry(chan.channel_id()) {
2952 hash_map::Entry::Occupied(_) => {
2953 panic!("Generated duplicate funding txid?");
2955 hash_map::Entry::Vacant(e) => {
2956 let mut id_to_peer = self.id_to_peer.lock().unwrap();
2957 if id_to_peer.insert(chan.channel_id(), chan.get_counterparty_node_id()).is_some() {
2958 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
2967 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> {
2968 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
2969 Ok(OutPoint { txid: tx.txid(), index: output_index })
2973 /// Call this upon creation of a funding transaction for the given channel.
2975 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
2976 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
2978 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
2979 /// across the p2p network.
2981 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
2982 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
2984 /// May panic if the output found in the funding transaction is duplicative with some other
2985 /// channel (note that this should be trivially prevented by using unique funding transaction
2986 /// keys per-channel).
2988 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
2989 /// counterparty's signature the funding transaction will automatically be broadcast via the
2990 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
2992 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
2993 /// not currently support replacing a funding transaction on an existing channel. Instead,
2994 /// create a new channel with a conflicting funding transaction.
2996 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
2997 /// the wallet software generating the funding transaction to apply anti-fee sniping as
2998 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
2999 /// for more details.
3001 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
3002 /// [`Event::ChannelClosed`]: crate::util::events::Event::ChannelClosed
3003 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
3004 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3006 for inp in funding_transaction.input.iter() {
3007 if inp.witness.is_empty() {
3008 return Err(APIError::APIMisuseError {
3009 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
3014 let height = self.best_block.read().unwrap().height();
3015 // Transactions are evaluated as final by network mempools at the next block. However, the modules
3016 // constituting our Lightning node might not have perfect sync about their blockchain views. Thus, if
3017 // the wallet module is in advance on the LDK view, allow one more block of headroom.
3018 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 {
3019 return Err(APIError::APIMisuseError {
3020 err: "Funding transaction absolute timelock is non-final".to_owned()
3024 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
3025 let mut output_index = None;
3026 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
3027 for (idx, outp) in tx.output.iter().enumerate() {
3028 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
3029 if output_index.is_some() {
3030 return Err(APIError::APIMisuseError {
3031 err: "Multiple outputs matched the expected script and value".to_owned()
3034 if idx > u16::max_value() as usize {
3035 return Err(APIError::APIMisuseError {
3036 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
3039 output_index = Some(idx as u16);
3042 if output_index.is_none() {
3043 return Err(APIError::APIMisuseError {
3044 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
3047 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
3051 /// Atomically updates the [`ChannelConfig`] for the given channels.
3053 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3054 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3055 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3056 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3058 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3059 /// `counterparty_node_id` is provided.
3061 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3062 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3064 /// If an error is returned, none of the updates should be considered applied.
3066 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3067 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3068 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3069 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3070 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3071 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3072 /// [`APIMisuseError`]: APIError::APIMisuseError
3073 pub fn update_channel_config(
3074 &self, counterparty_node_id: &PublicKey, channel_ids: &[[u8; 32]], config: &ChannelConfig,
3075 ) -> Result<(), APIError> {
3076 if config.cltv_expiry_delta < MIN_CLTV_EXPIRY_DELTA {
3077 return Err(APIError::APIMisuseError {
3078 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
3082 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(
3083 &self.total_consistency_lock, &self.persistence_notifier,
3086 let mut channel_state_lock = self.channel_state.lock().unwrap();
3087 let channel_state = &mut *channel_state_lock;
3088 for channel_id in channel_ids {
3089 let channel_counterparty_node_id = channel_state.by_id.get(channel_id)
3090 .ok_or(APIError::ChannelUnavailable {
3091 err: format!("Channel with ID {} was not found", log_bytes!(*channel_id)),
3093 .get_counterparty_node_id();
3094 if channel_counterparty_node_id != *counterparty_node_id {
3095 return Err(APIError::APIMisuseError {
3096 err: "counterparty node id mismatch".to_owned(),
3100 for channel_id in channel_ids {
3101 let channel = channel_state.by_id.get_mut(channel_id).unwrap();
3102 if !channel.update_config(config) {
3105 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
3106 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
3107 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
3108 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
3109 node_id: channel.get_counterparty_node_id(),
3118 /// Processes HTLCs which are pending waiting on random forward delay.
3120 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
3121 /// Will likely generate further events.
3122 pub fn process_pending_htlc_forwards(&self) {
3123 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3125 let mut new_events = Vec::new();
3126 let mut failed_forwards = Vec::new();
3127 let mut phantom_receives: Vec<(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
3128 let mut handle_errors = Vec::new();
3130 let mut forward_htlcs = HashMap::new();
3131 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
3133 for (short_chan_id, mut pending_forwards) in forward_htlcs {
3134 let mut channel_state_lock = self.channel_state.lock().unwrap();
3135 let channel_state = &mut *channel_state_lock;
3136 if short_chan_id != 0 {
3137 let forward_chan_id = match channel_state.short_to_chan_info.get(&short_chan_id) {
3138 Some((_cp_id, chan_id)) => chan_id.clone(),
3140 for forward_info in pending_forwards.drain(..) {
3141 match forward_info {
3142 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
3143 routing, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value },
3144 prev_funding_outpoint } => {
3145 macro_rules! failure_handler {
3146 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
3147 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3149 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3150 short_channel_id: prev_short_channel_id,
3151 outpoint: prev_funding_outpoint,
3152 htlc_id: prev_htlc_id,
3153 incoming_packet_shared_secret: incoming_shared_secret,
3154 phantom_shared_secret: $phantom_ss,
3157 let reason = if $next_hop_unknown {
3158 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
3160 HTLCDestination::FailedPayment{ payment_hash }
3163 failed_forwards.push((htlc_source, payment_hash,
3164 HTLCFailReason::Reason { failure_code: $err_code, data: $err_data },
3170 macro_rules! fail_forward {
3171 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3173 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
3177 macro_rules! failed_payment {
3178 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3180 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
3184 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
3185 let phantom_secret_res = self.keys_manager.get_node_secret(Recipient::PhantomNode);
3186 if phantom_secret_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id) {
3187 let phantom_shared_secret = SharedSecret::new(&onion_packet.public_key.unwrap(), &phantom_secret_res.unwrap()).secret_bytes();
3188 let next_hop = match onion_utils::decode_next_payment_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
3190 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
3191 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
3192 // In this scenario, the phantom would have sent us an
3193 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
3194 // if it came from us (the second-to-last hop) but contains the sha256
3196 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
3198 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3199 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
3203 onion_utils::Hop::Receive(hop_data) => {
3204 match self.construct_recv_pending_htlc_info(hop_data, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value, Some(phantom_shared_secret)) {
3205 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, vec![(info, prev_htlc_id)])),
3206 Err(ReceiveError { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
3212 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3215 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3218 HTLCForwardInfo::FailHTLC { .. } => {
3219 // Channel went away before we could fail it. This implies
3220 // the channel is now on chain and our counterparty is
3221 // trying to broadcast the HTLC-Timeout, but that's their
3222 // problem, not ours.
3229 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
3230 let mut add_htlc_msgs = Vec::new();
3231 let mut fail_htlc_msgs = Vec::new();
3232 for forward_info in pending_forwards.drain(..) {
3233 match forward_info {
3234 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
3235 routing: PendingHTLCRouting::Forward {
3237 }, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value },
3238 prev_funding_outpoint } => {
3239 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);
3240 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3241 short_channel_id: prev_short_channel_id,
3242 outpoint: prev_funding_outpoint,
3243 htlc_id: prev_htlc_id,
3244 incoming_packet_shared_secret: incoming_shared_secret,
3245 // Phantom payments are only PendingHTLCRouting::Receive.
3246 phantom_shared_secret: None,
3248 match chan.get_mut().send_htlc(amt_to_forward, payment_hash, outgoing_cltv_value, htlc_source.clone(), onion_packet, &self.logger) {
3250 if let ChannelError::Ignore(msg) = e {
3251 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
3253 panic!("Stated return value requirements in send_htlc() were not met");
3255 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan.get());
3256 failed_forwards.push((htlc_source, payment_hash,
3257 HTLCFailReason::Reason { failure_code, data },
3258 HTLCDestination::NextHopChannel { node_id: Some(chan.get().get_counterparty_node_id()), channel_id: forward_chan_id }
3264 Some(msg) => { add_htlc_msgs.push(msg); },
3266 // Nothing to do here...we're waiting on a remote
3267 // revoke_and_ack before we can add anymore HTLCs. The Channel
3268 // will automatically handle building the update_add_htlc and
3269 // commitment_signed messages when we can.
3270 // TODO: Do some kind of timer to set the channel as !is_live()
3271 // as we don't really want others relying on us relaying through
3272 // this channel currently :/.
3278 HTLCForwardInfo::AddHTLC { .. } => {
3279 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
3281 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
3282 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
3283 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet, &self.logger) {
3285 if let ChannelError::Ignore(msg) = e {
3286 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
3288 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
3290 // fail-backs are best-effort, we probably already have one
3291 // pending, and if not that's OK, if not, the channel is on
3292 // the chain and sending the HTLC-Timeout is their problem.
3295 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
3297 // Nothing to do here...we're waiting on a remote
3298 // revoke_and_ack before we can update the commitment
3299 // transaction. The Channel will automatically handle
3300 // building the update_fail_htlc and commitment_signed
3301 // messages when we can.
3302 // We don't need any kind of timer here as they should fail
3303 // the channel onto the chain if they can't get our
3304 // update_fail_htlc in time, it's not our problem.
3311 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
3312 let (commitment_msg, monitor_update) = match chan.get_mut().send_commitment(&self.logger) {
3315 // We surely failed send_commitment due to bad keys, in that case
3316 // close channel and then send error message to peer.
3317 let counterparty_node_id = chan.get().get_counterparty_node_id();
3318 let err: Result<(), _> = match e {
3319 ChannelError::Ignore(_) | ChannelError::Warn(_) => {
3320 panic!("Stated return value requirements in send_commitment() were not met");
3322 ChannelError::Close(msg) => {
3323 log_trace!(self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
3324 let mut channel = remove_channel!(self, channel_state, chan);
3325 // ChannelClosed event is generated by handle_error for us.
3326 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()))
3329 handle_errors.push((counterparty_node_id, err));
3333 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3334 ChannelMonitorUpdateStatus::Completed => {},
3336 handle_errors.push((chan.get().get_counterparty_node_id(), handle_monitor_update_res!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
3340 log_debug!(self.logger, "Forwarding HTLCs resulted in a commitment update with {} HTLCs added and {} HTLCs failed for channel {}",
3341 add_htlc_msgs.len(), fail_htlc_msgs.len(), log_bytes!(chan.get().channel_id()));
3342 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3343 node_id: chan.get().get_counterparty_node_id(),
3344 updates: msgs::CommitmentUpdate {
3345 update_add_htlcs: add_htlc_msgs,
3346 update_fulfill_htlcs: Vec::new(),
3347 update_fail_htlcs: fail_htlc_msgs,
3348 update_fail_malformed_htlcs: Vec::new(),
3350 commitment_signed: commitment_msg,
3358 for forward_info in pending_forwards.drain(..) {
3359 match forward_info {
3360 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
3361 routing, incoming_shared_secret, payment_hash, amt_to_forward, .. },
3362 prev_funding_outpoint } => {
3363 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret) = match routing {
3364 PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry, phantom_shared_secret } => {
3365 let _legacy_hop_data = Some(payment_data.clone());
3366 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data }, Some(payment_data), phantom_shared_secret)
3368 PendingHTLCRouting::ReceiveKeysend { payment_preimage, incoming_cltv_expiry } =>
3369 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage), None, None),
3371 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
3374 let claimable_htlc = ClaimableHTLC {
3375 prev_hop: HTLCPreviousHopData {
3376 short_channel_id: prev_short_channel_id,
3377 outpoint: prev_funding_outpoint,
3378 htlc_id: prev_htlc_id,
3379 incoming_packet_shared_secret: incoming_shared_secret,
3380 phantom_shared_secret,
3382 value: amt_to_forward,
3384 total_msat: if let Some(data) = &payment_data { data.total_msat } else { amt_to_forward },
3389 macro_rules! fail_htlc {
3390 ($htlc: expr, $payment_hash: expr) => {
3391 let mut htlc_msat_height_data = byte_utils::be64_to_array($htlc.value).to_vec();
3392 htlc_msat_height_data.extend_from_slice(
3393 &byte_utils::be32_to_array(self.best_block.read().unwrap().height()),
3395 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
3396 short_channel_id: $htlc.prev_hop.short_channel_id,
3397 outpoint: prev_funding_outpoint,
3398 htlc_id: $htlc.prev_hop.htlc_id,
3399 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
3400 phantom_shared_secret,
3402 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data },
3403 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
3408 macro_rules! check_total_value {
3409 ($payment_data: expr, $payment_preimage: expr) => {{
3410 let mut payment_received_generated = false;
3412 events::PaymentPurpose::InvoicePayment {
3413 payment_preimage: $payment_preimage,
3414 payment_secret: $payment_data.payment_secret,
3417 let (_, htlcs) = channel_state.claimable_htlcs.entry(payment_hash)
3418 .or_insert_with(|| (purpose(), Vec::new()));
3419 if htlcs.len() == 1 {
3420 if let OnionPayload::Spontaneous(_) = htlcs[0].onion_payload {
3421 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));
3422 fail_htlc!(claimable_htlc, payment_hash);
3426 let mut total_value = claimable_htlc.value;
3427 for htlc in htlcs.iter() {
3428 total_value += htlc.value;
3429 match &htlc.onion_payload {
3430 OnionPayload::Invoice { .. } => {
3431 if htlc.total_msat != $payment_data.total_msat {
3432 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
3433 log_bytes!(payment_hash.0), $payment_data.total_msat, htlc.total_msat);
3434 total_value = msgs::MAX_VALUE_MSAT;
3436 if total_value >= msgs::MAX_VALUE_MSAT { break; }
3438 _ => unreachable!(),
3441 if total_value >= msgs::MAX_VALUE_MSAT || total_value > $payment_data.total_msat {
3442 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
3443 log_bytes!(payment_hash.0), total_value, $payment_data.total_msat);
3444 fail_htlc!(claimable_htlc, payment_hash);
3445 } else if total_value == $payment_data.total_msat {
3446 htlcs.push(claimable_htlc);
3447 new_events.push(events::Event::PaymentReceived {
3450 amount_msat: total_value,
3452 payment_received_generated = true;
3454 // Nothing to do - we haven't reached the total
3455 // payment value yet, wait until we receive more
3457 htlcs.push(claimable_htlc);
3459 payment_received_generated
3463 // Check that the payment hash and secret are known. Note that we
3464 // MUST take care to handle the "unknown payment hash" and
3465 // "incorrect payment secret" cases here identically or we'd expose
3466 // that we are the ultimate recipient of the given payment hash.
3467 // Further, we must not expose whether we have any other HTLCs
3468 // associated with the same payment_hash pending or not.
3469 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
3470 match payment_secrets.entry(payment_hash) {
3471 hash_map::Entry::Vacant(_) => {
3472 match claimable_htlc.onion_payload {
3473 OnionPayload::Invoice { .. } => {
3474 let payment_data = payment_data.unwrap();
3475 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) {
3476 Ok(payment_preimage) => payment_preimage,
3478 fail_htlc!(claimable_htlc, payment_hash);
3482 check_total_value!(payment_data, payment_preimage);
3484 OnionPayload::Spontaneous(preimage) => {
3485 match channel_state.claimable_htlcs.entry(payment_hash) {
3486 hash_map::Entry::Vacant(e) => {
3487 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
3488 e.insert((purpose.clone(), vec![claimable_htlc]));
3489 new_events.push(events::Event::PaymentReceived {
3491 amount_msat: amt_to_forward,
3495 hash_map::Entry::Occupied(_) => {
3496 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
3497 fail_htlc!(claimable_htlc, payment_hash);
3503 hash_map::Entry::Occupied(inbound_payment) => {
3504 if payment_data.is_none() {
3505 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));
3506 fail_htlc!(claimable_htlc, payment_hash);
3509 let payment_data = payment_data.unwrap();
3510 if inbound_payment.get().payment_secret != payment_data.payment_secret {
3511 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
3512 fail_htlc!(claimable_htlc, payment_hash);
3513 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
3514 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
3515 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
3516 fail_htlc!(claimable_htlc, payment_hash);
3518 let payment_received_generated = check_total_value!(payment_data, inbound_payment.get().payment_preimage);
3519 if payment_received_generated {
3520 inbound_payment.remove_entry();
3526 HTLCForwardInfo::FailHTLC { .. } => {
3527 panic!("Got pending fail of our own HTLC");
3535 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
3536 self.fail_htlc_backwards_internal(htlc_source, &payment_hash, failure_reason, destination);
3538 self.forward_htlcs(&mut phantom_receives);
3540 for (counterparty_node_id, err) in handle_errors.drain(..) {
3541 let _ = handle_error!(self, err, counterparty_node_id);
3544 if new_events.is_empty() { return }
3545 let mut events = self.pending_events.lock().unwrap();
3546 events.append(&mut new_events);
3549 /// Free the background events, generally called from timer_tick_occurred.
3551 /// Exposed for testing to allow us to process events quickly without generating accidental
3552 /// BroadcastChannelUpdate events in timer_tick_occurred.
3554 /// Expects the caller to have a total_consistency_lock read lock.
3555 fn process_background_events(&self) -> bool {
3556 let mut background_events = Vec::new();
3557 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
3558 if background_events.is_empty() {
3562 for event in background_events.drain(..) {
3564 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
3565 // The channel has already been closed, so no use bothering to care about the
3566 // monitor updating completing.
3567 let _ = self.chain_monitor.update_channel(funding_txo, update);
3574 #[cfg(any(test, feature = "_test_utils"))]
3575 /// Process background events, for functional testing
3576 pub fn test_process_background_events(&self) {
3577 self.process_background_events();
3580 fn update_channel_fee(&self, short_to_chan_info: &mut HashMap<u64, (PublicKey, [u8; 32])>, 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>) {
3581 if !chan.is_outbound() { return (true, NotifyOption::SkipPersist, Ok(())); }
3582 // If the feerate has decreased by less than half, don't bother
3583 if new_feerate <= chan.get_feerate() && new_feerate * 2 > chan.get_feerate() {
3584 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
3585 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3586 return (true, NotifyOption::SkipPersist, Ok(()));
3588 if !chan.is_live() {
3589 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).",
3590 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3591 return (true, NotifyOption::SkipPersist, Ok(()));
3593 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
3594 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3596 let mut retain_channel = true;
3597 let res = match chan.send_update_fee_and_commit(new_feerate, &self.logger) {
3600 let (drop, res) = convert_chan_err!(self, e, short_to_chan_info, chan, chan_id);
3601 if drop { retain_channel = false; }
3605 let ret_err = match res {
3606 Ok(Some((update_fee, commitment_signed, monitor_update))) => {
3607 match self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
3608 ChannelMonitorUpdateStatus::Completed => {
3609 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3610 node_id: chan.get_counterparty_node_id(),
3611 updates: msgs::CommitmentUpdate {
3612 update_add_htlcs: Vec::new(),
3613 update_fulfill_htlcs: Vec::new(),
3614 update_fail_htlcs: Vec::new(),
3615 update_fail_malformed_htlcs: Vec::new(),
3616 update_fee: Some(update_fee),
3623 let (res, drop) = handle_monitor_update_res!(self, e, short_to_chan_info, chan, RAACommitmentOrder::CommitmentFirst, chan_id, COMMITMENT_UPDATE_ONLY);
3624 if drop { retain_channel = false; }
3632 (retain_channel, NotifyOption::DoPersist, ret_err)
3636 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
3637 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
3638 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
3639 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
3640 pub fn maybe_update_chan_fees(&self) {
3641 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3642 let mut should_persist = NotifyOption::SkipPersist;
3644 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3646 let mut handle_errors = Vec::new();
3648 let mut channel_state_lock = self.channel_state.lock().unwrap();
3649 let channel_state = &mut *channel_state_lock;
3650 let pending_msg_events = &mut channel_state.pending_msg_events;
3651 let short_to_chan_info = &mut channel_state.short_to_chan_info;
3652 channel_state.by_id.retain(|chan_id, chan| {
3653 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(short_to_chan_info, pending_msg_events, chan_id, chan, new_feerate);
3654 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3656 handle_errors.push(err);
3666 fn remove_stale_resolved_payments(&self) {
3667 // If an outbound payment was completed, and no pending HTLCs remain, we should remove it
3668 // from the map. However, if we did that immediately when the last payment HTLC is claimed,
3669 // this could race the user making a duplicate send_payment call and our idempotency
3670 // guarantees would be violated. Instead, we wait a few timer ticks to do the actual
3671 // removal. This should be more than sufficient to ensure the idempotency of any
3672 // `send_payment` calls that were made at the same time the `PaymentSent` event was being
3674 let mut pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
3675 let pending_events = self.pending_events.lock().unwrap();
3676 pending_outbound_payments.retain(|payment_id, payment| {
3677 if let PendingOutboundPayment::Fulfilled { session_privs, timer_ticks_without_htlcs, .. } = payment {
3678 let mut no_remaining_entries = session_privs.is_empty();
3679 if no_remaining_entries {
3680 for ev in pending_events.iter() {
3682 events::Event::PaymentSent { payment_id: Some(ev_payment_id), .. } |
3683 events::Event::PaymentPathSuccessful { payment_id: ev_payment_id, .. } |
3684 events::Event::PaymentPathFailed { payment_id: Some(ev_payment_id), .. } => {
3685 if payment_id == ev_payment_id {
3686 no_remaining_entries = false;
3694 if no_remaining_entries {
3695 *timer_ticks_without_htlcs += 1;
3696 *timer_ticks_without_htlcs <= IDEMPOTENCY_TIMEOUT_TICKS
3698 *timer_ticks_without_htlcs = 0;
3705 /// Performs actions which should happen on startup and roughly once per minute thereafter.
3707 /// This currently includes:
3708 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
3709 /// * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
3710 /// than a minute, informing the network that they should no longer attempt to route over
3712 /// * Expiring a channel's previous `ChannelConfig` if necessary to only allow forwarding HTLCs
3713 /// with the current `ChannelConfig`.
3715 /// Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
3716 /// estimate fetches.
3717 pub fn timer_tick_occurred(&self) {
3718 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3719 let mut should_persist = NotifyOption::SkipPersist;
3720 if self.process_background_events() { should_persist = NotifyOption::DoPersist; }
3722 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3724 let mut handle_errors = Vec::new();
3725 let mut timed_out_mpp_htlcs = Vec::new();
3727 let mut channel_state_lock = self.channel_state.lock().unwrap();
3728 let channel_state = &mut *channel_state_lock;
3729 let pending_msg_events = &mut channel_state.pending_msg_events;
3730 let short_to_chan_info = &mut channel_state.short_to_chan_info;
3731 channel_state.by_id.retain(|chan_id, chan| {
3732 let counterparty_node_id = chan.get_counterparty_node_id();
3733 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(short_to_chan_info, pending_msg_events, chan_id, chan, new_feerate);
3734 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3736 handle_errors.push((err, counterparty_node_id));
3738 if !retain_channel { return false; }
3740 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
3741 let (needs_close, err) = convert_chan_err!(self, e, short_to_chan_info, chan, chan_id);
3742 handle_errors.push((Err(err), chan.get_counterparty_node_id()));
3743 if needs_close { return false; }
3746 match chan.channel_update_status() {
3747 ChannelUpdateStatus::Enabled if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged),
3748 ChannelUpdateStatus::Disabled if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged),
3749 ChannelUpdateStatus::DisabledStaged if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
3750 ChannelUpdateStatus::EnabledStaged if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
3751 ChannelUpdateStatus::DisabledStaged if !chan.is_live() => {
3752 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3753 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3757 should_persist = NotifyOption::DoPersist;
3758 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
3760 ChannelUpdateStatus::EnabledStaged if chan.is_live() => {
3761 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3762 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3766 should_persist = NotifyOption::DoPersist;
3767 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
3772 chan.maybe_expire_prev_config();
3777 channel_state.claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
3778 if htlcs.is_empty() {
3779 // This should be unreachable
3780 debug_assert!(false);
3783 if let OnionPayload::Invoice { .. } = htlcs[0].onion_payload {
3784 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
3785 // In this case we're not going to handle any timeouts of the parts here.
3786 if htlcs[0].total_msat == htlcs.iter().fold(0, |total, htlc| total + htlc.value) {
3788 } else if htlcs.into_iter().any(|htlc| {
3789 htlc.timer_ticks += 1;
3790 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
3792 timed_out_mpp_htlcs.extend(htlcs.into_iter().map(|htlc| (htlc.prev_hop.clone(), payment_hash.clone())));
3800 for htlc_source in timed_out_mpp_htlcs.drain(..) {
3801 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
3802 self.fail_htlc_backwards_internal(HTLCSource::PreviousHopData(htlc_source.0.clone()), &htlc_source.1, HTLCFailReason::Reason { failure_code: 23, data: Vec::new() }, receiver );
3805 for (err, counterparty_node_id) in handle_errors.drain(..) {
3806 let _ = handle_error!(self, err, counterparty_node_id);
3809 self.remove_stale_resolved_payments();
3815 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
3816 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
3817 /// along the path (including in our own channel on which we received it).
3819 /// Note that in some cases around unclean shutdown, it is possible the payment may have
3820 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
3821 /// second copy of) the [`events::Event::PaymentReceived`] event. Alternatively, the payment
3822 /// may have already been failed automatically by LDK if it was nearing its expiration time.
3824 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
3825 /// [`ChannelManager::claim_funds`]), you should still monitor for
3826 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
3827 /// startup during which time claims that were in-progress at shutdown may be replayed.
3828 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
3829 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3831 let removed_source = {
3832 let mut channel_state = self.channel_state.lock().unwrap();
3833 channel_state.claimable_htlcs.remove(payment_hash)
3835 if let Some((_, mut sources)) = removed_source {
3836 for htlc in sources.drain(..) {
3837 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
3838 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
3839 self.best_block.read().unwrap().height()));
3840 self.fail_htlc_backwards_internal(
3841 HTLCSource::PreviousHopData(htlc.prev_hop), payment_hash,
3842 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data },
3843 HTLCDestination::FailedPayment { payment_hash: *payment_hash });
3848 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3849 /// that we want to return and a channel.
3851 /// This is for failures on the channel on which the HTLC was *received*, not failures
3853 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<<K::Target as KeysInterface>::Signer>) -> (u16, Vec<u8>) {
3854 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
3855 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
3856 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
3857 // an inbound SCID alias before the real SCID.
3858 let scid_pref = if chan.should_announce() {
3859 chan.get_short_channel_id().or(chan.latest_inbound_scid_alias())
3861 chan.latest_inbound_scid_alias().or(chan.get_short_channel_id())
3863 if let Some(scid) = scid_pref {
3864 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
3866 (0x4000|10, Vec::new())
3871 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3872 /// that we want to return and a channel.
3873 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>) {
3874 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
3875 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
3876 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
3877 if desired_err_code == 0x1000 | 20 {
3878 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
3879 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
3880 0u16.write(&mut enc).expect("Writes cannot fail");
3882 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
3883 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
3884 upd.write(&mut enc).expect("Writes cannot fail");
3885 (desired_err_code, enc.0)
3887 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
3888 // which means we really shouldn't have gotten a payment to be forwarded over this
3889 // channel yet, or if we did it's from a route hint. Either way, returning an error of
3890 // PERM|no_such_channel should be fine.
3891 (0x4000|10, Vec::new())
3895 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
3896 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
3897 // be surfaced to the user.
3898 fn fail_holding_cell_htlcs(
3899 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32],
3900 counterparty_node_id: &PublicKey
3902 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
3903 let (failure_code, onion_failure_data) =
3904 match self.channel_state.lock().unwrap().by_id.entry(channel_id) {
3905 hash_map::Entry::Occupied(chan_entry) => {
3906 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan_entry.get())
3908 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
3911 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
3912 self.fail_htlc_backwards_internal(htlc_src, &payment_hash, HTLCFailReason::Reason { failure_code, data: onion_failure_data }, receiver);
3916 /// Fails an HTLC backwards to the sender of it to us.
3917 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
3918 fn fail_htlc_backwards_internal(&self, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason,destination: HTLCDestination) {
3919 #[cfg(debug_assertions)]
3921 // Ensure that the `channel_state` lock is not held when calling this function.
3922 // This ensures that future code doesn't introduce a lock_order requirement for
3923 // `forward_htlcs` to be locked after the `channel_state` lock, which calling this
3924 // function with the `channel_state` locked would.
3925 assert!(self.channel_state.try_lock().is_ok());
3928 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
3929 //identify whether we sent it or not based on the (I presume) very different runtime
3930 //between the branches here. We should make this async and move it into the forward HTLCs
3933 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3934 // from block_connected which may run during initialization prior to the chain_monitor
3935 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
3937 HTLCSource::OutboundRoute { ref path, session_priv, payment_id, ref payment_params, .. } => {
3938 let mut session_priv_bytes = [0; 32];
3939 session_priv_bytes.copy_from_slice(&session_priv[..]);
3940 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
3941 let mut all_paths_failed = false;
3942 let mut full_failure_ev = None;
3943 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
3944 if !payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
3945 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3948 if payment.get().is_fulfilled() {
3949 log_trace!(self.logger, "Received failure of HTLC with payment_hash {} after payment completion", log_bytes!(payment_hash.0));
3952 if payment.get().remaining_parts() == 0 {
3953 all_paths_failed = true;
3954 if payment.get().abandoned() {
3955 full_failure_ev = Some(events::Event::PaymentFailed {
3957 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
3963 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3966 let mut retry = if let Some(payment_params_data) = payment_params {
3967 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
3968 Some(RouteParameters {
3969 payment_params: payment_params_data.clone(),
3970 final_value_msat: path_last_hop.fee_msat,
3971 final_cltv_expiry_delta: path_last_hop.cltv_expiry_delta,
3974 log_trace!(self.logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3976 let path_failure = match &onion_error {
3977 &HTLCFailReason::LightningError { ref err } => {
3979 let (network_update, short_channel_id, payment_retryable, onion_error_code, onion_error_data) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
3981 let (network_update, short_channel_id, payment_retryable, _, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
3983 if self.payment_is_probe(payment_hash, &payment_id) {
3984 if !payment_retryable {
3985 events::Event::ProbeSuccessful {
3987 payment_hash: payment_hash.clone(),
3991 events::Event::ProbeFailed {
3993 payment_hash: payment_hash.clone(),
3999 // TODO: If we decided to blame ourselves (or one of our channels) in
4000 // process_onion_failure we should close that channel as it implies our
4001 // next-hop is needlessly blaming us!
4002 if let Some(scid) = short_channel_id {
4003 retry.as_mut().map(|r| r.payment_params.previously_failed_channels.push(scid));
4005 events::Event::PaymentPathFailed {
4006 payment_id: Some(payment_id),
4007 payment_hash: payment_hash.clone(),
4008 payment_failed_permanently: !payment_retryable,
4015 error_code: onion_error_code,
4017 error_data: onion_error_data
4021 &HTLCFailReason::Reason {
4027 // we get a fail_malformed_htlc from the first hop
4028 // TODO: We'd like to generate a NetworkUpdate for temporary
4029 // failures here, but that would be insufficient as find_route
4030 // generally ignores its view of our own channels as we provide them via
4032 // TODO: For non-temporary failures, we really should be closing the
4033 // channel here as we apparently can't relay through them anyway.
4034 let scid = path.first().unwrap().short_channel_id;
4035 retry.as_mut().map(|r| r.payment_params.previously_failed_channels.push(scid));
4037 if self.payment_is_probe(payment_hash, &payment_id) {
4038 events::Event::ProbeFailed {
4040 payment_hash: payment_hash.clone(),
4042 short_channel_id: Some(scid),
4045 events::Event::PaymentPathFailed {
4046 payment_id: Some(payment_id),
4047 payment_hash: payment_hash.clone(),
4048 payment_failed_permanently: false,
4049 network_update: None,
4052 short_channel_id: Some(scid),
4055 error_code: Some(*failure_code),
4057 error_data: Some(data.clone()),
4062 let mut pending_events = self.pending_events.lock().unwrap();
4063 pending_events.push(path_failure);
4064 if let Some(ev) = full_failure_ev { pending_events.push(ev); }
4066 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret, phantom_shared_secret, outpoint }) => {
4067 let err_packet = match onion_error {
4068 HTLCFailReason::Reason { failure_code, data } => {
4069 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
4070 if let Some(phantom_ss) = phantom_shared_secret {
4071 let phantom_packet = onion_utils::build_failure_packet(&phantom_ss, failure_code, &data[..]).encode();
4072 let encrypted_phantom_packet = onion_utils::encrypt_failure_packet(&phantom_ss, &phantom_packet);
4073 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &encrypted_phantom_packet.data[..])
4075 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
4076 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
4079 HTLCFailReason::LightningError { err } => {
4080 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
4081 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
4085 let mut forward_event = None;
4086 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
4087 if forward_htlcs.is_empty() {
4088 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
4090 match forward_htlcs.entry(short_channel_id) {
4091 hash_map::Entry::Occupied(mut entry) => {
4092 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
4094 hash_map::Entry::Vacant(entry) => {
4095 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
4098 mem::drop(forward_htlcs);
4099 let mut pending_events = self.pending_events.lock().unwrap();
4100 if let Some(time) = forward_event {
4101 pending_events.push(events::Event::PendingHTLCsForwardable {
4102 time_forwardable: time
4105 pending_events.push(events::Event::HTLCHandlingFailed {
4106 prev_channel_id: outpoint.to_channel_id(),
4107 failed_next_destination: destination
4113 /// Provides a payment preimage in response to [`Event::PaymentReceived`], generating any
4114 /// [`MessageSendEvent`]s needed to claim the payment.
4116 /// Note that calling this method does *not* guarantee that the payment has been claimed. You
4117 /// *must* wait for an [`Event::PaymentClaimed`] event which upon a successful claim will be
4118 /// provided to your [`EventHandler`] when [`process_pending_events`] is next called.
4120 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
4121 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
4122 /// event matches your expectation. If you fail to do so and call this method, you may provide
4123 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
4125 /// [`Event::PaymentReceived`]: crate::util::events::Event::PaymentReceived
4126 /// [`Event::PaymentClaimed`]: crate::util::events::Event::PaymentClaimed
4127 /// [`process_pending_events`]: EventsProvider::process_pending_events
4128 /// [`create_inbound_payment`]: Self::create_inbound_payment
4129 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
4130 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
4131 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
4132 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4134 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4136 let removed_source = self.channel_state.lock().unwrap().claimable_htlcs.remove(&payment_hash);
4137 if let Some((payment_purpose, mut sources)) = removed_source {
4138 assert!(!sources.is_empty());
4140 // If we are claiming an MPP payment, we have to take special care to ensure that each
4141 // channel exists before claiming all of the payments (inside one lock).
4142 // Note that channel existance is sufficient as we should always get a monitor update
4143 // which will take care of the real HTLC claim enforcement.
4145 // If we find an HTLC which we would need to claim but for which we do not have a
4146 // channel, we will fail all parts of the MPP payment. While we could wait and see if
4147 // the sender retries the already-failed path(s), it should be a pretty rare case where
4148 // we got all the HTLCs and then a channel closed while we were waiting for the user to
4149 // provide the preimage, so worrying too much about the optimal handling isn't worth
4151 let mut claimable_amt_msat = 0;
4152 let mut expected_amt_msat = None;
4153 let mut valid_mpp = true;
4154 let mut errs = Vec::new();
4155 let mut claimed_any_htlcs = false;
4156 let mut channel_state_lock = self.channel_state.lock().unwrap();
4157 let channel_state = &mut *channel_state_lock;
4158 for htlc in sources.iter() {
4159 if let None = channel_state.short_to_chan_info.get(&htlc.prev_hop.short_channel_id) {
4163 if expected_amt_msat.is_some() && expected_amt_msat != Some(htlc.total_msat) {
4164 log_error!(self.logger, "Somehow ended up with an MPP payment with different total amounts - this should not be reachable!");
4165 debug_assert!(false);
4169 expected_amt_msat = Some(htlc.total_msat);
4170 if let OnionPayload::Spontaneous(_) = &htlc.onion_payload {
4171 // We don't currently support MPP for spontaneous payments, so just check
4172 // that there's one payment here and move on.
4173 if sources.len() != 1 {
4174 log_error!(self.logger, "Somehow ended up with an MPP spontaneous payment - this should not be reachable!");
4175 debug_assert!(false);
4181 claimable_amt_msat += htlc.value;
4183 if sources.is_empty() || expected_amt_msat.is_none() {
4184 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
4187 if claimable_amt_msat != expected_amt_msat.unwrap() {
4188 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
4189 expected_amt_msat.unwrap(), claimable_amt_msat);
4193 for htlc in sources.drain(..) {
4194 match self.claim_funds_from_hop(&mut channel_state_lock, htlc.prev_hop, payment_preimage) {
4195 ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) => {
4196 if let msgs::ErrorAction::IgnoreError = err.err.action {
4197 // We got a temporary failure updating monitor, but will claim the
4198 // HTLC when the monitor updating is restored (or on chain).
4199 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
4200 claimed_any_htlcs = true;
4201 } else { errs.push((pk, err)); }
4203 ClaimFundsFromHop::PrevHopForceClosed => unreachable!("We already checked for channel existence, we can't fail here!"),
4204 ClaimFundsFromHop::DuplicateClaim => {
4205 // While we should never get here in most cases, if we do, it likely
4206 // indicates that the HTLC was timed out some time ago and is no longer
4207 // available to be claimed. Thus, it does not make sense to set
4208 // `claimed_any_htlcs`.
4210 ClaimFundsFromHop::Success(_) => claimed_any_htlcs = true,
4214 mem::drop(channel_state_lock);
4216 for htlc in sources.drain(..) {
4217 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
4218 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
4219 self.best_block.read().unwrap().height()));
4220 self.fail_htlc_backwards_internal(
4221 HTLCSource::PreviousHopData(htlc.prev_hop), &payment_hash,
4222 HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_height_data },
4223 HTLCDestination::FailedPayment { payment_hash } );
4227 if claimed_any_htlcs {
4228 self.pending_events.lock().unwrap().push(events::Event::PaymentClaimed {
4230 purpose: payment_purpose,
4231 amount_msat: claimable_amt_msat,
4235 // Now we can handle any errors which were generated.
4236 for (counterparty_node_id, err) in errs.drain(..) {
4237 let res: Result<(), _> = Err(err);
4238 let _ = handle_error!(self, res, counterparty_node_id);
4243 fn claim_funds_from_hop(&self, channel_state_lock: &mut MutexGuard<ChannelHolder<<K::Target as KeysInterface>::Signer>>, prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage) -> ClaimFundsFromHop {
4244 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
4245 let channel_state = &mut **channel_state_lock;
4246 let chan_id = match channel_state.short_to_chan_info.get(&prev_hop.short_channel_id) {
4247 Some((_cp_id, chan_id)) => chan_id.clone(),
4249 return ClaimFundsFromHop::PrevHopForceClosed
4253 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
4254 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
4255 Ok(msgs_monitor_option) => {
4256 if let UpdateFulfillCommitFetch::NewClaim { msgs, htlc_value_msat, monitor_update } = msgs_monitor_option {
4257 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
4258 ChannelMonitorUpdateStatus::Completed => {},
4260 log_given_level!(self.logger, if e == ChannelMonitorUpdateStatus::PermanentFailure { Level::Error } else { Level::Debug },
4261 "Failed to update channel monitor with preimage {:?}: {:?}",
4262 payment_preimage, e);
4263 return ClaimFundsFromHop::MonitorUpdateFail(
4264 chan.get().get_counterparty_node_id(),
4265 handle_monitor_update_res!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()).unwrap_err(),
4266 Some(htlc_value_msat)
4270 if let Some((msg, commitment_signed)) = msgs {
4271 log_debug!(self.logger, "Claiming funds for HTLC with preimage {} resulted in a commitment_signed for channel {}",
4272 log_bytes!(payment_preimage.0), log_bytes!(chan.get().channel_id()));
4273 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4274 node_id: chan.get().get_counterparty_node_id(),
4275 updates: msgs::CommitmentUpdate {
4276 update_add_htlcs: Vec::new(),
4277 update_fulfill_htlcs: vec![msg],
4278 update_fail_htlcs: Vec::new(),
4279 update_fail_malformed_htlcs: Vec::new(),
4285 return ClaimFundsFromHop::Success(htlc_value_msat);
4287 return ClaimFundsFromHop::DuplicateClaim;
4290 Err((e, monitor_update)) => {
4291 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
4292 ChannelMonitorUpdateStatus::Completed => {},
4294 log_given_level!(self.logger, if e == ChannelMonitorUpdateStatus::PermanentFailure { Level::Error } else { Level::Info },
4295 "Failed to update channel monitor with preimage {:?} immediately prior to force-close: {:?}",
4296 payment_preimage, e);
4299 let counterparty_node_id = chan.get().get_counterparty_node_id();
4300 let (drop, res) = convert_chan_err!(self, e, channel_state.short_to_chan_info, chan.get_mut(), &chan_id);
4302 chan.remove_entry();
4304 return ClaimFundsFromHop::MonitorUpdateFail(counterparty_node_id, res, None);
4307 } else { unreachable!(); }
4310 fn finalize_claims(&self, mut sources: Vec<HTLCSource>) {
4311 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
4312 let mut pending_events = self.pending_events.lock().unwrap();
4313 for source in sources.drain(..) {
4314 if let HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } = source {
4315 let mut session_priv_bytes = [0; 32];
4316 session_priv_bytes.copy_from_slice(&session_priv[..]);
4317 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
4318 assert!(payment.get().is_fulfilled());
4319 if payment.get_mut().remove(&session_priv_bytes, None) {
4320 pending_events.push(
4321 events::Event::PaymentPathSuccessful {
4323 payment_hash: payment.get().payment_hash(),
4333 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]) {
4335 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
4336 mem::drop(channel_state_lock);
4337 let mut session_priv_bytes = [0; 32];
4338 session_priv_bytes.copy_from_slice(&session_priv[..]);
4339 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
4340 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
4341 let mut pending_events = self.pending_events.lock().unwrap();
4342 if !payment.get().is_fulfilled() {
4343 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4344 let fee_paid_msat = payment.get().get_pending_fee_msat();
4345 pending_events.push(
4346 events::Event::PaymentSent {
4347 payment_id: Some(payment_id),
4353 payment.get_mut().mark_fulfilled();
4357 // We currently immediately remove HTLCs which were fulfilled on-chain.
4358 // This could potentially lead to removing a pending payment too early,
4359 // with a reorg of one block causing us to re-add the fulfilled payment on
4361 // TODO: We should have a second monitor event that informs us of payments
4362 // irrevocably fulfilled.
4363 if payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
4364 let payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0).into_inner()));
4365 pending_events.push(
4366 events::Event::PaymentPathSuccessful {
4375 log_trace!(self.logger, "Received duplicative fulfill for HTLC with payment_preimage {}", log_bytes!(payment_preimage.0));
4378 HTLCSource::PreviousHopData(hop_data) => {
4379 let prev_outpoint = hop_data.outpoint;
4380 let res = self.claim_funds_from_hop(&mut channel_state_lock, hop_data, payment_preimage);
4381 let claimed_htlc = if let ClaimFundsFromHop::DuplicateClaim = res { false } else { true };
4382 let htlc_claim_value_msat = match res {
4383 ClaimFundsFromHop::MonitorUpdateFail(_, _, amt_opt) => amt_opt,
4384 ClaimFundsFromHop::Success(amt) => Some(amt),
4387 if let ClaimFundsFromHop::PrevHopForceClosed = res {
4388 let preimage_update = ChannelMonitorUpdate {
4389 update_id: CLOSED_CHANNEL_UPDATE_ID,
4390 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
4391 payment_preimage: payment_preimage.clone(),
4394 // We update the ChannelMonitor on the backward link, after
4395 // receiving an offchain preimage event from the forward link (the
4396 // event being update_fulfill_htlc).
4397 let update_res = self.chain_monitor.update_channel(prev_outpoint, preimage_update);
4398 if update_res != ChannelMonitorUpdateStatus::Completed {
4399 // TODO: This needs to be handled somehow - if we receive a monitor update
4400 // with a preimage we *must* somehow manage to propagate it to the upstream
4401 // channel, or we must have an ability to receive the same event and try
4402 // again on restart.
4403 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
4404 payment_preimage, update_res);
4406 // Note that we do *not* set `claimed_htlc` to false here. In fact, this
4407 // totally could be a duplicate claim, but we have no way of knowing
4408 // without interrogating the `ChannelMonitor` we've provided the above
4409 // update to. Instead, we simply document in `PaymentForwarded` that this
4412 mem::drop(channel_state_lock);
4413 if let ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) = res {
4414 let result: Result<(), _> = Err(err);
4415 let _ = handle_error!(self, result, pk);
4419 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
4420 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
4421 Some(claimed_htlc_value - forwarded_htlc_value)
4424 let mut pending_events = self.pending_events.lock().unwrap();
4425 let prev_channel_id = Some(prev_outpoint.to_channel_id());
4426 let next_channel_id = Some(next_channel_id);
4428 pending_events.push(events::Event::PaymentForwarded {
4430 claim_from_onchain_tx: from_onchain,
4440 /// Gets the node_id held by this ChannelManager
4441 pub fn get_our_node_id(&self) -> PublicKey {
4442 self.our_network_pubkey.clone()
4445 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64) {
4446 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4448 let chan_restoration_res;
4449 let (mut pending_failures, finalized_claims, counterparty_node_id) = {
4450 let mut channel_lock = self.channel_state.lock().unwrap();
4451 let channel_state = &mut *channel_lock;
4452 let mut channel = match channel_state.by_id.entry(funding_txo.to_channel_id()) {
4453 hash_map::Entry::Occupied(chan) => chan,
4454 hash_map::Entry::Vacant(_) => return,
4456 if !channel.get().is_awaiting_monitor_update() || channel.get().get_latest_monitor_update_id() != highest_applied_update_id {
4460 let counterparty_node_id = channel.get().get_counterparty_node_id();
4461 let updates = channel.get_mut().monitor_updating_restored(&self.logger, self.get_our_node_id(), self.genesis_hash, self.best_block.read().unwrap().height());
4462 let channel_update = if updates.channel_ready.is_some() && channel.get().is_usable() {
4463 // We only send a channel_update in the case where we are just now sending a
4464 // channel_ready and the channel is in a usable state. We may re-send a
4465 // channel_update later through the announcement_signatures process for public
4466 // channels, but there's no reason not to just inform our counterparty of our fees
4468 if let Ok(msg) = self.get_channel_update_for_unicast(channel.get()) {
4469 Some(events::MessageSendEvent::SendChannelUpdate {
4470 node_id: channel.get().get_counterparty_node_id(),
4475 chan_restoration_res = handle_chan_restoration_locked!(self, channel_lock, channel_state, channel, updates.raa, updates.commitment_update, updates.order, None, updates.accepted_htlcs, updates.funding_broadcastable, updates.channel_ready, updates.announcement_sigs);
4476 if let Some(upd) = channel_update {
4477 channel_state.pending_msg_events.push(upd);
4480 (updates.failed_htlcs, updates.finalized_claimed_htlcs, counterparty_node_id)
4482 post_handle_chan_restoration!(self, chan_restoration_res);
4483 self.finalize_claims(finalized_claims);
4484 for failure in pending_failures.drain(..) {
4485 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id: funding_txo.to_channel_id() };
4486 self.fail_htlc_backwards_internal(failure.0, &failure.1, failure.2, receiver);
4490 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
4492 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
4493 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
4496 /// The `user_channel_id` parameter will be provided back in
4497 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4498 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4500 /// Note that this method will return an error and reject the channel, if it requires support
4501 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
4502 /// used to accept such channels.
4504 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4505 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4506 pub fn accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u64) -> Result<(), APIError> {
4507 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
4510 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
4511 /// it as confirmed immediately.
4513 /// The `user_channel_id` parameter will be provided back in
4514 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4515 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4517 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
4518 /// and (if the counterparty agrees), enables forwarding of payments immediately.
4520 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
4521 /// transaction and blindly assumes that it will eventually confirm.
4523 /// If it does not confirm before we decide to close the channel, or if the funding transaction
4524 /// does not pay to the correct script the correct amount, *you will lose funds*.
4526 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4527 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4528 pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u64) -> Result<(), APIError> {
4529 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
4532 fn do_accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u64) -> Result<(), APIError> {
4533 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4535 let mut channel_state_lock = self.channel_state.lock().unwrap();
4536 let channel_state = &mut *channel_state_lock;
4537 match channel_state.by_id.entry(temporary_channel_id.clone()) {
4538 hash_map::Entry::Occupied(mut channel) => {
4539 if !channel.get().inbound_is_awaiting_accept() {
4540 return Err(APIError::APIMisuseError { err: "The channel isn't currently awaiting to be accepted.".to_owned() });
4542 if *counterparty_node_id != channel.get().get_counterparty_node_id() {
4543 return Err(APIError::APIMisuseError { err: "The passed counterparty_node_id doesn't match the channel's counterparty node_id".to_owned() });
4546 channel.get_mut().set_0conf();
4547 } else if channel.get().get_channel_type().requires_zero_conf() {
4548 let send_msg_err_event = events::MessageSendEvent::HandleError {
4549 node_id: channel.get().get_counterparty_node_id(),
4550 action: msgs::ErrorAction::SendErrorMessage{
4551 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
4554 channel_state.pending_msg_events.push(send_msg_err_event);
4555 let _ = remove_channel!(self, channel_state, channel);
4556 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
4559 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4560 node_id: channel.get().get_counterparty_node_id(),
4561 msg: channel.get_mut().accept_inbound_channel(user_channel_id),
4564 hash_map::Entry::Vacant(_) => {
4565 return Err(APIError::ChannelUnavailable { err: "Can't accept a channel that doesn't exist".to_owned() });
4571 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
4572 if msg.chain_hash != self.genesis_hash {
4573 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
4576 if !self.default_configuration.accept_inbound_channels {
4577 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4580 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
4581 let mut channel = match Channel::new_from_req(&self.fee_estimator, &self.keys_manager,
4582 counterparty_node_id.clone(), &their_features, msg, 0, &self.default_configuration,
4583 self.best_block.read().unwrap().height(), &self.logger, outbound_scid_alias)
4586 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4587 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
4591 let mut channel_state_lock = self.channel_state.lock().unwrap();
4592 let channel_state = &mut *channel_state_lock;
4593 match channel_state.by_id.entry(channel.channel_id()) {
4594 hash_map::Entry::Occupied(_) => {
4595 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4596 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!".to_owned(), msg.temporary_channel_id.clone()))
4598 hash_map::Entry::Vacant(entry) => {
4599 if !self.default_configuration.manually_accept_inbound_channels {
4600 if channel.get_channel_type().requires_zero_conf() {
4601 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4603 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4604 node_id: counterparty_node_id.clone(),
4605 msg: channel.accept_inbound_channel(0),
4608 let mut pending_events = self.pending_events.lock().unwrap();
4609 pending_events.push(
4610 events::Event::OpenChannelRequest {
4611 temporary_channel_id: msg.temporary_channel_id.clone(),
4612 counterparty_node_id: counterparty_node_id.clone(),
4613 funding_satoshis: msg.funding_satoshis,
4614 push_msat: msg.push_msat,
4615 channel_type: channel.get_channel_type().clone(),
4620 entry.insert(channel);
4626 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
4627 let (value, output_script, user_id) = {
4628 let mut channel_lock = self.channel_state.lock().unwrap();
4629 let channel_state = &mut *channel_lock;
4630 match channel_state.by_id.entry(msg.temporary_channel_id) {
4631 hash_map::Entry::Occupied(mut chan) => {
4632 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4633 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
4635 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &their_features), channel_state, chan);
4636 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
4638 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
4641 let mut pending_events = self.pending_events.lock().unwrap();
4642 pending_events.push(events::Event::FundingGenerationReady {
4643 temporary_channel_id: msg.temporary_channel_id,
4644 counterparty_node_id: *counterparty_node_id,
4645 channel_value_satoshis: value,
4647 user_channel_id: user_id,
4652 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
4653 let ((funding_msg, monitor, mut channel_ready), mut chan) = {
4654 let best_block = *self.best_block.read().unwrap();
4655 let mut channel_lock = self.channel_state.lock().unwrap();
4656 let channel_state = &mut *channel_lock;
4657 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
4658 hash_map::Entry::Occupied(mut chan) => {
4659 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4660 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
4662 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.logger), channel_state, chan), chan.remove())
4664 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
4667 // Because we have exclusive ownership of the channel here we can release the channel_state
4668 // lock before watch_channel
4669 match self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
4670 ChannelMonitorUpdateStatus::Completed => {},
4671 ChannelMonitorUpdateStatus::PermanentFailure => {
4672 // Note that we reply with the new channel_id in error messages if we gave up on the
4673 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
4674 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
4675 // any messages referencing a previously-closed channel anyway.
4676 // We do not propagate the monitor update to the user as it would be for a monitor
4677 // that we didn't manage to store (and that we don't care about - we don't respond
4678 // with the funding_signed so the channel can never go on chain).
4679 let (_monitor_update, failed_htlcs) = chan.force_shutdown(false);
4680 assert!(failed_htlcs.is_empty());
4681 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
4683 ChannelMonitorUpdateStatus::InProgress => {
4684 // There's no problem signing a counterparty's funding transaction if our monitor
4685 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
4686 // accepted payment from yet. We do, however, need to wait to send our channel_ready
4687 // until we have persisted our monitor.
4688 chan.monitor_updating_paused(false, false, channel_ready.is_some(), Vec::new(), Vec::new(), Vec::new());
4689 channel_ready = None; // Don't send the channel_ready now
4692 let mut channel_state_lock = self.channel_state.lock().unwrap();
4693 let channel_state = &mut *channel_state_lock;
4694 match channel_state.by_id.entry(funding_msg.channel_id) {
4695 hash_map::Entry::Occupied(_) => {
4696 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
4698 hash_map::Entry::Vacant(e) => {
4699 let mut id_to_peer = self.id_to_peer.lock().unwrap();
4700 match id_to_peer.entry(chan.channel_id()) {
4701 hash_map::Entry::Occupied(_) => {
4702 return Err(MsgHandleErrInternal::send_err_msg_no_close(
4703 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
4704 funding_msg.channel_id))
4706 hash_map::Entry::Vacant(i_e) => {
4707 i_e.insert(chan.get_counterparty_node_id());
4710 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
4711 node_id: counterparty_node_id.clone(),
4714 if let Some(msg) = channel_ready {
4715 send_channel_ready!(channel_state.short_to_chan_info, channel_state.pending_msg_events, chan, msg);
4723 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
4725 let best_block = *self.best_block.read().unwrap();
4726 let mut channel_lock = self.channel_state.lock().unwrap();
4727 let channel_state = &mut *channel_lock;
4728 match channel_state.by_id.entry(msg.channel_id) {
4729 hash_map::Entry::Occupied(mut chan) => {
4730 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4731 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4733 let (monitor, funding_tx, channel_ready) = match chan.get_mut().funding_signed(&msg, best_block, &self.logger) {
4734 Ok(update) => update,
4735 Err(e) => try_chan_entry!(self, Err(e), channel_state, chan),
4737 match self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
4738 ChannelMonitorUpdateStatus::Completed => {},
4740 let mut res = handle_monitor_update_res!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, channel_ready.is_some(), OPTIONALLY_RESEND_FUNDING_LOCKED);
4741 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
4742 // We weren't able to watch the channel to begin with, so no updates should be made on
4743 // it. Previously, full_stack_target found an (unreachable) panic when the
4744 // monitor update contained within `shutdown_finish` was applied.
4745 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
4746 shutdown_finish.0.take();
4752 if let Some(msg) = channel_ready {
4753 send_channel_ready!(channel_state.short_to_chan_info, channel_state.pending_msg_events, chan.get(), msg);
4757 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4760 log_info!(self.logger, "Broadcasting funding transaction with txid {}", funding_tx.txid());
4761 self.tx_broadcaster.broadcast_transaction(&funding_tx);
4765 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
4766 let mut channel_state_lock = self.channel_state.lock().unwrap();
4767 let channel_state = &mut *channel_state_lock;
4768 match channel_state.by_id.entry(msg.channel_id) {
4769 hash_map::Entry::Occupied(mut chan) => {
4770 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4771 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4773 let announcement_sigs_opt = try_chan_entry!(self, chan.get_mut().channel_ready(&msg, self.get_our_node_id(),
4774 self.genesis_hash.clone(), &self.best_block.read().unwrap(), &self.logger), channel_state, chan);
4775 if let Some(announcement_sigs) = announcement_sigs_opt {
4776 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(chan.get().channel_id()));
4777 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4778 node_id: counterparty_node_id.clone(),
4779 msg: announcement_sigs,
4781 } else if chan.get().is_usable() {
4782 // If we're sending an announcement_signatures, we'll send the (public)
4783 // channel_update after sending a channel_announcement when we receive our
4784 // counterparty's announcement_signatures. Thus, we only bother to send a
4785 // channel_update here if the channel is not public, i.e. we're not sending an
4786 // announcement_signatures.
4787 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", log_bytes!(chan.get().channel_id()));
4788 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
4789 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4790 node_id: counterparty_node_id.clone(),
4796 emit_channel_ready_event!(self, chan.get_mut());
4800 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4804 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
4805 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
4806 let result: Result<(), _> = loop {
4807 let mut channel_state_lock = self.channel_state.lock().unwrap();
4808 let channel_state = &mut *channel_state_lock;
4810 match channel_state.by_id.entry(msg.channel_id.clone()) {
4811 hash_map::Entry::Occupied(mut chan_entry) => {
4812 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
4813 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4816 if !chan_entry.get().received_shutdown() {
4817 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
4818 log_bytes!(msg.channel_id),
4819 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
4822 let (shutdown, monitor_update, htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&self.keys_manager, &their_features, &msg), channel_state, chan_entry);
4823 dropped_htlcs = htlcs;
4825 // Update the monitor with the shutdown script if necessary.
4826 if let Some(monitor_update) = monitor_update {
4827 let update_res = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update);
4828 let (result, is_permanent) =
4829 handle_monitor_update_res!(self, update_res, channel_state.short_to_chan_info, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
4831 remove_channel!(self, channel_state, chan_entry);
4836 if let Some(msg) = shutdown {
4837 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
4838 node_id: *counterparty_node_id,
4845 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4848 for htlc_source in dropped_htlcs.drain(..) {
4849 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
4850 self.fail_htlc_backwards_internal(htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
4853 let _ = handle_error!(self, result, *counterparty_node_id);
4857 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
4858 let (tx, chan_option) = {
4859 let mut channel_state_lock = self.channel_state.lock().unwrap();
4860 let channel_state = &mut *channel_state_lock;
4861 match channel_state.by_id.entry(msg.channel_id.clone()) {
4862 hash_map::Entry::Occupied(mut chan_entry) => {
4863 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
4864 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4866 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), channel_state, chan_entry);
4867 if let Some(msg) = closing_signed {
4868 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
4869 node_id: counterparty_node_id.clone(),
4874 // We're done with this channel, we've got a signed closing transaction and
4875 // will send the closing_signed back to the remote peer upon return. This
4876 // also implies there are no pending HTLCs left on the channel, so we can
4877 // fully delete it from tracking (the channel monitor is still around to
4878 // watch for old state broadcasts)!
4879 (tx, Some(remove_channel!(self, channel_state, chan_entry)))
4880 } else { (tx, None) }
4882 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4885 if let Some(broadcast_tx) = tx {
4886 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
4887 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
4889 if let Some(chan) = chan_option {
4890 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4891 let mut channel_state = self.channel_state.lock().unwrap();
4892 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4896 self.issue_channel_close_events(&chan, ClosureReason::CooperativeClosure);
4901 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
4902 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
4903 //determine the state of the payment based on our response/if we forward anything/the time
4904 //we take to respond. We should take care to avoid allowing such an attack.
4906 //TODO: There exists a further attack where a node may garble the onion data, forward it to
4907 //us repeatedly garbled in different ways, and compare our error messages, which are
4908 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
4909 //but we should prevent it anyway.
4911 let pending_forward_info = self.decode_update_add_htlc_onion(msg);
4912 let mut channel_state_lock = self.channel_state.lock().unwrap();
4913 let channel_state = &mut *channel_state_lock;
4915 match channel_state.by_id.entry(msg.channel_id) {
4916 hash_map::Entry::Occupied(mut chan) => {
4917 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4918 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4921 let create_pending_htlc_status = |chan: &Channel<<K::Target as KeysInterface>::Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
4922 // If the update_add is completely bogus, the call will Err and we will close,
4923 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
4924 // want to reject the new HTLC and fail it backwards instead of forwarding.
4925 match pending_forward_info {
4926 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
4927 let reason = if (error_code & 0x1000) != 0 {
4928 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
4929 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, real_code, &error_data)
4931 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, error_code, &[])
4933 let msg = msgs::UpdateFailHTLC {
4934 channel_id: msg.channel_id,
4935 htlc_id: msg.htlc_id,
4938 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
4940 _ => pending_forward_info
4943 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), channel_state, chan);
4945 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4950 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
4951 let mut channel_lock = self.channel_state.lock().unwrap();
4952 let (htlc_source, forwarded_htlc_value) = {
4953 let channel_state = &mut *channel_lock;
4954 match channel_state.by_id.entry(msg.channel_id) {
4955 hash_map::Entry::Occupied(mut chan) => {
4956 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4957 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4959 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
4961 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4964 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, msg.channel_id);
4968 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
4969 let mut channel_lock = self.channel_state.lock().unwrap();
4970 let channel_state = &mut *channel_lock;
4971 match channel_state.by_id.entry(msg.channel_id) {
4972 hash_map::Entry::Occupied(mut chan) => {
4973 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4974 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4976 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
4978 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4983 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
4984 let mut channel_lock = self.channel_state.lock().unwrap();
4985 let channel_state = &mut *channel_lock;
4986 match channel_state.by_id.entry(msg.channel_id) {
4987 hash_map::Entry::Occupied(mut chan) => {
4988 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4989 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4991 if (msg.failure_code & 0x8000) == 0 {
4992 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
4993 try_chan_entry!(self, Err(chan_err), channel_state, chan);
4995 try_chan_entry!(self, chan.get_mut().update_fail_malformed_htlc(&msg, HTLCFailReason::Reason { failure_code: msg.failure_code, data: Vec::new() }), channel_state, chan);
4998 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5002 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
5003 let mut channel_state_lock = self.channel_state.lock().unwrap();
5004 let channel_state = &mut *channel_state_lock;
5005 match channel_state.by_id.entry(msg.channel_id) {
5006 hash_map::Entry::Occupied(mut chan) => {
5007 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5008 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5010 let (revoke_and_ack, commitment_signed, monitor_update) =
5011 match chan.get_mut().commitment_signed(&msg, &self.logger) {
5012 Err((None, e)) => try_chan_entry!(self, Err(e), channel_state, chan),
5013 Err((Some(update), e)) => {
5014 assert!(chan.get().is_awaiting_monitor_update());
5015 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), update);
5016 try_chan_entry!(self, Err(e), channel_state, chan);
5021 let update_res = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update);
5022 if let Err(e) = handle_monitor_update_res!(self, update_res, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some()) {
5026 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
5027 node_id: counterparty_node_id.clone(),
5028 msg: revoke_and_ack,
5030 if let Some(msg) = commitment_signed {
5031 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5032 node_id: counterparty_node_id.clone(),
5033 updates: msgs::CommitmentUpdate {
5034 update_add_htlcs: Vec::new(),
5035 update_fulfill_htlcs: Vec::new(),
5036 update_fail_htlcs: Vec::new(),
5037 update_fail_malformed_htlcs: Vec::new(),
5039 commitment_signed: msg,
5045 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5050 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)]) {
5051 for &mut (prev_short_channel_id, prev_funding_outpoint, ref mut pending_forwards) in per_source_pending_forwards {
5052 let mut forward_event = None;
5053 if !pending_forwards.is_empty() {
5054 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
5055 if forward_htlcs.is_empty() {
5056 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
5058 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
5059 match forward_htlcs.entry(match forward_info.routing {
5060 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
5061 PendingHTLCRouting::Receive { .. } => 0,
5062 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
5064 hash_map::Entry::Occupied(mut entry) => {
5065 entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
5066 prev_htlc_id, forward_info });
5068 hash_map::Entry::Vacant(entry) => {
5069 entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
5070 prev_htlc_id, forward_info }));
5075 match forward_event {
5077 let mut pending_events = self.pending_events.lock().unwrap();
5078 pending_events.push(events::Event::PendingHTLCsForwardable {
5079 time_forwardable: time
5087 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
5088 let mut htlcs_to_fail = Vec::new();
5090 let mut channel_state_lock = self.channel_state.lock().unwrap();
5091 let channel_state = &mut *channel_state_lock;
5092 match channel_state.by_id.entry(msg.channel_id) {
5093 hash_map::Entry::Occupied(mut chan) => {
5094 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5095 break Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5097 let was_paused_for_mon_update = chan.get().is_awaiting_monitor_update();
5098 let raa_updates = break_chan_entry!(self,
5099 chan.get_mut().revoke_and_ack(&msg, &self.logger), channel_state, chan);
5100 htlcs_to_fail = raa_updates.holding_cell_failed_htlcs;
5101 let update_res = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), raa_updates.monitor_update);
5102 if was_paused_for_mon_update {
5103 assert!(update_res != ChannelMonitorUpdateStatus::Completed);
5104 assert!(raa_updates.commitment_update.is_none());
5105 assert!(raa_updates.accepted_htlcs.is_empty());
5106 assert!(raa_updates.failed_htlcs.is_empty());
5107 assert!(raa_updates.finalized_claimed_htlcs.is_empty());
5108 break Err(MsgHandleErrInternal::ignore_no_close("Existing pending monitor update prevented responses to RAA".to_owned()));
5110 if update_res != ChannelMonitorUpdateStatus::Completed {
5111 if let Err(e) = handle_monitor_update_res!(self, update_res, channel_state, chan,
5112 RAACommitmentOrder::CommitmentFirst, false,
5113 raa_updates.commitment_update.is_some(), false,
5114 raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
5115 raa_updates.finalized_claimed_htlcs) {
5117 } else { unreachable!(); }
5119 if let Some(updates) = raa_updates.commitment_update {
5120 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5121 node_id: counterparty_node_id.clone(),
5125 break Ok((raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
5126 raa_updates.finalized_claimed_htlcs,
5127 chan.get().get_short_channel_id()
5128 .unwrap_or(chan.get().outbound_scid_alias()),
5129 chan.get().get_funding_txo().unwrap()))
5131 hash_map::Entry::Vacant(_) => break Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5134 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
5136 Ok((pending_forwards, mut pending_failures, finalized_claim_htlcs,
5137 short_channel_id, channel_outpoint)) =>
5139 for failure in pending_failures.drain(..) {
5140 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: channel_outpoint.to_channel_id() };
5141 self.fail_htlc_backwards_internal(failure.0, &failure.1, failure.2, receiver);
5143 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, pending_forwards)]);
5144 self.finalize_claims(finalized_claim_htlcs);
5151 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
5152 let mut channel_lock = self.channel_state.lock().unwrap();
5153 let channel_state = &mut *channel_lock;
5154 match channel_state.by_id.entry(msg.channel_id) {
5155 hash_map::Entry::Occupied(mut chan) => {
5156 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5157 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5159 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg), channel_state, chan);
5161 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5166 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
5167 let mut channel_state_lock = self.channel_state.lock().unwrap();
5168 let channel_state = &mut *channel_state_lock;
5170 match channel_state.by_id.entry(msg.channel_id) {
5171 hash_map::Entry::Occupied(mut chan) => {
5172 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5173 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5175 if !chan.get().is_usable() {
5176 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
5179 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5180 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(
5181 self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height(), msg), channel_state, chan),
5182 // Note that announcement_signatures fails if the channel cannot be announced,
5183 // so get_channel_update_for_broadcast will never fail by the time we get here.
5184 update_msg: self.get_channel_update_for_broadcast(chan.get()).unwrap(),
5187 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5192 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
5193 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
5194 let mut channel_state_lock = self.channel_state.lock().unwrap();
5195 let channel_state = &mut *channel_state_lock;
5196 let chan_id = match channel_state.short_to_chan_info.get(&msg.contents.short_channel_id) {
5197 Some((_cp_id, chan_id)) => chan_id.clone(),
5199 // It's not a local channel
5200 return Ok(NotifyOption::SkipPersist)
5203 match channel_state.by_id.entry(chan_id) {
5204 hash_map::Entry::Occupied(mut chan) => {
5205 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5206 if chan.get().should_announce() {
5207 // If the announcement is about a channel of ours which is public, some
5208 // other peer may simply be forwarding all its gossip to us. Don't provide
5209 // a scary-looking error message and return Ok instead.
5210 return Ok(NotifyOption::SkipPersist);
5212 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));
5214 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().get_counterparty_node_id().serialize()[..];
5215 let msg_from_node_one = msg.contents.flags & 1 == 0;
5216 if were_node_one == msg_from_node_one {
5217 return Ok(NotifyOption::SkipPersist);
5219 log_debug!(self.logger, "Received channel_update for channel {}.", log_bytes!(chan_id));
5220 try_chan_entry!(self, chan.get_mut().channel_update(&msg), channel_state, chan);
5223 hash_map::Entry::Vacant(_) => unreachable!()
5225 Ok(NotifyOption::DoPersist)
5228 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
5229 let chan_restoration_res;
5230 let (htlcs_failed_forward, need_lnd_workaround) = {
5231 let mut channel_state_lock = self.channel_state.lock().unwrap();
5232 let channel_state = &mut *channel_state_lock;
5234 match channel_state.by_id.entry(msg.channel_id) {
5235 hash_map::Entry::Occupied(mut chan) => {
5236 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5237 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5239 // Currently, we expect all holding cell update_adds to be dropped on peer
5240 // disconnect, so Channel's reestablish will never hand us any holding cell
5241 // freed HTLCs to fail backwards. If in the future we no longer drop pending
5242 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
5243 let responses = try_chan_entry!(self, chan.get_mut().channel_reestablish(
5244 msg, &self.logger, self.our_network_pubkey.clone(), self.genesis_hash,
5245 &*self.best_block.read().unwrap()), channel_state, chan);
5246 let mut channel_update = None;
5247 if let Some(msg) = responses.shutdown_msg {
5248 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5249 node_id: counterparty_node_id.clone(),
5252 } else if chan.get().is_usable() {
5253 // If the channel is in a usable state (ie the channel is not being shut
5254 // down), send a unicast channel_update to our counterparty to make sure
5255 // they have the latest channel parameters.
5256 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
5257 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
5258 node_id: chan.get().get_counterparty_node_id(),
5263 let need_lnd_workaround = chan.get_mut().workaround_lnd_bug_4006.take();
5264 chan_restoration_res = handle_chan_restoration_locked!(
5265 self, channel_state_lock, channel_state, chan, responses.raa, responses.commitment_update, responses.order,
5266 responses.mon_update, Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
5267 if let Some(upd) = channel_update {
5268 channel_state.pending_msg_events.push(upd);
5270 (responses.holding_cell_failed_htlcs, need_lnd_workaround)
5272 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5275 post_handle_chan_restoration!(self, chan_restoration_res);
5276 self.fail_holding_cell_htlcs(htlcs_failed_forward, msg.channel_id, counterparty_node_id);
5278 if let Some(channel_ready_msg) = need_lnd_workaround {
5279 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
5284 /// Process pending events from the `chain::Watch`, returning whether any events were processed.
5285 fn process_pending_monitor_events(&self) -> bool {
5286 let mut failed_channels = Vec::new();
5287 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
5288 let has_pending_monitor_events = !pending_monitor_events.is_empty();
5289 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
5290 for monitor_event in monitor_events.drain(..) {
5291 match monitor_event {
5292 MonitorEvent::HTLCEvent(htlc_update) => {
5293 if let Some(preimage) = htlc_update.payment_preimage {
5294 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
5295 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());
5297 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
5298 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
5299 self.fail_htlc_backwards_internal(htlc_update.source, &htlc_update.payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
5302 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
5303 MonitorEvent::UpdateFailed(funding_outpoint) => {
5304 let mut channel_lock = self.channel_state.lock().unwrap();
5305 let channel_state = &mut *channel_lock;
5306 let by_id = &mut channel_state.by_id;
5307 let pending_msg_events = &mut channel_state.pending_msg_events;
5308 if let hash_map::Entry::Occupied(chan_entry) = by_id.entry(funding_outpoint.to_channel_id()) {
5309 let mut chan = remove_channel!(self, channel_state, chan_entry);
5310 failed_channels.push(chan.force_shutdown(false));
5311 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5312 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5316 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
5317 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
5319 ClosureReason::CommitmentTxConfirmed
5321 self.issue_channel_close_events(&chan, reason);
5322 pending_msg_events.push(events::MessageSendEvent::HandleError {
5323 node_id: chan.get_counterparty_node_id(),
5324 action: msgs::ErrorAction::SendErrorMessage {
5325 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
5330 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
5331 self.channel_monitor_updated(&funding_txo, monitor_update_id);
5337 for failure in failed_channels.drain(..) {
5338 self.finish_force_close_channel(failure);
5341 has_pending_monitor_events
5344 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
5345 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
5346 /// update events as a separate process method here.
5348 pub fn process_monitor_events(&self) {
5349 self.process_pending_monitor_events();
5352 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
5353 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
5354 /// update was applied.
5356 /// This should only apply to HTLCs which were added to the holding cell because we were
5357 /// waiting on a monitor update to finish. In that case, we don't want to free the holding cell
5358 /// directly in `channel_monitor_updated` as it may introduce deadlocks calling back into user
5359 /// code to inform them of a channel monitor update.
5360 fn check_free_holding_cells(&self) -> bool {
5361 let mut has_monitor_update = false;
5362 let mut failed_htlcs = Vec::new();
5363 let mut handle_errors = Vec::new();
5365 let mut channel_state_lock = self.channel_state.lock().unwrap();
5366 let channel_state = &mut *channel_state_lock;
5367 let by_id = &mut channel_state.by_id;
5368 let short_to_chan_info = &mut channel_state.short_to_chan_info;
5369 let pending_msg_events = &mut channel_state.pending_msg_events;
5371 by_id.retain(|channel_id, chan| {
5372 match chan.maybe_free_holding_cell_htlcs(&self.logger) {
5373 Ok((commitment_opt, holding_cell_failed_htlcs)) => {
5374 if !holding_cell_failed_htlcs.is_empty() {
5376 holding_cell_failed_htlcs,
5378 chan.get_counterparty_node_id()
5381 if let Some((commitment_update, monitor_update)) = commitment_opt {
5382 match self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
5383 ChannelMonitorUpdateStatus::Completed => {
5384 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5385 node_id: chan.get_counterparty_node_id(),
5386 updates: commitment_update,
5390 has_monitor_update = true;
5391 let (res, close_channel) = handle_monitor_update_res!(self, e, short_to_chan_info, chan, RAACommitmentOrder::CommitmentFirst, channel_id, COMMITMENT_UPDATE_ONLY);
5392 handle_errors.push((chan.get_counterparty_node_id(), res));
5393 if close_channel { return false; }
5400 let (close_channel, res) = convert_chan_err!(self, e, short_to_chan_info, chan, channel_id);
5401 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5402 // ChannelClosed event is generated by handle_error for us
5409 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
5410 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
5411 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
5414 for (counterparty_node_id, err) in handle_errors.drain(..) {
5415 let _ = handle_error!(self, err, counterparty_node_id);
5421 /// Check whether any channels have finished removing all pending updates after a shutdown
5422 /// exchange and can now send a closing_signed.
5423 /// Returns whether any closing_signed messages were generated.
5424 fn maybe_generate_initial_closing_signed(&self) -> bool {
5425 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
5426 let mut has_update = false;
5428 let mut channel_state_lock = self.channel_state.lock().unwrap();
5429 let channel_state = &mut *channel_state_lock;
5430 let by_id = &mut channel_state.by_id;
5431 let short_to_chan_info = &mut channel_state.short_to_chan_info;
5432 let pending_msg_events = &mut channel_state.pending_msg_events;
5434 by_id.retain(|channel_id, chan| {
5435 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
5436 Ok((msg_opt, tx_opt)) => {
5437 if let Some(msg) = msg_opt {
5439 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5440 node_id: chan.get_counterparty_node_id(), msg,
5443 if let Some(tx) = tx_opt {
5444 // We're done with this channel. We got a closing_signed and sent back
5445 // a closing_signed with a closing transaction to broadcast.
5446 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5447 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5452 self.issue_channel_close_events(chan, ClosureReason::CooperativeClosure);
5454 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
5455 self.tx_broadcaster.broadcast_transaction(&tx);
5456 update_maps_on_chan_removal!(self, short_to_chan_info, chan);
5462 let (close_channel, res) = convert_chan_err!(self, e, short_to_chan_info, chan, channel_id);
5463 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5470 for (counterparty_node_id, err) in handle_errors.drain(..) {
5471 let _ = handle_error!(self, err, counterparty_node_id);
5477 /// Handle a list of channel failures during a block_connected or block_disconnected call,
5478 /// pushing the channel monitor update (if any) to the background events queue and removing the
5480 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
5481 for mut failure in failed_channels.drain(..) {
5482 // Either a commitment transactions has been confirmed on-chain or
5483 // Channel::block_disconnected detected that the funding transaction has been
5484 // reorganized out of the main chain.
5485 // We cannot broadcast our latest local state via monitor update (as
5486 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
5487 // so we track the update internally and handle it when the user next calls
5488 // timer_tick_occurred, guaranteeing we're running normally.
5489 if let Some((funding_txo, update)) = failure.0.take() {
5490 assert_eq!(update.updates.len(), 1);
5491 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
5492 assert!(should_broadcast);
5493 } else { unreachable!(); }
5494 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
5496 self.finish_force_close_channel(failure);
5500 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> {
5501 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
5503 if min_value_msat.is_some() && min_value_msat.unwrap() > MAX_VALUE_MSAT {
5504 return Err(APIError::APIMisuseError { err: format!("min_value_msat of {} greater than total 21 million bitcoin supply", min_value_msat.unwrap()) });
5507 let payment_secret = PaymentSecret(self.keys_manager.get_secure_random_bytes());
5509 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5510 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5511 match payment_secrets.entry(payment_hash) {
5512 hash_map::Entry::Vacant(e) => {
5513 e.insert(PendingInboundPayment {
5514 payment_secret, min_value_msat, payment_preimage,
5515 user_payment_id: 0, // For compatibility with version 0.0.103 and earlier
5516 // We assume that highest_seen_timestamp is pretty close to the current time -
5517 // it's updated when we receive a new block with the maximum time we've seen in
5518 // a header. It should never be more than two hours in the future.
5519 // Thus, we add two hours here as a buffer to ensure we absolutely
5520 // never fail a payment too early.
5521 // Note that we assume that received blocks have reasonably up-to-date
5523 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
5526 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
5531 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
5534 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
5535 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
5537 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
5538 /// will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
5539 /// passed directly to [`claim_funds`].
5541 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
5543 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5544 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5548 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5549 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5551 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5553 /// [`claim_funds`]: Self::claim_funds
5554 /// [`PaymentReceived`]: events::Event::PaymentReceived
5555 /// [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
5556 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5557 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), ()> {
5558 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)
5561 /// Legacy version of [`create_inbound_payment`]. Use this method if you wish to share
5562 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5564 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5567 /// This method is deprecated and will be removed soon.
5569 /// [`create_inbound_payment`]: Self::create_inbound_payment
5571 pub fn create_inbound_payment_legacy(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), APIError> {
5572 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
5573 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
5574 let payment_secret = self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs)?;
5575 Ok((payment_hash, payment_secret))
5578 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
5579 /// stored external to LDK.
5581 /// A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
5582 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
5583 /// the `min_value_msat` provided here, if one is provided.
5585 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
5586 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
5589 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
5590 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
5591 /// before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
5592 /// sender "proof-of-payment" unless they have paid the required amount.
5594 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
5595 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
5596 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
5597 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
5598 /// invoices when no timeout is set.
5600 /// Note that we use block header time to time-out pending inbound payments (with some margin
5601 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
5602 /// accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
5603 /// If you need exact expiry semantics, you should enforce them upon receipt of
5604 /// [`PaymentReceived`].
5606 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
5607 /// set to at least [`MIN_FINAL_CLTV_EXPIRY`].
5609 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5610 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5614 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5615 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5617 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5619 /// [`create_inbound_payment`]: Self::create_inbound_payment
5620 /// [`PaymentReceived`]: events::Event::PaymentReceived
5621 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<PaymentSecret, ()> {
5622 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)
5625 /// Legacy version of [`create_inbound_payment_for_hash`]. Use this method if you wish to share
5626 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5628 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5631 /// This method is deprecated and will be removed soon.
5633 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5635 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> {
5636 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
5639 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
5640 /// previously returned from [`create_inbound_payment`].
5642 /// [`create_inbound_payment`]: Self::create_inbound_payment
5643 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
5644 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
5647 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
5648 /// are used when constructing the phantom invoice's route hints.
5650 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5651 pub fn get_phantom_scid(&self) -> u64 {
5652 let mut channel_state = self.channel_state.lock().unwrap();
5653 let best_block = self.best_block.read().unwrap();
5655 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block.height(), &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
5656 // Ensure the generated scid doesn't conflict with a real channel.
5657 match channel_state.short_to_chan_info.entry(scid_candidate) {
5658 hash_map::Entry::Occupied(_) => continue,
5659 hash_map::Entry::Vacant(_) => return scid_candidate
5664 /// Gets route hints for use in receiving [phantom node payments].
5666 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5667 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
5669 channels: self.list_usable_channels(),
5670 phantom_scid: self.get_phantom_scid(),
5671 real_node_pubkey: self.get_our_node_id(),
5675 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
5676 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
5677 let events = core::cell::RefCell::new(Vec::new());
5678 let event_handler = |event: &events::Event| events.borrow_mut().push(event.clone());
5679 self.process_pending_events(&event_handler);
5684 pub fn has_pending_payments(&self) -> bool {
5685 !self.pending_outbound_payments.lock().unwrap().is_empty()
5689 pub fn clear_pending_payments(&self) {
5690 self.pending_outbound_payments.lock().unwrap().clear()
5694 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<M, T, K, F, L>
5695 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
5696 T::Target: BroadcasterInterface,
5697 K::Target: KeysInterface,
5698 F::Target: FeeEstimator,
5701 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
5702 let events = RefCell::new(Vec::new());
5703 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5704 let mut result = NotifyOption::SkipPersist;
5706 // TODO: This behavior should be documented. It's unintuitive that we query
5707 // ChannelMonitors when clearing other events.
5708 if self.process_pending_monitor_events() {
5709 result = NotifyOption::DoPersist;
5712 if self.check_free_holding_cells() {
5713 result = NotifyOption::DoPersist;
5715 if self.maybe_generate_initial_closing_signed() {
5716 result = NotifyOption::DoPersist;
5719 let mut pending_events = Vec::new();
5720 let mut channel_state = self.channel_state.lock().unwrap();
5721 mem::swap(&mut pending_events, &mut channel_state.pending_msg_events);
5723 if !pending_events.is_empty() {
5724 events.replace(pending_events);
5733 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> EventsProvider for ChannelManager<M, T, K, F, L>
5735 M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
5736 T::Target: BroadcasterInterface,
5737 K::Target: KeysInterface,
5738 F::Target: FeeEstimator,
5741 /// Processes events that must be periodically handled.
5743 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
5744 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
5745 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
5746 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5747 let mut result = NotifyOption::SkipPersist;
5749 // TODO: This behavior should be documented. It's unintuitive that we query
5750 // ChannelMonitors when clearing other events.
5751 if self.process_pending_monitor_events() {
5752 result = NotifyOption::DoPersist;
5755 let mut pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5756 if !pending_events.is_empty() {
5757 result = NotifyOption::DoPersist;
5760 for event in pending_events.drain(..) {
5761 handler.handle_event(&event);
5769 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Listen for ChannelManager<M, T, K, F, L>
5771 M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
5772 T::Target: BroadcasterInterface,
5773 K::Target: KeysInterface,
5774 F::Target: FeeEstimator,
5777 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5779 let best_block = self.best_block.read().unwrap();
5780 assert_eq!(best_block.block_hash(), header.prev_blockhash,
5781 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
5782 assert_eq!(best_block.height(), height - 1,
5783 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
5786 self.transactions_confirmed(header, txdata, height);
5787 self.best_block_updated(header, height);
5790 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
5791 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5792 let new_height = height - 1;
5794 let mut best_block = self.best_block.write().unwrap();
5795 assert_eq!(best_block.block_hash(), header.block_hash(),
5796 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
5797 assert_eq!(best_block.height(), height,
5798 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
5799 *best_block = BestBlock::new(header.prev_blockhash, new_height)
5802 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));
5806 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Confirm for ChannelManager<M, T, K, F, L>
5808 M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
5809 T::Target: BroadcasterInterface,
5810 K::Target: KeysInterface,
5811 F::Target: FeeEstimator,
5814 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5815 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5816 // during initialization prior to the chain_monitor being fully configured in some cases.
5817 // See the docs for `ChannelManagerReadArgs` for more.
5819 let block_hash = header.block_hash();
5820 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
5822 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5823 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)
5824 .map(|(a, b)| (a, Vec::new(), b)));
5826 let last_best_block_height = self.best_block.read().unwrap().height();
5827 if height < last_best_block_height {
5828 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
5829 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));
5833 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
5834 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5835 // during initialization prior to the chain_monitor being fully configured in some cases.
5836 // See the docs for `ChannelManagerReadArgs` for more.
5838 let block_hash = header.block_hash();
5839 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
5841 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5843 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
5845 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));
5847 macro_rules! max_time {
5848 ($timestamp: expr) => {
5850 // Update $timestamp to be the max of its current value and the block
5851 // timestamp. This should keep us close to the current time without relying on
5852 // having an explicit local time source.
5853 // Just in case we end up in a race, we loop until we either successfully
5854 // update $timestamp or decide we don't need to.
5855 let old_serial = $timestamp.load(Ordering::Acquire);
5856 if old_serial >= header.time as usize { break; }
5857 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
5863 max_time!(self.highest_seen_timestamp);
5864 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5865 payment_secrets.retain(|_, inbound_payment| {
5866 inbound_payment.expiry_time > header.time as u64
5870 fn get_relevant_txids(&self) -> Vec<Txid> {
5871 let channel_state = self.channel_state.lock().unwrap();
5872 let mut res = Vec::with_capacity(channel_state.short_to_chan_info.len());
5873 for chan in channel_state.by_id.values() {
5874 if let Some(funding_txo) = chan.get_funding_txo() {
5875 res.push(funding_txo.txid);
5881 fn transaction_unconfirmed(&self, txid: &Txid) {
5882 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5883 self.do_chain_event(None, |channel| {
5884 if let Some(funding_txo) = channel.get_funding_txo() {
5885 if funding_txo.txid == *txid {
5886 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
5887 } else { Ok((None, Vec::new(), None)) }
5888 } else { Ok((None, Vec::new(), None)) }
5893 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F, L>
5895 M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
5896 T::Target: BroadcasterInterface,
5897 K::Target: KeysInterface,
5898 F::Target: FeeEstimator,
5901 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
5902 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
5904 fn do_chain_event<FN: Fn(&mut Channel<<K::Target as KeysInterface>::Signer>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
5905 (&self, height_opt: Option<u32>, f: FN) {
5906 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5907 // during initialization prior to the chain_monitor being fully configured in some cases.
5908 // See the docs for `ChannelManagerReadArgs` for more.
5910 let mut failed_channels = Vec::new();
5911 let mut timed_out_htlcs = Vec::new();
5913 let mut channel_lock = self.channel_state.lock().unwrap();
5914 let channel_state = &mut *channel_lock;
5915 let short_to_chan_info = &mut channel_state.short_to_chan_info;
5916 let pending_msg_events = &mut channel_state.pending_msg_events;
5917 channel_state.by_id.retain(|_, channel| {
5918 let res = f(channel);
5919 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
5920 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
5921 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
5922 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::Reason {
5924 }, HTLCDestination::NextHopChannel { node_id: Some(channel.get_counterparty_node_id()), channel_id: channel.channel_id() }));
5926 if let Some(channel_ready) = channel_ready_opt {
5927 send_channel_ready!(short_to_chan_info, pending_msg_events, channel, channel_ready);
5928 if channel.is_usable() {
5929 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", log_bytes!(channel.channel_id()));
5930 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
5931 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
5932 node_id: channel.get_counterparty_node_id(),
5937 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", log_bytes!(channel.channel_id()));
5941 emit_channel_ready_event!(self, channel);
5943 if let Some(announcement_sigs) = announcement_sigs {
5944 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(channel.channel_id()));
5945 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5946 node_id: channel.get_counterparty_node_id(),
5947 msg: announcement_sigs,
5949 if let Some(height) = height_opt {
5950 if let Some(announcement) = channel.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash, height) {
5951 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5953 // Note that announcement_signatures fails if the channel cannot be announced,
5954 // so get_channel_update_for_broadcast will never fail by the time we get here.
5955 update_msg: self.get_channel_update_for_broadcast(channel).unwrap(),
5960 if channel.is_our_channel_ready() {
5961 if let Some(real_scid) = channel.get_short_channel_id() {
5962 // If we sent a 0conf channel_ready, and now have an SCID, we add it
5963 // to the short_to_chan_info map here. Note that we check whether we
5964 // can relay using the real SCID at relay-time (i.e.
5965 // enforce option_scid_alias then), and if the funding tx is ever
5966 // un-confirmed we force-close the channel, ensuring short_to_chan_info
5967 // is always consistent.
5968 let scid_insert = short_to_chan_info.insert(real_scid, (channel.get_counterparty_node_id(), channel.channel_id()));
5969 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.get_counterparty_node_id(), channel.channel_id()),
5970 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
5971 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
5974 } else if let Err(reason) = res {
5975 update_maps_on_chan_removal!(self, short_to_chan_info, channel);
5976 // It looks like our counterparty went on-chain or funding transaction was
5977 // reorged out of the main chain. Close the channel.
5978 failed_channels.push(channel.force_shutdown(true));
5979 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
5980 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5984 let reason_message = format!("{}", reason);
5985 self.issue_channel_close_events(channel, reason);
5986 pending_msg_events.push(events::MessageSendEvent::HandleError {
5987 node_id: channel.get_counterparty_node_id(),
5988 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
5989 channel_id: channel.channel_id(),
5990 data: reason_message,
5998 if let Some(height) = height_opt {
5999 channel_state.claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
6000 htlcs.retain(|htlc| {
6001 // If height is approaching the number of blocks we think it takes us to get
6002 // our commitment transaction confirmed before the HTLC expires, plus the
6003 // number of blocks we generally consider it to take to do a commitment update,
6004 // just give up on it and fail the HTLC.
6005 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
6006 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
6007 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(height));
6009 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(), HTLCFailReason::Reason {
6010 failure_code: 0x4000 | 15,
6011 data: htlc_msat_height_data
6012 }, HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
6016 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
6021 self.handle_init_event_channel_failures(failed_channels);
6023 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
6024 self.fail_htlc_backwards_internal(source, &payment_hash, reason, destination);
6028 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
6029 /// indicating whether persistence is necessary. Only one listener on
6030 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
6033 /// Note that this method is not available with the `no-std` feature.
6034 #[cfg(any(test, feature = "std"))]
6035 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
6036 self.persistence_notifier.wait_timeout(max_wait)
6039 /// Blocks until ChannelManager needs to be persisted. Only one listener on
6040 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
6042 pub fn await_persistable_update(&self) {
6043 self.persistence_notifier.wait()
6046 /// Gets a [`Future`] that completes when a persistable update is available. Note that
6047 /// callbacks registered on the [`Future`] MUST NOT call back into this [`ChannelManager`] and
6048 /// should instead register actions to be taken later.
6049 pub fn get_persistable_update_future(&self) -> Future {
6050 self.persistence_notifier.get_future()
6053 #[cfg(any(test, feature = "_test_utils"))]
6054 pub fn get_persistence_condvar_value(&self) -> bool {
6055 self.persistence_notifier.notify_pending()
6058 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
6059 /// [`chain::Confirm`] interfaces.
6060 pub fn current_best_block(&self) -> BestBlock {
6061 self.best_block.read().unwrap().clone()
6065 impl<M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
6066 ChannelMessageHandler for ChannelManager<M, T, K, F, L>
6067 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
6068 T::Target: BroadcasterInterface,
6069 K::Target: KeysInterface,
6070 F::Target: FeeEstimator,
6073 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
6074 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6075 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
6078 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
6079 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6080 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
6083 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
6084 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6085 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
6088 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
6089 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6090 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
6093 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
6094 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6095 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
6098 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) {
6099 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6100 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, their_features, msg), *counterparty_node_id);
6103 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
6104 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6105 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
6108 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
6109 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6110 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
6113 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
6114 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6115 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
6118 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
6119 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6120 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
6123 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
6124 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6125 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
6128 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
6129 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6130 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
6133 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
6134 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6135 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
6138 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
6139 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6140 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
6143 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
6144 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6145 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
6148 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
6149 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
6150 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
6153 NotifyOption::SkipPersist
6158 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
6159 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6160 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
6163 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
6164 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6165 let mut failed_channels = Vec::new();
6166 let mut no_channels_remain = true;
6168 let mut channel_state_lock = self.channel_state.lock().unwrap();
6169 let channel_state = &mut *channel_state_lock;
6170 let pending_msg_events = &mut channel_state.pending_msg_events;
6171 let short_to_chan_info = &mut channel_state.short_to_chan_info;
6172 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates. We believe we {} make future connections to this peer.",
6173 log_pubkey!(counterparty_node_id), if no_connection_possible { "cannot" } else { "can" });
6174 channel_state.by_id.retain(|_, chan| {
6175 if chan.get_counterparty_node_id() == *counterparty_node_id {
6176 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
6177 if chan.is_shutdown() {
6178 update_maps_on_chan_removal!(self, short_to_chan_info, chan);
6179 self.issue_channel_close_events(chan, ClosureReason::DisconnectedPeer);
6182 no_channels_remain = false;
6187 pending_msg_events.retain(|msg| {
6189 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != counterparty_node_id,
6190 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != counterparty_node_id,
6191 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != counterparty_node_id,
6192 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != counterparty_node_id,
6193 &events::MessageSendEvent::SendChannelReady { ref node_id, .. } => node_id != counterparty_node_id,
6194 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != counterparty_node_id,
6195 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != counterparty_node_id,
6196 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != counterparty_node_id,
6197 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != counterparty_node_id,
6198 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != counterparty_node_id,
6199 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != counterparty_node_id,
6200 &events::MessageSendEvent::SendChannelAnnouncement { ref node_id, .. } => node_id != counterparty_node_id,
6201 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
6202 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
6203 &events::MessageSendEvent::SendChannelUpdate { ref node_id, .. } => node_id != counterparty_node_id,
6204 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != counterparty_node_id,
6205 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
6206 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
6207 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
6208 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
6212 if no_channels_remain {
6213 self.per_peer_state.write().unwrap().remove(counterparty_node_id);
6216 for failure in failed_channels.drain(..) {
6217 self.finish_force_close_channel(failure);
6221 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) -> Result<(), ()> {
6222 if !init_msg.features.supports_static_remote_key() {
6223 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(counterparty_node_id));
6227 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
6229 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6232 let mut peer_state_lock = self.per_peer_state.write().unwrap();
6233 match peer_state_lock.entry(counterparty_node_id.clone()) {
6234 hash_map::Entry::Vacant(e) => {
6235 e.insert(Mutex::new(PeerState {
6236 latest_features: init_msg.features.clone(),
6239 hash_map::Entry::Occupied(e) => {
6240 e.get().lock().unwrap().latest_features = init_msg.features.clone();
6245 let mut channel_state_lock = self.channel_state.lock().unwrap();
6246 let channel_state = &mut *channel_state_lock;
6247 let pending_msg_events = &mut channel_state.pending_msg_events;
6248 channel_state.by_id.retain(|_, chan| {
6249 let retain = if chan.get_counterparty_node_id() == *counterparty_node_id {
6250 if !chan.have_received_message() {
6251 // If we created this (outbound) channel while we were disconnected from the
6252 // peer we probably failed to send the open_channel message, which is now
6253 // lost. We can't have had anything pending related to this channel, so we just
6257 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
6258 node_id: chan.get_counterparty_node_id(),
6259 msg: chan.get_channel_reestablish(&self.logger),
6264 if retain && chan.get_counterparty_node_id() != *counterparty_node_id {
6265 if let Some(msg) = chan.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height()) {
6266 if let Ok(update_msg) = self.get_channel_update_for_broadcast(chan) {
6267 pending_msg_events.push(events::MessageSendEvent::SendChannelAnnouncement {
6268 node_id: *counterparty_node_id,
6276 //TODO: Also re-broadcast announcement_signatures
6280 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
6281 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6283 if msg.channel_id == [0; 32] {
6284 for chan in self.list_channels() {
6285 if chan.counterparty.node_id == *counterparty_node_id {
6286 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6287 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data), true);
6292 // First check if we can advance the channel type and try again.
6293 let mut channel_state = self.channel_state.lock().unwrap();
6294 if let Some(chan) = channel_state.by_id.get_mut(&msg.channel_id) {
6295 if chan.get_counterparty_node_id() != *counterparty_node_id {
6298 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash) {
6299 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
6300 node_id: *counterparty_node_id,
6308 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6309 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
6313 fn provided_node_features(&self) -> NodeFeatures {
6314 provided_node_features()
6317 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
6318 provided_init_features()
6322 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
6323 /// [`ChannelManager`].
6324 pub fn provided_node_features() -> NodeFeatures {
6325 provided_init_features().to_context()
6328 /// Fetches the set of [`InvoiceFeatures`] flags which are provided by or required by
6329 /// [`ChannelManager`].
6331 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
6332 /// or not. Thus, this method is not public.
6333 #[cfg(any(feature = "_test_utils", test))]
6334 pub fn provided_invoice_features() -> InvoiceFeatures {
6335 provided_init_features().to_context()
6338 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
6339 /// [`ChannelManager`].
6340 pub fn provided_channel_features() -> ChannelFeatures {
6341 provided_init_features().to_context()
6344 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
6345 /// [`ChannelManager`].
6346 pub fn provided_init_features() -> InitFeatures {
6347 // Note that if new features are added here which other peers may (eventually) require, we
6348 // should also add the corresponding (optional) bit to the ChannelMessageHandler impl for
6349 // ErroringMessageHandler.
6350 let mut features = InitFeatures::empty();
6351 features.set_data_loss_protect_optional();
6352 features.set_upfront_shutdown_script_optional();
6353 features.set_variable_length_onion_required();
6354 features.set_static_remote_key_required();
6355 features.set_payment_secret_required();
6356 features.set_basic_mpp_optional();
6357 features.set_wumbo_optional();
6358 features.set_shutdown_any_segwit_optional();
6359 features.set_channel_type_optional();
6360 features.set_scid_privacy_optional();
6361 features.set_zero_conf_optional();
6365 const SERIALIZATION_VERSION: u8 = 1;
6366 const MIN_SERIALIZATION_VERSION: u8 = 1;
6368 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
6369 (2, fee_base_msat, required),
6370 (4, fee_proportional_millionths, required),
6371 (6, cltv_expiry_delta, required),
6374 impl_writeable_tlv_based!(ChannelCounterparty, {
6375 (2, node_id, required),
6376 (4, features, required),
6377 (6, unspendable_punishment_reserve, required),
6378 (8, forwarding_info, option),
6379 (9, outbound_htlc_minimum_msat, option),
6380 (11, outbound_htlc_maximum_msat, option),
6383 impl_writeable_tlv_based!(ChannelDetails, {
6384 (1, inbound_scid_alias, option),
6385 (2, channel_id, required),
6386 (3, channel_type, option),
6387 (4, counterparty, required),
6388 (5, outbound_scid_alias, option),
6389 (6, funding_txo, option),
6390 (7, config, option),
6391 (8, short_channel_id, option),
6392 (10, channel_value_satoshis, required),
6393 (12, unspendable_punishment_reserve, option),
6394 (14, user_channel_id, required),
6395 (16, balance_msat, required),
6396 (18, outbound_capacity_msat, required),
6397 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6398 // filled in, so we can safely unwrap it here.
6399 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6400 (20, inbound_capacity_msat, required),
6401 (22, confirmations_required, option),
6402 (24, force_close_spend_delay, option),
6403 (26, is_outbound, required),
6404 (28, is_channel_ready, required),
6405 (30, is_usable, required),
6406 (32, is_public, required),
6407 (33, inbound_htlc_minimum_msat, option),
6408 (35, inbound_htlc_maximum_msat, option),
6411 impl_writeable_tlv_based!(PhantomRouteHints, {
6412 (2, channels, vec_type),
6413 (4, phantom_scid, required),
6414 (6, real_node_pubkey, required),
6417 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
6419 (0, onion_packet, required),
6420 (2, short_channel_id, required),
6423 (0, payment_data, required),
6424 (1, phantom_shared_secret, option),
6425 (2, incoming_cltv_expiry, required),
6427 (2, ReceiveKeysend) => {
6428 (0, payment_preimage, required),
6429 (2, incoming_cltv_expiry, required),
6433 impl_writeable_tlv_based!(PendingHTLCInfo, {
6434 (0, routing, required),
6435 (2, incoming_shared_secret, required),
6436 (4, payment_hash, required),
6437 (6, amt_to_forward, required),
6438 (8, outgoing_cltv_value, required)
6442 impl Writeable for HTLCFailureMsg {
6443 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6445 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
6447 channel_id.write(writer)?;
6448 htlc_id.write(writer)?;
6449 reason.write(writer)?;
6451 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6452 channel_id, htlc_id, sha256_of_onion, failure_code
6455 channel_id.write(writer)?;
6456 htlc_id.write(writer)?;
6457 sha256_of_onion.write(writer)?;
6458 failure_code.write(writer)?;
6465 impl Readable for HTLCFailureMsg {
6466 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6467 let id: u8 = Readable::read(reader)?;
6470 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
6471 channel_id: Readable::read(reader)?,
6472 htlc_id: Readable::read(reader)?,
6473 reason: Readable::read(reader)?,
6477 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6478 channel_id: Readable::read(reader)?,
6479 htlc_id: Readable::read(reader)?,
6480 sha256_of_onion: Readable::read(reader)?,
6481 failure_code: Readable::read(reader)?,
6484 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
6485 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
6486 // messages contained in the variants.
6487 // In version 0.0.101, support for reading the variants with these types was added, and
6488 // we should migrate to writing these variants when UpdateFailHTLC or
6489 // UpdateFailMalformedHTLC get TLV fields.
6491 let length: BigSize = Readable::read(reader)?;
6492 let mut s = FixedLengthReader::new(reader, length.0);
6493 let res = Readable::read(&mut s)?;
6494 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6495 Ok(HTLCFailureMsg::Relay(res))
6498 let length: BigSize = Readable::read(reader)?;
6499 let mut s = FixedLengthReader::new(reader, length.0);
6500 let res = Readable::read(&mut s)?;
6501 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6502 Ok(HTLCFailureMsg::Malformed(res))
6504 _ => Err(DecodeError::UnknownRequiredFeature),
6509 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
6514 impl_writeable_tlv_based!(HTLCPreviousHopData, {
6515 (0, short_channel_id, required),
6516 (1, phantom_shared_secret, option),
6517 (2, outpoint, required),
6518 (4, htlc_id, required),
6519 (6, incoming_packet_shared_secret, required)
6522 impl Writeable for ClaimableHTLC {
6523 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6524 let (payment_data, keysend_preimage) = match &self.onion_payload {
6525 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
6526 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
6528 write_tlv_fields!(writer, {
6529 (0, self.prev_hop, required),
6530 (1, self.total_msat, required),
6531 (2, self.value, required),
6532 (4, payment_data, option),
6533 (6, self.cltv_expiry, required),
6534 (8, keysend_preimage, option),
6540 impl Readable for ClaimableHTLC {
6541 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6542 let mut prev_hop = crate::util::ser::OptionDeserWrapper(None);
6544 let mut payment_data: Option<msgs::FinalOnionHopData> = None;
6545 let mut cltv_expiry = 0;
6546 let mut total_msat = None;
6547 let mut keysend_preimage: Option<PaymentPreimage> = None;
6548 read_tlv_fields!(reader, {
6549 (0, prev_hop, required),
6550 (1, total_msat, option),
6551 (2, value, required),
6552 (4, payment_data, option),
6553 (6, cltv_expiry, required),
6554 (8, keysend_preimage, option)
6556 let onion_payload = match keysend_preimage {
6558 if payment_data.is_some() {
6559 return Err(DecodeError::InvalidValue)
6561 if total_msat.is_none() {
6562 total_msat = Some(value);
6564 OnionPayload::Spontaneous(p)
6567 if total_msat.is_none() {
6568 if payment_data.is_none() {
6569 return Err(DecodeError::InvalidValue)
6571 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
6573 OnionPayload::Invoice { _legacy_hop_data: payment_data }
6577 prev_hop: prev_hop.0.unwrap(),
6580 total_msat: total_msat.unwrap(),
6587 impl Readable for HTLCSource {
6588 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6589 let id: u8 = Readable::read(reader)?;
6592 let mut session_priv: crate::util::ser::OptionDeserWrapper<SecretKey> = crate::util::ser::OptionDeserWrapper(None);
6593 let mut first_hop_htlc_msat: u64 = 0;
6594 let mut path = Some(Vec::new());
6595 let mut payment_id = None;
6596 let mut payment_secret = None;
6597 let mut payment_params = None;
6598 read_tlv_fields!(reader, {
6599 (0, session_priv, required),
6600 (1, payment_id, option),
6601 (2, first_hop_htlc_msat, required),
6602 (3, payment_secret, option),
6603 (4, path, vec_type),
6604 (5, payment_params, option),
6606 if payment_id.is_none() {
6607 // For backwards compat, if there was no payment_id written, use the session_priv bytes
6609 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
6611 Ok(HTLCSource::OutboundRoute {
6612 session_priv: session_priv.0.unwrap(),
6613 first_hop_htlc_msat,
6614 path: path.unwrap(),
6615 payment_id: payment_id.unwrap(),
6620 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
6621 _ => Err(DecodeError::UnknownRequiredFeature),
6626 impl Writeable for HTLCSource {
6627 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
6629 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id, payment_secret, payment_params } => {
6631 let payment_id_opt = Some(payment_id);
6632 write_tlv_fields!(writer, {
6633 (0, session_priv, required),
6634 (1, payment_id_opt, option),
6635 (2, first_hop_htlc_msat, required),
6636 (3, payment_secret, option),
6637 (4, path, vec_type),
6638 (5, payment_params, option),
6641 HTLCSource::PreviousHopData(ref field) => {
6643 field.write(writer)?;
6650 impl_writeable_tlv_based_enum!(HTLCFailReason,
6651 (0, LightningError) => {
6655 (0, failure_code, required),
6656 (2, data, vec_type),
6660 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
6662 (0, forward_info, required),
6663 (2, prev_short_channel_id, required),
6664 (4, prev_htlc_id, required),
6665 (6, prev_funding_outpoint, required),
6668 (0, htlc_id, required),
6669 (2, err_packet, required),
6673 impl_writeable_tlv_based!(PendingInboundPayment, {
6674 (0, payment_secret, required),
6675 (2, expiry_time, required),
6676 (4, user_payment_id, required),
6677 (6, payment_preimage, required),
6678 (8, min_value_msat, required),
6681 impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
6683 (0, session_privs, required),
6686 (0, session_privs, required),
6687 (1, payment_hash, option),
6688 (3, timer_ticks_without_htlcs, (default_value, 0)),
6691 (0, session_privs, required),
6692 (1, pending_fee_msat, option),
6693 (2, payment_hash, required),
6694 (4, payment_secret, option),
6695 (6, total_msat, required),
6696 (8, pending_amt_msat, required),
6697 (10, starting_block_height, required),
6700 (0, session_privs, required),
6701 (2, payment_hash, required),
6705 impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Writeable for ChannelManager<M, T, K, F, L>
6706 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
6707 T::Target: BroadcasterInterface,
6708 K::Target: KeysInterface,
6709 F::Target: FeeEstimator,
6712 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6713 let _consistency_lock = self.total_consistency_lock.write().unwrap();
6715 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
6717 self.genesis_hash.write(writer)?;
6719 let best_block = self.best_block.read().unwrap();
6720 best_block.height().write(writer)?;
6721 best_block.block_hash().write(writer)?;
6725 // Take `channel_state` lock temporarily to avoid creating a lock order that requires
6726 // that the `forward_htlcs` lock is taken after `channel_state`
6727 let channel_state = self.channel_state.lock().unwrap();
6728 let mut unfunded_channels = 0;
6729 for (_, channel) in channel_state.by_id.iter() {
6730 if !channel.is_funding_initiated() {
6731 unfunded_channels += 1;
6734 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
6735 for (_, channel) in channel_state.by_id.iter() {
6736 if channel.is_funding_initiated() {
6737 channel.write(writer)?;
6743 let forward_htlcs = self.forward_htlcs.lock().unwrap();
6744 (forward_htlcs.len() as u64).write(writer)?;
6745 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
6746 short_channel_id.write(writer)?;
6747 (pending_forwards.len() as u64).write(writer)?;
6748 for forward in pending_forwards {
6749 forward.write(writer)?;
6754 let channel_state = self.channel_state.lock().unwrap();
6755 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
6756 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
6757 for (payment_hash, (purpose, previous_hops)) in channel_state.claimable_htlcs.iter() {
6758 payment_hash.write(writer)?;
6759 (previous_hops.len() as u64).write(writer)?;
6760 for htlc in previous_hops.iter() {
6761 htlc.write(writer)?;
6763 htlc_purposes.push(purpose);
6766 let per_peer_state = self.per_peer_state.write().unwrap();
6767 (per_peer_state.len() as u64).write(writer)?;
6768 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
6769 peer_pubkey.write(writer)?;
6770 let peer_state = peer_state_mutex.lock().unwrap();
6771 peer_state.latest_features.write(writer)?;
6774 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
6775 let pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
6776 let events = self.pending_events.lock().unwrap();
6777 (events.len() as u64).write(writer)?;
6778 for event in events.iter() {
6779 event.write(writer)?;
6782 let background_events = self.pending_background_events.lock().unwrap();
6783 (background_events.len() as u64).write(writer)?;
6784 for event in background_events.iter() {
6786 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
6788 funding_txo.write(writer)?;
6789 monitor_update.write(writer)?;
6794 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
6795 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
6796 // likely to be identical.
6797 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
6798 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
6800 (pending_inbound_payments.len() as u64).write(writer)?;
6801 for (hash, pending_payment) in pending_inbound_payments.iter() {
6802 hash.write(writer)?;
6803 pending_payment.write(writer)?;
6806 // For backwards compat, write the session privs and their total length.
6807 let mut num_pending_outbounds_compat: u64 = 0;
6808 for (_, outbound) in pending_outbound_payments.iter() {
6809 if !outbound.is_fulfilled() && !outbound.abandoned() {
6810 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
6813 num_pending_outbounds_compat.write(writer)?;
6814 for (_, outbound) in pending_outbound_payments.iter() {
6816 PendingOutboundPayment::Legacy { session_privs } |
6817 PendingOutboundPayment::Retryable { session_privs, .. } => {
6818 for session_priv in session_privs.iter() {
6819 session_priv.write(writer)?;
6822 PendingOutboundPayment::Fulfilled { .. } => {},
6823 PendingOutboundPayment::Abandoned { .. } => {},
6827 // Encode without retry info for 0.0.101 compatibility.
6828 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
6829 for (id, outbound) in pending_outbound_payments.iter() {
6831 PendingOutboundPayment::Legacy { session_privs } |
6832 PendingOutboundPayment::Retryable { session_privs, .. } => {
6833 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
6838 write_tlv_fields!(writer, {
6839 (1, pending_outbound_payments_no_retry, required),
6840 (3, pending_outbound_payments, required),
6841 (5, self.our_network_pubkey, required),
6842 (7, self.fake_scid_rand_bytes, required),
6843 (9, htlc_purposes, vec_type),
6844 (11, self.probing_cookie_secret, required),
6851 /// Arguments for the creation of a ChannelManager that are not deserialized.
6853 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
6855 /// 1) Deserialize all stored [`ChannelMonitor`]s.
6856 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
6857 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
6858 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
6859 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
6860 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
6861 /// same way you would handle a [`chain::Filter`] call using
6862 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
6863 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
6864 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
6865 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
6866 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
6867 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
6869 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
6870 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
6872 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
6873 /// call any other methods on the newly-deserialized [`ChannelManager`].
6875 /// Note that because some channels may be closed during deserialization, it is critical that you
6876 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
6877 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
6878 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
6879 /// not force-close the same channels but consider them live), you may end up revoking a state for
6880 /// which you've already broadcasted the transaction.
6882 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
6883 pub struct ChannelManagerReadArgs<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6884 where M::Target: chain::Watch<Signer>,
6885 T::Target: BroadcasterInterface,
6886 K::Target: KeysInterface<Signer = Signer>,
6887 F::Target: FeeEstimator,
6890 /// The keys provider which will give us relevant keys. Some keys will be loaded during
6891 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
6893 pub keys_manager: K,
6895 /// The fee_estimator for use in the ChannelManager in the future.
6897 /// No calls to the FeeEstimator will be made during deserialization.
6898 pub fee_estimator: F,
6899 /// The chain::Watch for use in the ChannelManager in the future.
6901 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
6902 /// you have deserialized ChannelMonitors separately and will add them to your
6903 /// chain::Watch after deserializing this ChannelManager.
6904 pub chain_monitor: M,
6906 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
6907 /// used to broadcast the latest local commitment transactions of channels which must be
6908 /// force-closed during deserialization.
6909 pub tx_broadcaster: T,
6910 /// The Logger for use in the ChannelManager and which may be used to log information during
6911 /// deserialization.
6913 /// Default settings used for new channels. Any existing channels will continue to use the
6914 /// runtime settings which were stored when the ChannelManager was serialized.
6915 pub default_config: UserConfig,
6917 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
6918 /// value.get_funding_txo() should be the key).
6920 /// If a monitor is inconsistent with the channel state during deserialization the channel will
6921 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
6922 /// is true for missing channels as well. If there is a monitor missing for which we find
6923 /// channel data Err(DecodeError::InvalidValue) will be returned.
6925 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
6928 /// (C-not exported) because we have no HashMap bindings
6929 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<Signer>>,
6932 impl<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6933 ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>
6934 where M::Target: chain::Watch<Signer>,
6935 T::Target: BroadcasterInterface,
6936 K::Target: KeysInterface<Signer = Signer>,
6937 F::Target: FeeEstimator,
6940 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
6941 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
6942 /// populate a HashMap directly from C.
6943 pub fn new(keys_manager: K, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, logger: L, default_config: UserConfig,
6944 mut channel_monitors: Vec<&'a mut ChannelMonitor<Signer>>) -> Self {
6946 keys_manager, fee_estimator, chain_monitor, tx_broadcaster, logger, default_config,
6947 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
6952 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
6953 // SipmleArcChannelManager type:
6954 impl<'a, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6955 ReadableArgs<ChannelManagerReadArgs<'a, <K::Target as KeysInterface>::Signer, M, T, K, F, L>> for (BlockHash, Arc<ChannelManager<M, T, K, F, L>>)
6956 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
6957 T::Target: BroadcasterInterface,
6958 K::Target: KeysInterface,
6959 F::Target: FeeEstimator,
6962 fn read<R: io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, <K::Target as KeysInterface>::Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
6963 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, K, F, L>)>::read(reader, args)?;
6964 Ok((blockhash, Arc::new(chan_manager)))
6968 impl<'a, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6969 ReadableArgs<ChannelManagerReadArgs<'a, <K::Target as KeysInterface>::Signer, M, T, K, F, L>> for (BlockHash, ChannelManager<M, T, K, F, L>)
6970 where M::Target: chain::Watch<<K::Target as KeysInterface>::Signer>,
6971 T::Target: BroadcasterInterface,
6972 K::Target: KeysInterface,
6973 F::Target: FeeEstimator,
6976 fn read<R: io::Read>(reader: &mut R, mut args: ChannelManagerReadArgs<'a, <K::Target as KeysInterface>::Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
6977 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
6979 let genesis_hash: BlockHash = Readable::read(reader)?;
6980 let best_block_height: u32 = Readable::read(reader)?;
6981 let best_block_hash: BlockHash = Readable::read(reader)?;
6983 let mut failed_htlcs = Vec::new();
6985 let channel_count: u64 = Readable::read(reader)?;
6986 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
6987 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
6988 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
6989 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
6990 let mut channel_closures = Vec::new();
6991 for _ in 0..channel_count {
6992 let mut channel: Channel<<K::Target as KeysInterface>::Signer> = Channel::read(reader, (&args.keys_manager, best_block_height))?;
6993 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
6994 funding_txo_set.insert(funding_txo.clone());
6995 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
6996 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
6997 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
6998 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
6999 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
7000 // If the channel is ahead of the monitor, return InvalidValue:
7001 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
7002 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
7003 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
7004 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
7005 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
7006 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
7007 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");
7008 return Err(DecodeError::InvalidValue);
7009 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
7010 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
7011 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
7012 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
7013 // But if the channel is behind of the monitor, close the channel:
7014 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
7015 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
7016 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
7017 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
7018 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
7019 failed_htlcs.append(&mut new_failed_htlcs);
7020 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
7021 channel_closures.push(events::Event::ChannelClosed {
7022 channel_id: channel.channel_id(),
7023 user_channel_id: channel.get_user_id(),
7024 reason: ClosureReason::OutdatedChannelManager
7027 log_info!(args.logger, "Successfully loaded channel {}", log_bytes!(channel.channel_id()));
7028 if let Some(short_channel_id) = channel.get_short_channel_id() {
7029 short_to_chan_info.insert(short_channel_id, (channel.get_counterparty_node_id(), channel.channel_id()));
7031 if channel.is_funding_initiated() {
7032 id_to_peer.insert(channel.channel_id(), channel.get_counterparty_node_id());
7034 by_id.insert(channel.channel_id(), channel);
7036 } else if channel.is_awaiting_initial_mon_persist() {
7037 // If we were persisted and shut down while the initial ChannelMonitor persistence
7038 // was in-progress, we never broadcasted the funding transaction and can still
7039 // safely discard the channel.
7040 let _ = channel.force_shutdown(false);
7041 channel_closures.push(events::Event::ChannelClosed {
7042 channel_id: channel.channel_id(),
7043 user_channel_id: channel.get_user_id(),
7044 reason: ClosureReason::DisconnectedPeer,
7047 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.channel_id()));
7048 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
7049 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
7050 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
7051 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");
7052 return Err(DecodeError::InvalidValue);
7056 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
7057 if !funding_txo_set.contains(funding_txo) {
7058 log_info!(args.logger, "Broadcasting latest holder commitment transaction for closed channel {}", log_bytes!(funding_txo.to_channel_id()));
7059 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
7063 const MAX_ALLOC_SIZE: usize = 1024 * 64;
7064 let forward_htlcs_count: u64 = Readable::read(reader)?;
7065 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
7066 for _ in 0..forward_htlcs_count {
7067 let short_channel_id = Readable::read(reader)?;
7068 let pending_forwards_count: u64 = Readable::read(reader)?;
7069 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
7070 for _ in 0..pending_forwards_count {
7071 pending_forwards.push(Readable::read(reader)?);
7073 forward_htlcs.insert(short_channel_id, pending_forwards);
7076 let claimable_htlcs_count: u64 = Readable::read(reader)?;
7077 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
7078 for _ in 0..claimable_htlcs_count {
7079 let payment_hash = Readable::read(reader)?;
7080 let previous_hops_len: u64 = Readable::read(reader)?;
7081 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
7082 for _ in 0..previous_hops_len {
7083 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
7085 claimable_htlcs_list.push((payment_hash, previous_hops));
7088 let peer_count: u64 = Readable::read(reader)?;
7089 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState>)>()));
7090 for _ in 0..peer_count {
7091 let peer_pubkey = Readable::read(reader)?;
7092 let peer_state = PeerState {
7093 latest_features: Readable::read(reader)?,
7095 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
7098 let event_count: u64 = Readable::read(reader)?;
7099 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>()));
7100 for _ in 0..event_count {
7101 match MaybeReadable::read(reader)? {
7102 Some(event) => pending_events_read.push(event),
7106 if forward_htlcs_count > 0 {
7107 // If we have pending HTLCs to forward, assume we either dropped a
7108 // `PendingHTLCsForwardable` or the user received it but never processed it as they
7109 // shut down before the timer hit. Either way, set the time_forwardable to a small
7110 // constant as enough time has likely passed that we should simply handle the forwards
7111 // now, or at least after the user gets a chance to reconnect to our peers.
7112 pending_events_read.push(events::Event::PendingHTLCsForwardable {
7113 time_forwardable: Duration::from_secs(2),
7117 let background_event_count: u64 = Readable::read(reader)?;
7118 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>()));
7119 for _ in 0..background_event_count {
7120 match <u8 as Readable>::read(reader)? {
7121 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
7122 _ => return Err(DecodeError::InvalidValue),
7126 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
7127 let highest_seen_timestamp: u32 = Readable::read(reader)?;
7129 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
7130 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
7131 for _ in 0..pending_inbound_payment_count {
7132 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
7133 return Err(DecodeError::InvalidValue);
7137 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
7138 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
7139 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
7140 for _ in 0..pending_outbound_payments_count_compat {
7141 let session_priv = Readable::read(reader)?;
7142 let payment = PendingOutboundPayment::Legacy {
7143 session_privs: [session_priv].iter().cloned().collect()
7145 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
7146 return Err(DecodeError::InvalidValue)
7150 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
7151 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
7152 let mut pending_outbound_payments = None;
7153 let mut received_network_pubkey: Option<PublicKey> = None;
7154 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
7155 let mut probing_cookie_secret: Option<[u8; 32]> = None;
7156 let mut claimable_htlc_purposes = None;
7157 read_tlv_fields!(reader, {
7158 (1, pending_outbound_payments_no_retry, option),
7159 (3, pending_outbound_payments, option),
7160 (5, received_network_pubkey, option),
7161 (7, fake_scid_rand_bytes, option),
7162 (9, claimable_htlc_purposes, vec_type),
7163 (11, probing_cookie_secret, option),
7165 if fake_scid_rand_bytes.is_none() {
7166 fake_scid_rand_bytes = Some(args.keys_manager.get_secure_random_bytes());
7169 if probing_cookie_secret.is_none() {
7170 probing_cookie_secret = Some(args.keys_manager.get_secure_random_bytes());
7173 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
7174 pending_outbound_payments = Some(pending_outbound_payments_compat);
7175 } else if pending_outbound_payments.is_none() {
7176 let mut outbounds = HashMap::new();
7177 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
7178 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
7180 pending_outbound_payments = Some(outbounds);
7182 // If we're tracking pending payments, ensure we haven't lost any by looking at the
7183 // ChannelMonitor data for any channels for which we do not have authorative state
7184 // (i.e. those for which we just force-closed above or we otherwise don't have a
7185 // corresponding `Channel` at all).
7186 // This avoids several edge-cases where we would otherwise "forget" about pending
7187 // payments which are still in-flight via their on-chain state.
7188 // We only rebuild the pending payments map if we were most recently serialized by
7190 for (_, monitor) in args.channel_monitors.iter() {
7191 if by_id.get(&monitor.get_funding_txo().0.to_channel_id()).is_none() {
7192 for (htlc_source, htlc) in monitor.get_pending_outbound_htlcs() {
7193 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, payment_secret, .. } = htlc_source {
7194 if path.is_empty() {
7195 log_error!(args.logger, "Got an empty path for a pending payment");
7196 return Err(DecodeError::InvalidValue);
7198 let path_amt = path.last().unwrap().fee_msat;
7199 let mut session_priv_bytes = [0; 32];
7200 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
7201 match pending_outbound_payments.as_mut().unwrap().entry(payment_id) {
7202 hash_map::Entry::Occupied(mut entry) => {
7203 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
7204 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
7205 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), log_bytes!(htlc.payment_hash.0));
7207 hash_map::Entry::Vacant(entry) => {
7208 let path_fee = path.get_path_fees();
7209 entry.insert(PendingOutboundPayment::Retryable {
7210 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
7211 payment_hash: htlc.payment_hash,
7213 pending_amt_msat: path_amt,
7214 pending_fee_msat: Some(path_fee),
7215 total_msat: path_amt,
7216 starting_block_height: best_block_height,
7218 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
7219 path_amt, log_bytes!(htlc.payment_hash.0), log_bytes!(session_priv_bytes));
7228 let inbound_pmt_key_material = args.keys_manager.get_inbound_payment_key_material();
7229 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
7231 let mut claimable_htlcs = HashMap::with_capacity(claimable_htlcs_list.len());
7232 if let Some(mut purposes) = claimable_htlc_purposes {
7233 if purposes.len() != claimable_htlcs_list.len() {
7234 return Err(DecodeError::InvalidValue);
7236 for (purpose, (payment_hash, previous_hops)) in purposes.drain(..).zip(claimable_htlcs_list.drain(..)) {
7237 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7240 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
7241 // include a `_legacy_hop_data` in the `OnionPayload`.
7242 for (payment_hash, previous_hops) in claimable_htlcs_list.drain(..) {
7243 if previous_hops.is_empty() {
7244 return Err(DecodeError::InvalidValue);
7246 let purpose = match &previous_hops[0].onion_payload {
7247 OnionPayload::Invoice { _legacy_hop_data } => {
7248 if let Some(hop_data) = _legacy_hop_data {
7249 events::PaymentPurpose::InvoicePayment {
7250 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
7251 Some(inbound_payment) => inbound_payment.payment_preimage,
7252 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
7253 Ok(payment_preimage) => payment_preimage,
7255 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));
7256 return Err(DecodeError::InvalidValue);
7260 payment_secret: hop_data.payment_secret,
7262 } else { return Err(DecodeError::InvalidValue); }
7264 OnionPayload::Spontaneous(payment_preimage) =>
7265 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
7267 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7271 let mut secp_ctx = Secp256k1::new();
7272 secp_ctx.seeded_randomize(&args.keys_manager.get_secure_random_bytes());
7274 if !channel_closures.is_empty() {
7275 pending_events_read.append(&mut channel_closures);
7278 let our_network_key = match args.keys_manager.get_node_secret(Recipient::Node) {
7280 Err(()) => return Err(DecodeError::InvalidValue)
7282 let our_network_pubkey = PublicKey::from_secret_key(&secp_ctx, &our_network_key);
7283 if let Some(network_pubkey) = received_network_pubkey {
7284 if network_pubkey != our_network_pubkey {
7285 log_error!(args.logger, "Key that was generated does not match the existing key.");
7286 return Err(DecodeError::InvalidValue);
7290 let mut outbound_scid_aliases = HashSet::new();
7291 for (chan_id, chan) in by_id.iter_mut() {
7292 if chan.outbound_scid_alias() == 0 {
7293 let mut outbound_scid_alias;
7295 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
7296 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.keys_manager);
7297 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
7299 chan.set_outbound_scid_alias(outbound_scid_alias);
7300 } else if !outbound_scid_aliases.insert(chan.outbound_scid_alias()) {
7301 // Note that in rare cases its possible to hit this while reading an older
7302 // channel if we just happened to pick a colliding outbound alias above.
7303 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7304 return Err(DecodeError::InvalidValue);
7306 if chan.is_usable() {
7307 if short_to_chan_info.insert(chan.outbound_scid_alias(), (chan.get_counterparty_node_id(), *chan_id)).is_some() {
7308 // Note that in rare cases its possible to hit this while reading an older
7309 // channel if we just happened to pick a colliding outbound alias above.
7310 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7311 return Err(DecodeError::InvalidValue);
7316 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
7318 for (_, monitor) in args.channel_monitors.iter() {
7319 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
7320 if let Some((payment_purpose, claimable_htlcs)) = claimable_htlcs.remove(&payment_hash) {
7321 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", log_bytes!(payment_hash.0));
7322 let mut claimable_amt_msat = 0;
7323 for claimable_htlc in claimable_htlcs {
7324 claimable_amt_msat += claimable_htlc.value;
7326 // Add a holding-cell claim of the payment to the Channel, which should be
7327 // applied ~immediately on peer reconnection. Because it won't generate a
7328 // new commitment transaction we can just provide the payment preimage to
7329 // the corresponding ChannelMonitor and nothing else.
7331 // We do so directly instead of via the normal ChannelMonitor update
7332 // procedure as the ChainMonitor hasn't yet been initialized, implying
7333 // we're not allowed to call it directly yet. Further, we do the update
7334 // without incrementing the ChannelMonitor update ID as there isn't any
7336 // If we were to generate a new ChannelMonitor update ID here and then
7337 // crash before the user finishes block connect we'd end up force-closing
7338 // this channel as well. On the flip side, there's no harm in restarting
7339 // without the new monitor persisted - we'll end up right back here on
7341 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
7342 if let Some(channel) = by_id.get_mut(&previous_channel_id) {
7343 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
7345 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
7346 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
7349 pending_events_read.push(events::Event::PaymentClaimed {
7351 purpose: payment_purpose,
7352 amount_msat: claimable_amt_msat,
7358 let channel_manager = ChannelManager {
7360 fee_estimator: bounded_fee_estimator,
7361 chain_monitor: args.chain_monitor,
7362 tx_broadcaster: args.tx_broadcaster,
7364 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
7366 channel_state: Mutex::new(ChannelHolder {
7370 pending_msg_events: Vec::new(),
7372 inbound_payment_key: expanded_inbound_key,
7373 pending_inbound_payments: Mutex::new(pending_inbound_payments),
7374 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
7376 forward_htlcs: Mutex::new(forward_htlcs),
7377 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
7378 id_to_peer: Mutex::new(id_to_peer),
7379 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
7381 probing_cookie_secret: probing_cookie_secret.unwrap(),
7387 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
7389 per_peer_state: RwLock::new(per_peer_state),
7391 pending_events: Mutex::new(pending_events_read),
7392 pending_background_events: Mutex::new(pending_background_events_read),
7393 total_consistency_lock: RwLock::new(()),
7394 persistence_notifier: Notifier::new(),
7396 keys_manager: args.keys_manager,
7397 logger: args.logger,
7398 default_configuration: args.default_config,
7401 for htlc_source in failed_htlcs.drain(..) {
7402 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
7403 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
7404 channel_manager.fail_htlc_backwards_internal(source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
7407 //TODO: Broadcast channel update for closed channels, but only after we've made a
7408 //connection or two.
7410 Ok((best_block_hash.clone(), channel_manager))
7416 use bitcoin::hashes::Hash;
7417 use bitcoin::hashes::sha256::Hash as Sha256;
7418 use core::time::Duration;
7419 use core::sync::atomic::Ordering;
7420 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
7421 use crate::ln::channelmanager::{self, inbound_payment, PaymentId, PaymentSendFailure};
7422 use crate::ln::functional_test_utils::*;
7423 use crate::ln::msgs;
7424 use crate::ln::msgs::ChannelMessageHandler;
7425 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
7426 use crate::util::errors::APIError;
7427 use crate::util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
7428 use crate::util::test_utils;
7429 use crate::chain::keysinterface::KeysInterface;
7432 fn test_notify_limits() {
7433 // Check that a few cases which don't require the persistence of a new ChannelManager,
7434 // indeed, do not cause the persistence of a new ChannelManager.
7435 let chanmon_cfgs = create_chanmon_cfgs(3);
7436 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7437 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7438 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7440 // All nodes start with a persistable update pending as `create_network` connects each node
7441 // with all other nodes to make most tests simpler.
7442 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7443 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7444 assert!(nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7446 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7448 // We check that the channel info nodes have doesn't change too early, even though we try
7449 // to connect messages with new values
7450 chan.0.contents.fee_base_msat *= 2;
7451 chan.1.contents.fee_base_msat *= 2;
7452 let node_a_chan_info = nodes[0].node.list_channels()[0].clone();
7453 let node_b_chan_info = nodes[1].node.list_channels()[0].clone();
7455 // The first two nodes (which opened a channel) should now require fresh persistence
7456 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7457 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7458 // ... but the last node should not.
7459 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7460 // After persisting the first two nodes they should no longer need fresh persistence.
7461 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7462 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7464 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
7465 // about the channel.
7466 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
7467 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
7468 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7470 // The nodes which are a party to the channel should also ignore messages from unrelated
7472 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7473 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7474 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7475 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7476 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7477 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7479 // At this point the channel info given by peers should still be the same.
7480 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7481 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7483 // An earlier version of handle_channel_update didn't check the directionality of the
7484 // update message and would always update the local fee info, even if our peer was
7485 // (spuriously) forwarding us our own channel_update.
7486 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
7487 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
7488 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
7490 // First deliver each peers' own message, checking that the node doesn't need to be
7491 // persisted and that its channel info remains the same.
7492 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
7493 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
7494 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7495 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7496 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7497 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7499 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
7500 // the channel info has updated.
7501 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
7502 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
7503 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7504 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7505 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
7506 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
7510 fn test_keysend_dup_hash_partial_mpp() {
7511 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
7513 let chanmon_cfgs = create_chanmon_cfgs(2);
7514 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7515 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7516 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7517 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7519 // First, send a partial MPP payment.
7520 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
7521 let mut mpp_route = route.clone();
7522 mpp_route.paths.push(mpp_route.paths[0].clone());
7524 let payment_id = PaymentId([42; 32]);
7525 // Use the utility function send_payment_along_path to send the payment with MPP data which
7526 // indicates there are more HTLCs coming.
7527 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.
7528 let session_privs = nodes[0].node.add_new_pending_payment(our_payment_hash, Some(payment_secret), payment_id, &mpp_route).unwrap();
7529 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();
7530 check_added_monitors!(nodes[0], 1);
7531 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7532 assert_eq!(events.len(), 1);
7533 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
7535 // Next, send a keysend payment with the same payment_hash and make sure it fails.
7536 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7537 check_added_monitors!(nodes[0], 1);
7538 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7539 assert_eq!(events.len(), 1);
7540 let ev = events.drain(..).next().unwrap();
7541 let payment_event = SendEvent::from_event(ev);
7542 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7543 check_added_monitors!(nodes[1], 0);
7544 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7545 expect_pending_htlcs_forwardable!(nodes[1]);
7546 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
7547 check_added_monitors!(nodes[1], 1);
7548 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7549 assert!(updates.update_add_htlcs.is_empty());
7550 assert!(updates.update_fulfill_htlcs.is_empty());
7551 assert_eq!(updates.update_fail_htlcs.len(), 1);
7552 assert!(updates.update_fail_malformed_htlcs.is_empty());
7553 assert!(updates.update_fee.is_none());
7554 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7555 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7556 expect_payment_failed!(nodes[0], our_payment_hash, true);
7558 // Send the second half of the original MPP payment.
7559 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();
7560 check_added_monitors!(nodes[0], 1);
7561 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7562 assert_eq!(events.len(), 1);
7563 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
7565 // Claim the full MPP payment. Note that we can't use a test utility like
7566 // claim_funds_along_route because the ordering of the messages causes the second half of the
7567 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
7568 // lightning messages manually.
7569 nodes[1].node.claim_funds(payment_preimage);
7570 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
7571 check_added_monitors!(nodes[1], 2);
7573 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7574 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
7575 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
7576 check_added_monitors!(nodes[0], 1);
7577 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7578 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
7579 check_added_monitors!(nodes[1], 1);
7580 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7581 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
7582 check_added_monitors!(nodes[1], 1);
7583 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7584 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
7585 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
7586 check_added_monitors!(nodes[0], 1);
7587 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7588 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
7589 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7590 check_added_monitors!(nodes[0], 1);
7591 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
7592 check_added_monitors!(nodes[1], 1);
7593 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
7594 check_added_monitors!(nodes[1], 1);
7595 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7596 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
7597 check_added_monitors!(nodes[0], 1);
7599 // Note that successful MPP payments will generate a single PaymentSent event upon the first
7600 // path's success and a PaymentPathSuccessful event for each path's success.
7601 let events = nodes[0].node.get_and_clear_pending_events();
7602 assert_eq!(events.len(), 3);
7604 Event::PaymentSent { payment_id: ref id, payment_preimage: ref preimage, payment_hash: ref hash, .. } => {
7605 assert_eq!(Some(payment_id), *id);
7606 assert_eq!(payment_preimage, *preimage);
7607 assert_eq!(our_payment_hash, *hash);
7609 _ => panic!("Unexpected event"),
7612 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7613 assert_eq!(payment_id, *actual_payment_id);
7614 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7615 assert_eq!(route.paths[0], *path);
7617 _ => panic!("Unexpected event"),
7620 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7621 assert_eq!(payment_id, *actual_payment_id);
7622 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7623 assert_eq!(route.paths[0], *path);
7625 _ => panic!("Unexpected event"),
7630 fn test_keysend_dup_payment_hash() {
7631 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
7632 // outbound regular payment fails as expected.
7633 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
7634 // fails as expected.
7635 let chanmon_cfgs = create_chanmon_cfgs(2);
7636 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7637 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7638 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7639 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7640 let scorer = test_utils::TestScorer::with_penalty(0);
7641 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7643 // To start (1), send a regular payment but don't claim it.
7644 let expected_route = [&nodes[1]];
7645 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
7647 // Next, attempt a keysend payment and make sure it fails.
7648 let route_params = RouteParameters {
7649 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id()),
7650 final_value_msat: 100_000,
7651 final_cltv_expiry_delta: TEST_FINAL_CLTV,
7653 let route = find_route(
7654 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
7655 None, nodes[0].logger, &scorer, &random_seed_bytes
7657 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7658 check_added_monitors!(nodes[0], 1);
7659 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7660 assert_eq!(events.len(), 1);
7661 let ev = events.drain(..).next().unwrap();
7662 let payment_event = SendEvent::from_event(ev);
7663 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7664 check_added_monitors!(nodes[1], 0);
7665 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7666 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
7667 // fails), the second will process the resulting failure and fail the HTLC backward
7668 expect_pending_htlcs_forwardable!(nodes[1]);
7669 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
7670 check_added_monitors!(nodes[1], 1);
7671 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7672 assert!(updates.update_add_htlcs.is_empty());
7673 assert!(updates.update_fulfill_htlcs.is_empty());
7674 assert_eq!(updates.update_fail_htlcs.len(), 1);
7675 assert!(updates.update_fail_malformed_htlcs.is_empty());
7676 assert!(updates.update_fee.is_none());
7677 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7678 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7679 expect_payment_failed!(nodes[0], payment_hash, true);
7681 // Finally, claim the original payment.
7682 claim_payment(&nodes[0], &expected_route, payment_preimage);
7684 // To start (2), send a keysend payment but don't claim it.
7685 let payment_preimage = PaymentPreimage([42; 32]);
7686 let route = find_route(
7687 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
7688 None, nodes[0].logger, &scorer, &random_seed_bytes
7690 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7691 check_added_monitors!(nodes[0], 1);
7692 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7693 assert_eq!(events.len(), 1);
7694 let event = events.pop().unwrap();
7695 let path = vec![&nodes[1]];
7696 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
7698 // Next, attempt a regular payment and make sure it fails.
7699 let payment_secret = PaymentSecret([43; 32]);
7700 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
7701 check_added_monitors!(nodes[0], 1);
7702 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7703 assert_eq!(events.len(), 1);
7704 let ev = events.drain(..).next().unwrap();
7705 let payment_event = SendEvent::from_event(ev);
7706 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7707 check_added_monitors!(nodes[1], 0);
7708 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7709 expect_pending_htlcs_forwardable!(nodes[1]);
7710 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
7711 check_added_monitors!(nodes[1], 1);
7712 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7713 assert!(updates.update_add_htlcs.is_empty());
7714 assert!(updates.update_fulfill_htlcs.is_empty());
7715 assert_eq!(updates.update_fail_htlcs.len(), 1);
7716 assert!(updates.update_fail_malformed_htlcs.is_empty());
7717 assert!(updates.update_fee.is_none());
7718 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7719 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7720 expect_payment_failed!(nodes[0], payment_hash, true);
7722 // Finally, succeed the keysend payment.
7723 claim_payment(&nodes[0], &expected_route, payment_preimage);
7727 fn test_keysend_hash_mismatch() {
7728 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
7729 // preimage doesn't match the msg's payment hash.
7730 let chanmon_cfgs = create_chanmon_cfgs(2);
7731 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7732 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7733 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7735 let payer_pubkey = nodes[0].node.get_our_node_id();
7736 let payee_pubkey = nodes[1].node.get_our_node_id();
7737 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7738 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7740 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], channelmanager::provided_init_features(), channelmanager::provided_init_features());
7741 let route_params = RouteParameters {
7742 payment_params: PaymentParameters::for_keysend(payee_pubkey),
7743 final_value_msat: 10_000,
7744 final_cltv_expiry_delta: 40,
7746 let network_graph = nodes[0].network_graph;
7747 let first_hops = nodes[0].node.list_usable_channels();
7748 let scorer = test_utils::TestScorer::with_penalty(0);
7749 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7750 let route = find_route(
7751 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
7752 nodes[0].logger, &scorer, &random_seed_bytes
7755 let test_preimage = PaymentPreimage([42; 32]);
7756 let mismatch_payment_hash = PaymentHash([43; 32]);
7757 let session_privs = nodes[0].node.add_new_pending_payment(mismatch_payment_hash, None, PaymentId(mismatch_payment_hash.0), &route).unwrap();
7758 nodes[0].node.send_payment_internal(&route, mismatch_payment_hash, &None, Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
7759 check_added_monitors!(nodes[0], 1);
7761 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7762 assert_eq!(updates.update_add_htlcs.len(), 1);
7763 assert!(updates.update_fulfill_htlcs.is_empty());
7764 assert!(updates.update_fail_htlcs.is_empty());
7765 assert!(updates.update_fail_malformed_htlcs.is_empty());
7766 assert!(updates.update_fee.is_none());
7767 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7769 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Payment preimage didn't match payment hash".to_string(), 1);
7773 fn test_keysend_msg_with_secret_err() {
7774 // Test that we error as expected if we receive a keysend payment that includes a payment secret.
7775 let chanmon_cfgs = create_chanmon_cfgs(2);
7776 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7777 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7778 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7780 let payer_pubkey = nodes[0].node.get_our_node_id();
7781 let payee_pubkey = nodes[1].node.get_our_node_id();
7782 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7783 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7785 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], channelmanager::provided_init_features(), channelmanager::provided_init_features());
7786 let route_params = RouteParameters {
7787 payment_params: PaymentParameters::for_keysend(payee_pubkey),
7788 final_value_msat: 10_000,
7789 final_cltv_expiry_delta: 40,
7791 let network_graph = nodes[0].network_graph;
7792 let first_hops = nodes[0].node.list_usable_channels();
7793 let scorer = test_utils::TestScorer::with_penalty(0);
7794 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7795 let route = find_route(
7796 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
7797 nodes[0].logger, &scorer, &random_seed_bytes
7800 let test_preimage = PaymentPreimage([42; 32]);
7801 let test_secret = PaymentSecret([43; 32]);
7802 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
7803 let session_privs = nodes[0].node.add_new_pending_payment(payment_hash, Some(test_secret), PaymentId(payment_hash.0), &route).unwrap();
7804 nodes[0].node.send_payment_internal(&route, payment_hash, &Some(test_secret), Some(test_preimage), PaymentId(payment_hash.0), None, session_privs).unwrap();
7805 check_added_monitors!(nodes[0], 1);
7807 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7808 assert_eq!(updates.update_add_htlcs.len(), 1);
7809 assert!(updates.update_fulfill_htlcs.is_empty());
7810 assert!(updates.update_fail_htlcs.is_empty());
7811 assert!(updates.update_fail_malformed_htlcs.is_empty());
7812 assert!(updates.update_fee.is_none());
7813 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7815 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "We don't support MPP keysend payments".to_string(), 1);
7819 fn test_multi_hop_missing_secret() {
7820 let chanmon_cfgs = create_chanmon_cfgs(4);
7821 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7822 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7823 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7825 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;
7826 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;
7827 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;
7828 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;
7830 // Marshall an MPP route.
7831 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
7832 let path = route.paths[0].clone();
7833 route.paths.push(path);
7834 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
7835 route.paths[0][0].short_channel_id = chan_1_id;
7836 route.paths[0][1].short_channel_id = chan_3_id;
7837 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
7838 route.paths[1][0].short_channel_id = chan_2_id;
7839 route.paths[1][1].short_channel_id = chan_4_id;
7841 match nodes[0].node.send_payment(&route, payment_hash, &None, PaymentId(payment_hash.0)).unwrap_err() {
7842 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
7843 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err)) },
7844 _ => panic!("unexpected error")
7849 fn bad_inbound_payment_hash() {
7850 // Add coverage for checking that a user-provided payment hash matches the payment secret.
7851 let chanmon_cfgs = create_chanmon_cfgs(2);
7852 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7853 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7854 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7856 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
7857 let payment_data = msgs::FinalOnionHopData {
7859 total_msat: 100_000,
7862 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
7863 // payment verification fails as expected.
7864 let mut bad_payment_hash = payment_hash.clone();
7865 bad_payment_hash.0[0] += 1;
7866 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) {
7867 Ok(_) => panic!("Unexpected ok"),
7869 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment".to_string(), "Failing HTLC with user-generated payment_hash".to_string(), 1);
7873 // Check that using the original payment hash succeeds.
7874 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());
7878 fn test_id_to_peer_coverage() {
7879 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
7880 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
7881 // the channel is successfully closed.
7882 let chanmon_cfgs = create_chanmon_cfgs(2);
7883 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7884 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7885 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7887 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
7888 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7889 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
7890 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7891 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
7893 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
7894 let channel_id = &tx.txid().into_inner();
7896 // Ensure that the `id_to_peer` map is empty until either party has received the
7897 // funding transaction, and have the real `channel_id`.
7898 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
7899 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
7902 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
7904 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
7905 // as it has the funding transaction.
7906 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
7907 assert_eq!(nodes_0_lock.len(), 1);
7908 assert!(nodes_0_lock.contains_key(channel_id));
7910 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
7913 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
7915 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
7917 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
7918 assert_eq!(nodes_0_lock.len(), 1);
7919 assert!(nodes_0_lock.contains_key(channel_id));
7921 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
7922 // as it has the funding transaction.
7923 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
7924 assert_eq!(nodes_1_lock.len(), 1);
7925 assert!(nodes_1_lock.contains_key(channel_id));
7927 check_added_monitors!(nodes[1], 1);
7928 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
7929 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
7930 check_added_monitors!(nodes[0], 1);
7931 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
7932 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
7933 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
7935 nodes[0].node.close_channel(channel_id, &nodes[1].node.get_our_node_id()).unwrap();
7936 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()));
7937 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7938 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &nodes_1_shutdown);
7940 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
7941 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
7943 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
7944 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
7945 // fee for the closing transaction has been negotiated and the parties has the other
7946 // party's signature for the fee negotiated closing transaction.)
7947 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
7948 assert_eq!(nodes_0_lock.len(), 1);
7949 assert!(nodes_0_lock.contains_key(channel_id));
7951 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
7952 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
7953 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
7954 // kept in the `nodes[1]`'s `id_to_peer` map.
7955 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
7956 assert_eq!(nodes_1_lock.len(), 1);
7957 assert!(nodes_1_lock.contains_key(channel_id));
7960 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()));
7962 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
7963 // therefore has all it needs to fully close the channel (both signatures for the
7964 // closing transaction).
7965 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
7966 // fully closed by `nodes[0]`.
7967 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
7969 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
7970 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
7971 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
7972 assert_eq!(nodes_1_lock.len(), 1);
7973 assert!(nodes_1_lock.contains_key(channel_id));
7976 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
7978 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
7980 // Assert that the channel has now been removed from both parties `id_to_peer` map once
7981 // they both have everything required to fully close the channel.
7982 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
7984 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
7986 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
7987 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
7991 #[cfg(all(any(test, feature = "_test_utils"), feature = "_bench_unstable"))]
7993 use crate::chain::Listen;
7994 use crate::chain::chainmonitor::{ChainMonitor, Persist};
7995 use crate::chain::keysinterface::{KeysManager, KeysInterface, InMemorySigner};
7996 use crate::ln::channelmanager::{self, BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId};
7997 use crate::ln::functional_test_utils::*;
7998 use crate::ln::msgs::{ChannelMessageHandler, Init};
7999 use crate::routing::gossip::NetworkGraph;
8000 use crate::routing::router::{PaymentParameters, get_route};
8001 use crate::util::test_utils;
8002 use crate::util::config::UserConfig;
8003 use crate::util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
8005 use bitcoin::hashes::Hash;
8006 use bitcoin::hashes::sha256::Hash as Sha256;
8007 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
8009 use crate::sync::{Arc, Mutex};
8013 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
8014 node: &'a ChannelManager<
8015 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
8016 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
8017 &'a test_utils::TestLogger, &'a P>,
8018 &'a test_utils::TestBroadcaster, &'a KeysManager,
8019 &'a test_utils::TestFeeEstimator, &'a test_utils::TestLogger>,
8024 fn bench_sends(bench: &mut Bencher) {
8025 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
8028 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
8029 // Do a simple benchmark of sending a payment back and forth between two nodes.
8030 // Note that this is unrealistic as each payment send will require at least two fsync
8032 let network = bitcoin::Network::Testnet;
8033 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
8035 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
8036 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
8038 let mut config: UserConfig = Default::default();
8039 config.channel_handshake_config.minimum_depth = 1;
8041 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
8042 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
8043 let seed_a = [1u8; 32];
8044 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
8045 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &logger_a, &keys_manager_a, config.clone(), ChainParameters {
8047 best_block: BestBlock::from_genesis(network),
8049 let node_a_holder = NodeHolder { node: &node_a };
8051 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
8052 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
8053 let seed_b = [2u8; 32];
8054 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
8055 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &logger_b, &keys_manager_b, config.clone(), ChainParameters {
8057 best_block: BestBlock::from_genesis(network),
8059 let node_b_holder = NodeHolder { node: &node_b };
8061 node_a.peer_connected(&node_b.get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8062 node_b.peer_connected(&node_a.get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
8063 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
8064 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()));
8065 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()));
8068 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
8069 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
8070 value: 8_000_000, script_pubkey: output_script,
8072 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
8073 } else { panic!(); }
8075 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()));
8076 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()));
8078 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
8081 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
8084 Listen::block_connected(&node_a, &block, 1);
8085 Listen::block_connected(&node_b, &block, 1);
8087 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()));
8088 let msg_events = node_a.get_and_clear_pending_msg_events();
8089 assert_eq!(msg_events.len(), 2);
8090 match msg_events[0] {
8091 MessageSendEvent::SendChannelReady { ref msg, .. } => {
8092 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
8093 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
8097 match msg_events[1] {
8098 MessageSendEvent::SendChannelUpdate { .. } => {},
8102 let events_a = node_a.get_and_clear_pending_events();
8103 assert_eq!(events_a.len(), 1);
8105 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8106 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
8108 _ => panic!("Unexpected event"),
8111 let events_b = node_b.get_and_clear_pending_events();
8112 assert_eq!(events_b.len(), 1);
8114 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8115 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
8117 _ => panic!("Unexpected event"),
8120 let dummy_graph = NetworkGraph::new(genesis_hash, &logger_a);
8122 let mut payment_count: u64 = 0;
8123 macro_rules! send_payment {
8124 ($node_a: expr, $node_b: expr) => {
8125 let usable_channels = $node_a.list_usable_channels();
8126 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id())
8127 .with_features(channelmanager::provided_invoice_features());
8128 let scorer = test_utils::TestScorer::with_penalty(0);
8129 let seed = [3u8; 32];
8130 let keys_manager = KeysManager::new(&seed, 42, 42);
8131 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8132 let route = get_route(&$node_a.get_our_node_id(), &payment_params, &dummy_graph.read_only(),
8133 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), 10_000, TEST_FINAL_CLTV, &logger_a, &scorer, &random_seed_bytes).unwrap();
8135 let mut payment_preimage = PaymentPreimage([0; 32]);
8136 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
8138 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
8139 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200).unwrap();
8141 $node_a.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
8142 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
8143 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
8144 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
8145 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
8146 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
8147 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
8148 $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()));
8150 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
8151 expect_payment_received!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
8152 $node_b.claim_funds(payment_preimage);
8153 expect_payment_claimed!(NodeHolder { node: &$node_b }, payment_hash, 10_000);
8155 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
8156 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
8157 assert_eq!(node_id, $node_a.get_our_node_id());
8158 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8159 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
8161 _ => panic!("Failed to generate claim event"),
8164 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
8165 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
8166 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
8167 $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()));
8169 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
8174 send_payment!(node_a, node_b);
8175 send_payment!(node_b, node_a);