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 chain::{Confirm, ChannelMonitorUpdateStatus, Watch, BestBlock};
39 use chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator};
40 use 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 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 ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
45 use ln::channel::{Channel, ChannelError, ChannelUpdateStatus, UpdateFulfillCommitFetch};
46 use ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
47 #[cfg(any(feature = "_test_utils", test))]
48 use ln::features::InvoiceFeatures;
49 use routing::router::{PaymentParameters, Route, RouteHop, RoutePath, RouteParameters};
52 use ln::msgs::{ChannelMessageHandler, DecodeError, LightningError, MAX_VALUE_MSAT};
54 use chain::keysinterface::{Sign, KeysInterface, KeysManager, InMemorySigner, Recipient};
55 use util::config::{UserConfig, ChannelConfig};
56 use util::events::{EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
57 use util::{byte_utils, events};
58 use util::wakers::{Future, Notifier};
59 use util::scid_utils::fake_scid;
60 use util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
61 use util::logger::{Level, Logger};
62 use util::errors::APIError;
67 use core::cell::RefCell;
69 use 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 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
406 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
407 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
408 /// and via the classic SCID.
410 /// Note that while this is held in the same mutex as the channels themselves, no consistency
411 /// guarantees are made about the existence of a channel with the short id here, nor the short
412 /// ids in the PendingHTLCInfo!
413 pub(super) forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
414 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
415 /// failed/claimed by the user.
417 /// Note that while this is held in the same mutex as the channels themselves, no consistency
418 /// guarantees are made about the channels given here actually existing anymore by the time you
420 claimable_htlcs: HashMap<PaymentHash, (events::PaymentPurpose, Vec<ClaimableHTLC>)>,
421 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
422 /// for broadcast messages, where ordering isn't as strict).
423 pub(super) pending_msg_events: Vec<MessageSendEvent>,
426 /// Events which we process internally but cannot be procsesed immediately at the generation site
427 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
428 /// quite some time lag.
429 enum BackgroundEvent {
430 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
431 /// commitment transaction.
432 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
435 /// State we hold per-peer. In the future we should put channels in here, but for now we only hold
436 /// the latest Init features we heard from the peer.
438 latest_features: InitFeatures,
441 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
442 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
444 /// For users who don't want to bother doing their own payment preimage storage, we also store that
447 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
448 /// and instead encoding it in the payment secret.
449 struct PendingInboundPayment {
450 /// The payment secret that the sender must use for us to accept this payment
451 payment_secret: PaymentSecret,
452 /// Time at which this HTLC expires - blocks with a header time above this value will result in
453 /// this payment being removed.
455 /// Arbitrary identifier the user specifies (or not)
456 user_payment_id: u64,
457 // Other required attributes of the payment, optionally enforced:
458 payment_preimage: Option<PaymentPreimage>,
459 min_value_msat: Option<u64>,
462 /// Stores the session_priv for each part of a payment that is still pending. For versions 0.0.102
463 /// and later, also stores information for retrying the payment.
464 pub(crate) enum PendingOutboundPayment {
466 session_privs: HashSet<[u8; 32]>,
469 session_privs: HashSet<[u8; 32]>,
470 payment_hash: PaymentHash,
471 payment_secret: Option<PaymentSecret>,
472 pending_amt_msat: u64,
473 /// Used to track the fee paid. Only present if the payment was serialized on 0.0.103+.
474 pending_fee_msat: Option<u64>,
475 /// The total payment amount across all paths, used to verify that a retry is not overpaying.
477 /// Our best known block height at the time this payment was initiated.
478 starting_block_height: u32,
480 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
481 /// been resolved. This ensures we don't look up pending payments in ChannelMonitors on restart
482 /// and add a pending payment that was already fulfilled.
484 session_privs: HashSet<[u8; 32]>,
485 payment_hash: Option<PaymentHash>,
487 /// When a payer gives up trying to retry a payment, they inform us, letting us generate a
488 /// `PaymentFailed` event when all HTLCs have irrevocably failed. This avoids a number of race
489 /// conditions in MPP-aware payment retriers (1), where the possibility of multiple
490 /// `PaymentPathFailed` events with `all_paths_failed` can be pending at once, confusing a
491 /// downstream event handler as to when a payment has actually failed.
493 /// (1) https://github.com/lightningdevkit/rust-lightning/issues/1164
495 session_privs: HashSet<[u8; 32]>,
496 payment_hash: PaymentHash,
500 impl PendingOutboundPayment {
501 fn is_retryable(&self) -> bool {
503 PendingOutboundPayment::Retryable { .. } => true,
507 fn is_fulfilled(&self) -> bool {
509 PendingOutboundPayment::Fulfilled { .. } => true,
513 fn abandoned(&self) -> bool {
515 PendingOutboundPayment::Abandoned { .. } => true,
519 fn get_pending_fee_msat(&self) -> Option<u64> {
521 PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
526 fn payment_hash(&self) -> Option<PaymentHash> {
528 PendingOutboundPayment::Legacy { .. } => None,
529 PendingOutboundPayment::Retryable { payment_hash, .. } => Some(*payment_hash),
530 PendingOutboundPayment::Fulfilled { payment_hash, .. } => *payment_hash,
531 PendingOutboundPayment::Abandoned { payment_hash, .. } => Some(*payment_hash),
535 fn mark_fulfilled(&mut self) {
536 let mut session_privs = HashSet::new();
537 core::mem::swap(&mut session_privs, match self {
538 PendingOutboundPayment::Legacy { session_privs } |
539 PendingOutboundPayment::Retryable { session_privs, .. } |
540 PendingOutboundPayment::Fulfilled { session_privs, .. } |
541 PendingOutboundPayment::Abandoned { session_privs, .. }
544 let payment_hash = self.payment_hash();
545 *self = PendingOutboundPayment::Fulfilled { session_privs, payment_hash };
548 fn mark_abandoned(&mut self) -> Result<(), ()> {
549 let mut session_privs = HashSet::new();
550 let our_payment_hash;
551 core::mem::swap(&mut session_privs, match self {
552 PendingOutboundPayment::Legacy { .. } |
553 PendingOutboundPayment::Fulfilled { .. } =>
555 PendingOutboundPayment::Retryable { session_privs, payment_hash, .. } |
556 PendingOutboundPayment::Abandoned { session_privs, payment_hash, .. } => {
557 our_payment_hash = *payment_hash;
561 *self = PendingOutboundPayment::Abandoned { session_privs, payment_hash: our_payment_hash };
565 /// panics if path is None and !self.is_fulfilled
566 fn remove(&mut self, session_priv: &[u8; 32], path: Option<&Vec<RouteHop>>) -> bool {
567 let remove_res = match self {
568 PendingOutboundPayment::Legacy { session_privs } |
569 PendingOutboundPayment::Retryable { session_privs, .. } |
570 PendingOutboundPayment::Fulfilled { session_privs, .. } |
571 PendingOutboundPayment::Abandoned { session_privs, .. } => {
572 session_privs.remove(session_priv)
576 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
577 let path = path.expect("Fulfilling a payment should always come with a path");
578 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
579 *pending_amt_msat -= path_last_hop.fee_msat;
580 if let Some(fee_msat) = pending_fee_msat.as_mut() {
581 *fee_msat -= path.get_path_fees();
588 fn insert(&mut self, session_priv: [u8; 32], path: &Vec<RouteHop>) -> bool {
589 let insert_res = match self {
590 PendingOutboundPayment::Legacy { session_privs } |
591 PendingOutboundPayment::Retryable { session_privs, .. } => {
592 session_privs.insert(session_priv)
594 PendingOutboundPayment::Fulfilled { .. } => false,
595 PendingOutboundPayment::Abandoned { .. } => false,
598 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
599 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
600 *pending_amt_msat += path_last_hop.fee_msat;
601 if let Some(fee_msat) = pending_fee_msat.as_mut() {
602 *fee_msat += path.get_path_fees();
609 fn remaining_parts(&self) -> usize {
611 PendingOutboundPayment::Legacy { session_privs } |
612 PendingOutboundPayment::Retryable { session_privs, .. } |
613 PendingOutboundPayment::Fulfilled { session_privs, .. } |
614 PendingOutboundPayment::Abandoned { session_privs, .. } => {
621 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
622 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
623 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
624 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
625 /// issues such as overly long function definitions. Note that the ChannelManager can take any
626 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
627 /// concrete type of the KeysManager.
629 /// (C-not exported) as Arcs don't make sense in bindings
630 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<InMemorySigner, Arc<M>, Arc<T>, Arc<KeysManager>, Arc<F>, Arc<L>>;
632 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
633 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
634 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
635 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
636 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
637 /// helps with issues such as long function definitions. Note that the ChannelManager can take any
638 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
639 /// concrete type of the KeysManager.
641 /// (C-not exported) as Arcs don't make sense in bindings
642 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L> = ChannelManager<InMemorySigner, &'a M, &'b T, &'c KeysManager, &'d F, &'e L>;
644 /// Manager which keeps track of a number of channels and sends messages to the appropriate
645 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
647 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
648 /// to individual Channels.
650 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
651 /// all peers during write/read (though does not modify this instance, only the instance being
652 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
653 /// called funding_transaction_generated for outbound channels).
655 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
656 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
657 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
658 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
659 /// the serialization process). If the deserialized version is out-of-date compared to the
660 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
661 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
663 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
664 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
665 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
666 /// block_connected() to step towards your best block) upon deserialization before using the
669 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
670 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
671 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
672 /// offline for a full minute. In order to track this, you must call
673 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
675 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
676 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
677 /// essentially you should default to using a SimpleRefChannelManager, and use a
678 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
679 /// you're using lightning-net-tokio.
680 pub struct ChannelManager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
681 where M::Target: chain::Watch<Signer>,
682 T::Target: BroadcasterInterface,
683 K::Target: KeysInterface<Signer = Signer>,
684 F::Target: FeeEstimator,
687 default_configuration: UserConfig,
688 genesis_hash: BlockHash,
689 fee_estimator: LowerBoundedFeeEstimator<F>,
694 pub(super) best_block: RwLock<BestBlock>,
696 best_block: RwLock<BestBlock>,
697 secp_ctx: Secp256k1<secp256k1::All>,
699 #[cfg(any(test, feature = "_test_utils"))]
700 pub(super) channel_state: Mutex<ChannelHolder<Signer>>,
701 #[cfg(not(any(test, feature = "_test_utils")))]
702 channel_state: Mutex<ChannelHolder<Signer>>,
704 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
705 /// expose them to users via a PaymentReceived event. HTLCs which do not meet the requirements
706 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
707 /// after we generate a PaymentReceived upon receipt of all MPP parts or when they time out.
708 /// Locked *after* channel_state.
709 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
711 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
712 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
713 /// (if the channel has been force-closed), however we track them here to prevent duplicative
714 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
715 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
716 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
717 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
718 /// after reloading from disk while replaying blocks against ChannelMonitors.
720 /// See `PendingOutboundPayment` documentation for more info.
722 /// Locked *after* channel_state.
723 pending_outbound_payments: Mutex<HashMap<PaymentId, PendingOutboundPayment>>,
725 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
726 /// and some closed channels which reached a usable state prior to being closed. This is used
727 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
728 /// active channel list on load.
729 outbound_scid_aliases: Mutex<HashSet<u64>>,
731 /// `channel_id` -> `counterparty_node_id`.
733 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
734 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
735 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
737 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
738 /// the corresponding channel for the event, as we only have access to the `channel_id` during
739 /// the handling of the events.
742 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
743 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
744 /// would break backwards compatability.
745 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
746 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
747 /// required to access the channel with the `counterparty_node_id`.
748 id_to_peer: Mutex<HashMap<[u8; 32], PublicKey>>,
750 our_network_key: SecretKey,
751 our_network_pubkey: PublicKey,
753 inbound_payment_key: inbound_payment::ExpandedKey,
755 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
756 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
757 /// we encrypt the namespace identifier using these bytes.
759 /// [fake scids]: crate::util::scid_utils::fake_scid
760 fake_scid_rand_bytes: [u8; 32],
762 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
763 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
764 /// keeping additional state.
765 probing_cookie_secret: [u8; 32],
767 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
768 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
769 /// very far in the past, and can only ever be up to two hours in the future.
770 highest_seen_timestamp: AtomicUsize,
772 /// The bulk of our storage will eventually be here (channels and message queues and the like).
773 /// If we are connected to a peer we always at least have an entry here, even if no channels
774 /// are currently open with that peer.
775 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
776 /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
779 /// If also holding `channel_state` lock, must lock `channel_state` prior to `per_peer_state`.
780 per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
782 pending_events: Mutex<Vec<events::Event>>,
783 pending_background_events: Mutex<Vec<BackgroundEvent>>,
784 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
785 /// Essentially just when we're serializing ourselves out.
786 /// Taken first everywhere where we are making changes before any other locks.
787 /// When acquiring this lock in read mode, rather than acquiring it directly, call
788 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
789 /// Notifier the lock contains sends out a notification when the lock is released.
790 total_consistency_lock: RwLock<()>,
792 persistence_notifier: Notifier,
799 /// Chain-related parameters used to construct a new `ChannelManager`.
801 /// Typically, the block-specific parameters are derived from the best block hash for the network,
802 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
803 /// are not needed when deserializing a previously constructed `ChannelManager`.
804 #[derive(Clone, Copy, PartialEq)]
805 pub struct ChainParameters {
806 /// The network for determining the `chain_hash` in Lightning messages.
807 pub network: Network,
809 /// The hash and height of the latest block successfully connected.
811 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
812 pub best_block: BestBlock,
815 #[derive(Copy, Clone, PartialEq)]
821 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
822 /// desirable to notify any listeners on `await_persistable_update_timeout`/
823 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
824 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
825 /// sending the aforementioned notification (since the lock being released indicates that the
826 /// updates are ready for persistence).
828 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
829 /// notify or not based on whether relevant changes have been made, providing a closure to
830 /// `optionally_notify` which returns a `NotifyOption`.
831 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
832 persistence_notifier: &'a Notifier,
834 // We hold onto this result so the lock doesn't get released immediately.
835 _read_guard: RwLockReadGuard<'a, ()>,
838 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
839 fn notify_on_drop(lock: &'a RwLock<()>, notifier: &'a Notifier) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
840 PersistenceNotifierGuard::optionally_notify(lock, notifier, || -> NotifyOption { NotifyOption::DoPersist })
843 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a Notifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
844 let read_guard = lock.read().unwrap();
846 PersistenceNotifierGuard {
847 persistence_notifier: notifier,
848 should_persist: persist_check,
849 _read_guard: read_guard,
854 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
856 if (self.should_persist)() == NotifyOption::DoPersist {
857 self.persistence_notifier.notify();
862 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
863 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
865 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
867 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
868 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
869 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
870 /// the maximum required amount in lnd as of March 2021.
871 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
873 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
874 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
876 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
878 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
879 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
880 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
881 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
882 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
883 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
884 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
885 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
886 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
887 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
888 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
889 // routing failure for any HTLC sender picking up an LDK node among the first hops.
890 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
892 /// Minimum CLTV difference between the current block height and received inbound payments.
893 /// Invoices generated for payment to us must set their `min_final_cltv_expiry` field to at least
895 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
896 // any payments to succeed. Further, we don't want payments to fail if a block was found while
897 // a payment was being routed, so we add an extra block to be safe.
898 pub const MIN_FINAL_CLTV_EXPIRY: u32 = HTLC_FAIL_BACK_BUFFER + 3;
900 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
901 // ie that if the next-hop peer fails the HTLC within
902 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
903 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
904 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
905 // LATENCY_GRACE_PERIOD_BLOCKS.
908 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;
910 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
911 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
914 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
916 /// The number of blocks before we consider an outbound payment for expiry if it doesn't have any
917 /// pending HTLCs in flight.
918 pub(crate) const PAYMENT_EXPIRY_BLOCKS: u32 = 3;
920 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
921 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
923 /// Information needed for constructing an invoice route hint for this channel.
924 #[derive(Clone, Debug, PartialEq)]
925 pub struct CounterpartyForwardingInfo {
926 /// Base routing fee in millisatoshis.
927 pub fee_base_msat: u32,
928 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
929 pub fee_proportional_millionths: u32,
930 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
931 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
932 /// `cltv_expiry_delta` for more details.
933 pub cltv_expiry_delta: u16,
936 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
937 /// to better separate parameters.
938 #[derive(Clone, Debug, PartialEq)]
939 pub struct ChannelCounterparty {
940 /// The node_id of our counterparty
941 pub node_id: PublicKey,
942 /// The Features the channel counterparty provided upon last connection.
943 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
944 /// many routing-relevant features are present in the init context.
945 pub features: InitFeatures,
946 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
947 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
948 /// claiming at least this value on chain.
950 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
952 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
953 pub unspendable_punishment_reserve: u64,
954 /// Information on the fees and requirements that the counterparty requires when forwarding
955 /// payments to us through this channel.
956 pub forwarding_info: Option<CounterpartyForwardingInfo>,
957 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
958 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
959 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
960 pub outbound_htlc_minimum_msat: Option<u64>,
961 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
962 pub outbound_htlc_maximum_msat: Option<u64>,
965 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
966 #[derive(Clone, Debug, PartialEq)]
967 pub struct ChannelDetails {
968 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
969 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
970 /// Note that this means this value is *not* persistent - it can change once during the
971 /// lifetime of the channel.
972 pub channel_id: [u8; 32],
973 /// Parameters which apply to our counterparty. See individual fields for more information.
974 pub counterparty: ChannelCounterparty,
975 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
976 /// our counterparty already.
978 /// Note that, if this has been set, `channel_id` will be equivalent to
979 /// `funding_txo.unwrap().to_channel_id()`.
980 pub funding_txo: Option<OutPoint>,
981 /// The features which this channel operates with. See individual features for more info.
983 /// `None` until negotiation completes and the channel type is finalized.
984 pub channel_type: Option<ChannelTypeFeatures>,
985 /// The position of the funding transaction in the chain. None if the funding transaction has
986 /// not yet been confirmed and the channel fully opened.
988 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
989 /// payments instead of this. See [`get_inbound_payment_scid`].
991 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
992 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
994 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
995 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
996 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
997 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
998 /// [`confirmations_required`]: Self::confirmations_required
999 pub short_channel_id: Option<u64>,
1000 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1001 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1002 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1005 /// This will be `None` as long as the channel is not available for routing outbound payments.
1007 /// [`short_channel_id`]: Self::short_channel_id
1008 /// [`confirmations_required`]: Self::confirmations_required
1009 pub outbound_scid_alias: Option<u64>,
1010 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1011 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1012 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1013 /// when they see a payment to be routed to us.
1015 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1016 /// previous values for inbound payment forwarding.
1018 /// [`short_channel_id`]: Self::short_channel_id
1019 pub inbound_scid_alias: Option<u64>,
1020 /// The value, in satoshis, of this channel as appears in the funding output
1021 pub channel_value_satoshis: u64,
1022 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1023 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1024 /// this value on chain.
1026 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1028 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1030 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1031 pub unspendable_punishment_reserve: Option<u64>,
1032 /// The `user_channel_id` passed in to create_channel, or 0 if the channel was inbound.
1033 pub user_channel_id: u64,
1034 /// Our total balance. This is the amount we would get if we close the channel.
1035 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1036 /// amount is not likely to be recoverable on close.
1038 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1039 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1040 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1041 /// This does not consider any on-chain fees.
1043 /// See also [`ChannelDetails::outbound_capacity_msat`]
1044 pub balance_msat: u64,
1045 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1046 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1047 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1048 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1050 /// See also [`ChannelDetails::balance_msat`]
1052 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1053 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1054 /// should be able to spend nearly this amount.
1055 pub outbound_capacity_msat: u64,
1056 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1057 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1058 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1059 /// to use a limit as close as possible to the HTLC limit we can currently send.
1061 /// See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
1062 pub next_outbound_htlc_limit_msat: u64,
1063 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1064 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1065 /// available for inclusion in new inbound HTLCs).
1066 /// Note that there are some corner cases not fully handled here, so the actual available
1067 /// inbound capacity may be slightly higher than this.
1069 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1070 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1071 /// However, our counterparty should be able to spend nearly this amount.
1072 pub inbound_capacity_msat: u64,
1073 /// The number of required confirmations on the funding transaction before the funding will be
1074 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1075 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1076 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1077 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1079 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1081 /// [`is_outbound`]: ChannelDetails::is_outbound
1082 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1083 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1084 pub confirmations_required: Option<u32>,
1085 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1086 /// until we can claim our funds after we force-close the channel. During this time our
1087 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1088 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1089 /// time to claim our non-HTLC-encumbered funds.
1091 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1092 pub force_close_spend_delay: Option<u16>,
1093 /// True if the channel was initiated (and thus funded) by us.
1094 pub is_outbound: bool,
1095 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1096 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1097 /// required confirmation count has been reached (and we were connected to the peer at some
1098 /// point after the funding transaction received enough confirmations). The required
1099 /// confirmation count is provided in [`confirmations_required`].
1101 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1102 pub is_channel_ready: bool,
1103 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1104 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1106 /// This is a strict superset of `is_channel_ready`.
1107 pub is_usable: bool,
1108 /// True if this channel is (or will be) publicly-announced.
1109 pub is_public: bool,
1110 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1111 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1112 pub inbound_htlc_minimum_msat: Option<u64>,
1113 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1114 pub inbound_htlc_maximum_msat: Option<u64>,
1115 /// Set of configurable parameters that affect channel operation.
1117 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1118 pub config: Option<ChannelConfig>,
1121 impl ChannelDetails {
1122 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1123 /// This should be used for providing invoice hints or in any other context where our
1124 /// counterparty will forward a payment to us.
1126 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1127 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1128 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1129 self.inbound_scid_alias.or(self.short_channel_id)
1132 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1133 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1134 /// we're sending or forwarding a payment outbound over this channel.
1136 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1137 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1138 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1139 self.short_channel_id.or(self.outbound_scid_alias)
1143 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
1144 /// Err() type describing which state the payment is in, see the description of individual enum
1145 /// states for more.
1146 #[derive(Clone, Debug)]
1147 pub enum PaymentSendFailure {
1148 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
1149 /// send the payment at all. No channel state has been changed or messages sent to peers, and
1150 /// once you've changed the parameter at error, you can freely retry the payment in full.
1151 ParameterError(APIError),
1152 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
1153 /// from attempting to send the payment at all. No channel state has been changed or messages
1154 /// sent to peers, and once you've changed the parameter at error, you can freely retry the
1155 /// payment in full.
1157 /// The results here are ordered the same as the paths in the route object which was passed to
1159 PathParameterError(Vec<Result<(), APIError>>),
1160 /// All paths which were attempted failed to send, with no channel state change taking place.
1161 /// You can freely retry the payment in full (though you probably want to do so over different
1162 /// paths than the ones selected).
1163 AllFailedRetrySafe(Vec<APIError>),
1164 /// Some paths which were attempted failed to send, though possibly not all. At least some
1165 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
1166 /// in over-/re-payment.
1168 /// The results here are ordered the same as the paths in the route object which was passed to
1169 /// send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
1170 /// retried (though there is currently no API with which to do so).
1172 /// Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
1173 /// as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
1174 /// case of Ok(())) or will send once a [`MonitorEvent::Completed`] is provided for the
1175 /// next-hop channel with the latest update_id.
1177 /// The errors themselves, in the same order as the route hops.
1178 results: Vec<Result<(), APIError>>,
1179 /// If some paths failed without irrevocably committing to the new HTLC(s), this will
1180 /// contain a [`RouteParameters`] object which can be used to calculate a new route that
1181 /// will pay all remaining unpaid balance.
1182 failed_paths_retry: Option<RouteParameters>,
1183 /// The payment id for the payment, which is now at least partially pending.
1184 payment_id: PaymentId,
1188 /// Route hints used in constructing invoices for [phantom node payents].
1190 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
1192 pub struct PhantomRouteHints {
1193 /// The list of channels to be included in the invoice route hints.
1194 pub channels: Vec<ChannelDetails>,
1195 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1197 pub phantom_scid: u64,
1198 /// The pubkey of the real backing node that would ultimately receive the payment.
1199 pub real_node_pubkey: PublicKey,
1202 macro_rules! handle_error {
1203 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
1206 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish }) => {
1207 #[cfg(debug_assertions)]
1209 // In testing, ensure there are no deadlocks where the lock is already held upon
1210 // entering the macro.
1211 assert!($self.channel_state.try_lock().is_ok());
1212 assert!($self.pending_events.try_lock().is_ok());
1215 let mut msg_events = Vec::with_capacity(2);
1217 if let Some((shutdown_res, update_option)) = shutdown_finish {
1218 $self.finish_force_close_channel(shutdown_res);
1219 if let Some(update) = update_option {
1220 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1224 if let Some((channel_id, user_channel_id)) = chan_id {
1225 $self.pending_events.lock().unwrap().push(events::Event::ChannelClosed {
1226 channel_id, user_channel_id,
1227 reason: ClosureReason::ProcessingError { err: err.err.clone() }
1232 log_error!($self.logger, "{}", err.err);
1233 if let msgs::ErrorAction::IgnoreError = err.action {
1235 msg_events.push(events::MessageSendEvent::HandleError {
1236 node_id: $counterparty_node_id,
1237 action: err.action.clone()
1241 if !msg_events.is_empty() {
1242 $self.channel_state.lock().unwrap().pending_msg_events.append(&mut msg_events);
1245 // Return error in case higher-API need one
1252 macro_rules! update_maps_on_chan_removal {
1253 ($self: expr, $short_to_chan_info: expr, $channel: expr) => {
1254 if let Some(short_id) = $channel.get_short_channel_id() {
1255 $short_to_chan_info.remove(&short_id);
1257 // If the channel was never confirmed on-chain prior to its closure, remove the
1258 // outbound SCID alias we used for it from the collision-prevention set. While we
1259 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1260 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1261 // opening a million channels with us which are closed before we ever reach the funding
1263 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel.outbound_scid_alias());
1264 debug_assert!(alias_removed);
1266 $self.id_to_peer.lock().unwrap().remove(&$channel.channel_id());
1267 $short_to_chan_info.remove(&$channel.outbound_scid_alias());
1271 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1272 macro_rules! convert_chan_err {
1273 ($self: ident, $err: expr, $short_to_chan_info: expr, $channel: expr, $channel_id: expr) => {
1275 ChannelError::Warn(msg) => {
1276 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), $channel_id.clone()))
1278 ChannelError::Ignore(msg) => {
1279 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
1281 ChannelError::Close(msg) => {
1282 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
1283 update_maps_on_chan_removal!($self, $short_to_chan_info, $channel);
1284 let shutdown_res = $channel.force_shutdown(true);
1285 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
1286 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
1292 macro_rules! break_chan_entry {
1293 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
1297 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_chan_info, $entry.get_mut(), $entry.key());
1299 $entry.remove_entry();
1307 macro_rules! try_chan_entry {
1308 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
1312 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_chan_info, $entry.get_mut(), $entry.key());
1314 $entry.remove_entry();
1322 macro_rules! remove_channel {
1323 ($self: expr, $channel_state: expr, $entry: expr) => {
1325 let channel = $entry.remove_entry().1;
1326 update_maps_on_chan_removal!($self, $channel_state.short_to_chan_info, channel);
1332 macro_rules! handle_monitor_err {
1333 ($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) => {
1335 ChannelMonitorUpdateStatus::PermanentFailure => {
1336 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateStatus::PermanentFailure", log_bytes!($chan_id[..]));
1337 update_maps_on_chan_removal!($self, $short_to_chan_info, $chan);
1338 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
1339 // chain in a confused state! We need to move them into the ChannelMonitor which
1340 // will be responsible for failing backwards once things confirm on-chain.
1341 // It's ok that we drop $failed_forwards here - at this point we'd rather they
1342 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
1343 // us bother trying to claim it just to forward on to another peer. If we're
1344 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
1345 // given up the preimage yet, so might as well just wait until the payment is
1346 // retried, avoiding the on-chain fees.
1347 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure".to_owned(), *$chan_id, $chan.get_user_id(),
1348 $chan.force_shutdown(false), $self.get_channel_update_for_broadcast(&$chan).ok() ));
1351 ChannelMonitorUpdateStatus::InProgress => {
1352 log_info!($self.logger, "Disabling channel {} due to monitor update in progress. On restore will send {} and process {} forwards, {} fails, and {} fulfill finalizations",
1353 log_bytes!($chan_id[..]),
1354 if $resend_commitment && $resend_raa {
1355 match $action_type {
1356 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
1357 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
1359 } else if $resend_commitment { "commitment" }
1360 else if $resend_raa { "RAA" }
1362 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
1363 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len(),
1364 (&$failed_finalized_fulfills as &Vec<HTLCSource>).len());
1365 if !$resend_commitment {
1366 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
1369 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
1371 $chan.monitor_updating_paused($resend_raa, $resend_commitment, $resend_channel_ready, $failed_forwards, $failed_fails, $failed_finalized_fulfills);
1372 (Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$chan_id)), false)
1374 ChannelMonitorUpdateStatus::Completed => {
1379 ($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) => { {
1380 let (res, drop) = handle_monitor_err!($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());
1382 $entry.remove_entry();
1386 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $chan_id: expr, COMMITMENT_UPDATE_ONLY) => { {
1387 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst);
1388 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, false, true, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1390 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $chan_id: expr, NO_UPDATE) => {
1391 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, false, false, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1393 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_channel_ready: expr, OPTIONALLY_RESEND_FUNDING_LOCKED) => {
1394 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, false, false, $resend_channel_ready, Vec::new(), Vec::new(), Vec::new())
1396 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1397 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, false, Vec::new(), Vec::new(), Vec::new())
1399 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
1400 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, false, $failed_forwards, $failed_fails, Vec::new())
1404 macro_rules! send_channel_ready {
1405 ($short_to_chan_info: expr, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {
1406 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1407 node_id: $channel.get_counterparty_node_id(),
1408 msg: $channel_ready_msg,
1410 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1411 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1412 let outbound_alias_insert = $short_to_chan_info.insert($channel.outbound_scid_alias(), ($channel.get_counterparty_node_id(), $channel.channel_id()));
1413 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1414 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1415 if let Some(real_scid) = $channel.get_short_channel_id() {
1416 let scid_insert = $short_to_chan_info.insert(real_scid, ($channel.get_counterparty_node_id(), $channel.channel_id()));
1417 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1418 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1423 macro_rules! handle_chan_restoration_locked {
1424 ($self: ident, $channel_lock: expr, $channel_state: expr, $channel_entry: expr,
1425 $raa: expr, $commitment_update: expr, $order: expr, $chanmon_update: expr,
1426 $pending_forwards: expr, $funding_broadcastable: expr, $channel_ready: expr, $announcement_sigs: expr) => { {
1427 let mut htlc_forwards = None;
1429 let chanmon_update: Option<ChannelMonitorUpdate> = $chanmon_update; // Force type-checking to resolve
1430 let chanmon_update_is_none = chanmon_update.is_none();
1431 let counterparty_node_id = $channel_entry.get().get_counterparty_node_id();
1433 let forwards: Vec<(PendingHTLCInfo, u64)> = $pending_forwards; // Force type-checking to resolve
1434 if !forwards.is_empty() {
1435 htlc_forwards = Some(($channel_entry.get().get_short_channel_id().unwrap_or($channel_entry.get().outbound_scid_alias()),
1436 $channel_entry.get().get_funding_txo().unwrap(), forwards));
1439 if chanmon_update.is_some() {
1440 // On reconnect, we, by definition, only resend a channel_ready if there have been
1441 // no commitment updates, so the only channel monitor update which could also be
1442 // associated with a channel_ready would be the funding_created/funding_signed
1443 // monitor update. That monitor update failing implies that we won't send
1444 // channel_ready until it's been updated, so we can't have a channel_ready and a
1445 // monitor update here (so we don't bother to handle it correctly below).
1446 assert!($channel_ready.is_none());
1447 // A channel monitor update makes no sense without either a channel_ready or a
1448 // commitment update to process after it. Since we can't have a channel_ready, we
1449 // only bother to handle the monitor-update + commitment_update case below.
1450 assert!($commitment_update.is_some());
1453 if let Some(msg) = $channel_ready {
1454 // Similar to the above, this implies that we're letting the channel_ready fly
1455 // before it should be allowed to.
1456 assert!(chanmon_update.is_none());
1457 send_channel_ready!($channel_state.short_to_chan_info, $channel_state.pending_msg_events, $channel_entry.get(), msg);
1459 if let Some(msg) = $announcement_sigs {
1460 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1461 node_id: counterparty_node_id,
1466 let funding_broadcastable: Option<Transaction> = $funding_broadcastable; // Force type-checking to resolve
1467 if let Some(monitor_update) = chanmon_update {
1468 // We only ever broadcast a funding transaction in response to a funding_signed
1469 // message and the resulting monitor update. Thus, on channel_reestablish
1470 // message handling we can't have a funding transaction to broadcast. When
1471 // processing a monitor update finishing resulting in a funding broadcast, we
1472 // cannot have a second monitor update, thus this case would indicate a bug.
1473 assert!(funding_broadcastable.is_none());
1474 // Given we were just reconnected or finished updating a channel monitor, the
1475 // only case where we can get a new ChannelMonitorUpdate would be if we also
1476 // have some commitment updates to send as well.
1477 assert!($commitment_update.is_some());
1478 match $self.chain_monitor.update_channel($channel_entry.get().get_funding_txo().unwrap(), monitor_update) {
1479 ChannelMonitorUpdateStatus::Completed => {},
1481 // channel_reestablish doesn't guarantee the order it returns is sensical
1482 // for the messages it returns, but if we're setting what messages to
1483 // re-transmit on monitor update success, we need to make sure it is sane.
1484 let mut order = $order;
1486 order = RAACommitmentOrder::CommitmentFirst;
1488 break handle_monitor_err!($self, e, $channel_state, $channel_entry, order, $raa.is_some(), true);
1493 macro_rules! handle_cs { () => {
1494 if let Some(update) = $commitment_update {
1495 $channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1496 node_id: counterparty_node_id,
1501 macro_rules! handle_raa { () => {
1502 if let Some(revoke_and_ack) = $raa {
1503 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1504 node_id: counterparty_node_id,
1505 msg: revoke_and_ack,
1510 RAACommitmentOrder::CommitmentFirst => {
1514 RAACommitmentOrder::RevokeAndACKFirst => {
1519 if let Some(tx) = funding_broadcastable {
1520 log_info!($self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
1521 $self.tx_broadcaster.broadcast_transaction(&tx);
1526 if chanmon_update_is_none {
1527 // If there was no ChannelMonitorUpdate, we should never generate an Err in the res loop
1528 // above. Doing so would imply calling handle_err!() from channel_monitor_updated() which
1529 // should *never* end up calling back to `chain_monitor.update_channel()`.
1530 assert!(res.is_ok());
1533 (htlc_forwards, res, counterparty_node_id)
1537 macro_rules! post_handle_chan_restoration {
1538 ($self: ident, $locked_res: expr) => { {
1539 let (htlc_forwards, res, counterparty_node_id) = $locked_res;
1541 let _ = handle_error!($self, res, counterparty_node_id);
1543 if let Some(forwards) = htlc_forwards {
1544 $self.forward_htlcs(&mut [forwards][..]);
1549 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
1550 where M::Target: chain::Watch<Signer>,
1551 T::Target: BroadcasterInterface,
1552 K::Target: KeysInterface<Signer = Signer>,
1553 F::Target: FeeEstimator,
1556 /// Constructs a new ChannelManager to hold several channels and route between them.
1558 /// This is the main "logic hub" for all channel-related actions, and implements
1559 /// ChannelMessageHandler.
1561 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1563 /// Users need to notify the new ChannelManager when a new block is connected or
1564 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
1565 /// from after `params.latest_hash`.
1566 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, logger: L, keys_manager: K, config: UserConfig, params: ChainParameters) -> Self {
1567 let mut secp_ctx = Secp256k1::new();
1568 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
1569 let inbound_pmt_key_material = keys_manager.get_inbound_payment_key_material();
1570 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
1572 default_configuration: config.clone(),
1573 genesis_hash: genesis_block(params.network).header.block_hash(),
1574 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
1578 best_block: RwLock::new(params.best_block),
1580 channel_state: Mutex::new(ChannelHolder{
1581 by_id: HashMap::new(),
1582 short_to_chan_info: HashMap::new(),
1583 forward_htlcs: HashMap::new(),
1584 claimable_htlcs: HashMap::new(),
1585 pending_msg_events: Vec::new(),
1587 outbound_scid_aliases: Mutex::new(HashSet::new()),
1588 pending_inbound_payments: Mutex::new(HashMap::new()),
1589 pending_outbound_payments: Mutex::new(HashMap::new()),
1590 id_to_peer: Mutex::new(HashMap::new()),
1592 our_network_key: keys_manager.get_node_secret(Recipient::Node).unwrap(),
1593 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret(Recipient::Node).unwrap()),
1596 inbound_payment_key: expanded_inbound_key,
1597 fake_scid_rand_bytes: keys_manager.get_secure_random_bytes(),
1599 probing_cookie_secret: keys_manager.get_secure_random_bytes(),
1601 highest_seen_timestamp: AtomicUsize::new(0),
1603 per_peer_state: RwLock::new(HashMap::new()),
1605 pending_events: Mutex::new(Vec::new()),
1606 pending_background_events: Mutex::new(Vec::new()),
1607 total_consistency_lock: RwLock::new(()),
1608 persistence_notifier: Notifier::new(),
1616 /// Gets the current configuration applied to all new channels.
1617 pub fn get_current_default_configuration(&self) -> &UserConfig {
1618 &self.default_configuration
1621 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
1622 let height = self.best_block.read().unwrap().height();
1623 let mut outbound_scid_alias = 0;
1626 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
1627 outbound_scid_alias += 1;
1629 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
1631 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
1635 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"); }
1640 /// Creates a new outbound channel to the given remote node and with the given value.
1642 /// `user_channel_id` will be provided back as in
1643 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
1644 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to 0
1645 /// for inbound channels, so you may wish to avoid using 0 for `user_channel_id` here.
1646 /// `user_channel_id` has no meaning inside of LDK, it is simply copied to events and otherwise
1649 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
1650 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
1652 /// Note that we do not check if you are currently connected to the given peer. If no
1653 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
1654 /// the channel eventually being silently forgotten (dropped on reload).
1656 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
1657 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
1658 /// [`ChannelDetails::channel_id`] until after
1659 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
1660 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
1661 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
1663 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
1664 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
1665 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
1666 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> {
1667 if channel_value_satoshis < 1000 {
1668 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
1672 let per_peer_state = self.per_peer_state.read().unwrap();
1673 match per_peer_state.get(&their_network_key) {
1674 Some(peer_state) => {
1675 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
1676 let peer_state = peer_state.lock().unwrap();
1677 let their_features = &peer_state.latest_features;
1678 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
1679 match Channel::new_outbound(&self.fee_estimator, &self.keys_manager, their_network_key,
1680 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
1681 self.best_block.read().unwrap().height(), outbound_scid_alias)
1685 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
1690 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", their_network_key) }),
1693 let res = channel.get_open_channel(self.genesis_hash.clone());
1695 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1696 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
1697 debug_assert!(&self.total_consistency_lock.try_write().is_err());
1699 let temporary_channel_id = channel.channel_id();
1700 let mut channel_state = self.channel_state.lock().unwrap();
1701 match channel_state.by_id.entry(temporary_channel_id) {
1702 hash_map::Entry::Occupied(_) => {
1704 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
1706 panic!("RNG is bad???");
1709 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
1711 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
1712 node_id: their_network_key,
1715 Ok(temporary_channel_id)
1718 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<Signer>)) -> bool>(&self, f: Fn) -> Vec<ChannelDetails> {
1719 let mut res = Vec::new();
1721 let channel_state = self.channel_state.lock().unwrap();
1722 res.reserve(channel_state.by_id.len());
1723 for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
1724 let balance = channel.get_available_balances();
1725 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1726 channel.get_holder_counterparty_selected_channel_reserve_satoshis();
1727 res.push(ChannelDetails {
1728 channel_id: (*channel_id).clone(),
1729 counterparty: ChannelCounterparty {
1730 node_id: channel.get_counterparty_node_id(),
1731 features: InitFeatures::empty(),
1732 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1733 forwarding_info: channel.counterparty_forwarding_info(),
1734 // Ensures that we have actually received the `htlc_minimum_msat` value
1735 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1736 // message (as they are always the first message from the counterparty).
1737 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1738 // default `0` value set by `Channel::new_outbound`.
1739 outbound_htlc_minimum_msat: if channel.have_received_message() {
1740 Some(channel.get_counterparty_htlc_minimum_msat()) } else { None },
1741 outbound_htlc_maximum_msat: channel.get_counterparty_htlc_maximum_msat(),
1743 funding_txo: channel.get_funding_txo(),
1744 // Note that accept_channel (or open_channel) is always the first message, so
1745 // `have_received_message` indicates that type negotiation has completed.
1746 channel_type: if channel.have_received_message() { Some(channel.get_channel_type().clone()) } else { None },
1747 short_channel_id: channel.get_short_channel_id(),
1748 outbound_scid_alias: if channel.is_usable() { Some(channel.outbound_scid_alias()) } else { None },
1749 inbound_scid_alias: channel.latest_inbound_scid_alias(),
1750 channel_value_satoshis: channel.get_value_satoshis(),
1751 unspendable_punishment_reserve: to_self_reserve_satoshis,
1752 balance_msat: balance.balance_msat,
1753 inbound_capacity_msat: balance.inbound_capacity_msat,
1754 outbound_capacity_msat: balance.outbound_capacity_msat,
1755 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1756 user_channel_id: channel.get_user_id(),
1757 confirmations_required: channel.minimum_depth(),
1758 force_close_spend_delay: channel.get_counterparty_selected_contest_delay(),
1759 is_outbound: channel.is_outbound(),
1760 is_channel_ready: channel.is_usable(),
1761 is_usable: channel.is_live(),
1762 is_public: channel.should_announce(),
1763 inbound_htlc_minimum_msat: Some(channel.get_holder_htlc_minimum_msat()),
1764 inbound_htlc_maximum_msat: channel.get_holder_htlc_maximum_msat(),
1765 config: Some(channel.config()),
1769 let per_peer_state = self.per_peer_state.read().unwrap();
1770 for chan in res.iter_mut() {
1771 if let Some(peer_state) = per_peer_state.get(&chan.counterparty.node_id) {
1772 chan.counterparty.features = peer_state.lock().unwrap().latest_features.clone();
1778 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
1779 /// more information.
1780 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1781 self.list_channels_with_filter(|_| true)
1784 /// Gets the list of usable channels, in random order. Useful as an argument to [`find_route`]
1785 /// to ensure non-announced channels are used.
1787 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1788 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1791 /// [`find_route`]: crate::routing::router::find_route
1792 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1793 // Note we use is_live here instead of usable which leads to somewhat confused
1794 // internal/external nomenclature, but that's ok cause that's probably what the user
1795 // really wanted anyway.
1796 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1799 /// Helper function that issues the channel close events
1800 fn issue_channel_close_events(&self, channel: &Channel<Signer>, closure_reason: ClosureReason) {
1801 let mut pending_events_lock = self.pending_events.lock().unwrap();
1802 match channel.unbroadcasted_funding() {
1803 Some(transaction) => {
1804 pending_events_lock.push(events::Event::DiscardFunding { channel_id: channel.channel_id(), transaction })
1808 pending_events_lock.push(events::Event::ChannelClosed {
1809 channel_id: channel.channel_id(),
1810 user_channel_id: channel.get_user_id(),
1811 reason: closure_reason
1815 fn close_channel_internal(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>) -> Result<(), APIError> {
1816 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1818 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
1819 let result: Result<(), _> = loop {
1820 let mut channel_state_lock = self.channel_state.lock().unwrap();
1821 let channel_state = &mut *channel_state_lock;
1822 match channel_state.by_id.entry(channel_id.clone()) {
1823 hash_map::Entry::Occupied(mut chan_entry) => {
1824 if *counterparty_node_id != chan_entry.get().get_counterparty_node_id(){
1825 return Err(APIError::APIMisuseError { err: "The passed counterparty_node_id doesn't match the channel's counterparty node_id".to_owned() });
1827 let per_peer_state = self.per_peer_state.read().unwrap();
1828 let (shutdown_msg, monitor_update, htlcs) = match per_peer_state.get(&counterparty_node_id) {
1829 Some(peer_state) => {
1830 let peer_state = peer_state.lock().unwrap();
1831 let their_features = &peer_state.latest_features;
1832 chan_entry.get_mut().get_shutdown(&self.keys_manager, their_features, target_feerate_sats_per_1000_weight)?
1834 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", counterparty_node_id) }),
1836 failed_htlcs = htlcs;
1838 // Update the monitor with the shutdown script if necessary.
1839 if let Some(monitor_update) = monitor_update {
1840 let update_res = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update);
1841 let (result, is_permanent) =
1842 handle_monitor_err!(self, update_res, channel_state.short_to_chan_info, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
1844 remove_channel!(self, channel_state, chan_entry);
1849 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1850 node_id: *counterparty_node_id,
1854 if chan_entry.get().is_shutdown() {
1855 let channel = remove_channel!(self, channel_state, chan_entry);
1856 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
1857 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1861 self.issue_channel_close_events(&channel, ClosureReason::HolderForceClosed);
1865 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()})
1869 for htlc_source in failed_htlcs.drain(..) {
1870 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
1871 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
1874 let _ = handle_error!(self, result, *counterparty_node_id);
1878 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1879 /// will be accepted on the given channel, and after additional timeout/the closing of all
1880 /// pending HTLCs, the channel will be closed on chain.
1882 /// * If we are the channel initiator, we will pay between our [`Background`] and
1883 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1885 /// * If our counterparty is the channel initiator, we will require a channel closing
1886 /// transaction feerate of at least our [`Background`] feerate or the feerate which
1887 /// would appear on a force-closure transaction, whichever is lower. We will allow our
1888 /// counterparty to pay as much fee as they'd like, however.
1890 /// May generate a SendShutdown message event on success, which should be relayed.
1892 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1893 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1894 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1895 pub fn close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
1896 self.close_channel_internal(channel_id, counterparty_node_id, None)
1899 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1900 /// will be accepted on the given channel, and after additional timeout/the closing of all
1901 /// pending HTLCs, the channel will be closed on chain.
1903 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
1904 /// the channel being closed or not:
1905 /// * If we are the channel initiator, we will pay at least this feerate on the closing
1906 /// transaction. The upper-bound is set by
1907 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1908 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
1909 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
1910 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
1911 /// will appear on a force-closure transaction, whichever is lower).
1913 /// May generate a SendShutdown message event on success, which should be relayed.
1915 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1916 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1917 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1918 pub fn close_channel_with_target_feerate(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: u32) -> Result<(), APIError> {
1919 self.close_channel_internal(channel_id, counterparty_node_id, Some(target_feerate_sats_per_1000_weight))
1923 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1924 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1925 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
1926 for htlc_source in failed_htlcs.drain(..) {
1927 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
1928 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id: channel_id };
1929 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
1931 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1932 // There isn't anything we can do if we get an update failure - we're already
1933 // force-closing. The monitor update on the required in-memory copy should broadcast
1934 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1935 // ignore the result here.
1936 let _ = self.chain_monitor.update_channel(funding_txo, monitor_update);
1940 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
1941 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
1942 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
1943 -> Result<PublicKey, APIError> {
1945 let mut channel_state_lock = self.channel_state.lock().unwrap();
1946 let channel_state = &mut *channel_state_lock;
1947 if let hash_map::Entry::Occupied(chan) = channel_state.by_id.entry(channel_id.clone()) {
1948 if chan.get().get_counterparty_node_id() != *peer_node_id {
1949 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1951 if let Some(peer_msg) = peer_msg {
1952 self.issue_channel_close_events(chan.get(),ClosureReason::CounterpartyForceClosed { peer_msg: peer_msg.to_string() });
1954 self.issue_channel_close_events(chan.get(),ClosureReason::HolderForceClosed);
1956 remove_channel!(self, channel_state, chan)
1958 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1961 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
1962 self.finish_force_close_channel(chan.force_shutdown(broadcast));
1963 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
1964 let mut channel_state = self.channel_state.lock().unwrap();
1965 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1970 Ok(chan.get_counterparty_node_id())
1973 fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
1974 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1975 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
1976 Ok(counterparty_node_id) => {
1977 self.channel_state.lock().unwrap().pending_msg_events.push(
1978 events::MessageSendEvent::HandleError {
1979 node_id: counterparty_node_id,
1980 action: msgs::ErrorAction::SendErrorMessage {
1981 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
1991 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
1992 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
1993 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
1995 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
1996 -> Result<(), APIError> {
1997 self.force_close_sending_error(channel_id, counterparty_node_id, true)
2000 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
2001 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
2002 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
2004 /// You can always get the latest local transaction(s) to broadcast from
2005 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
2006 pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
2007 -> Result<(), APIError> {
2008 self.force_close_sending_error(channel_id, counterparty_node_id, false)
2011 /// Force close all channels, immediately broadcasting the latest local commitment transaction
2012 /// for each to the chain and rejecting new HTLCs on each.
2013 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
2014 for chan in self.list_channels() {
2015 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
2019 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
2020 /// local transaction(s).
2021 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
2022 for chan in self.list_channels() {
2023 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
2027 fn construct_recv_pending_htlc_info(&self, hop_data: msgs::OnionHopData, shared_secret: [u8; 32],
2028 payment_hash: PaymentHash, amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>) -> Result<PendingHTLCInfo, ReceiveError>
2030 // final_incorrect_cltv_expiry
2031 if hop_data.outgoing_cltv_value != cltv_expiry {
2032 return Err(ReceiveError {
2033 msg: "Upstream node set CLTV to the wrong value",
2035 err_data: byte_utils::be32_to_array(cltv_expiry).to_vec()
2038 // final_expiry_too_soon
2039 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
2040 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
2041 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
2042 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
2043 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
2044 if (hop_data.outgoing_cltv_value as u64) <= self.best_block.read().unwrap().height() as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
2045 return Err(ReceiveError {
2047 err_data: Vec::new(),
2048 msg: "The final CLTV expiry is too soon to handle",
2051 if hop_data.amt_to_forward > amt_msat {
2052 return Err(ReceiveError {
2054 err_data: byte_utils::be64_to_array(amt_msat).to_vec(),
2055 msg: "Upstream node sent less than we were supposed to receive in payment",
2059 let routing = match hop_data.format {
2060 msgs::OnionHopDataFormat::Legacy { .. } => {
2061 return Err(ReceiveError {
2062 err_code: 0x4000|0x2000|3,
2063 err_data: Vec::new(),
2064 msg: "We require payment_secrets",
2067 msgs::OnionHopDataFormat::NonFinalNode { .. } => {
2068 return Err(ReceiveError {
2069 err_code: 0x4000|22,
2070 err_data: Vec::new(),
2071 msg: "Got non final data with an HMAC of 0",
2074 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage } => {
2075 if payment_data.is_some() && keysend_preimage.is_some() {
2076 return Err(ReceiveError {
2077 err_code: 0x4000|22,
2078 err_data: Vec::new(),
2079 msg: "We don't support MPP keysend payments",
2081 } else if let Some(data) = payment_data {
2082 PendingHTLCRouting::Receive {
2084 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2085 phantom_shared_secret,
2087 } else if let Some(payment_preimage) = keysend_preimage {
2088 // We need to check that the sender knows the keysend preimage before processing this
2089 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
2090 // could discover the final destination of X, by probing the adjacent nodes on the route
2091 // with a keysend payment of identical payment hash to X and observing the processing
2092 // time discrepancies due to a hash collision with X.
2093 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2094 if hashed_preimage != payment_hash {
2095 return Err(ReceiveError {
2096 err_code: 0x4000|22,
2097 err_data: Vec::new(),
2098 msg: "Payment preimage didn't match payment hash",
2102 PendingHTLCRouting::ReceiveKeysend {
2104 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2107 return Err(ReceiveError {
2108 err_code: 0x4000|0x2000|3,
2109 err_data: Vec::new(),
2110 msg: "We require payment_secrets",
2115 Ok(PendingHTLCInfo {
2118 incoming_shared_secret: shared_secret,
2119 amt_to_forward: amt_msat,
2120 outgoing_cltv_value: hop_data.outgoing_cltv_value,
2124 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> PendingHTLCStatus {
2125 macro_rules! return_malformed_err {
2126 ($msg: expr, $err_code: expr) => {
2128 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2129 return PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
2130 channel_id: msg.channel_id,
2131 htlc_id: msg.htlc_id,
2132 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
2133 failure_code: $err_code,
2139 if let Err(_) = msg.onion_routing_packet.public_key {
2140 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2143 let shared_secret = SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key).secret_bytes();
2145 if msg.onion_routing_packet.version != 0 {
2146 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2147 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2148 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2149 //receiving node would have to brute force to figure out which version was put in the
2150 //packet by the node that send us the message, in the case of hashing the hop_data, the
2151 //node knows the HMAC matched, so they already know what is there...
2152 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2154 macro_rules! return_err {
2155 ($msg: expr, $err_code: expr, $data: expr) => {
2157 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2158 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2159 channel_id: msg.channel_id,
2160 htlc_id: msg.htlc_id,
2161 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
2167 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) {
2169 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2170 return_malformed_err!(err_msg, err_code);
2172 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2173 return_err!(err_msg, err_code, &[0; 0]);
2177 let pending_forward_info = match next_hop {
2178 onion_utils::Hop::Receive(next_hop_data) => {
2180 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash, msg.amount_msat, msg.cltv_expiry, None) {
2182 // Note that we could obviously respond immediately with an update_fulfill_htlc
2183 // message, however that would leak that we are the recipient of this payment, so
2184 // instead we stay symmetric with the forwarding case, only responding (after a
2185 // delay) once they've send us a commitment_signed!
2186 PendingHTLCStatus::Forward(info)
2188 Err(ReceiveError { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
2191 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
2192 let new_pubkey = msg.onion_routing_packet.public_key.unwrap();
2193 let outgoing_packet = msgs::OnionPacket {
2195 public_key: onion_utils::next_hop_packet_pubkey(&self.secp_ctx, new_pubkey, &shared_secret),
2196 hop_data: new_packet_bytes,
2197 hmac: next_hop_hmac.clone(),
2200 let short_channel_id = match next_hop_data.format {
2201 msgs::OnionHopDataFormat::Legacy { short_channel_id } => short_channel_id,
2202 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
2203 msgs::OnionHopDataFormat::FinalNode { .. } => {
2204 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
2208 PendingHTLCStatus::Forward(PendingHTLCInfo {
2209 routing: PendingHTLCRouting::Forward {
2210 onion_packet: outgoing_packet,
2213 payment_hash: msg.payment_hash.clone(),
2214 incoming_shared_secret: shared_secret,
2215 amt_to_forward: next_hop_data.amt_to_forward,
2216 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
2221 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
2222 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
2223 // with a short_channel_id of 0. This is important as various things later assume
2224 // short_channel_id is non-0 in any ::Forward.
2225 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
2226 if let Some((err, code, chan_update)) = loop {
2227 let mut channel_state = self.channel_state.lock().unwrap();
2228 let id_option = channel_state.short_to_chan_info.get(&short_channel_id).cloned();
2229 let forwarding_id_opt = match id_option {
2230 None => { // unknown_next_peer
2231 // Note that this is likely a timing oracle for detecting whether an scid is a
2233 if fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, *short_channel_id) {
2236 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2239 Some((_cp_id, chan_id)) => Some(chan_id.clone()),
2241 let chan_update_opt = if let Some(forwarding_id) = forwarding_id_opt {
2242 let chan = channel_state.by_id.get_mut(&forwarding_id).unwrap();
2243 if !chan.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
2244 // Note that the behavior here should be identical to the above block - we
2245 // should NOT reveal the existence or non-existence of a private channel if
2246 // we don't allow forwards outbound over them.
2247 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
2249 if chan.get_channel_type().supports_scid_privacy() && *short_channel_id != chan.outbound_scid_alias() {
2250 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
2251 // "refuse to forward unless the SCID alias was used", so we pretend
2252 // we don't have the channel here.
2253 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
2255 let chan_update_opt = self.get_channel_update_for_onion(*short_channel_id, chan).ok();
2257 // Note that we could technically not return an error yet here and just hope
2258 // that the connection is reestablished or monitor updated by the time we get
2259 // around to doing the actual forward, but better to fail early if we can and
2260 // hopefully an attacker trying to path-trace payments cannot make this occur
2261 // on a small/per-node/per-channel scale.
2262 if !chan.is_live() { // channel_disabled
2263 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, chan_update_opt));
2265 if *amt_to_forward < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
2266 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
2268 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, *amt_to_forward, *outgoing_cltv_value) {
2269 break Some((err, code, chan_update_opt));
2273 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
2275 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
2282 let cur_height = self.best_block.read().unwrap().height() + 1;
2283 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
2284 // but we want to be robust wrt to counterparty packet sanitization (see
2285 // HTLC_FAIL_BACK_BUFFER rationale).
2286 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
2287 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
2289 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
2290 break Some(("CLTV expiry is too far in the future", 21, None));
2292 // If the HTLC expires ~now, don't bother trying to forward it to our
2293 // counterparty. They should fail it anyway, but we don't want to bother with
2294 // the round-trips or risk them deciding they definitely want the HTLC and
2295 // force-closing to ensure they get it if we're offline.
2296 // We previously had a much more aggressive check here which tried to ensure
2297 // our counterparty receives an HTLC which has *our* risk threshold met on it,
2298 // but there is no need to do that, and since we're a bit conservative with our
2299 // risk threshold it just results in failing to forward payments.
2300 if (*outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
2301 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
2307 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
2308 if let Some(chan_update) = chan_update {
2309 if code == 0x1000 | 11 || code == 0x1000 | 12 {
2310 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
2312 else if code == 0x1000 | 13 {
2313 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
2315 else if code == 0x1000 | 20 {
2316 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
2317 0u16.write(&mut res).expect("Writes cannot fail");
2319 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
2320 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
2321 chan_update.write(&mut res).expect("Writes cannot fail");
2323 return_err!(err, code, &res.0[..]);
2328 pending_forward_info
2331 /// Gets the current channel_update for the given channel. This first checks if the channel is
2332 /// public, and thus should be called whenever the result is going to be passed out in a
2333 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
2335 /// May be called with channel_state already locked!
2336 fn get_channel_update_for_broadcast(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2337 if !chan.should_announce() {
2338 return Err(LightningError {
2339 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
2340 action: msgs::ErrorAction::IgnoreError
2343 if chan.get_short_channel_id().is_none() {
2344 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
2346 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.channel_id()));
2347 self.get_channel_update_for_unicast(chan)
2350 /// Gets the current channel_update for the given channel. This does not check if the channel
2351 /// is public (only returning an Err if the channel does not yet have an assigned short_id),
2352 /// and thus MUST NOT be called unless the recipient of the resulting message has already
2353 /// provided evidence that they know about the existence of the channel.
2354 /// May be called with channel_state already locked!
2355 fn get_channel_update_for_unicast(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2356 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.channel_id()));
2357 let short_channel_id = match chan.get_short_channel_id().or(chan.latest_inbound_scid_alias()) {
2358 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
2362 self.get_channel_update_for_onion(short_channel_id, chan)
2364 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2365 log_trace!(self.logger, "Generating channel update for channel {}", log_bytes!(chan.channel_id()));
2366 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
2368 let unsigned = msgs::UnsignedChannelUpdate {
2369 chain_hash: self.genesis_hash,
2371 timestamp: chan.get_update_time_counter(),
2372 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
2373 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
2374 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
2375 htlc_maximum_msat: chan.get_announced_htlc_max_msat(),
2376 fee_base_msat: chan.get_outbound_forwarding_fee_base_msat(),
2377 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
2378 excess_data: Vec::new(),
2381 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
2382 let sig = self.secp_ctx.sign_ecdsa(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
2384 Ok(msgs::ChannelUpdate {
2390 // Only public for testing, this should otherwise never be called direcly
2391 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>) -> Result<(), APIError> {
2392 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
2393 let prng_seed = self.keys_manager.get_secure_random_bytes();
2394 let session_priv_bytes = self.keys_manager.get_secure_random_bytes();
2395 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
2397 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
2398 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
2399 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
2400 if onion_utils::route_size_insane(&onion_payloads) {
2401 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
2403 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
2405 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2407 let err: Result<(), _> = loop {
2408 let mut channel_lock = self.channel_state.lock().unwrap();
2410 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
2411 let payment_entry = pending_outbounds.entry(payment_id);
2412 if let hash_map::Entry::Occupied(payment) = &payment_entry {
2413 if !payment.get().is_retryable() {
2414 return Err(APIError::RouteError {
2415 err: "Payment already completed"
2420 let id = match channel_lock.short_to_chan_info.get(&path.first().unwrap().short_channel_id) {
2421 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
2422 Some((_cp_id, chan_id)) => chan_id.clone(),
2425 macro_rules! insert_outbound_payment {
2427 let payment = payment_entry.or_insert_with(|| PendingOutboundPayment::Retryable {
2428 session_privs: HashSet::new(),
2429 pending_amt_msat: 0,
2430 pending_fee_msat: Some(0),
2431 payment_hash: *payment_hash,
2432 payment_secret: *payment_secret,
2433 starting_block_height: self.best_block.read().unwrap().height(),
2434 total_msat: total_value,
2436 assert!(payment.insert(session_priv_bytes, path));
2440 let channel_state = &mut *channel_lock;
2441 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
2443 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
2444 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
2446 if !chan.get().is_live() {
2447 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
2449 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(
2450 htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
2452 session_priv: session_priv.clone(),
2453 first_hop_htlc_msat: htlc_msat,
2455 payment_secret: payment_secret.clone(),
2456 payment_params: payment_params.clone(),
2457 }, onion_packet, &self.logger),
2458 channel_state, chan)
2460 Some((update_add, commitment_signed, monitor_update)) => {
2461 let update_err = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update);
2462 let chan_id = chan.get().channel_id();
2464 handle_monitor_err!(self, update_err, channel_state, chan,
2465 RAACommitmentOrder::CommitmentFirst, false, true))
2467 (ChannelMonitorUpdateStatus::PermanentFailure, Err(e)) => break Err(e),
2468 (ChannelMonitorUpdateStatus::Completed, Ok(())) => {
2469 insert_outbound_payment!();
2471 (ChannelMonitorUpdateStatus::InProgress, Err(_)) => {
2472 // Note that MonitorUpdateFailed here indicates (per function docs)
2473 // that we will resend the commitment update once monitor updating
2474 // is restored. Therefore, we must return an error indicating that
2475 // it is unsafe to retry the payment wholesale, which we do in the
2476 // send_payment check for MonitorUpdateFailed, below.
2477 insert_outbound_payment!(); // Only do this after possibly break'ing on Perm failure above.
2478 return Err(APIError::MonitorUpdateFailed);
2480 _ => unreachable!(),
2483 log_debug!(self.logger, "Sending payment along path resulted in a commitment_signed for channel {}", log_bytes!(chan_id));
2484 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2485 node_id: path.first().unwrap().pubkey,
2486 updates: msgs::CommitmentUpdate {
2487 update_add_htlcs: vec![update_add],
2488 update_fulfill_htlcs: Vec::new(),
2489 update_fail_htlcs: Vec::new(),
2490 update_fail_malformed_htlcs: Vec::new(),
2496 None => { insert_outbound_payment!(); },
2498 } else { unreachable!(); }
2502 match handle_error!(self, err, path.first().unwrap().pubkey) {
2503 Ok(_) => unreachable!(),
2505 Err(APIError::ChannelUnavailable { err: e.err })
2510 /// Sends a payment along a given route.
2512 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
2513 /// fields for more info.
2515 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
2516 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
2517 /// next hop knows the preimage to payment_hash they can claim an additional amount as
2518 /// specified in the last hop in the route! Thus, you should probably do your own
2519 /// payment_preimage tracking (which you should already be doing as they represent "proof of
2520 /// payment") and prevent double-sends yourself.
2522 /// May generate SendHTLCs message(s) event on success, which should be relayed.
2524 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
2525 /// each entry matching the corresponding-index entry in the route paths, see
2526 /// PaymentSendFailure for more info.
2528 /// In general, a path may raise:
2529 /// * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
2530 /// node public key) is specified.
2531 /// * APIError::ChannelUnavailable if the next-hop channel is not available for updates
2532 /// (including due to previous monitor update failure or new permanent monitor update
2534 /// * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
2535 /// relevant updates.
2537 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
2538 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
2539 /// different route unless you intend to pay twice!
2541 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
2542 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
2543 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
2544 /// must not contain multiple paths as multi-path payments require a recipient-provided
2546 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
2547 /// bit set (either as required or as available). If multiple paths are present in the Route,
2548 /// we assume the invoice had the basic_mpp feature set.
2549 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>) -> Result<PaymentId, PaymentSendFailure> {
2550 self.send_payment_internal(route, payment_hash, payment_secret, None, None, None)
2553 fn send_payment_internal(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, keysend_preimage: Option<PaymentPreimage>, payment_id: Option<PaymentId>, recv_value_msat: Option<u64>) -> Result<PaymentId, PaymentSendFailure> {
2554 if route.paths.len() < 1 {
2555 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
2557 if payment_secret.is_none() && route.paths.len() > 1 {
2558 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
2560 let mut total_value = 0;
2561 let our_node_id = self.get_our_node_id();
2562 let mut path_errs = Vec::with_capacity(route.paths.len());
2563 let payment_id = if let Some(id) = payment_id { id } else { PaymentId(self.keys_manager.get_secure_random_bytes()) };
2564 'path_check: for path in route.paths.iter() {
2565 if path.len() < 1 || path.len() > 20 {
2566 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
2567 continue 'path_check;
2569 for (idx, hop) in path.iter().enumerate() {
2570 if idx != path.len() - 1 && hop.pubkey == our_node_id {
2571 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
2572 continue 'path_check;
2575 total_value += path.last().unwrap().fee_msat;
2576 path_errs.push(Ok(()));
2578 if path_errs.iter().any(|e| e.is_err()) {
2579 return Err(PaymentSendFailure::PathParameterError(path_errs));
2581 if let Some(amt_msat) = recv_value_msat {
2582 debug_assert!(amt_msat >= total_value);
2583 total_value = amt_msat;
2586 let cur_height = self.best_block.read().unwrap().height() + 1;
2587 let mut results = Vec::new();
2588 for path in route.paths.iter() {
2589 results.push(self.send_payment_along_path(&path, &route.payment_params, &payment_hash, payment_secret, total_value, cur_height, payment_id, &keysend_preimage));
2591 let mut has_ok = false;
2592 let mut has_err = false;
2593 let mut pending_amt_unsent = 0;
2594 let mut max_unsent_cltv_delta = 0;
2595 for (res, path) in results.iter().zip(route.paths.iter()) {
2596 if res.is_ok() { has_ok = true; }
2597 if res.is_err() { has_err = true; }
2598 if let &Err(APIError::MonitorUpdateFailed) = res {
2599 // MonitorUpdateFailed is inherently unsafe to retry, so we call it a
2603 } else if res.is_err() {
2604 pending_amt_unsent += path.last().unwrap().fee_msat;
2605 max_unsent_cltv_delta = cmp::max(max_unsent_cltv_delta, path.last().unwrap().cltv_expiry_delta);
2608 if has_err && has_ok {
2609 Err(PaymentSendFailure::PartialFailure {
2612 failed_paths_retry: if pending_amt_unsent != 0 {
2613 if let Some(payment_params) = &route.payment_params {
2614 Some(RouteParameters {
2615 payment_params: payment_params.clone(),
2616 final_value_msat: pending_amt_unsent,
2617 final_cltv_expiry_delta: max_unsent_cltv_delta,
2623 // If we failed to send any paths, we shouldn't have inserted the new PaymentId into
2624 // our `pending_outbound_payments` map at all.
2625 debug_assert!(self.pending_outbound_payments.lock().unwrap().get(&payment_id).is_none());
2626 Err(PaymentSendFailure::AllFailedRetrySafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
2632 /// Retries a payment along the given [`Route`].
2634 /// Errors returned are a superset of those returned from [`send_payment`], so see
2635 /// [`send_payment`] documentation for more details on errors. This method will also error if the
2636 /// retry amount puts the payment more than 10% over the payment's total amount, if the payment
2637 /// for the given `payment_id` cannot be found (likely due to timeout or success), or if
2638 /// further retries have been disabled with [`abandon_payment`].
2640 /// [`send_payment`]: [`ChannelManager::send_payment`]
2641 /// [`abandon_payment`]: [`ChannelManager::abandon_payment`]
2642 pub fn retry_payment(&self, route: &Route, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2643 const RETRY_OVERFLOW_PERCENTAGE: u64 = 10;
2644 for path in route.paths.iter() {
2645 if path.len() == 0 {
2646 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2647 err: "length-0 path in route".to_string()
2652 let (total_msat, payment_hash, payment_secret) = {
2653 let outbounds = self.pending_outbound_payments.lock().unwrap();
2654 if let Some(payment) = outbounds.get(&payment_id) {
2656 PendingOutboundPayment::Retryable {
2657 total_msat, payment_hash, payment_secret, pending_amt_msat, ..
2659 let retry_amt_msat: u64 = route.paths.iter().map(|path| path.last().unwrap().fee_msat).sum();
2660 if retry_amt_msat + *pending_amt_msat > *total_msat * (100 + RETRY_OVERFLOW_PERCENTAGE) / 100 {
2661 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2662 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()
2665 (*total_msat, *payment_hash, *payment_secret)
2667 PendingOutboundPayment::Legacy { .. } => {
2668 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2669 err: "Unable to retry payments that were initially sent on LDK versions prior to 0.0.102".to_string()
2672 PendingOutboundPayment::Fulfilled { .. } => {
2673 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2674 err: "Payment already completed".to_owned()
2677 PendingOutboundPayment::Abandoned { .. } => {
2678 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2679 err: "Payment already abandoned (with some HTLCs still pending)".to_owned()
2684 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2685 err: format!("Payment with ID {} not found", log_bytes!(payment_id.0)),
2689 return self.send_payment_internal(route, payment_hash, &payment_secret, None, Some(payment_id), Some(total_msat)).map(|_| ())
2692 /// Signals that no further retries for the given payment will occur.
2694 /// After this method returns, any future calls to [`retry_payment`] for the given `payment_id`
2695 /// will fail with [`PaymentSendFailure::ParameterError`]. If no such event has been generated,
2696 /// an [`Event::PaymentFailed`] event will be generated as soon as there are no remaining
2697 /// pending HTLCs for this payment.
2699 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
2700 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
2701 /// determine the ultimate status of a payment.
2703 /// [`retry_payment`]: Self::retry_payment
2704 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
2705 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2706 pub fn abandon_payment(&self, payment_id: PaymentId) {
2707 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2709 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
2710 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
2711 if let Ok(()) = payment.get_mut().mark_abandoned() {
2712 if payment.get().remaining_parts() == 0 {
2713 self.pending_events.lock().unwrap().push(events::Event::PaymentFailed {
2715 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
2723 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
2724 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
2725 /// the preimage, it must be a cryptographically secure random value that no intermediate node
2726 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
2727 /// never reach the recipient.
2729 /// See [`send_payment`] documentation for more details on the return value of this function.
2731 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
2732 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
2734 /// Note that `route` must have exactly one path.
2736 /// [`send_payment`]: Self::send_payment
2737 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
2738 let preimage = match payment_preimage {
2740 None => PaymentPreimage(self.keys_manager.get_secure_random_bytes()),
2742 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
2743 match self.send_payment_internal(route, payment_hash, &None, Some(preimage), None, None) {
2744 Ok(payment_id) => Ok((payment_hash, payment_id)),
2749 /// Send a payment that is probing the given route for liquidity. We calculate the
2750 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
2751 /// us to easily discern them from real payments.
2752 pub fn send_probe(&self, hops: Vec<RouteHop>) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
2753 let payment_id = PaymentId(self.keys_manager.get_secure_random_bytes());
2755 let payment_hash = self.probing_cookie_from_id(&payment_id);
2758 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2759 err: "No need probing a path with less than two hops".to_string()
2763 let route = Route { paths: vec![hops], payment_params: None };
2765 match self.send_payment_internal(&route, payment_hash, &None, None, Some(payment_id), None) {
2766 Ok(payment_id) => Ok((payment_hash, payment_id)),
2771 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
2773 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
2774 let target_payment_hash = self.probing_cookie_from_id(payment_id);
2775 target_payment_hash == *payment_hash
2778 /// Returns the 'probing cookie' for the given [`PaymentId`].
2779 fn probing_cookie_from_id(&self, payment_id: &PaymentId) -> PaymentHash {
2780 let mut preimage = [0u8; 64];
2781 preimage[..32].copy_from_slice(&self.probing_cookie_secret);
2782 preimage[32..].copy_from_slice(&payment_id.0);
2783 PaymentHash(Sha256::hash(&preimage).into_inner())
2786 /// Handles the generation of a funding transaction, optionally (for tests) with a function
2787 /// which checks the correctness of the funding transaction given the associated channel.
2788 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<Signer>, &Transaction) -> Result<OutPoint, APIError>>(
2789 &self, temporary_channel_id: &[u8; 32], _counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
2790 ) -> Result<(), APIError> {
2792 let (res, chan) = match self.channel_state.lock().unwrap().by_id.remove(temporary_channel_id) {
2794 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
2796 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
2797 .map_err(|e| if let ChannelError::Close(msg) = e {
2798 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.get_user_id(), chan.force_shutdown(true), None)
2799 } else { unreachable!(); })
2802 None => { return Err(APIError::ChannelUnavailable { err: "No such channel".to_owned() }) },
2804 match handle_error!(self, res, chan.get_counterparty_node_id()) {
2805 Ok(funding_msg) => {
2808 Err(_) => { return Err(APIError::ChannelUnavailable {
2809 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()
2814 let mut channel_state = self.channel_state.lock().unwrap();
2815 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
2816 node_id: chan.get_counterparty_node_id(),
2819 match channel_state.by_id.entry(chan.channel_id()) {
2820 hash_map::Entry::Occupied(_) => {
2821 panic!("Generated duplicate funding txid?");
2823 hash_map::Entry::Vacant(e) => {
2824 let mut id_to_peer = self.id_to_peer.lock().unwrap();
2825 if id_to_peer.insert(chan.channel_id(), chan.get_counterparty_node_id()).is_some() {
2826 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
2835 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> {
2836 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
2837 Ok(OutPoint { txid: tx.txid(), index: output_index })
2841 /// Call this upon creation of a funding transaction for the given channel.
2843 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
2844 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
2846 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
2847 /// across the p2p network.
2849 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
2850 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
2852 /// May panic if the output found in the funding transaction is duplicative with some other
2853 /// channel (note that this should be trivially prevented by using unique funding transaction
2854 /// keys per-channel).
2856 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
2857 /// counterparty's signature the funding transaction will automatically be broadcast via the
2858 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
2860 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
2861 /// not currently support replacing a funding transaction on an existing channel. Instead,
2862 /// create a new channel with a conflicting funding transaction.
2864 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
2865 /// the wallet software generating the funding transaction to apply anti-fee sniping as
2866 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
2867 /// for more details.
2869 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
2870 /// [`Event::ChannelClosed`]: crate::util::events::Event::ChannelClosed
2871 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
2872 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2874 for inp in funding_transaction.input.iter() {
2875 if inp.witness.is_empty() {
2876 return Err(APIError::APIMisuseError {
2877 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
2882 let height = self.best_block.read().unwrap().height();
2883 // Transactions are evaluated as final by network mempools at the next block. However, the modules
2884 // constituting our Lightning node might not have perfect sync about their blockchain views. Thus, if
2885 // the wallet module is in advance on the LDK view, allow one more block of headroom.
2886 // TODO: updated if/when https://github.com/rust-bitcoin/rust-bitcoin/pull/994 landed and rust-bitcoin bumped.
2887 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 {
2888 return Err(APIError::APIMisuseError {
2889 err: "Funding transaction absolute timelock is non-final".to_owned()
2893 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
2894 let mut output_index = None;
2895 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
2896 for (idx, outp) in tx.output.iter().enumerate() {
2897 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
2898 if output_index.is_some() {
2899 return Err(APIError::APIMisuseError {
2900 err: "Multiple outputs matched the expected script and value".to_owned()
2903 if idx > u16::max_value() as usize {
2904 return Err(APIError::APIMisuseError {
2905 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
2908 output_index = Some(idx as u16);
2911 if output_index.is_none() {
2912 return Err(APIError::APIMisuseError {
2913 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
2916 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
2920 /// Atomically updates the [`ChannelConfig`] for the given channels.
2922 /// Once the updates are applied, each eligible channel (advertised with a known short channel
2923 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
2924 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
2925 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
2927 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
2928 /// `counterparty_node_id` is provided.
2930 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
2931 /// below [`MIN_CLTV_EXPIRY_DELTA`].
2933 /// If an error is returned, none of the updates should be considered applied.
2935 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
2936 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
2937 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
2938 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
2939 /// [`ChannelUpdate`]: msgs::ChannelUpdate
2940 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
2941 /// [`APIMisuseError`]: APIError::APIMisuseError
2942 pub fn update_channel_config(
2943 &self, counterparty_node_id: &PublicKey, channel_ids: &[[u8; 32]], config: &ChannelConfig,
2944 ) -> Result<(), APIError> {
2945 if config.cltv_expiry_delta < MIN_CLTV_EXPIRY_DELTA {
2946 return Err(APIError::APIMisuseError {
2947 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
2951 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(
2952 &self.total_consistency_lock, &self.persistence_notifier,
2955 let mut channel_state_lock = self.channel_state.lock().unwrap();
2956 let channel_state = &mut *channel_state_lock;
2957 for channel_id in channel_ids {
2958 let channel_counterparty_node_id = channel_state.by_id.get(channel_id)
2959 .ok_or(APIError::ChannelUnavailable {
2960 err: format!("Channel with ID {} was not found", log_bytes!(*channel_id)),
2962 .get_counterparty_node_id();
2963 if channel_counterparty_node_id != *counterparty_node_id {
2964 return Err(APIError::APIMisuseError {
2965 err: "counterparty node id mismatch".to_owned(),
2969 for channel_id in channel_ids {
2970 let channel = channel_state.by_id.get_mut(channel_id).unwrap();
2971 if !channel.update_config(config) {
2974 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
2975 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
2976 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
2977 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
2978 node_id: channel.get_counterparty_node_id(),
2987 /// Processes HTLCs which are pending waiting on random forward delay.
2989 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
2990 /// Will likely generate further events.
2991 pub fn process_pending_htlc_forwards(&self) {
2992 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2994 let mut new_events = Vec::new();
2995 let mut failed_forwards = Vec::new();
2996 let mut phantom_receives: Vec<(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
2997 let mut handle_errors = Vec::new();
2999 let mut channel_state_lock = self.channel_state.lock().unwrap();
3000 let channel_state = &mut *channel_state_lock;
3002 for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
3003 if short_chan_id != 0 {
3004 let forward_chan_id = match channel_state.short_to_chan_info.get(&short_chan_id) {
3005 Some((_cp_id, chan_id)) => chan_id.clone(),
3007 for forward_info in pending_forwards.drain(..) {
3008 match forward_info {
3009 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
3010 routing, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value },
3011 prev_funding_outpoint } => {
3012 macro_rules! failure_handler {
3013 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
3014 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3016 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3017 short_channel_id: prev_short_channel_id,
3018 outpoint: prev_funding_outpoint,
3019 htlc_id: prev_htlc_id,
3020 incoming_packet_shared_secret: incoming_shared_secret,
3021 phantom_shared_secret: $phantom_ss,
3024 let reason = if $next_hop_unknown {
3025 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
3027 HTLCDestination::FailedPayment{ payment_hash }
3030 failed_forwards.push((htlc_source, payment_hash,
3031 HTLCFailReason::Reason { failure_code: $err_code, data: $err_data },
3037 macro_rules! fail_forward {
3038 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3040 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
3044 macro_rules! failed_payment {
3045 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3047 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
3051 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
3052 let phantom_secret_res = self.keys_manager.get_node_secret(Recipient::PhantomNode);
3053 if phantom_secret_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id) {
3054 let phantom_shared_secret = SharedSecret::new(&onion_packet.public_key.unwrap(), &phantom_secret_res.unwrap()).secret_bytes();
3055 let next_hop = match onion_utils::decode_next_payment_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
3057 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
3058 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
3059 // In this scenario, the phantom would have sent us an
3060 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
3061 // if it came from us (the second-to-last hop) but contains the sha256
3063 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
3065 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3066 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
3070 onion_utils::Hop::Receive(hop_data) => {
3071 match self.construct_recv_pending_htlc_info(hop_data, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value, Some(phantom_shared_secret)) {
3072 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, vec![(info, prev_htlc_id)])),
3073 Err(ReceiveError { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
3079 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3082 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3085 HTLCForwardInfo::FailHTLC { .. } => {
3086 // Channel went away before we could fail it. This implies
3087 // the channel is now on chain and our counterparty is
3088 // trying to broadcast the HTLC-Timeout, but that's their
3089 // problem, not ours.
3096 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
3097 let mut add_htlc_msgs = Vec::new();
3098 let mut fail_htlc_msgs = Vec::new();
3099 for forward_info in pending_forwards.drain(..) {
3100 match forward_info {
3101 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
3102 routing: PendingHTLCRouting::Forward {
3104 }, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value },
3105 prev_funding_outpoint } => {
3106 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);
3107 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3108 short_channel_id: prev_short_channel_id,
3109 outpoint: prev_funding_outpoint,
3110 htlc_id: prev_htlc_id,
3111 incoming_packet_shared_secret: incoming_shared_secret,
3112 // Phantom payments are only PendingHTLCRouting::Receive.
3113 phantom_shared_secret: None,
3115 match chan.get_mut().send_htlc(amt_to_forward, payment_hash, outgoing_cltv_value, htlc_source.clone(), onion_packet, &self.logger) {
3117 if let ChannelError::Ignore(msg) = e {
3118 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
3120 panic!("Stated return value requirements in send_htlc() were not met");
3122 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan.get());
3123 failed_forwards.push((htlc_source, payment_hash,
3124 HTLCFailReason::Reason { failure_code, data },
3125 HTLCDestination::NextHopChannel { node_id: Some(chan.get().get_counterparty_node_id()), channel_id: forward_chan_id }
3131 Some(msg) => { add_htlc_msgs.push(msg); },
3133 // Nothing to do here...we're waiting on a remote
3134 // revoke_and_ack before we can add anymore HTLCs. The Channel
3135 // will automatically handle building the update_add_htlc and
3136 // commitment_signed messages when we can.
3137 // TODO: Do some kind of timer to set the channel as !is_live()
3138 // as we don't really want others relying on us relaying through
3139 // this channel currently :/.
3145 HTLCForwardInfo::AddHTLC { .. } => {
3146 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
3148 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
3149 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
3150 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet, &self.logger) {
3152 if let ChannelError::Ignore(msg) = e {
3153 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
3155 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
3157 // fail-backs are best-effort, we probably already have one
3158 // pending, and if not that's OK, if not, the channel is on
3159 // the chain and sending the HTLC-Timeout is their problem.
3162 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
3164 // Nothing to do here...we're waiting on a remote
3165 // revoke_and_ack before we can update the commitment
3166 // transaction. The Channel will automatically handle
3167 // building the update_fail_htlc and commitment_signed
3168 // messages when we can.
3169 // We don't need any kind of timer here as they should fail
3170 // the channel onto the chain if they can't get our
3171 // update_fail_htlc in time, it's not our problem.
3178 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
3179 let (commitment_msg, monitor_update) = match chan.get_mut().send_commitment(&self.logger) {
3182 // We surely failed send_commitment due to bad keys, in that case
3183 // close channel and then send error message to peer.
3184 let counterparty_node_id = chan.get().get_counterparty_node_id();
3185 let err: Result<(), _> = match e {
3186 ChannelError::Ignore(_) | ChannelError::Warn(_) => {
3187 panic!("Stated return value requirements in send_commitment() were not met");
3189 ChannelError::Close(msg) => {
3190 log_trace!(self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
3191 let mut channel = remove_channel!(self, channel_state, chan);
3192 // ChannelClosed event is generated by handle_error for us.
3193 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()))
3196 handle_errors.push((counterparty_node_id, err));
3200 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3201 ChannelMonitorUpdateStatus::Completed => {},
3203 handle_errors.push((chan.get().get_counterparty_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
3207 log_debug!(self.logger, "Forwarding HTLCs resulted in a commitment update with {} HTLCs added and {} HTLCs failed for channel {}",
3208 add_htlc_msgs.len(), fail_htlc_msgs.len(), log_bytes!(chan.get().channel_id()));
3209 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3210 node_id: chan.get().get_counterparty_node_id(),
3211 updates: msgs::CommitmentUpdate {
3212 update_add_htlcs: add_htlc_msgs,
3213 update_fulfill_htlcs: Vec::new(),
3214 update_fail_htlcs: fail_htlc_msgs,
3215 update_fail_malformed_htlcs: Vec::new(),
3217 commitment_signed: commitment_msg,
3225 for forward_info in pending_forwards.drain(..) {
3226 match forward_info {
3227 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
3228 routing, incoming_shared_secret, payment_hash, amt_to_forward, .. },
3229 prev_funding_outpoint } => {
3230 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret) = match routing {
3231 PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry, phantom_shared_secret } => {
3232 let _legacy_hop_data = Some(payment_data.clone());
3233 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data }, Some(payment_data), phantom_shared_secret)
3235 PendingHTLCRouting::ReceiveKeysend { payment_preimage, incoming_cltv_expiry } =>
3236 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage), None, None),
3238 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
3241 let claimable_htlc = ClaimableHTLC {
3242 prev_hop: HTLCPreviousHopData {
3243 short_channel_id: prev_short_channel_id,
3244 outpoint: prev_funding_outpoint,
3245 htlc_id: prev_htlc_id,
3246 incoming_packet_shared_secret: incoming_shared_secret,
3247 phantom_shared_secret,
3249 value: amt_to_forward,
3251 total_msat: if let Some(data) = &payment_data { data.total_msat } else { amt_to_forward },
3256 macro_rules! fail_htlc {
3257 ($htlc: expr, $payment_hash: expr) => {
3258 let mut htlc_msat_height_data = byte_utils::be64_to_array($htlc.value).to_vec();
3259 htlc_msat_height_data.extend_from_slice(
3260 &byte_utils::be32_to_array(self.best_block.read().unwrap().height()),
3262 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
3263 short_channel_id: $htlc.prev_hop.short_channel_id,
3264 outpoint: prev_funding_outpoint,
3265 htlc_id: $htlc.prev_hop.htlc_id,
3266 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
3267 phantom_shared_secret,
3269 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data },
3270 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
3275 macro_rules! check_total_value {
3276 ($payment_data: expr, $payment_preimage: expr) => {{
3277 let mut payment_received_generated = false;
3279 events::PaymentPurpose::InvoicePayment {
3280 payment_preimage: $payment_preimage,
3281 payment_secret: $payment_data.payment_secret,
3284 let (_, htlcs) = channel_state.claimable_htlcs.entry(payment_hash)
3285 .or_insert_with(|| (purpose(), Vec::new()));
3286 if htlcs.len() == 1 {
3287 if let OnionPayload::Spontaneous(_) = htlcs[0].onion_payload {
3288 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));
3289 fail_htlc!(claimable_htlc, payment_hash);
3293 let mut total_value = claimable_htlc.value;
3294 for htlc in htlcs.iter() {
3295 total_value += htlc.value;
3296 match &htlc.onion_payload {
3297 OnionPayload::Invoice { .. } => {
3298 if htlc.total_msat != $payment_data.total_msat {
3299 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
3300 log_bytes!(payment_hash.0), $payment_data.total_msat, htlc.total_msat);
3301 total_value = msgs::MAX_VALUE_MSAT;
3303 if total_value >= msgs::MAX_VALUE_MSAT { break; }
3305 _ => unreachable!(),
3308 if total_value >= msgs::MAX_VALUE_MSAT || total_value > $payment_data.total_msat {
3309 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
3310 log_bytes!(payment_hash.0), total_value, $payment_data.total_msat);
3311 fail_htlc!(claimable_htlc, payment_hash);
3312 } else if total_value == $payment_data.total_msat {
3313 htlcs.push(claimable_htlc);
3314 new_events.push(events::Event::PaymentReceived {
3317 amount_msat: total_value,
3319 payment_received_generated = true;
3321 // Nothing to do - we haven't reached the total
3322 // payment value yet, wait until we receive more
3324 htlcs.push(claimable_htlc);
3326 payment_received_generated
3330 // Check that the payment hash and secret are known. Note that we
3331 // MUST take care to handle the "unknown payment hash" and
3332 // "incorrect payment secret" cases here identically or we'd expose
3333 // that we are the ultimate recipient of the given payment hash.
3334 // Further, we must not expose whether we have any other HTLCs
3335 // associated with the same payment_hash pending or not.
3336 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
3337 match payment_secrets.entry(payment_hash) {
3338 hash_map::Entry::Vacant(_) => {
3339 match claimable_htlc.onion_payload {
3340 OnionPayload::Invoice { .. } => {
3341 let payment_data = payment_data.unwrap();
3342 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) {
3343 Ok(payment_preimage) => payment_preimage,
3345 fail_htlc!(claimable_htlc, payment_hash);
3349 check_total_value!(payment_data, payment_preimage);
3351 OnionPayload::Spontaneous(preimage) => {
3352 match channel_state.claimable_htlcs.entry(payment_hash) {
3353 hash_map::Entry::Vacant(e) => {
3354 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
3355 e.insert((purpose.clone(), vec![claimable_htlc]));
3356 new_events.push(events::Event::PaymentReceived {
3358 amount_msat: amt_to_forward,
3362 hash_map::Entry::Occupied(_) => {
3363 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
3364 fail_htlc!(claimable_htlc, payment_hash);
3370 hash_map::Entry::Occupied(inbound_payment) => {
3371 if payment_data.is_none() {
3372 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));
3373 fail_htlc!(claimable_htlc, payment_hash);
3376 let payment_data = payment_data.unwrap();
3377 if inbound_payment.get().payment_secret != payment_data.payment_secret {
3378 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
3379 fail_htlc!(claimable_htlc, payment_hash);
3380 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
3381 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
3382 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
3383 fail_htlc!(claimable_htlc, payment_hash);
3385 let payment_received_generated = check_total_value!(payment_data, inbound_payment.get().payment_preimage);
3386 if payment_received_generated {
3387 inbound_payment.remove_entry();
3393 HTLCForwardInfo::FailHTLC { .. } => {
3394 panic!("Got pending fail of our own HTLC");
3402 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
3403 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, failure_reason, destination);
3405 self.forward_htlcs(&mut phantom_receives);
3407 for (counterparty_node_id, err) in handle_errors.drain(..) {
3408 let _ = handle_error!(self, err, counterparty_node_id);
3411 if new_events.is_empty() { return }
3412 let mut events = self.pending_events.lock().unwrap();
3413 events.append(&mut new_events);
3416 /// Free the background events, generally called from timer_tick_occurred.
3418 /// Exposed for testing to allow us to process events quickly without generating accidental
3419 /// BroadcastChannelUpdate events in timer_tick_occurred.
3421 /// Expects the caller to have a total_consistency_lock read lock.
3422 fn process_background_events(&self) -> bool {
3423 let mut background_events = Vec::new();
3424 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
3425 if background_events.is_empty() {
3429 for event in background_events.drain(..) {
3431 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
3432 // The channel has already been closed, so no use bothering to care about the
3433 // monitor updating completing.
3434 let _ = self.chain_monitor.update_channel(funding_txo, update);
3441 #[cfg(any(test, feature = "_test_utils"))]
3442 /// Process background events, for functional testing
3443 pub fn test_process_background_events(&self) {
3444 self.process_background_events();
3447 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<Signer>, new_feerate: u32) -> (bool, NotifyOption, Result<(), MsgHandleErrInternal>) {
3448 if !chan.is_outbound() { return (true, NotifyOption::SkipPersist, Ok(())); }
3449 // If the feerate has decreased by less than half, don't bother
3450 if new_feerate <= chan.get_feerate() && new_feerate * 2 > chan.get_feerate() {
3451 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
3452 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3453 return (true, NotifyOption::SkipPersist, Ok(()));
3455 if !chan.is_live() {
3456 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).",
3457 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3458 return (true, NotifyOption::SkipPersist, Ok(()));
3460 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
3461 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3463 let mut retain_channel = true;
3464 let res = match chan.send_update_fee_and_commit(new_feerate, &self.logger) {
3467 let (drop, res) = convert_chan_err!(self, e, short_to_chan_info, chan, chan_id);
3468 if drop { retain_channel = false; }
3472 let ret_err = match res {
3473 Ok(Some((update_fee, commitment_signed, monitor_update))) => {
3474 match self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
3475 ChannelMonitorUpdateStatus::Completed => {
3476 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3477 node_id: chan.get_counterparty_node_id(),
3478 updates: msgs::CommitmentUpdate {
3479 update_add_htlcs: Vec::new(),
3480 update_fulfill_htlcs: Vec::new(),
3481 update_fail_htlcs: Vec::new(),
3482 update_fail_malformed_htlcs: Vec::new(),
3483 update_fee: Some(update_fee),
3490 let (res, drop) = handle_monitor_err!(self, e, short_to_chan_info, chan, RAACommitmentOrder::CommitmentFirst, chan_id, COMMITMENT_UPDATE_ONLY);
3491 if drop { retain_channel = false; }
3499 (retain_channel, NotifyOption::DoPersist, ret_err)
3503 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
3504 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
3505 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
3506 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
3507 pub fn maybe_update_chan_fees(&self) {
3508 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3509 let mut should_persist = NotifyOption::SkipPersist;
3511 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3513 let mut handle_errors = Vec::new();
3515 let mut channel_state_lock = self.channel_state.lock().unwrap();
3516 let channel_state = &mut *channel_state_lock;
3517 let pending_msg_events = &mut channel_state.pending_msg_events;
3518 let short_to_chan_info = &mut channel_state.short_to_chan_info;
3519 channel_state.by_id.retain(|chan_id, chan| {
3520 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(short_to_chan_info, pending_msg_events, chan_id, chan, new_feerate);
3521 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3523 handle_errors.push(err);
3533 /// Performs actions which should happen on startup and roughly once per minute thereafter.
3535 /// This currently includes:
3536 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
3537 /// * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
3538 /// than a minute, informing the network that they should no longer attempt to route over
3540 /// * Expiring a channel's previous `ChannelConfig` if necessary to only allow forwarding HTLCs
3541 /// with the current `ChannelConfig`.
3543 /// Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
3544 /// estimate fetches.
3545 pub fn timer_tick_occurred(&self) {
3546 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3547 let mut should_persist = NotifyOption::SkipPersist;
3548 if self.process_background_events() { should_persist = NotifyOption::DoPersist; }
3550 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3552 let mut handle_errors = Vec::new();
3553 let mut timed_out_mpp_htlcs = Vec::new();
3555 let mut channel_state_lock = self.channel_state.lock().unwrap();
3556 let channel_state = &mut *channel_state_lock;
3557 let pending_msg_events = &mut channel_state.pending_msg_events;
3558 let short_to_chan_info = &mut channel_state.short_to_chan_info;
3559 channel_state.by_id.retain(|chan_id, chan| {
3560 let counterparty_node_id = chan.get_counterparty_node_id();
3561 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(short_to_chan_info, pending_msg_events, chan_id, chan, new_feerate);
3562 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3564 handle_errors.push((err, counterparty_node_id));
3566 if !retain_channel { return false; }
3568 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
3569 let (needs_close, err) = convert_chan_err!(self, e, short_to_chan_info, chan, chan_id);
3570 handle_errors.push((Err(err), chan.get_counterparty_node_id()));
3571 if needs_close { return false; }
3574 match chan.channel_update_status() {
3575 ChannelUpdateStatus::Enabled if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged),
3576 ChannelUpdateStatus::Disabled if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged),
3577 ChannelUpdateStatus::DisabledStaged if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
3578 ChannelUpdateStatus::EnabledStaged if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
3579 ChannelUpdateStatus::DisabledStaged if !chan.is_live() => {
3580 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3581 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3585 should_persist = NotifyOption::DoPersist;
3586 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
3588 ChannelUpdateStatus::EnabledStaged if chan.is_live() => {
3589 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3590 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3594 should_persist = NotifyOption::DoPersist;
3595 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
3600 chan.maybe_expire_prev_config();
3605 channel_state.claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
3606 if htlcs.is_empty() {
3607 // This should be unreachable
3608 debug_assert!(false);
3611 if let OnionPayload::Invoice { .. } = htlcs[0].onion_payload {
3612 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
3613 // In this case we're not going to handle any timeouts of the parts here.
3614 if htlcs[0].total_msat == htlcs.iter().fold(0, |total, htlc| total + htlc.value) {
3616 } else if htlcs.into_iter().any(|htlc| {
3617 htlc.timer_ticks += 1;
3618 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
3620 timed_out_mpp_htlcs.extend(htlcs.into_iter().map(|htlc| (htlc.prev_hop.clone(), payment_hash.clone())));
3628 for htlc_source in timed_out_mpp_htlcs.drain(..) {
3629 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
3630 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), HTLCSource::PreviousHopData(htlc_source.0.clone()), &htlc_source.1, HTLCFailReason::Reason { failure_code: 23, data: Vec::new() }, receiver );
3633 for (err, counterparty_node_id) in handle_errors.drain(..) {
3634 let _ = handle_error!(self, err, counterparty_node_id);
3640 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
3641 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
3642 /// along the path (including in our own channel on which we received it).
3644 /// Note that in some cases around unclean shutdown, it is possible the payment may have
3645 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
3646 /// second copy of) the [`events::Event::PaymentReceived`] event. Alternatively, the payment
3647 /// may have already been failed automatically by LDK if it was nearing its expiration time.
3649 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
3650 /// [`ChannelManager::claim_funds`]), you should still monitor for
3651 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
3652 /// startup during which time claims that were in-progress at shutdown may be replayed.
3653 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
3654 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3656 let mut channel_state = Some(self.channel_state.lock().unwrap());
3657 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
3658 if let Some((_, mut sources)) = removed_source {
3659 for htlc in sources.drain(..) {
3660 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
3661 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
3662 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
3663 self.best_block.read().unwrap().height()));
3664 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
3665 HTLCSource::PreviousHopData(htlc.prev_hop), payment_hash,
3666 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data },
3667 HTLCDestination::FailedPayment { payment_hash: *payment_hash });
3672 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3673 /// that we want to return and a channel.
3675 /// This is for failures on the channel on which the HTLC was *received*, not failures
3677 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<Signer>) -> (u16, Vec<u8>) {
3678 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
3679 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
3680 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
3681 // an inbound SCID alias before the real SCID.
3682 let scid_pref = if chan.should_announce() {
3683 chan.get_short_channel_id().or(chan.latest_inbound_scid_alias())
3685 chan.latest_inbound_scid_alias().or(chan.get_short_channel_id())
3687 if let Some(scid) = scid_pref {
3688 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
3690 (0x4000|10, Vec::new())
3695 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3696 /// that we want to return and a channel.
3697 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<Signer>) -> (u16, Vec<u8>) {
3698 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
3699 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
3700 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
3701 if desired_err_code == 0x1000 | 20 {
3702 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
3703 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
3704 0u16.write(&mut enc).expect("Writes cannot fail");
3706 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
3707 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
3708 upd.write(&mut enc).expect("Writes cannot fail");
3709 (desired_err_code, enc.0)
3711 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
3712 // which means we really shouldn't have gotten a payment to be forwarded over this
3713 // channel yet, or if we did it's from a route hint. Either way, returning an error of
3714 // PERM|no_such_channel should be fine.
3715 (0x4000|10, Vec::new())
3719 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
3720 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
3721 // be surfaced to the user.
3722 fn fail_holding_cell_htlcs(
3723 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32],
3724 counterparty_node_id: &PublicKey
3726 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
3727 let mut channel_state = self.channel_state.lock().unwrap();
3728 let (failure_code, onion_failure_data) =
3729 match channel_state.by_id.entry(channel_id) {
3730 hash_map::Entry::Occupied(chan_entry) => {
3731 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan_entry.get())
3733 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
3736 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
3737 self.fail_htlc_backwards_internal(channel_state, htlc_src, &payment_hash, HTLCFailReason::Reason { failure_code, data: onion_failure_data }, receiver);
3741 /// Fails an HTLC backwards to the sender of it to us.
3742 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
3743 /// There are several callsites that do stupid things like loop over a list of payment_hashes
3744 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
3745 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
3746 /// still-available channels.
3747 fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason, destination: HTLCDestination) {
3748 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
3749 //identify whether we sent it or not based on the (I presume) very different runtime
3750 //between the branches here. We should make this async and move it into the forward HTLCs
3753 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3754 // from block_connected which may run during initialization prior to the chain_monitor
3755 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
3757 HTLCSource::OutboundRoute { ref path, session_priv, payment_id, ref payment_params, .. } => {
3758 let mut session_priv_bytes = [0; 32];
3759 session_priv_bytes.copy_from_slice(&session_priv[..]);
3760 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
3761 let mut all_paths_failed = false;
3762 let mut full_failure_ev = None;
3763 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
3764 if !payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
3765 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3768 if payment.get().is_fulfilled() {
3769 log_trace!(self.logger, "Received failure of HTLC with payment_hash {} after payment completion", log_bytes!(payment_hash.0));
3772 if payment.get().remaining_parts() == 0 {
3773 all_paths_failed = true;
3774 if payment.get().abandoned() {
3775 full_failure_ev = Some(events::Event::PaymentFailed {
3777 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
3783 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3786 mem::drop(channel_state_lock);
3787 let mut retry = if let Some(payment_params_data) = payment_params {
3788 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
3789 Some(RouteParameters {
3790 payment_params: payment_params_data.clone(),
3791 final_value_msat: path_last_hop.fee_msat,
3792 final_cltv_expiry_delta: path_last_hop.cltv_expiry_delta,
3795 log_trace!(self.logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3797 let path_failure = match &onion_error {
3798 &HTLCFailReason::LightningError { ref err } => {
3800 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());
3802 let (network_update, short_channel_id, payment_retryable, _, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
3804 if self.payment_is_probe(payment_hash, &payment_id) {
3805 if !payment_retryable {
3806 events::Event::ProbeSuccessful {
3808 payment_hash: payment_hash.clone(),
3812 events::Event::ProbeFailed {
3813 payment_id: payment_id,
3814 payment_hash: payment_hash.clone(),
3820 // TODO: If we decided to blame ourselves (or one of our channels) in
3821 // process_onion_failure we should close that channel as it implies our
3822 // next-hop is needlessly blaming us!
3823 if let Some(scid) = short_channel_id {
3824 retry.as_mut().map(|r| r.payment_params.previously_failed_channels.push(scid));
3826 events::Event::PaymentPathFailed {
3827 payment_id: Some(payment_id),
3828 payment_hash: payment_hash.clone(),
3829 payment_failed_permanently: !payment_retryable,
3836 error_code: onion_error_code,
3838 error_data: onion_error_data
3842 &HTLCFailReason::Reason {
3848 // we get a fail_malformed_htlc from the first hop
3849 // TODO: We'd like to generate a NetworkUpdate for temporary
3850 // failures here, but that would be insufficient as find_route
3851 // generally ignores its view of our own channels as we provide them via
3853 // TODO: For non-temporary failures, we really should be closing the
3854 // channel here as we apparently can't relay through them anyway.
3855 let scid = path.first().unwrap().short_channel_id;
3856 retry.as_mut().map(|r| r.payment_params.previously_failed_channels.push(scid));
3858 if self.payment_is_probe(payment_hash, &payment_id) {
3859 events::Event::ProbeFailed {
3860 payment_id: payment_id,
3861 payment_hash: payment_hash.clone(),
3863 short_channel_id: Some(scid),
3866 events::Event::PaymentPathFailed {
3867 payment_id: Some(payment_id),
3868 payment_hash: payment_hash.clone(),
3869 payment_failed_permanently: false,
3870 network_update: None,
3873 short_channel_id: Some(scid),
3876 error_code: Some(*failure_code),
3878 error_data: Some(data.clone()),
3883 let mut pending_events = self.pending_events.lock().unwrap();
3884 pending_events.push(path_failure);
3885 if let Some(ev) = full_failure_ev { pending_events.push(ev); }
3887 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret, phantom_shared_secret, outpoint }) => {
3888 let err_packet = match onion_error {
3889 HTLCFailReason::Reason { failure_code, data } => {
3890 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
3891 if let Some(phantom_ss) = phantom_shared_secret {
3892 let phantom_packet = onion_utils::build_failure_packet(&phantom_ss, failure_code, &data[..]).encode();
3893 let encrypted_phantom_packet = onion_utils::encrypt_failure_packet(&phantom_ss, &phantom_packet);
3894 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &encrypted_phantom_packet.data[..])
3896 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
3897 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
3900 HTLCFailReason::LightningError { err } => {
3901 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
3902 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
3906 let mut forward_event = None;
3907 if channel_state_lock.forward_htlcs.is_empty() {
3908 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
3910 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
3911 hash_map::Entry::Occupied(mut entry) => {
3912 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
3914 hash_map::Entry::Vacant(entry) => {
3915 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
3918 mem::drop(channel_state_lock);
3919 let mut pending_events = self.pending_events.lock().unwrap();
3920 if let Some(time) = forward_event {
3921 pending_events.push(events::Event::PendingHTLCsForwardable {
3922 time_forwardable: time
3925 pending_events.push(events::Event::HTLCHandlingFailed {
3926 prev_channel_id: outpoint.to_channel_id(),
3927 failed_next_destination: destination
3933 /// Provides a payment preimage in response to [`Event::PaymentReceived`], generating any
3934 /// [`MessageSendEvent`]s needed to claim the payment.
3936 /// Note that calling this method does *not* guarantee that the payment has been claimed. You
3937 /// *must* wait for an [`Event::PaymentClaimed`] event which upon a successful claim will be
3938 /// provided to your [`EventHandler`] when [`process_pending_events`] is next called.
3940 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
3941 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
3942 /// event matches your expectation. If you fail to do so and call this method, you may provide
3943 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
3945 /// [`Event::PaymentReceived`]: crate::util::events::Event::PaymentReceived
3946 /// [`Event::PaymentClaimed`]: crate::util::events::Event::PaymentClaimed
3947 /// [`process_pending_events`]: EventsProvider::process_pending_events
3948 /// [`create_inbound_payment`]: Self::create_inbound_payment
3949 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
3950 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
3951 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
3952 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
3954 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3956 let mut channel_state = Some(self.channel_state.lock().unwrap());
3957 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
3958 if let Some((payment_purpose, mut sources)) = removed_source {
3959 assert!(!sources.is_empty());
3961 // If we are claiming an MPP payment, we have to take special care to ensure that each
3962 // channel exists before claiming all of the payments (inside one lock).
3963 // Note that channel existance is sufficient as we should always get a monitor update
3964 // which will take care of the real HTLC claim enforcement.
3966 // If we find an HTLC which we would need to claim but for which we do not have a
3967 // channel, we will fail all parts of the MPP payment. While we could wait and see if
3968 // the sender retries the already-failed path(s), it should be a pretty rare case where
3969 // we got all the HTLCs and then a channel closed while we were waiting for the user to
3970 // provide the preimage, so worrying too much about the optimal handling isn't worth
3972 let mut claimable_amt_msat = 0;
3973 let mut expected_amt_msat = None;
3974 let mut valid_mpp = true;
3975 for htlc in sources.iter() {
3976 if let None = channel_state.as_ref().unwrap().short_to_chan_info.get(&htlc.prev_hop.short_channel_id) {
3980 if expected_amt_msat.is_some() && expected_amt_msat != Some(htlc.total_msat) {
3981 log_error!(self.logger, "Somehow ended up with an MPP payment with different total amounts - this should not be reachable!");
3982 debug_assert!(false);
3986 expected_amt_msat = Some(htlc.total_msat);
3987 if let OnionPayload::Spontaneous(_) = &htlc.onion_payload {
3988 // We don't currently support MPP for spontaneous payments, so just check
3989 // that there's one payment here and move on.
3990 if sources.len() != 1 {
3991 log_error!(self.logger, "Somehow ended up with an MPP spontaneous payment - this should not be reachable!");
3992 debug_assert!(false);
3998 claimable_amt_msat += htlc.value;
4000 if sources.is_empty() || expected_amt_msat.is_none() {
4001 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
4004 if claimable_amt_msat != expected_amt_msat.unwrap() {
4005 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
4006 expected_amt_msat.unwrap(), claimable_amt_msat);
4010 let mut errs = Vec::new();
4011 let mut claimed_any_htlcs = false;
4012 for htlc in sources.drain(..) {
4014 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
4015 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
4016 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
4017 self.best_block.read().unwrap().height()));
4018 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
4019 HTLCSource::PreviousHopData(htlc.prev_hop), &payment_hash,
4020 HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_height_data },
4021 HTLCDestination::FailedPayment { payment_hash } );
4023 match self.claim_funds_from_hop(channel_state.as_mut().unwrap(), htlc.prev_hop, payment_preimage) {
4024 ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) => {
4025 if let msgs::ErrorAction::IgnoreError = err.err.action {
4026 // We got a temporary failure updating monitor, but will claim the
4027 // HTLC when the monitor updating is restored (or on chain).
4028 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
4029 claimed_any_htlcs = true;
4030 } else { errs.push((pk, err)); }
4032 ClaimFundsFromHop::PrevHopForceClosed => unreachable!("We already checked for channel existence, we can't fail here!"),
4033 ClaimFundsFromHop::DuplicateClaim => {
4034 // While we should never get here in most cases, if we do, it likely
4035 // indicates that the HTLC was timed out some time ago and is no longer
4036 // available to be claimed. Thus, it does not make sense to set
4037 // `claimed_any_htlcs`.
4039 ClaimFundsFromHop::Success(_) => claimed_any_htlcs = true,
4044 if claimed_any_htlcs {
4045 self.pending_events.lock().unwrap().push(events::Event::PaymentClaimed {
4047 purpose: payment_purpose,
4048 amount_msat: claimable_amt_msat,
4052 // Now that we've done the entire above loop in one lock, we can handle any errors
4053 // which were generated.
4054 channel_state.take();
4056 for (counterparty_node_id, err) in errs.drain(..) {
4057 let res: Result<(), _> = Err(err);
4058 let _ = handle_error!(self, res, counterparty_node_id);
4063 fn claim_funds_from_hop(&self, channel_state_lock: &mut MutexGuard<ChannelHolder<Signer>>, prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage) -> ClaimFundsFromHop {
4064 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
4065 let channel_state = &mut **channel_state_lock;
4066 let chan_id = match channel_state.short_to_chan_info.get(&prev_hop.short_channel_id) {
4067 Some((_cp_id, chan_id)) => chan_id.clone(),
4069 return ClaimFundsFromHop::PrevHopForceClosed
4073 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
4074 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
4075 Ok(msgs_monitor_option) => {
4076 if let UpdateFulfillCommitFetch::NewClaim { msgs, htlc_value_msat, monitor_update } = msgs_monitor_option {
4077 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
4078 ChannelMonitorUpdateStatus::Completed => {},
4080 log_given_level!(self.logger, if e == ChannelMonitorUpdateStatus::PermanentFailure { Level::Error } else { Level::Debug },
4081 "Failed to update channel monitor with preimage {:?}: {:?}",
4082 payment_preimage, e);
4083 return ClaimFundsFromHop::MonitorUpdateFail(
4084 chan.get().get_counterparty_node_id(),
4085 handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()).unwrap_err(),
4086 Some(htlc_value_msat)
4090 if let Some((msg, commitment_signed)) = msgs {
4091 log_debug!(self.logger, "Claiming funds for HTLC with preimage {} resulted in a commitment_signed for channel {}",
4092 log_bytes!(payment_preimage.0), log_bytes!(chan.get().channel_id()));
4093 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4094 node_id: chan.get().get_counterparty_node_id(),
4095 updates: msgs::CommitmentUpdate {
4096 update_add_htlcs: Vec::new(),
4097 update_fulfill_htlcs: vec![msg],
4098 update_fail_htlcs: Vec::new(),
4099 update_fail_malformed_htlcs: Vec::new(),
4105 return ClaimFundsFromHop::Success(htlc_value_msat);
4107 return ClaimFundsFromHop::DuplicateClaim;
4110 Err((e, monitor_update)) => {
4111 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
4112 ChannelMonitorUpdateStatus::Completed => {},
4114 log_given_level!(self.logger, if e == ChannelMonitorUpdateStatus::PermanentFailure { Level::Error } else { Level::Info },
4115 "Failed to update channel monitor with preimage {:?} immediately prior to force-close: {:?}",
4116 payment_preimage, e);
4119 let counterparty_node_id = chan.get().get_counterparty_node_id();
4120 let (drop, res) = convert_chan_err!(self, e, channel_state.short_to_chan_info, chan.get_mut(), &chan_id);
4122 chan.remove_entry();
4124 return ClaimFundsFromHop::MonitorUpdateFail(counterparty_node_id, res, None);
4127 } else { unreachable!(); }
4130 fn finalize_claims(&self, mut sources: Vec<HTLCSource>) {
4131 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
4132 let mut pending_events = self.pending_events.lock().unwrap();
4133 for source in sources.drain(..) {
4134 if let HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } = source {
4135 let mut session_priv_bytes = [0; 32];
4136 session_priv_bytes.copy_from_slice(&session_priv[..]);
4137 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
4138 assert!(payment.get().is_fulfilled());
4139 if payment.get_mut().remove(&session_priv_bytes, None) {
4140 pending_events.push(
4141 events::Event::PaymentPathSuccessful {
4143 payment_hash: payment.get().payment_hash(),
4148 if payment.get().remaining_parts() == 0 {
4156 fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_preimage: PaymentPreimage, forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, next_channel_id: [u8; 32]) {
4158 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
4159 mem::drop(channel_state_lock);
4160 let mut session_priv_bytes = [0; 32];
4161 session_priv_bytes.copy_from_slice(&session_priv[..]);
4162 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
4163 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
4164 let mut pending_events = self.pending_events.lock().unwrap();
4165 if !payment.get().is_fulfilled() {
4166 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4167 let fee_paid_msat = payment.get().get_pending_fee_msat();
4168 pending_events.push(
4169 events::Event::PaymentSent {
4170 payment_id: Some(payment_id),
4176 payment.get_mut().mark_fulfilled();
4180 // We currently immediately remove HTLCs which were fulfilled on-chain.
4181 // This could potentially lead to removing a pending payment too early,
4182 // with a reorg of one block causing us to re-add the fulfilled payment on
4184 // TODO: We should have a second monitor event that informs us of payments
4185 // irrevocably fulfilled.
4186 if payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
4187 let payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0).into_inner()));
4188 pending_events.push(
4189 events::Event::PaymentPathSuccessful {
4197 if payment.get().remaining_parts() == 0 {
4202 log_trace!(self.logger, "Received duplicative fulfill for HTLC with payment_preimage {}", log_bytes!(payment_preimage.0));
4205 HTLCSource::PreviousHopData(hop_data) => {
4206 let prev_outpoint = hop_data.outpoint;
4207 let res = self.claim_funds_from_hop(&mut channel_state_lock, hop_data, payment_preimage);
4208 let claimed_htlc = if let ClaimFundsFromHop::DuplicateClaim = res { false } else { true };
4209 let htlc_claim_value_msat = match res {
4210 ClaimFundsFromHop::MonitorUpdateFail(_, _, amt_opt) => amt_opt,
4211 ClaimFundsFromHop::Success(amt) => Some(amt),
4214 if let ClaimFundsFromHop::PrevHopForceClosed = res {
4215 let preimage_update = ChannelMonitorUpdate {
4216 update_id: CLOSED_CHANNEL_UPDATE_ID,
4217 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
4218 payment_preimage: payment_preimage.clone(),
4221 // We update the ChannelMonitor on the backward link, after
4222 // receiving an offchain preimage event from the forward link (the
4223 // event being update_fulfill_htlc).
4224 let update_res = self.chain_monitor.update_channel(prev_outpoint, preimage_update);
4225 if update_res != ChannelMonitorUpdateStatus::Completed {
4226 // TODO: This needs to be handled somehow - if we receive a monitor update
4227 // with a preimage we *must* somehow manage to propagate it to the upstream
4228 // channel, or we must have an ability to receive the same event and try
4229 // again on restart.
4230 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
4231 payment_preimage, update_res);
4233 // Note that we do *not* set `claimed_htlc` to false here. In fact, this
4234 // totally could be a duplicate claim, but we have no way of knowing
4235 // without interrogating the `ChannelMonitor` we've provided the above
4236 // update to. Instead, we simply document in `PaymentForwarded` that this
4239 mem::drop(channel_state_lock);
4240 if let ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) = res {
4241 let result: Result<(), _> = Err(err);
4242 let _ = handle_error!(self, result, pk);
4246 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
4247 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
4248 Some(claimed_htlc_value - forwarded_htlc_value)
4251 let mut pending_events = self.pending_events.lock().unwrap();
4252 let prev_channel_id = Some(prev_outpoint.to_channel_id());
4253 let next_channel_id = Some(next_channel_id);
4255 pending_events.push(events::Event::PaymentForwarded {
4257 claim_from_onchain_tx: from_onchain,
4267 /// Gets the node_id held by this ChannelManager
4268 pub fn get_our_node_id(&self) -> PublicKey {
4269 self.our_network_pubkey.clone()
4272 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64) {
4273 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4275 let chan_restoration_res;
4276 let (mut pending_failures, finalized_claims, counterparty_node_id) = {
4277 let mut channel_lock = self.channel_state.lock().unwrap();
4278 let channel_state = &mut *channel_lock;
4279 let mut channel = match channel_state.by_id.entry(funding_txo.to_channel_id()) {
4280 hash_map::Entry::Occupied(chan) => chan,
4281 hash_map::Entry::Vacant(_) => return,
4283 if !channel.get().is_awaiting_monitor_update() || channel.get().get_latest_monitor_update_id() != highest_applied_update_id {
4287 let counterparty_node_id = channel.get().get_counterparty_node_id();
4288 let updates = channel.get_mut().monitor_updating_restored(&self.logger, self.get_our_node_id(), self.genesis_hash, self.best_block.read().unwrap().height());
4289 let channel_update = if updates.channel_ready.is_some() && channel.get().is_usable() {
4290 // We only send a channel_update in the case where we are just now sending a
4291 // channel_ready and the channel is in a usable state. We may re-send a
4292 // channel_update later through the announcement_signatures process for public
4293 // channels, but there's no reason not to just inform our counterparty of our fees
4295 if let Ok(msg) = self.get_channel_update_for_unicast(channel.get()) {
4296 Some(events::MessageSendEvent::SendChannelUpdate {
4297 node_id: channel.get().get_counterparty_node_id(),
4302 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);
4303 if let Some(upd) = channel_update {
4304 channel_state.pending_msg_events.push(upd);
4307 (updates.failed_htlcs, updates.finalized_claimed_htlcs, counterparty_node_id)
4309 post_handle_chan_restoration!(self, chan_restoration_res);
4310 self.finalize_claims(finalized_claims);
4311 for failure in pending_failures.drain(..) {
4312 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id: funding_txo.to_channel_id() };
4313 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2, receiver);
4317 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
4319 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
4320 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
4323 /// The `user_channel_id` parameter will be provided back in
4324 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4325 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4327 /// Note that this method will return an error and reject the channel, if it requires support
4328 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
4329 /// used to accept such channels.
4331 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4332 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4333 pub fn accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u64) -> Result<(), APIError> {
4334 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
4337 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
4338 /// it as confirmed immediately.
4340 /// The `user_channel_id` parameter will be provided back in
4341 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4342 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4344 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
4345 /// and (if the counterparty agrees), enables forwarding of payments immediately.
4347 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
4348 /// transaction and blindly assumes that it will eventually confirm.
4350 /// If it does not confirm before we decide to close the channel, or if the funding transaction
4351 /// does not pay to the correct script the correct amount, *you will lose funds*.
4353 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4354 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4355 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> {
4356 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
4359 fn do_accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u64) -> Result<(), APIError> {
4360 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4362 let mut channel_state_lock = self.channel_state.lock().unwrap();
4363 let channel_state = &mut *channel_state_lock;
4364 match channel_state.by_id.entry(temporary_channel_id.clone()) {
4365 hash_map::Entry::Occupied(mut channel) => {
4366 if !channel.get().inbound_is_awaiting_accept() {
4367 return Err(APIError::APIMisuseError { err: "The channel isn't currently awaiting to be accepted.".to_owned() });
4369 if *counterparty_node_id != channel.get().get_counterparty_node_id() {
4370 return Err(APIError::APIMisuseError { err: "The passed counterparty_node_id doesn't match the channel's counterparty node_id".to_owned() });
4373 channel.get_mut().set_0conf();
4374 } else if channel.get().get_channel_type().requires_zero_conf() {
4375 let send_msg_err_event = events::MessageSendEvent::HandleError {
4376 node_id: channel.get().get_counterparty_node_id(),
4377 action: msgs::ErrorAction::SendErrorMessage{
4378 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
4381 channel_state.pending_msg_events.push(send_msg_err_event);
4382 let _ = remove_channel!(self, channel_state, channel);
4383 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
4386 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4387 node_id: channel.get().get_counterparty_node_id(),
4388 msg: channel.get_mut().accept_inbound_channel(user_channel_id),
4391 hash_map::Entry::Vacant(_) => {
4392 return Err(APIError::ChannelUnavailable { err: "Can't accept a channel that doesn't exist".to_owned() });
4398 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
4399 if msg.chain_hash != self.genesis_hash {
4400 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
4403 if !self.default_configuration.accept_inbound_channels {
4404 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4407 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
4408 let mut channel = match Channel::new_from_req(&self.fee_estimator, &self.keys_manager,
4409 counterparty_node_id.clone(), &their_features, msg, 0, &self.default_configuration,
4410 self.best_block.read().unwrap().height(), &self.logger, outbound_scid_alias)
4413 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4414 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
4418 let mut channel_state_lock = self.channel_state.lock().unwrap();
4419 let channel_state = &mut *channel_state_lock;
4420 match channel_state.by_id.entry(channel.channel_id()) {
4421 hash_map::Entry::Occupied(_) => {
4422 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4423 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!".to_owned(), msg.temporary_channel_id.clone()))
4425 hash_map::Entry::Vacant(entry) => {
4426 if !self.default_configuration.manually_accept_inbound_channels {
4427 if channel.get_channel_type().requires_zero_conf() {
4428 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4430 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4431 node_id: counterparty_node_id.clone(),
4432 msg: channel.accept_inbound_channel(0),
4435 let mut pending_events = self.pending_events.lock().unwrap();
4436 pending_events.push(
4437 events::Event::OpenChannelRequest {
4438 temporary_channel_id: msg.temporary_channel_id.clone(),
4439 counterparty_node_id: counterparty_node_id.clone(),
4440 funding_satoshis: msg.funding_satoshis,
4441 push_msat: msg.push_msat,
4442 channel_type: channel.get_channel_type().clone(),
4447 entry.insert(channel);
4453 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
4454 let (value, output_script, user_id) = {
4455 let mut channel_lock = self.channel_state.lock().unwrap();
4456 let channel_state = &mut *channel_lock;
4457 match channel_state.by_id.entry(msg.temporary_channel_id) {
4458 hash_map::Entry::Occupied(mut chan) => {
4459 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4460 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
4462 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &their_features), channel_state, chan);
4463 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
4465 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
4468 let mut pending_events = self.pending_events.lock().unwrap();
4469 pending_events.push(events::Event::FundingGenerationReady {
4470 temporary_channel_id: msg.temporary_channel_id,
4471 counterparty_node_id: *counterparty_node_id,
4472 channel_value_satoshis: value,
4474 user_channel_id: user_id,
4479 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
4480 let ((funding_msg, monitor, mut channel_ready), mut chan) = {
4481 let best_block = *self.best_block.read().unwrap();
4482 let mut channel_lock = self.channel_state.lock().unwrap();
4483 let channel_state = &mut *channel_lock;
4484 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
4485 hash_map::Entry::Occupied(mut chan) => {
4486 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4487 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
4489 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.logger), channel_state, chan), chan.remove())
4491 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
4494 // Because we have exclusive ownership of the channel here we can release the channel_state
4495 // lock before watch_channel
4496 match self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
4497 ChannelMonitorUpdateStatus::Completed => {},
4498 ChannelMonitorUpdateStatus::PermanentFailure => {
4499 // Note that we reply with the new channel_id in error messages if we gave up on the
4500 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
4501 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
4502 // any messages referencing a previously-closed channel anyway.
4503 // We do not propagate the monitor update to the user as it would be for a monitor
4504 // that we didn't manage to store (and that we don't care about - we don't respond
4505 // with the funding_signed so the channel can never go on chain).
4506 let (_monitor_update, failed_htlcs) = chan.force_shutdown(false);
4507 assert!(failed_htlcs.is_empty());
4508 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
4510 ChannelMonitorUpdateStatus::InProgress => {
4511 // There's no problem signing a counterparty's funding transaction if our monitor
4512 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
4513 // accepted payment from yet. We do, however, need to wait to send our channel_ready
4514 // until we have persisted our monitor.
4515 chan.monitor_updating_paused(false, false, channel_ready.is_some(), Vec::new(), Vec::new(), Vec::new());
4516 channel_ready = None; // Don't send the channel_ready now
4519 let mut channel_state_lock = self.channel_state.lock().unwrap();
4520 let channel_state = &mut *channel_state_lock;
4521 match channel_state.by_id.entry(funding_msg.channel_id) {
4522 hash_map::Entry::Occupied(_) => {
4523 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
4525 hash_map::Entry::Vacant(e) => {
4526 let mut id_to_peer = self.id_to_peer.lock().unwrap();
4527 match id_to_peer.entry(chan.channel_id()) {
4528 hash_map::Entry::Occupied(_) => {
4529 return Err(MsgHandleErrInternal::send_err_msg_no_close(
4530 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
4531 funding_msg.channel_id))
4533 hash_map::Entry::Vacant(i_e) => {
4534 i_e.insert(chan.get_counterparty_node_id());
4537 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
4538 node_id: counterparty_node_id.clone(),
4541 if let Some(msg) = channel_ready {
4542 send_channel_ready!(channel_state.short_to_chan_info, channel_state.pending_msg_events, chan, msg);
4550 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
4552 let best_block = *self.best_block.read().unwrap();
4553 let mut channel_lock = self.channel_state.lock().unwrap();
4554 let channel_state = &mut *channel_lock;
4555 match channel_state.by_id.entry(msg.channel_id) {
4556 hash_map::Entry::Occupied(mut chan) => {
4557 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4558 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4560 let (monitor, funding_tx, channel_ready) = match chan.get_mut().funding_signed(&msg, best_block, &self.logger) {
4561 Ok(update) => update,
4562 Err(e) => try_chan_entry!(self, Err(e), channel_state, chan),
4564 match self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
4565 ChannelMonitorUpdateStatus::Completed => {},
4567 let mut res = handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, channel_ready.is_some(), OPTIONALLY_RESEND_FUNDING_LOCKED);
4568 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
4569 // We weren't able to watch the channel to begin with, so no updates should be made on
4570 // it. Previously, full_stack_target found an (unreachable) panic when the
4571 // monitor update contained within `shutdown_finish` was applied.
4572 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
4573 shutdown_finish.0.take();
4579 if let Some(msg) = channel_ready {
4580 send_channel_ready!(channel_state.short_to_chan_info, channel_state.pending_msg_events, chan.get(), msg);
4584 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4587 log_info!(self.logger, "Broadcasting funding transaction with txid {}", funding_tx.txid());
4588 self.tx_broadcaster.broadcast_transaction(&funding_tx);
4592 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
4593 let mut channel_state_lock = self.channel_state.lock().unwrap();
4594 let channel_state = &mut *channel_state_lock;
4595 match channel_state.by_id.entry(msg.channel_id) {
4596 hash_map::Entry::Occupied(mut chan) => {
4597 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4598 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4600 let announcement_sigs_opt = try_chan_entry!(self, chan.get_mut().channel_ready(&msg, self.get_our_node_id(),
4601 self.genesis_hash.clone(), &self.best_block.read().unwrap(), &self.logger), channel_state, chan);
4602 if let Some(announcement_sigs) = announcement_sigs_opt {
4603 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(chan.get().channel_id()));
4604 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4605 node_id: counterparty_node_id.clone(),
4606 msg: announcement_sigs,
4608 } else if chan.get().is_usable() {
4609 // If we're sending an announcement_signatures, we'll send the (public)
4610 // channel_update after sending a channel_announcement when we receive our
4611 // counterparty's announcement_signatures. Thus, we only bother to send a
4612 // channel_update here if the channel is not public, i.e. we're not sending an
4613 // announcement_signatures.
4614 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", log_bytes!(chan.get().channel_id()));
4615 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
4616 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4617 node_id: counterparty_node_id.clone(),
4624 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4628 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
4629 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
4630 let result: Result<(), _> = loop {
4631 let mut channel_state_lock = self.channel_state.lock().unwrap();
4632 let channel_state = &mut *channel_state_lock;
4634 match channel_state.by_id.entry(msg.channel_id.clone()) {
4635 hash_map::Entry::Occupied(mut chan_entry) => {
4636 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
4637 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4640 if !chan_entry.get().received_shutdown() {
4641 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
4642 log_bytes!(msg.channel_id),
4643 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
4646 let (shutdown, monitor_update, htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&self.keys_manager, &their_features, &msg), channel_state, chan_entry);
4647 dropped_htlcs = htlcs;
4649 // Update the monitor with the shutdown script if necessary.
4650 if let Some(monitor_update) = monitor_update {
4651 let update_res = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update);
4652 let (result, is_permanent) =
4653 handle_monitor_err!(self, update_res, channel_state.short_to_chan_info, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
4655 remove_channel!(self, channel_state, chan_entry);
4660 if let Some(msg) = shutdown {
4661 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
4662 node_id: *counterparty_node_id,
4669 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4672 for htlc_source in dropped_htlcs.drain(..) {
4673 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
4674 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
4677 let _ = handle_error!(self, result, *counterparty_node_id);
4681 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
4682 let (tx, chan_option) = {
4683 let mut channel_state_lock = self.channel_state.lock().unwrap();
4684 let channel_state = &mut *channel_state_lock;
4685 match channel_state.by_id.entry(msg.channel_id.clone()) {
4686 hash_map::Entry::Occupied(mut chan_entry) => {
4687 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
4688 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4690 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), channel_state, chan_entry);
4691 if let Some(msg) = closing_signed {
4692 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
4693 node_id: counterparty_node_id.clone(),
4698 // We're done with this channel, we've got a signed closing transaction and
4699 // will send the closing_signed back to the remote peer upon return. This
4700 // also implies there are no pending HTLCs left on the channel, so we can
4701 // fully delete it from tracking (the channel monitor is still around to
4702 // watch for old state broadcasts)!
4703 (tx, Some(remove_channel!(self, channel_state, chan_entry)))
4704 } else { (tx, None) }
4706 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4709 if let Some(broadcast_tx) = tx {
4710 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
4711 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
4713 if let Some(chan) = chan_option {
4714 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4715 let mut channel_state = self.channel_state.lock().unwrap();
4716 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4720 self.issue_channel_close_events(&chan, ClosureReason::CooperativeClosure);
4725 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
4726 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
4727 //determine the state of the payment based on our response/if we forward anything/the time
4728 //we take to respond. We should take care to avoid allowing such an attack.
4730 //TODO: There exists a further attack where a node may garble the onion data, forward it to
4731 //us repeatedly garbled in different ways, and compare our error messages, which are
4732 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
4733 //but we should prevent it anyway.
4735 let pending_forward_info = self.decode_update_add_htlc_onion(msg);
4736 let mut channel_state_lock = self.channel_state.lock().unwrap();
4737 let channel_state = &mut *channel_state_lock;
4739 match channel_state.by_id.entry(msg.channel_id) {
4740 hash_map::Entry::Occupied(mut chan) => {
4741 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4742 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4745 let create_pending_htlc_status = |chan: &Channel<Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
4746 // If the update_add is completely bogus, the call will Err and we will close,
4747 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
4748 // want to reject the new HTLC and fail it backwards instead of forwarding.
4749 match pending_forward_info {
4750 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
4751 let reason = if (error_code & 0x1000) != 0 {
4752 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
4753 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, real_code, &error_data)
4755 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, error_code, &[])
4757 let msg = msgs::UpdateFailHTLC {
4758 channel_id: msg.channel_id,
4759 htlc_id: msg.htlc_id,
4762 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
4764 _ => pending_forward_info
4767 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), channel_state, chan);
4769 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4774 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
4775 let mut channel_lock = self.channel_state.lock().unwrap();
4776 let (htlc_source, forwarded_htlc_value) = {
4777 let channel_state = &mut *channel_lock;
4778 match channel_state.by_id.entry(msg.channel_id) {
4779 hash_map::Entry::Occupied(mut chan) => {
4780 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4781 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4783 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
4785 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4788 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, msg.channel_id);
4792 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
4793 let mut channel_lock = self.channel_state.lock().unwrap();
4794 let channel_state = &mut *channel_lock;
4795 match channel_state.by_id.entry(msg.channel_id) {
4796 hash_map::Entry::Occupied(mut chan) => {
4797 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4798 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4800 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
4802 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4807 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
4808 let mut channel_lock = self.channel_state.lock().unwrap();
4809 let channel_state = &mut *channel_lock;
4810 match channel_state.by_id.entry(msg.channel_id) {
4811 hash_map::Entry::Occupied(mut chan) => {
4812 if chan.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));
4815 if (msg.failure_code & 0x8000) == 0 {
4816 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
4817 try_chan_entry!(self, Err(chan_err), channel_state, chan);
4819 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);
4822 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4826 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
4827 let mut channel_state_lock = self.channel_state.lock().unwrap();
4828 let channel_state = &mut *channel_state_lock;
4829 match channel_state.by_id.entry(msg.channel_id) {
4830 hash_map::Entry::Occupied(mut chan) => {
4831 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4832 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4834 let (revoke_and_ack, commitment_signed, monitor_update) =
4835 match chan.get_mut().commitment_signed(&msg, &self.logger) {
4836 Err((None, e)) => try_chan_entry!(self, Err(e), channel_state, chan),
4837 Err((Some(update), e)) => {
4838 assert!(chan.get().is_awaiting_monitor_update());
4839 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), update);
4840 try_chan_entry!(self, Err(e), channel_state, chan);
4845 let update_res = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update);
4846 if let Err(e) = handle_monitor_err!(self, update_res, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some()) {
4850 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
4851 node_id: counterparty_node_id.clone(),
4852 msg: revoke_and_ack,
4854 if let Some(msg) = commitment_signed {
4855 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4856 node_id: counterparty_node_id.clone(),
4857 updates: msgs::CommitmentUpdate {
4858 update_add_htlcs: Vec::new(),
4859 update_fulfill_htlcs: Vec::new(),
4860 update_fail_htlcs: Vec::new(),
4861 update_fail_malformed_htlcs: Vec::new(),
4863 commitment_signed: msg,
4869 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4874 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)]) {
4875 for &mut (prev_short_channel_id, prev_funding_outpoint, ref mut pending_forwards) in per_source_pending_forwards {
4876 let mut forward_event = None;
4877 if !pending_forwards.is_empty() {
4878 let mut channel_state = self.channel_state.lock().unwrap();
4879 if channel_state.forward_htlcs.is_empty() {
4880 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
4882 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
4883 match channel_state.forward_htlcs.entry(match forward_info.routing {
4884 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
4885 PendingHTLCRouting::Receive { .. } => 0,
4886 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
4888 hash_map::Entry::Occupied(mut entry) => {
4889 entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
4890 prev_htlc_id, forward_info });
4892 hash_map::Entry::Vacant(entry) => {
4893 entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
4894 prev_htlc_id, forward_info }));
4899 match forward_event {
4901 let mut pending_events = self.pending_events.lock().unwrap();
4902 pending_events.push(events::Event::PendingHTLCsForwardable {
4903 time_forwardable: time
4911 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
4912 let mut htlcs_to_fail = Vec::new();
4914 let mut channel_state_lock = self.channel_state.lock().unwrap();
4915 let channel_state = &mut *channel_state_lock;
4916 match channel_state.by_id.entry(msg.channel_id) {
4917 hash_map::Entry::Occupied(mut chan) => {
4918 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4919 break Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4921 let was_paused_for_mon_update = chan.get().is_awaiting_monitor_update();
4922 let raa_updates = break_chan_entry!(self,
4923 chan.get_mut().revoke_and_ack(&msg, &self.logger), channel_state, chan);
4924 htlcs_to_fail = raa_updates.holding_cell_failed_htlcs;
4925 let update_res = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), raa_updates.monitor_update);
4926 if was_paused_for_mon_update {
4927 assert!(update_res != ChannelMonitorUpdateStatus::Completed);
4928 assert!(raa_updates.commitment_update.is_none());
4929 assert!(raa_updates.accepted_htlcs.is_empty());
4930 assert!(raa_updates.failed_htlcs.is_empty());
4931 assert!(raa_updates.finalized_claimed_htlcs.is_empty());
4932 break Err(MsgHandleErrInternal::ignore_no_close("Existing pending monitor update prevented responses to RAA".to_owned()));
4934 if update_res != ChannelMonitorUpdateStatus::Completed {
4935 if let Err(e) = handle_monitor_err!(self, update_res, channel_state, chan,
4936 RAACommitmentOrder::CommitmentFirst, false,
4937 raa_updates.commitment_update.is_some(), false,
4938 raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
4939 raa_updates.finalized_claimed_htlcs) {
4941 } else { unreachable!(); }
4943 if let Some(updates) = raa_updates.commitment_update {
4944 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4945 node_id: counterparty_node_id.clone(),
4949 break Ok((raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
4950 raa_updates.finalized_claimed_htlcs,
4951 chan.get().get_short_channel_id()
4952 .unwrap_or(chan.get().outbound_scid_alias()),
4953 chan.get().get_funding_txo().unwrap()))
4955 hash_map::Entry::Vacant(_) => break Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4958 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
4960 Ok((pending_forwards, mut pending_failures, finalized_claim_htlcs,
4961 short_channel_id, channel_outpoint)) =>
4963 for failure in pending_failures.drain(..) {
4964 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: channel_outpoint.to_channel_id() };
4965 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2, receiver);
4967 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, pending_forwards)]);
4968 self.finalize_claims(finalized_claim_htlcs);
4975 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
4976 let mut channel_lock = self.channel_state.lock().unwrap();
4977 let channel_state = &mut *channel_lock;
4978 match channel_state.by_id.entry(msg.channel_id) {
4979 hash_map::Entry::Occupied(mut chan) => {
4980 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4981 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4983 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg), channel_state, chan);
4985 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4990 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
4991 let mut channel_state_lock = self.channel_state.lock().unwrap();
4992 let channel_state = &mut *channel_state_lock;
4994 match channel_state.by_id.entry(msg.channel_id) {
4995 hash_map::Entry::Occupied(mut chan) => {
4996 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4997 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4999 if !chan.get().is_usable() {
5000 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
5003 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5004 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(
5005 self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height(), msg), channel_state, chan),
5006 // Note that announcement_signatures fails if the channel cannot be announced,
5007 // so get_channel_update_for_broadcast will never fail by the time we get here.
5008 update_msg: self.get_channel_update_for_broadcast(chan.get()).unwrap(),
5011 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5016 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
5017 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
5018 let mut channel_state_lock = self.channel_state.lock().unwrap();
5019 let channel_state = &mut *channel_state_lock;
5020 let chan_id = match channel_state.short_to_chan_info.get(&msg.contents.short_channel_id) {
5021 Some((_cp_id, chan_id)) => chan_id.clone(),
5023 // It's not a local channel
5024 return Ok(NotifyOption::SkipPersist)
5027 match channel_state.by_id.entry(chan_id) {
5028 hash_map::Entry::Occupied(mut chan) => {
5029 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5030 if chan.get().should_announce() {
5031 // If the announcement is about a channel of ours which is public, some
5032 // other peer may simply be forwarding all its gossip to us. Don't provide
5033 // a scary-looking error message and return Ok instead.
5034 return Ok(NotifyOption::SkipPersist);
5036 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));
5038 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().get_counterparty_node_id().serialize()[..];
5039 let msg_from_node_one = msg.contents.flags & 1 == 0;
5040 if were_node_one == msg_from_node_one {
5041 return Ok(NotifyOption::SkipPersist);
5043 log_debug!(self.logger, "Received channel_update for channel {}.", log_bytes!(chan_id));
5044 try_chan_entry!(self, chan.get_mut().channel_update(&msg), channel_state, chan);
5047 hash_map::Entry::Vacant(_) => unreachable!()
5049 Ok(NotifyOption::DoPersist)
5052 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
5053 let chan_restoration_res;
5054 let (htlcs_failed_forward, need_lnd_workaround) = {
5055 let mut channel_state_lock = self.channel_state.lock().unwrap();
5056 let channel_state = &mut *channel_state_lock;
5058 match channel_state.by_id.entry(msg.channel_id) {
5059 hash_map::Entry::Occupied(mut chan) => {
5060 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5061 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5063 // Currently, we expect all holding cell update_adds to be dropped on peer
5064 // disconnect, so Channel's reestablish will never hand us any holding cell
5065 // freed HTLCs to fail backwards. If in the future we no longer drop pending
5066 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
5067 let responses = try_chan_entry!(self, chan.get_mut().channel_reestablish(
5068 msg, &self.logger, self.our_network_pubkey.clone(), self.genesis_hash,
5069 &*self.best_block.read().unwrap()), channel_state, chan);
5070 let mut channel_update = None;
5071 if let Some(msg) = responses.shutdown_msg {
5072 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5073 node_id: counterparty_node_id.clone(),
5076 } else if chan.get().is_usable() {
5077 // If the channel is in a usable state (ie the channel is not being shut
5078 // down), send a unicast channel_update to our counterparty to make sure
5079 // they have the latest channel parameters.
5080 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
5081 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
5082 node_id: chan.get().get_counterparty_node_id(),
5087 let need_lnd_workaround = chan.get_mut().workaround_lnd_bug_4006.take();
5088 chan_restoration_res = handle_chan_restoration_locked!(
5089 self, channel_state_lock, channel_state, chan, responses.raa, responses.commitment_update, responses.order,
5090 responses.mon_update, Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
5091 if let Some(upd) = channel_update {
5092 channel_state.pending_msg_events.push(upd);
5094 (responses.holding_cell_failed_htlcs, need_lnd_workaround)
5096 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5099 post_handle_chan_restoration!(self, chan_restoration_res);
5100 self.fail_holding_cell_htlcs(htlcs_failed_forward, msg.channel_id, counterparty_node_id);
5102 if let Some(channel_ready_msg) = need_lnd_workaround {
5103 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
5108 /// Process pending events from the `chain::Watch`, returning whether any events were processed.
5109 fn process_pending_monitor_events(&self) -> bool {
5110 let mut failed_channels = Vec::new();
5111 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
5112 let has_pending_monitor_events = !pending_monitor_events.is_empty();
5113 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
5114 for monitor_event in monitor_events.drain(..) {
5115 match monitor_event {
5116 MonitorEvent::HTLCEvent(htlc_update) => {
5117 if let Some(preimage) = htlc_update.payment_preimage {
5118 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
5119 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());
5121 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
5122 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
5123 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_update.source, &htlc_update.payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
5126 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
5127 MonitorEvent::UpdateFailed(funding_outpoint) => {
5128 let mut channel_lock = self.channel_state.lock().unwrap();
5129 let channel_state = &mut *channel_lock;
5130 let by_id = &mut channel_state.by_id;
5131 let pending_msg_events = &mut channel_state.pending_msg_events;
5132 if let hash_map::Entry::Occupied(chan_entry) = by_id.entry(funding_outpoint.to_channel_id()) {
5133 let mut chan = remove_channel!(self, channel_state, chan_entry);
5134 failed_channels.push(chan.force_shutdown(false));
5135 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5136 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5140 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
5141 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
5143 ClosureReason::CommitmentTxConfirmed
5145 self.issue_channel_close_events(&chan, reason);
5146 pending_msg_events.push(events::MessageSendEvent::HandleError {
5147 node_id: chan.get_counterparty_node_id(),
5148 action: msgs::ErrorAction::SendErrorMessage {
5149 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
5154 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
5155 self.channel_monitor_updated(&funding_txo, monitor_update_id);
5161 for failure in failed_channels.drain(..) {
5162 self.finish_force_close_channel(failure);
5165 has_pending_monitor_events
5168 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
5169 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
5170 /// update events as a separate process method here.
5172 pub fn process_monitor_events(&self) {
5173 self.process_pending_monitor_events();
5176 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
5177 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
5178 /// update was applied.
5180 /// This should only apply to HTLCs which were added to the holding cell because we were
5181 /// waiting on a monitor update to finish. In that case, we don't want to free the holding cell
5182 /// directly in `channel_monitor_updated` as it may introduce deadlocks calling back into user
5183 /// code to inform them of a channel monitor update.
5184 fn check_free_holding_cells(&self) -> bool {
5185 let mut has_monitor_update = false;
5186 let mut failed_htlcs = Vec::new();
5187 let mut handle_errors = Vec::new();
5189 let mut channel_state_lock = self.channel_state.lock().unwrap();
5190 let channel_state = &mut *channel_state_lock;
5191 let by_id = &mut channel_state.by_id;
5192 let short_to_chan_info = &mut channel_state.short_to_chan_info;
5193 let pending_msg_events = &mut channel_state.pending_msg_events;
5195 by_id.retain(|channel_id, chan| {
5196 match chan.maybe_free_holding_cell_htlcs(&self.logger) {
5197 Ok((commitment_opt, holding_cell_failed_htlcs)) => {
5198 if !holding_cell_failed_htlcs.is_empty() {
5200 holding_cell_failed_htlcs,
5202 chan.get_counterparty_node_id()
5205 if let Some((commitment_update, monitor_update)) = commitment_opt {
5206 match self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
5207 ChannelMonitorUpdateStatus::Completed => {
5208 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5209 node_id: chan.get_counterparty_node_id(),
5210 updates: commitment_update,
5214 has_monitor_update = true;
5215 let (res, close_channel) = handle_monitor_err!(self, e, short_to_chan_info, chan, RAACommitmentOrder::CommitmentFirst, channel_id, COMMITMENT_UPDATE_ONLY);
5216 handle_errors.push((chan.get_counterparty_node_id(), res));
5217 if close_channel { return false; }
5224 let (close_channel, res) = convert_chan_err!(self, e, short_to_chan_info, chan, channel_id);
5225 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5226 // ChannelClosed event is generated by handle_error for us
5233 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
5234 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
5235 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
5238 for (counterparty_node_id, err) in handle_errors.drain(..) {
5239 let _ = handle_error!(self, err, counterparty_node_id);
5245 /// Check whether any channels have finished removing all pending updates after a shutdown
5246 /// exchange and can now send a closing_signed.
5247 /// Returns whether any closing_signed messages were generated.
5248 fn maybe_generate_initial_closing_signed(&self) -> bool {
5249 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
5250 let mut has_update = false;
5252 let mut channel_state_lock = self.channel_state.lock().unwrap();
5253 let channel_state = &mut *channel_state_lock;
5254 let by_id = &mut channel_state.by_id;
5255 let short_to_chan_info = &mut channel_state.short_to_chan_info;
5256 let pending_msg_events = &mut channel_state.pending_msg_events;
5258 by_id.retain(|channel_id, chan| {
5259 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
5260 Ok((msg_opt, tx_opt)) => {
5261 if let Some(msg) = msg_opt {
5263 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5264 node_id: chan.get_counterparty_node_id(), msg,
5267 if let Some(tx) = tx_opt {
5268 // We're done with this channel. We got a closing_signed and sent back
5269 // a closing_signed with a closing transaction to broadcast.
5270 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5271 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5276 self.issue_channel_close_events(chan, ClosureReason::CooperativeClosure);
5278 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
5279 self.tx_broadcaster.broadcast_transaction(&tx);
5280 update_maps_on_chan_removal!(self, short_to_chan_info, chan);
5286 let (close_channel, res) = convert_chan_err!(self, e, short_to_chan_info, chan, channel_id);
5287 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5294 for (counterparty_node_id, err) in handle_errors.drain(..) {
5295 let _ = handle_error!(self, err, counterparty_node_id);
5301 /// Handle a list of channel failures during a block_connected or block_disconnected call,
5302 /// pushing the channel monitor update (if any) to the background events queue and removing the
5304 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
5305 for mut failure in failed_channels.drain(..) {
5306 // Either a commitment transactions has been confirmed on-chain or
5307 // Channel::block_disconnected detected that the funding transaction has been
5308 // reorganized out of the main chain.
5309 // We cannot broadcast our latest local state via monitor update (as
5310 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
5311 // so we track the update internally and handle it when the user next calls
5312 // timer_tick_occurred, guaranteeing we're running normally.
5313 if let Some((funding_txo, update)) = failure.0.take() {
5314 assert_eq!(update.updates.len(), 1);
5315 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
5316 assert!(should_broadcast);
5317 } else { unreachable!(); }
5318 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
5320 self.finish_force_close_channel(failure);
5324 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> {
5325 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
5327 if min_value_msat.is_some() && min_value_msat.unwrap() > MAX_VALUE_MSAT {
5328 return Err(APIError::APIMisuseError { err: format!("min_value_msat of {} greater than total 21 million bitcoin supply", min_value_msat.unwrap()) });
5331 let payment_secret = PaymentSecret(self.keys_manager.get_secure_random_bytes());
5333 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5334 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5335 match payment_secrets.entry(payment_hash) {
5336 hash_map::Entry::Vacant(e) => {
5337 e.insert(PendingInboundPayment {
5338 payment_secret, min_value_msat, payment_preimage,
5339 user_payment_id: 0, // For compatibility with version 0.0.103 and earlier
5340 // We assume that highest_seen_timestamp is pretty close to the current time -
5341 // it's updated when we receive a new block with the maximum time we've seen in
5342 // a header. It should never be more than two hours in the future.
5343 // Thus, we add two hours here as a buffer to ensure we absolutely
5344 // never fail a payment too early.
5345 // Note that we assume that received blocks have reasonably up-to-date
5347 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
5350 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
5355 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
5358 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
5359 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
5361 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
5362 /// will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
5363 /// passed directly to [`claim_funds`].
5365 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
5367 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5368 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5372 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5373 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5375 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5377 /// [`claim_funds`]: Self::claim_funds
5378 /// [`PaymentReceived`]: events::Event::PaymentReceived
5379 /// [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
5380 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5381 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), ()> {
5382 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)
5385 /// Legacy version of [`create_inbound_payment`]. Use this method if you wish to share
5386 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5388 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5391 /// This method is deprecated and will be removed soon.
5393 /// [`create_inbound_payment`]: Self::create_inbound_payment
5395 pub fn create_inbound_payment_legacy(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), APIError> {
5396 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
5397 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
5398 let payment_secret = self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs)?;
5399 Ok((payment_hash, payment_secret))
5402 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
5403 /// stored external to LDK.
5405 /// A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
5406 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
5407 /// the `min_value_msat` provided here, if one is provided.
5409 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
5410 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
5413 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
5414 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
5415 /// before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
5416 /// sender "proof-of-payment" unless they have paid the required amount.
5418 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
5419 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
5420 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
5421 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
5422 /// invoices when no timeout is set.
5424 /// Note that we use block header time to time-out pending inbound payments (with some margin
5425 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
5426 /// accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
5427 /// If you need exact expiry semantics, you should enforce them upon receipt of
5428 /// [`PaymentReceived`].
5430 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
5431 /// set to at least [`MIN_FINAL_CLTV_EXPIRY`].
5433 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5434 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5438 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5439 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5441 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5443 /// [`create_inbound_payment`]: Self::create_inbound_payment
5444 /// [`PaymentReceived`]: events::Event::PaymentReceived
5445 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<PaymentSecret, ()> {
5446 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)
5449 /// Legacy version of [`create_inbound_payment_for_hash`]. Use this method if you wish to share
5450 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5452 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5455 /// This method is deprecated and will be removed soon.
5457 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5459 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> {
5460 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
5463 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
5464 /// previously returned from [`create_inbound_payment`].
5466 /// [`create_inbound_payment`]: Self::create_inbound_payment
5467 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
5468 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
5471 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
5472 /// are used when constructing the phantom invoice's route hints.
5474 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5475 pub fn get_phantom_scid(&self) -> u64 {
5476 let mut channel_state = self.channel_state.lock().unwrap();
5477 let best_block = self.best_block.read().unwrap();
5479 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block.height(), &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
5480 // Ensure the generated scid doesn't conflict with a real channel.
5481 match channel_state.short_to_chan_info.entry(scid_candidate) {
5482 hash_map::Entry::Occupied(_) => continue,
5483 hash_map::Entry::Vacant(_) => return scid_candidate
5488 /// Gets route hints for use in receiving [phantom node payments].
5490 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5491 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
5493 channels: self.list_usable_channels(),
5494 phantom_scid: self.get_phantom_scid(),
5495 real_node_pubkey: self.get_our_node_id(),
5499 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
5500 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
5501 let events = core::cell::RefCell::new(Vec::new());
5502 let event_handler = |event: &events::Event| events.borrow_mut().push(event.clone());
5503 self.process_pending_events(&event_handler);
5508 pub fn has_pending_payments(&self) -> bool {
5509 !self.pending_outbound_payments.lock().unwrap().is_empty()
5513 pub fn clear_pending_payments(&self) {
5514 self.pending_outbound_payments.lock().unwrap().clear()
5518 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<Signer, M, T, K, F, L>
5519 where M::Target: chain::Watch<Signer>,
5520 T::Target: BroadcasterInterface,
5521 K::Target: KeysInterface<Signer = Signer>,
5522 F::Target: FeeEstimator,
5525 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
5526 let events = RefCell::new(Vec::new());
5527 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5528 let mut result = NotifyOption::SkipPersist;
5530 // TODO: This behavior should be documented. It's unintuitive that we query
5531 // ChannelMonitors when clearing other events.
5532 if self.process_pending_monitor_events() {
5533 result = NotifyOption::DoPersist;
5536 if self.check_free_holding_cells() {
5537 result = NotifyOption::DoPersist;
5539 if self.maybe_generate_initial_closing_signed() {
5540 result = NotifyOption::DoPersist;
5543 let mut pending_events = Vec::new();
5544 let mut channel_state = self.channel_state.lock().unwrap();
5545 mem::swap(&mut pending_events, &mut channel_state.pending_msg_events);
5547 if !pending_events.is_empty() {
5548 events.replace(pending_events);
5557 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> EventsProvider for ChannelManager<Signer, M, T, K, F, L>
5559 M::Target: chain::Watch<Signer>,
5560 T::Target: BroadcasterInterface,
5561 K::Target: KeysInterface<Signer = Signer>,
5562 F::Target: FeeEstimator,
5565 /// Processes events that must be periodically handled.
5567 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
5568 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
5569 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
5570 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5571 let mut result = NotifyOption::SkipPersist;
5573 // TODO: This behavior should be documented. It's unintuitive that we query
5574 // ChannelMonitors when clearing other events.
5575 if self.process_pending_monitor_events() {
5576 result = NotifyOption::DoPersist;
5579 let mut pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5580 if !pending_events.is_empty() {
5581 result = NotifyOption::DoPersist;
5584 for event in pending_events.drain(..) {
5585 handler.handle_event(&event);
5593 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Listen for ChannelManager<Signer, M, T, K, F, L>
5595 M::Target: chain::Watch<Signer>,
5596 T::Target: BroadcasterInterface,
5597 K::Target: KeysInterface<Signer = Signer>,
5598 F::Target: FeeEstimator,
5601 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5603 let best_block = self.best_block.read().unwrap();
5604 assert_eq!(best_block.block_hash(), header.prev_blockhash,
5605 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
5606 assert_eq!(best_block.height(), height - 1,
5607 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
5610 self.transactions_confirmed(header, txdata, height);
5611 self.best_block_updated(header, height);
5614 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
5615 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5616 let new_height = height - 1;
5618 let mut best_block = self.best_block.write().unwrap();
5619 assert_eq!(best_block.block_hash(), header.block_hash(),
5620 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
5621 assert_eq!(best_block.height(), height,
5622 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
5623 *best_block = BestBlock::new(header.prev_blockhash, new_height)
5626 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));
5630 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Confirm for ChannelManager<Signer, M, T, K, F, L>
5632 M::Target: chain::Watch<Signer>,
5633 T::Target: BroadcasterInterface,
5634 K::Target: KeysInterface<Signer = Signer>,
5635 F::Target: FeeEstimator,
5638 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5639 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5640 // during initialization prior to the chain_monitor being fully configured in some cases.
5641 // See the docs for `ChannelManagerReadArgs` for more.
5643 let block_hash = header.block_hash();
5644 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
5646 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5647 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)
5648 .map(|(a, b)| (a, Vec::new(), b)));
5650 let last_best_block_height = self.best_block.read().unwrap().height();
5651 if height < last_best_block_height {
5652 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
5653 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));
5657 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
5658 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5659 // during initialization prior to the chain_monitor being fully configured in some cases.
5660 // See the docs for `ChannelManagerReadArgs` for more.
5662 let block_hash = header.block_hash();
5663 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
5665 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5667 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
5669 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));
5671 macro_rules! max_time {
5672 ($timestamp: expr) => {
5674 // Update $timestamp to be the max of its current value and the block
5675 // timestamp. This should keep us close to the current time without relying on
5676 // having an explicit local time source.
5677 // Just in case we end up in a race, we loop until we either successfully
5678 // update $timestamp or decide we don't need to.
5679 let old_serial = $timestamp.load(Ordering::Acquire);
5680 if old_serial >= header.time as usize { break; }
5681 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
5687 max_time!(self.highest_seen_timestamp);
5688 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5689 payment_secrets.retain(|_, inbound_payment| {
5690 inbound_payment.expiry_time > header.time as u64
5693 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
5694 let mut pending_events = self.pending_events.lock().unwrap();
5695 outbounds.retain(|payment_id, payment| {
5696 if payment.remaining_parts() != 0 { return true }
5697 if let PendingOutboundPayment::Retryable { starting_block_height, payment_hash, .. } = payment {
5698 if *starting_block_height + PAYMENT_EXPIRY_BLOCKS <= height {
5699 log_info!(self.logger, "Timing out payment with id {} and hash {}", log_bytes!(payment_id.0), log_bytes!(payment_hash.0));
5700 pending_events.push(events::Event::PaymentFailed {
5701 payment_id: *payment_id, payment_hash: *payment_hash,
5709 fn get_relevant_txids(&self) -> Vec<Txid> {
5710 let channel_state = self.channel_state.lock().unwrap();
5711 let mut res = Vec::with_capacity(channel_state.short_to_chan_info.len());
5712 for chan in channel_state.by_id.values() {
5713 if let Some(funding_txo) = chan.get_funding_txo() {
5714 res.push(funding_txo.txid);
5720 fn transaction_unconfirmed(&self, txid: &Txid) {
5721 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5722 self.do_chain_event(None, |channel| {
5723 if let Some(funding_txo) = channel.get_funding_txo() {
5724 if funding_txo.txid == *txid {
5725 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
5726 } else { Ok((None, Vec::new(), None)) }
5727 } else { Ok((None, Vec::new(), None)) }
5732 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
5734 M::Target: chain::Watch<Signer>,
5735 T::Target: BroadcasterInterface,
5736 K::Target: KeysInterface<Signer = Signer>,
5737 F::Target: FeeEstimator,
5740 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
5741 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
5743 fn do_chain_event<FN: Fn(&mut Channel<Signer>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
5744 (&self, height_opt: Option<u32>, f: FN) {
5745 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5746 // during initialization prior to the chain_monitor being fully configured in some cases.
5747 // See the docs for `ChannelManagerReadArgs` for more.
5749 let mut failed_channels = Vec::new();
5750 let mut timed_out_htlcs = Vec::new();
5752 let mut channel_lock = self.channel_state.lock().unwrap();
5753 let channel_state = &mut *channel_lock;
5754 let short_to_chan_info = &mut channel_state.short_to_chan_info;
5755 let pending_msg_events = &mut channel_state.pending_msg_events;
5756 channel_state.by_id.retain(|_, channel| {
5757 let res = f(channel);
5758 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
5759 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
5760 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
5761 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::Reason {
5763 }, HTLCDestination::NextHopChannel { node_id: Some(channel.get_counterparty_node_id()), channel_id: channel.channel_id() }));
5765 if let Some(channel_ready) = channel_ready_opt {
5766 send_channel_ready!(short_to_chan_info, pending_msg_events, channel, channel_ready);
5767 if channel.is_usable() {
5768 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", log_bytes!(channel.channel_id()));
5769 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
5770 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
5771 node_id: channel.get_counterparty_node_id(),
5776 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", log_bytes!(channel.channel_id()));
5779 if let Some(announcement_sigs) = announcement_sigs {
5780 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(channel.channel_id()));
5781 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5782 node_id: channel.get_counterparty_node_id(),
5783 msg: announcement_sigs,
5785 if let Some(height) = height_opt {
5786 if let Some(announcement) = channel.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash, height) {
5787 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5789 // Note that announcement_signatures fails if the channel cannot be announced,
5790 // so get_channel_update_for_broadcast will never fail by the time we get here.
5791 update_msg: self.get_channel_update_for_broadcast(channel).unwrap(),
5796 if channel.is_our_channel_ready() {
5797 if let Some(real_scid) = channel.get_short_channel_id() {
5798 // If we sent a 0conf channel_ready, and now have an SCID, we add it
5799 // to the short_to_chan_info map here. Note that we check whether we
5800 // can relay using the real SCID at relay-time (i.e.
5801 // enforce option_scid_alias then), and if the funding tx is ever
5802 // un-confirmed we force-close the channel, ensuring short_to_chan_info
5803 // is always consistent.
5804 let scid_insert = short_to_chan_info.insert(real_scid, (channel.get_counterparty_node_id(), channel.channel_id()));
5805 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.get_counterparty_node_id(), channel.channel_id()),
5806 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
5807 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
5810 } else if let Err(reason) = res {
5811 update_maps_on_chan_removal!(self, short_to_chan_info, channel);
5812 // It looks like our counterparty went on-chain or funding transaction was
5813 // reorged out of the main chain. Close the channel.
5814 failed_channels.push(channel.force_shutdown(true));
5815 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
5816 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5820 let reason_message = format!("{}", reason);
5821 self.issue_channel_close_events(channel, reason);
5822 pending_msg_events.push(events::MessageSendEvent::HandleError {
5823 node_id: channel.get_counterparty_node_id(),
5824 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
5825 channel_id: channel.channel_id(),
5826 data: reason_message,
5834 if let Some(height) = height_opt {
5835 channel_state.claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
5836 htlcs.retain(|htlc| {
5837 // If height is approaching the number of blocks we think it takes us to get
5838 // our commitment transaction confirmed before the HTLC expires, plus the
5839 // number of blocks we generally consider it to take to do a commitment update,
5840 // just give up on it and fail the HTLC.
5841 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
5842 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
5843 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(height));
5845 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(), HTLCFailReason::Reason {
5846 failure_code: 0x4000 | 15,
5847 data: htlc_msat_height_data
5848 }, HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
5852 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
5857 self.handle_init_event_channel_failures(failed_channels);
5859 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
5860 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), source, &payment_hash, reason, destination);
5864 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
5865 /// indicating whether persistence is necessary. Only one listener on
5866 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
5869 /// Note that this method is not available with the `no-std` feature.
5870 #[cfg(any(test, feature = "std"))]
5871 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
5872 self.persistence_notifier.wait_timeout(max_wait)
5875 /// Blocks until ChannelManager needs to be persisted. Only one listener on
5876 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
5878 pub fn await_persistable_update(&self) {
5879 self.persistence_notifier.wait()
5882 /// Gets a [`Future`] that completes when a persistable update is available. Note that
5883 /// callbacks registered on the [`Future`] MUST NOT call back into this [`ChannelManager`] and
5884 /// should instead register actions to be taken later.
5885 pub fn get_persistable_update_future(&self) -> Future {
5886 self.persistence_notifier.get_future()
5889 #[cfg(any(test, feature = "_test_utils"))]
5890 pub fn get_persistence_condvar_value(&self) -> bool {
5891 self.persistence_notifier.notify_pending()
5894 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
5895 /// [`chain::Confirm`] interfaces.
5896 pub fn current_best_block(&self) -> BestBlock {
5897 self.best_block.read().unwrap().clone()
5901 impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
5902 ChannelMessageHandler for ChannelManager<Signer, M, T, K, F, L>
5903 where M::Target: chain::Watch<Signer>,
5904 T::Target: BroadcasterInterface,
5905 K::Target: KeysInterface<Signer = Signer>,
5906 F::Target: FeeEstimator,
5909 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
5910 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5911 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
5914 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
5915 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5916 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
5919 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
5920 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5921 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
5924 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
5925 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5926 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
5929 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
5930 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5931 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
5934 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) {
5935 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5936 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, their_features, msg), *counterparty_node_id);
5939 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
5940 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5941 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
5944 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
5945 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5946 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
5949 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
5950 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5951 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
5954 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
5955 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5956 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
5959 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
5960 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5961 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
5964 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
5965 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5966 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
5969 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
5970 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5971 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
5974 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
5975 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5976 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
5979 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
5980 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5981 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
5984 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
5985 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5986 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
5989 NotifyOption::SkipPersist
5994 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
5995 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5996 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
5999 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
6000 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6001 let mut failed_channels = Vec::new();
6002 let mut no_channels_remain = true;
6004 let mut channel_state_lock = self.channel_state.lock().unwrap();
6005 let channel_state = &mut *channel_state_lock;
6006 let pending_msg_events = &mut channel_state.pending_msg_events;
6007 let short_to_chan_info = &mut channel_state.short_to_chan_info;
6008 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates. We believe we {} make future connections to this peer.",
6009 log_pubkey!(counterparty_node_id), if no_connection_possible { "cannot" } else { "can" });
6010 channel_state.by_id.retain(|_, chan| {
6011 if chan.get_counterparty_node_id() == *counterparty_node_id {
6012 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
6013 if chan.is_shutdown() {
6014 update_maps_on_chan_removal!(self, short_to_chan_info, chan);
6015 self.issue_channel_close_events(chan, ClosureReason::DisconnectedPeer);
6018 no_channels_remain = false;
6023 pending_msg_events.retain(|msg| {
6025 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != counterparty_node_id,
6026 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != counterparty_node_id,
6027 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != counterparty_node_id,
6028 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != counterparty_node_id,
6029 &events::MessageSendEvent::SendChannelReady { ref node_id, .. } => node_id != counterparty_node_id,
6030 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != counterparty_node_id,
6031 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != counterparty_node_id,
6032 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != counterparty_node_id,
6033 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != counterparty_node_id,
6034 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != counterparty_node_id,
6035 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != counterparty_node_id,
6036 &events::MessageSendEvent::SendChannelAnnouncement { ref node_id, .. } => node_id != counterparty_node_id,
6037 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
6038 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
6039 &events::MessageSendEvent::SendChannelUpdate { ref node_id, .. } => node_id != counterparty_node_id,
6040 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != counterparty_node_id,
6041 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
6042 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
6043 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
6044 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
6048 if no_channels_remain {
6049 self.per_peer_state.write().unwrap().remove(counterparty_node_id);
6052 for failure in failed_channels.drain(..) {
6053 self.finish_force_close_channel(failure);
6057 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) -> Result<(), ()> {
6058 if !init_msg.features.supports_static_remote_key() {
6059 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(counterparty_node_id));
6063 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
6065 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6068 let mut peer_state_lock = self.per_peer_state.write().unwrap();
6069 match peer_state_lock.entry(counterparty_node_id.clone()) {
6070 hash_map::Entry::Vacant(e) => {
6071 e.insert(Mutex::new(PeerState {
6072 latest_features: init_msg.features.clone(),
6075 hash_map::Entry::Occupied(e) => {
6076 e.get().lock().unwrap().latest_features = init_msg.features.clone();
6081 let mut channel_state_lock = self.channel_state.lock().unwrap();
6082 let channel_state = &mut *channel_state_lock;
6083 let pending_msg_events = &mut channel_state.pending_msg_events;
6084 channel_state.by_id.retain(|_, chan| {
6085 let retain = if chan.get_counterparty_node_id() == *counterparty_node_id {
6086 if !chan.have_received_message() {
6087 // If we created this (outbound) channel while we were disconnected from the
6088 // peer we probably failed to send the open_channel message, which is now
6089 // lost. We can't have had anything pending related to this channel, so we just
6093 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
6094 node_id: chan.get_counterparty_node_id(),
6095 msg: chan.get_channel_reestablish(&self.logger),
6100 if retain && chan.get_counterparty_node_id() != *counterparty_node_id {
6101 if let Some(msg) = chan.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height()) {
6102 if let Ok(update_msg) = self.get_channel_update_for_broadcast(chan) {
6103 pending_msg_events.push(events::MessageSendEvent::SendChannelAnnouncement {
6104 node_id: *counterparty_node_id,
6112 //TODO: Also re-broadcast announcement_signatures
6116 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
6117 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6119 if msg.channel_id == [0; 32] {
6120 for chan in self.list_channels() {
6121 if chan.counterparty.node_id == *counterparty_node_id {
6122 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6123 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data), true);
6128 // First check if we can advance the channel type and try again.
6129 let mut channel_state = self.channel_state.lock().unwrap();
6130 if let Some(chan) = channel_state.by_id.get_mut(&msg.channel_id) {
6131 if chan.get_counterparty_node_id() != *counterparty_node_id {
6134 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash) {
6135 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
6136 node_id: *counterparty_node_id,
6144 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6145 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
6149 fn provided_node_features(&self) -> NodeFeatures {
6150 provided_node_features()
6153 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
6154 provided_init_features()
6158 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
6159 /// [`ChannelManager`].
6160 pub fn provided_node_features() -> NodeFeatures {
6161 provided_init_features().to_context()
6164 /// Fetches the set of [`InvoiceFeatures`] flags which are provided by or required by
6165 /// [`ChannelManager`].
6167 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
6168 /// or not. Thus, this method is not public.
6169 #[cfg(any(feature = "_test_utils", test))]
6170 pub fn provided_invoice_features() -> InvoiceFeatures {
6171 provided_init_features().to_context()
6174 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
6175 /// [`ChannelManager`].
6176 pub fn provided_channel_features() -> ChannelFeatures {
6177 provided_init_features().to_context()
6180 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
6181 /// [`ChannelManager`].
6182 pub fn provided_init_features() -> InitFeatures {
6183 // Note that if new features are added here which other peers may (eventually) require, we
6184 // should also add the corresponding (optional) bit to the ChannelMessageHandler impl for
6185 // ErroringMessageHandler.
6186 let mut features = InitFeatures::empty();
6187 features.set_data_loss_protect_optional();
6188 features.set_upfront_shutdown_script_optional();
6189 features.set_variable_length_onion_required();
6190 features.set_static_remote_key_required();
6191 features.set_payment_secret_required();
6192 features.set_basic_mpp_optional();
6193 features.set_wumbo_optional();
6194 features.set_shutdown_any_segwit_optional();
6195 features.set_channel_type_optional();
6196 features.set_scid_privacy_optional();
6197 features.set_zero_conf_optional();
6201 const SERIALIZATION_VERSION: u8 = 1;
6202 const MIN_SERIALIZATION_VERSION: u8 = 1;
6204 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
6205 (2, fee_base_msat, required),
6206 (4, fee_proportional_millionths, required),
6207 (6, cltv_expiry_delta, required),
6210 impl_writeable_tlv_based!(ChannelCounterparty, {
6211 (2, node_id, required),
6212 (4, features, required),
6213 (6, unspendable_punishment_reserve, required),
6214 (8, forwarding_info, option),
6215 (9, outbound_htlc_minimum_msat, option),
6216 (11, outbound_htlc_maximum_msat, option),
6219 impl_writeable_tlv_based!(ChannelDetails, {
6220 (1, inbound_scid_alias, option),
6221 (2, channel_id, required),
6222 (3, channel_type, option),
6223 (4, counterparty, required),
6224 (5, outbound_scid_alias, option),
6225 (6, funding_txo, option),
6226 (7, config, option),
6227 (8, short_channel_id, option),
6228 (10, channel_value_satoshis, required),
6229 (12, unspendable_punishment_reserve, option),
6230 (14, user_channel_id, required),
6231 (16, balance_msat, required),
6232 (18, outbound_capacity_msat, required),
6233 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6234 // filled in, so we can safely unwrap it here.
6235 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6236 (20, inbound_capacity_msat, required),
6237 (22, confirmations_required, option),
6238 (24, force_close_spend_delay, option),
6239 (26, is_outbound, required),
6240 (28, is_channel_ready, required),
6241 (30, is_usable, required),
6242 (32, is_public, required),
6243 (33, inbound_htlc_minimum_msat, option),
6244 (35, inbound_htlc_maximum_msat, option),
6247 impl_writeable_tlv_based!(PhantomRouteHints, {
6248 (2, channels, vec_type),
6249 (4, phantom_scid, required),
6250 (6, real_node_pubkey, required),
6253 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
6255 (0, onion_packet, required),
6256 (2, short_channel_id, required),
6259 (0, payment_data, required),
6260 (1, phantom_shared_secret, option),
6261 (2, incoming_cltv_expiry, required),
6263 (2, ReceiveKeysend) => {
6264 (0, payment_preimage, required),
6265 (2, incoming_cltv_expiry, required),
6269 impl_writeable_tlv_based!(PendingHTLCInfo, {
6270 (0, routing, required),
6271 (2, incoming_shared_secret, required),
6272 (4, payment_hash, required),
6273 (6, amt_to_forward, required),
6274 (8, outgoing_cltv_value, required)
6278 impl Writeable for HTLCFailureMsg {
6279 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6281 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
6283 channel_id.write(writer)?;
6284 htlc_id.write(writer)?;
6285 reason.write(writer)?;
6287 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6288 channel_id, htlc_id, sha256_of_onion, failure_code
6291 channel_id.write(writer)?;
6292 htlc_id.write(writer)?;
6293 sha256_of_onion.write(writer)?;
6294 failure_code.write(writer)?;
6301 impl Readable for HTLCFailureMsg {
6302 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6303 let id: u8 = Readable::read(reader)?;
6306 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
6307 channel_id: Readable::read(reader)?,
6308 htlc_id: Readable::read(reader)?,
6309 reason: Readable::read(reader)?,
6313 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6314 channel_id: Readable::read(reader)?,
6315 htlc_id: Readable::read(reader)?,
6316 sha256_of_onion: Readable::read(reader)?,
6317 failure_code: Readable::read(reader)?,
6320 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
6321 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
6322 // messages contained in the variants.
6323 // In version 0.0.101, support for reading the variants with these types was added, and
6324 // we should migrate to writing these variants when UpdateFailHTLC or
6325 // UpdateFailMalformedHTLC get TLV fields.
6327 let length: BigSize = Readable::read(reader)?;
6328 let mut s = FixedLengthReader::new(reader, length.0);
6329 let res = Readable::read(&mut s)?;
6330 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6331 Ok(HTLCFailureMsg::Relay(res))
6334 let length: BigSize = Readable::read(reader)?;
6335 let mut s = FixedLengthReader::new(reader, length.0);
6336 let res = Readable::read(&mut s)?;
6337 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6338 Ok(HTLCFailureMsg::Malformed(res))
6340 _ => Err(DecodeError::UnknownRequiredFeature),
6345 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
6350 impl_writeable_tlv_based!(HTLCPreviousHopData, {
6351 (0, short_channel_id, required),
6352 (1, phantom_shared_secret, option),
6353 (2, outpoint, required),
6354 (4, htlc_id, required),
6355 (6, incoming_packet_shared_secret, required)
6358 impl Writeable for ClaimableHTLC {
6359 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6360 let (payment_data, keysend_preimage) = match &self.onion_payload {
6361 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
6362 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
6364 write_tlv_fields!(writer, {
6365 (0, self.prev_hop, required),
6366 (1, self.total_msat, required),
6367 (2, self.value, required),
6368 (4, payment_data, option),
6369 (6, self.cltv_expiry, required),
6370 (8, keysend_preimage, option),
6376 impl Readable for ClaimableHTLC {
6377 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6378 let mut prev_hop = ::util::ser::OptionDeserWrapper(None);
6380 let mut payment_data: Option<msgs::FinalOnionHopData> = None;
6381 let mut cltv_expiry = 0;
6382 let mut total_msat = None;
6383 let mut keysend_preimage: Option<PaymentPreimage> = None;
6384 read_tlv_fields!(reader, {
6385 (0, prev_hop, required),
6386 (1, total_msat, option),
6387 (2, value, required),
6388 (4, payment_data, option),
6389 (6, cltv_expiry, required),
6390 (8, keysend_preimage, option)
6392 let onion_payload = match keysend_preimage {
6394 if payment_data.is_some() {
6395 return Err(DecodeError::InvalidValue)
6397 if total_msat.is_none() {
6398 total_msat = Some(value);
6400 OnionPayload::Spontaneous(p)
6403 if total_msat.is_none() {
6404 if payment_data.is_none() {
6405 return Err(DecodeError::InvalidValue)
6407 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
6409 OnionPayload::Invoice { _legacy_hop_data: payment_data }
6413 prev_hop: prev_hop.0.unwrap(),
6416 total_msat: total_msat.unwrap(),
6423 impl Readable for HTLCSource {
6424 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6425 let id: u8 = Readable::read(reader)?;
6428 let mut session_priv: ::util::ser::OptionDeserWrapper<SecretKey> = ::util::ser::OptionDeserWrapper(None);
6429 let mut first_hop_htlc_msat: u64 = 0;
6430 let mut path = Some(Vec::new());
6431 let mut payment_id = None;
6432 let mut payment_secret = None;
6433 let mut payment_params = None;
6434 read_tlv_fields!(reader, {
6435 (0, session_priv, required),
6436 (1, payment_id, option),
6437 (2, first_hop_htlc_msat, required),
6438 (3, payment_secret, option),
6439 (4, path, vec_type),
6440 (5, payment_params, option),
6442 if payment_id.is_none() {
6443 // For backwards compat, if there was no payment_id written, use the session_priv bytes
6445 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
6447 Ok(HTLCSource::OutboundRoute {
6448 session_priv: session_priv.0.unwrap(),
6449 first_hop_htlc_msat: first_hop_htlc_msat,
6450 path: path.unwrap(),
6451 payment_id: payment_id.unwrap(),
6456 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
6457 _ => Err(DecodeError::UnknownRequiredFeature),
6462 impl Writeable for HTLCSource {
6463 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::io::Error> {
6465 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id, payment_secret, payment_params } => {
6467 let payment_id_opt = Some(payment_id);
6468 write_tlv_fields!(writer, {
6469 (0, session_priv, required),
6470 (1, payment_id_opt, option),
6471 (2, first_hop_htlc_msat, required),
6472 (3, payment_secret, option),
6473 (4, path, vec_type),
6474 (5, payment_params, option),
6477 HTLCSource::PreviousHopData(ref field) => {
6479 field.write(writer)?;
6486 impl_writeable_tlv_based_enum!(HTLCFailReason,
6487 (0, LightningError) => {
6491 (0, failure_code, required),
6492 (2, data, vec_type),
6496 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
6498 (0, forward_info, required),
6499 (2, prev_short_channel_id, required),
6500 (4, prev_htlc_id, required),
6501 (6, prev_funding_outpoint, required),
6504 (0, htlc_id, required),
6505 (2, err_packet, required),
6509 impl_writeable_tlv_based!(PendingInboundPayment, {
6510 (0, payment_secret, required),
6511 (2, expiry_time, required),
6512 (4, user_payment_id, required),
6513 (6, payment_preimage, required),
6514 (8, min_value_msat, required),
6517 impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
6519 (0, session_privs, required),
6522 (0, session_privs, required),
6523 (1, payment_hash, option),
6526 (0, session_privs, required),
6527 (1, pending_fee_msat, option),
6528 (2, payment_hash, required),
6529 (4, payment_secret, option),
6530 (6, total_msat, required),
6531 (8, pending_amt_msat, required),
6532 (10, starting_block_height, required),
6535 (0, session_privs, required),
6536 (2, payment_hash, required),
6540 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Writeable for ChannelManager<Signer, M, T, K, F, L>
6541 where M::Target: chain::Watch<Signer>,
6542 T::Target: BroadcasterInterface,
6543 K::Target: KeysInterface<Signer = Signer>,
6544 F::Target: FeeEstimator,
6547 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6548 let _consistency_lock = self.total_consistency_lock.write().unwrap();
6550 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
6552 self.genesis_hash.write(writer)?;
6554 let best_block = self.best_block.read().unwrap();
6555 best_block.height().write(writer)?;
6556 best_block.block_hash().write(writer)?;
6559 let channel_state = self.channel_state.lock().unwrap();
6560 let mut unfunded_channels = 0;
6561 for (_, channel) in channel_state.by_id.iter() {
6562 if !channel.is_funding_initiated() {
6563 unfunded_channels += 1;
6566 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
6567 for (_, channel) in channel_state.by_id.iter() {
6568 if channel.is_funding_initiated() {
6569 channel.write(writer)?;
6573 (channel_state.forward_htlcs.len() as u64).write(writer)?;
6574 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
6575 short_channel_id.write(writer)?;
6576 (pending_forwards.len() as u64).write(writer)?;
6577 for forward in pending_forwards {
6578 forward.write(writer)?;
6582 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
6583 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
6584 for (payment_hash, (purpose, previous_hops)) in channel_state.claimable_htlcs.iter() {
6585 payment_hash.write(writer)?;
6586 (previous_hops.len() as u64).write(writer)?;
6587 for htlc in previous_hops.iter() {
6588 htlc.write(writer)?;
6590 htlc_purposes.push(purpose);
6593 let per_peer_state = self.per_peer_state.write().unwrap();
6594 (per_peer_state.len() as u64).write(writer)?;
6595 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
6596 peer_pubkey.write(writer)?;
6597 let peer_state = peer_state_mutex.lock().unwrap();
6598 peer_state.latest_features.write(writer)?;
6601 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
6602 let pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
6603 let events = self.pending_events.lock().unwrap();
6604 (events.len() as u64).write(writer)?;
6605 for event in events.iter() {
6606 event.write(writer)?;
6609 let background_events = self.pending_background_events.lock().unwrap();
6610 (background_events.len() as u64).write(writer)?;
6611 for event in background_events.iter() {
6613 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
6615 funding_txo.write(writer)?;
6616 monitor_update.write(writer)?;
6621 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
6622 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
6623 // likely to be identical.
6624 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
6625 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
6627 (pending_inbound_payments.len() as u64).write(writer)?;
6628 for (hash, pending_payment) in pending_inbound_payments.iter() {
6629 hash.write(writer)?;
6630 pending_payment.write(writer)?;
6633 // For backwards compat, write the session privs and their total length.
6634 let mut num_pending_outbounds_compat: u64 = 0;
6635 for (_, outbound) in pending_outbound_payments.iter() {
6636 if !outbound.is_fulfilled() && !outbound.abandoned() {
6637 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
6640 num_pending_outbounds_compat.write(writer)?;
6641 for (_, outbound) in pending_outbound_payments.iter() {
6643 PendingOutboundPayment::Legacy { session_privs } |
6644 PendingOutboundPayment::Retryable { session_privs, .. } => {
6645 for session_priv in session_privs.iter() {
6646 session_priv.write(writer)?;
6649 PendingOutboundPayment::Fulfilled { .. } => {},
6650 PendingOutboundPayment::Abandoned { .. } => {},
6654 // Encode without retry info for 0.0.101 compatibility.
6655 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
6656 for (id, outbound) in pending_outbound_payments.iter() {
6658 PendingOutboundPayment::Legacy { session_privs } |
6659 PendingOutboundPayment::Retryable { session_privs, .. } => {
6660 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
6665 write_tlv_fields!(writer, {
6666 (1, pending_outbound_payments_no_retry, required),
6667 (3, pending_outbound_payments, required),
6668 (5, self.our_network_pubkey, required),
6669 (7, self.fake_scid_rand_bytes, required),
6670 (9, htlc_purposes, vec_type),
6671 (11, self.probing_cookie_secret, required),
6678 /// Arguments for the creation of a ChannelManager that are not deserialized.
6680 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
6682 /// 1) Deserialize all stored [`ChannelMonitor`]s.
6683 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
6684 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
6685 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
6686 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
6687 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
6688 /// same way you would handle a [`chain::Filter`] call using
6689 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
6690 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
6691 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
6692 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
6693 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
6694 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
6696 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
6697 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
6699 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
6700 /// call any other methods on the newly-deserialized [`ChannelManager`].
6702 /// Note that because some channels may be closed during deserialization, it is critical that you
6703 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
6704 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
6705 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
6706 /// not force-close the same channels but consider them live), you may end up revoking a state for
6707 /// which you've already broadcasted the transaction.
6709 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
6710 pub struct ChannelManagerReadArgs<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6711 where M::Target: chain::Watch<Signer>,
6712 T::Target: BroadcasterInterface,
6713 K::Target: KeysInterface<Signer = Signer>,
6714 F::Target: FeeEstimator,
6717 /// The keys provider which will give us relevant keys. Some keys will be loaded during
6718 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
6720 pub keys_manager: K,
6722 /// The fee_estimator for use in the ChannelManager in the future.
6724 /// No calls to the FeeEstimator will be made during deserialization.
6725 pub fee_estimator: F,
6726 /// The chain::Watch for use in the ChannelManager in the future.
6728 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
6729 /// you have deserialized ChannelMonitors separately and will add them to your
6730 /// chain::Watch after deserializing this ChannelManager.
6731 pub chain_monitor: M,
6733 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
6734 /// used to broadcast the latest local commitment transactions of channels which must be
6735 /// force-closed during deserialization.
6736 pub tx_broadcaster: T,
6737 /// The Logger for use in the ChannelManager and which may be used to log information during
6738 /// deserialization.
6740 /// Default settings used for new channels. Any existing channels will continue to use the
6741 /// runtime settings which were stored when the ChannelManager was serialized.
6742 pub default_config: UserConfig,
6744 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
6745 /// value.get_funding_txo() should be the key).
6747 /// If a monitor is inconsistent with the channel state during deserialization the channel will
6748 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
6749 /// is true for missing channels as well. If there is a monitor missing for which we find
6750 /// channel data Err(DecodeError::InvalidValue) will be returned.
6752 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
6755 /// (C-not exported) because we have no HashMap bindings
6756 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<Signer>>,
6759 impl<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6760 ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>
6761 where M::Target: chain::Watch<Signer>,
6762 T::Target: BroadcasterInterface,
6763 K::Target: KeysInterface<Signer = Signer>,
6764 F::Target: FeeEstimator,
6767 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
6768 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
6769 /// populate a HashMap directly from C.
6770 pub fn new(keys_manager: K, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, logger: L, default_config: UserConfig,
6771 mut channel_monitors: Vec<&'a mut ChannelMonitor<Signer>>) -> Self {
6773 keys_manager, fee_estimator, chain_monitor, tx_broadcaster, logger, default_config,
6774 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
6779 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
6780 // SipmleArcChannelManager type:
6781 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6782 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, Arc<ChannelManager<Signer, M, T, K, F, L>>)
6783 where M::Target: chain::Watch<Signer>,
6784 T::Target: BroadcasterInterface,
6785 K::Target: KeysInterface<Signer = Signer>,
6786 F::Target: FeeEstimator,
6789 fn read<R: io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
6790 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<Signer, M, T, K, F, L>)>::read(reader, args)?;
6791 Ok((blockhash, Arc::new(chan_manager)))
6795 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6796 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, ChannelManager<Signer, M, T, K, F, L>)
6797 where M::Target: chain::Watch<Signer>,
6798 T::Target: BroadcasterInterface,
6799 K::Target: KeysInterface<Signer = Signer>,
6800 F::Target: FeeEstimator,
6803 fn read<R: io::Read>(reader: &mut R, mut args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
6804 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
6806 let genesis_hash: BlockHash = Readable::read(reader)?;
6807 let best_block_height: u32 = Readable::read(reader)?;
6808 let best_block_hash: BlockHash = Readable::read(reader)?;
6810 let mut failed_htlcs = Vec::new();
6812 let channel_count: u64 = Readable::read(reader)?;
6813 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
6814 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
6815 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
6816 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
6817 let mut channel_closures = Vec::new();
6818 for _ in 0..channel_count {
6819 let mut channel: Channel<Signer> = Channel::read(reader, (&args.keys_manager, best_block_height))?;
6820 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
6821 funding_txo_set.insert(funding_txo.clone());
6822 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
6823 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
6824 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
6825 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
6826 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
6827 // If the channel is ahead of the monitor, return InvalidValue:
6828 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
6829 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
6830 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
6831 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
6832 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
6833 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
6834 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");
6835 return Err(DecodeError::InvalidValue);
6836 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
6837 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
6838 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
6839 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
6840 // But if the channel is behind of the monitor, close the channel:
6841 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
6842 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
6843 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
6844 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
6845 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
6846 failed_htlcs.append(&mut new_failed_htlcs);
6847 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
6848 channel_closures.push(events::Event::ChannelClosed {
6849 channel_id: channel.channel_id(),
6850 user_channel_id: channel.get_user_id(),
6851 reason: ClosureReason::OutdatedChannelManager
6854 log_info!(args.logger, "Successfully loaded channel {}", log_bytes!(channel.channel_id()));
6855 if let Some(short_channel_id) = channel.get_short_channel_id() {
6856 short_to_chan_info.insert(short_channel_id, (channel.get_counterparty_node_id(), channel.channel_id()));
6858 if channel.is_funding_initiated() {
6859 id_to_peer.insert(channel.channel_id(), channel.get_counterparty_node_id());
6861 by_id.insert(channel.channel_id(), channel);
6864 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.channel_id()));
6865 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
6866 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
6867 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
6868 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");
6869 return Err(DecodeError::InvalidValue);
6873 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
6874 if !funding_txo_set.contains(funding_txo) {
6875 log_info!(args.logger, "Broadcasting latest holder commitment transaction for closed channel {}", log_bytes!(funding_txo.to_channel_id()));
6876 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
6880 const MAX_ALLOC_SIZE: usize = 1024 * 64;
6881 let forward_htlcs_count: u64 = Readable::read(reader)?;
6882 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
6883 for _ in 0..forward_htlcs_count {
6884 let short_channel_id = Readable::read(reader)?;
6885 let pending_forwards_count: u64 = Readable::read(reader)?;
6886 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
6887 for _ in 0..pending_forwards_count {
6888 pending_forwards.push(Readable::read(reader)?);
6890 forward_htlcs.insert(short_channel_id, pending_forwards);
6893 let claimable_htlcs_count: u64 = Readable::read(reader)?;
6894 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
6895 for _ in 0..claimable_htlcs_count {
6896 let payment_hash = Readable::read(reader)?;
6897 let previous_hops_len: u64 = Readable::read(reader)?;
6898 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
6899 for _ in 0..previous_hops_len {
6900 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
6902 claimable_htlcs_list.push((payment_hash, previous_hops));
6905 let peer_count: u64 = Readable::read(reader)?;
6906 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState>)>()));
6907 for _ in 0..peer_count {
6908 let peer_pubkey = Readable::read(reader)?;
6909 let peer_state = PeerState {
6910 latest_features: Readable::read(reader)?,
6912 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
6915 let event_count: u64 = Readable::read(reader)?;
6916 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>()));
6917 for _ in 0..event_count {
6918 match MaybeReadable::read(reader)? {
6919 Some(event) => pending_events_read.push(event),
6923 if forward_htlcs_count > 0 {
6924 // If we have pending HTLCs to forward, assume we either dropped a
6925 // `PendingHTLCsForwardable` or the user received it but never processed it as they
6926 // shut down before the timer hit. Either way, set the time_forwardable to a small
6927 // constant as enough time has likely passed that we should simply handle the forwards
6928 // now, or at least after the user gets a chance to reconnect to our peers.
6929 pending_events_read.push(events::Event::PendingHTLCsForwardable {
6930 time_forwardable: Duration::from_secs(2),
6934 let background_event_count: u64 = Readable::read(reader)?;
6935 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>()));
6936 for _ in 0..background_event_count {
6937 match <u8 as Readable>::read(reader)? {
6938 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
6939 _ => return Err(DecodeError::InvalidValue),
6943 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
6944 let highest_seen_timestamp: u32 = Readable::read(reader)?;
6946 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
6947 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
6948 for _ in 0..pending_inbound_payment_count {
6949 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
6950 return Err(DecodeError::InvalidValue);
6954 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
6955 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
6956 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
6957 for _ in 0..pending_outbound_payments_count_compat {
6958 let session_priv = Readable::read(reader)?;
6959 let payment = PendingOutboundPayment::Legacy {
6960 session_privs: [session_priv].iter().cloned().collect()
6962 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
6963 return Err(DecodeError::InvalidValue)
6967 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
6968 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
6969 let mut pending_outbound_payments = None;
6970 let mut received_network_pubkey: Option<PublicKey> = None;
6971 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
6972 let mut probing_cookie_secret: Option<[u8; 32]> = None;
6973 let mut claimable_htlc_purposes = None;
6974 read_tlv_fields!(reader, {
6975 (1, pending_outbound_payments_no_retry, option),
6976 (3, pending_outbound_payments, option),
6977 (5, received_network_pubkey, option),
6978 (7, fake_scid_rand_bytes, option),
6979 (9, claimable_htlc_purposes, vec_type),
6980 (11, probing_cookie_secret, option),
6982 if fake_scid_rand_bytes.is_none() {
6983 fake_scid_rand_bytes = Some(args.keys_manager.get_secure_random_bytes());
6986 if probing_cookie_secret.is_none() {
6987 probing_cookie_secret = Some(args.keys_manager.get_secure_random_bytes());
6990 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
6991 pending_outbound_payments = Some(pending_outbound_payments_compat);
6992 } else if pending_outbound_payments.is_none() {
6993 let mut outbounds = HashMap::new();
6994 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
6995 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
6997 pending_outbound_payments = Some(outbounds);
6999 // If we're tracking pending payments, ensure we haven't lost any by looking at the
7000 // ChannelMonitor data for any channels for which we do not have authorative state
7001 // (i.e. those for which we just force-closed above or we otherwise don't have a
7002 // corresponding `Channel` at all).
7003 // This avoids several edge-cases where we would otherwise "forget" about pending
7004 // payments which are still in-flight via their on-chain state.
7005 // We only rebuild the pending payments map if we were most recently serialized by
7007 for (_, monitor) in args.channel_monitors.iter() {
7008 if by_id.get(&monitor.get_funding_txo().0.to_channel_id()).is_none() {
7009 for (htlc_source, htlc) in monitor.get_pending_outbound_htlcs() {
7010 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, payment_secret, .. } = htlc_source {
7011 if path.is_empty() {
7012 log_error!(args.logger, "Got an empty path for a pending payment");
7013 return Err(DecodeError::InvalidValue);
7015 let path_amt = path.last().unwrap().fee_msat;
7016 let mut session_priv_bytes = [0; 32];
7017 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
7018 match pending_outbound_payments.as_mut().unwrap().entry(payment_id) {
7019 hash_map::Entry::Occupied(mut entry) => {
7020 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
7021 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
7022 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), log_bytes!(htlc.payment_hash.0));
7024 hash_map::Entry::Vacant(entry) => {
7025 let path_fee = path.get_path_fees();
7026 entry.insert(PendingOutboundPayment::Retryable {
7027 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
7028 payment_hash: htlc.payment_hash,
7030 pending_amt_msat: path_amt,
7031 pending_fee_msat: Some(path_fee),
7032 total_msat: path_amt,
7033 starting_block_height: best_block_height,
7035 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
7036 path_amt, log_bytes!(htlc.payment_hash.0), log_bytes!(session_priv_bytes));
7045 let inbound_pmt_key_material = args.keys_manager.get_inbound_payment_key_material();
7046 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
7048 let mut claimable_htlcs = HashMap::with_capacity(claimable_htlcs_list.len());
7049 if let Some(mut purposes) = claimable_htlc_purposes {
7050 if purposes.len() != claimable_htlcs_list.len() {
7051 return Err(DecodeError::InvalidValue);
7053 for (purpose, (payment_hash, previous_hops)) in purposes.drain(..).zip(claimable_htlcs_list.drain(..)) {
7054 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7057 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
7058 // include a `_legacy_hop_data` in the `OnionPayload`.
7059 for (payment_hash, previous_hops) in claimable_htlcs_list.drain(..) {
7060 if previous_hops.is_empty() {
7061 return Err(DecodeError::InvalidValue);
7063 let purpose = match &previous_hops[0].onion_payload {
7064 OnionPayload::Invoice { _legacy_hop_data } => {
7065 if let Some(hop_data) = _legacy_hop_data {
7066 events::PaymentPurpose::InvoicePayment {
7067 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
7068 Some(inbound_payment) => inbound_payment.payment_preimage,
7069 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
7070 Ok(payment_preimage) => payment_preimage,
7072 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));
7073 return Err(DecodeError::InvalidValue);
7077 payment_secret: hop_data.payment_secret,
7079 } else { return Err(DecodeError::InvalidValue); }
7081 OnionPayload::Spontaneous(payment_preimage) =>
7082 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
7084 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7088 let mut secp_ctx = Secp256k1::new();
7089 secp_ctx.seeded_randomize(&args.keys_manager.get_secure_random_bytes());
7091 if !channel_closures.is_empty() {
7092 pending_events_read.append(&mut channel_closures);
7095 let our_network_key = match args.keys_manager.get_node_secret(Recipient::Node) {
7097 Err(()) => return Err(DecodeError::InvalidValue)
7099 let our_network_pubkey = PublicKey::from_secret_key(&secp_ctx, &our_network_key);
7100 if let Some(network_pubkey) = received_network_pubkey {
7101 if network_pubkey != our_network_pubkey {
7102 log_error!(args.logger, "Key that was generated does not match the existing key.");
7103 return Err(DecodeError::InvalidValue);
7107 let mut outbound_scid_aliases = HashSet::new();
7108 for (chan_id, chan) in by_id.iter_mut() {
7109 if chan.outbound_scid_alias() == 0 {
7110 let mut outbound_scid_alias;
7112 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
7113 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.keys_manager);
7114 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
7116 chan.set_outbound_scid_alias(outbound_scid_alias);
7117 } else if !outbound_scid_aliases.insert(chan.outbound_scid_alias()) {
7118 // Note that in rare cases its possible to hit this while reading an older
7119 // channel if we just happened to pick a colliding outbound alias above.
7120 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7121 return Err(DecodeError::InvalidValue);
7123 if chan.is_usable() {
7124 if short_to_chan_info.insert(chan.outbound_scid_alias(), (chan.get_counterparty_node_id(), *chan_id)).is_some() {
7125 // Note that in rare cases its possible to hit this while reading an older
7126 // channel if we just happened to pick a colliding outbound alias above.
7127 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7128 return Err(DecodeError::InvalidValue);
7133 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
7135 for (_, monitor) in args.channel_monitors.iter() {
7136 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
7137 if let Some((payment_purpose, claimable_htlcs)) = claimable_htlcs.remove(&payment_hash) {
7138 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", log_bytes!(payment_hash.0));
7139 let mut claimable_amt_msat = 0;
7140 for claimable_htlc in claimable_htlcs {
7141 claimable_amt_msat += claimable_htlc.value;
7143 // Add a holding-cell claim of the payment to the Channel, which should be
7144 // applied ~immediately on peer reconnection. Because it won't generate a
7145 // new commitment transaction we can just provide the payment preimage to
7146 // the corresponding ChannelMonitor and nothing else.
7148 // We do so directly instead of via the normal ChannelMonitor update
7149 // procedure as the ChainMonitor hasn't yet been initialized, implying
7150 // we're not allowed to call it directly yet. Further, we do the update
7151 // without incrementing the ChannelMonitor update ID as there isn't any
7153 // If we were to generate a new ChannelMonitor update ID here and then
7154 // crash before the user finishes block connect we'd end up force-closing
7155 // this channel as well. On the flip side, there's no harm in restarting
7156 // without the new monitor persisted - we'll end up right back here on
7158 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
7159 if let Some(channel) = by_id.get_mut(&previous_channel_id) {
7160 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
7162 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
7163 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
7166 pending_events_read.push(events::Event::PaymentClaimed {
7168 purpose: payment_purpose,
7169 amount_msat: claimable_amt_msat,
7175 let channel_manager = ChannelManager {
7177 fee_estimator: bounded_fee_estimator,
7178 chain_monitor: args.chain_monitor,
7179 tx_broadcaster: args.tx_broadcaster,
7181 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
7183 channel_state: Mutex::new(ChannelHolder {
7188 pending_msg_events: Vec::new(),
7190 inbound_payment_key: expanded_inbound_key,
7191 pending_inbound_payments: Mutex::new(pending_inbound_payments),
7192 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
7194 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
7195 id_to_peer: Mutex::new(id_to_peer),
7196 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
7198 probing_cookie_secret: probing_cookie_secret.unwrap(),
7204 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
7206 per_peer_state: RwLock::new(per_peer_state),
7208 pending_events: Mutex::new(pending_events_read),
7209 pending_background_events: Mutex::new(pending_background_events_read),
7210 total_consistency_lock: RwLock::new(()),
7211 persistence_notifier: Notifier::new(),
7213 keys_manager: args.keys_manager,
7214 logger: args.logger,
7215 default_configuration: args.default_config,
7218 for htlc_source in failed_htlcs.drain(..) {
7219 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
7220 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
7221 channel_manager.fail_htlc_backwards_internal(channel_manager.channel_state.lock().unwrap(), source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() }, receiver);
7224 //TODO: Broadcast channel update for closed channels, but only after we've made a
7225 //connection or two.
7227 Ok((best_block_hash.clone(), channel_manager))
7233 use bitcoin::hashes::Hash;
7234 use bitcoin::hashes::sha256::Hash as Sha256;
7235 use core::time::Duration;
7236 use core::sync::atomic::Ordering;
7237 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
7238 use ln::channelmanager::{self, inbound_payment, PaymentId, PaymentSendFailure};
7239 use ln::functional_test_utils::*;
7241 use ln::msgs::ChannelMessageHandler;
7242 use routing::router::{PaymentParameters, RouteParameters, find_route};
7243 use util::errors::APIError;
7244 use util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
7245 use util::test_utils;
7246 use chain::keysinterface::KeysInterface;
7249 fn test_notify_limits() {
7250 // Check that a few cases which don't require the persistence of a new ChannelManager,
7251 // indeed, do not cause the persistence of a new ChannelManager.
7252 let chanmon_cfgs = create_chanmon_cfgs(3);
7253 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7254 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7255 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7257 // All nodes start with a persistable update pending as `create_network` connects each node
7258 // with all other nodes to make most tests simpler.
7259 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7260 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7261 assert!(nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7263 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7265 // We check that the channel info nodes have doesn't change too early, even though we try
7266 // to connect messages with new values
7267 chan.0.contents.fee_base_msat *= 2;
7268 chan.1.contents.fee_base_msat *= 2;
7269 let node_a_chan_info = nodes[0].node.list_channels()[0].clone();
7270 let node_b_chan_info = nodes[1].node.list_channels()[0].clone();
7272 // The first two nodes (which opened a channel) should now require fresh persistence
7273 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7274 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7275 // ... but the last node should not.
7276 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7277 // After persisting the first two nodes they should no longer need fresh persistence.
7278 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7279 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7281 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
7282 // about the channel.
7283 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
7284 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
7285 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7287 // The nodes which are a party to the channel should also ignore messages from unrelated
7289 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7290 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7291 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7292 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7293 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7294 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7296 // At this point the channel info given by peers should still be the same.
7297 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7298 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7300 // An earlier version of handle_channel_update didn't check the directionality of the
7301 // update message and would always update the local fee info, even if our peer was
7302 // (spuriously) forwarding us our own channel_update.
7303 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
7304 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
7305 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
7307 // First deliver each peers' own message, checking that the node doesn't need to be
7308 // persisted and that its channel info remains the same.
7309 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
7310 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
7311 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7312 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7313 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7314 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7316 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
7317 // the channel info has updated.
7318 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
7319 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
7320 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7321 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7322 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
7323 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
7327 fn test_keysend_dup_hash_partial_mpp() {
7328 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
7330 let chanmon_cfgs = create_chanmon_cfgs(2);
7331 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7332 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7333 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7334 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7336 // First, send a partial MPP payment.
7337 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
7338 let payment_id = PaymentId([42; 32]);
7339 // Use the utility function send_payment_along_path to send the payment with MPP data which
7340 // indicates there are more HTLCs coming.
7341 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.
7342 nodes[0].node.send_payment_along_path(&route.paths[0], &route.payment_params, &our_payment_hash, &Some(payment_secret), 200_000, cur_height, payment_id, &None).unwrap();
7343 check_added_monitors!(nodes[0], 1);
7344 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7345 assert_eq!(events.len(), 1);
7346 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
7348 // Next, send a keysend payment with the same payment_hash and make sure it fails.
7349 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
7350 check_added_monitors!(nodes[0], 1);
7351 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7352 assert_eq!(events.len(), 1);
7353 let ev = events.drain(..).next().unwrap();
7354 let payment_event = SendEvent::from_event(ev);
7355 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7356 check_added_monitors!(nodes[1], 0);
7357 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7358 expect_pending_htlcs_forwardable!(nodes[1]);
7359 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
7360 check_added_monitors!(nodes[1], 1);
7361 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7362 assert!(updates.update_add_htlcs.is_empty());
7363 assert!(updates.update_fulfill_htlcs.is_empty());
7364 assert_eq!(updates.update_fail_htlcs.len(), 1);
7365 assert!(updates.update_fail_malformed_htlcs.is_empty());
7366 assert!(updates.update_fee.is_none());
7367 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7368 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7369 expect_payment_failed!(nodes[0], our_payment_hash, true);
7371 // Send the second half of the original MPP payment.
7372 nodes[0].node.send_payment_along_path(&route.paths[0], &route.payment_params, &our_payment_hash, &Some(payment_secret), 200_000, cur_height, payment_id, &None).unwrap();
7373 check_added_monitors!(nodes[0], 1);
7374 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7375 assert_eq!(events.len(), 1);
7376 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
7378 // Claim the full MPP payment. Note that we can't use a test utility like
7379 // claim_funds_along_route because the ordering of the messages causes the second half of the
7380 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
7381 // lightning messages manually.
7382 nodes[1].node.claim_funds(payment_preimage);
7383 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
7384 check_added_monitors!(nodes[1], 2);
7386 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7387 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
7388 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
7389 check_added_monitors!(nodes[0], 1);
7390 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7391 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
7392 check_added_monitors!(nodes[1], 1);
7393 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7394 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
7395 check_added_monitors!(nodes[1], 1);
7396 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7397 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
7398 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
7399 check_added_monitors!(nodes[0], 1);
7400 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7401 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
7402 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7403 check_added_monitors!(nodes[0], 1);
7404 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
7405 check_added_monitors!(nodes[1], 1);
7406 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
7407 check_added_monitors!(nodes[1], 1);
7408 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7409 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
7410 check_added_monitors!(nodes[0], 1);
7412 // Note that successful MPP payments will generate a single PaymentSent event upon the first
7413 // path's success and a PaymentPathSuccessful event for each path's success.
7414 let events = nodes[0].node.get_and_clear_pending_events();
7415 assert_eq!(events.len(), 3);
7417 Event::PaymentSent { payment_id: ref id, payment_preimage: ref preimage, payment_hash: ref hash, .. } => {
7418 assert_eq!(Some(payment_id), *id);
7419 assert_eq!(payment_preimage, *preimage);
7420 assert_eq!(our_payment_hash, *hash);
7422 _ => panic!("Unexpected event"),
7425 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7426 assert_eq!(payment_id, *actual_payment_id);
7427 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7428 assert_eq!(route.paths[0], *path);
7430 _ => panic!("Unexpected event"),
7433 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7434 assert_eq!(payment_id, *actual_payment_id);
7435 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7436 assert_eq!(route.paths[0], *path);
7438 _ => panic!("Unexpected event"),
7443 fn test_keysend_dup_payment_hash() {
7444 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
7445 // outbound regular payment fails as expected.
7446 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
7447 // fails as expected.
7448 let chanmon_cfgs = create_chanmon_cfgs(2);
7449 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7450 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7451 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7452 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7453 let scorer = test_utils::TestScorer::with_penalty(0);
7454 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7456 // To start (1), send a regular payment but don't claim it.
7457 let expected_route = [&nodes[1]];
7458 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
7460 // Next, attempt a keysend payment and make sure it fails.
7461 let route_params = RouteParameters {
7462 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id()),
7463 final_value_msat: 100_000,
7464 final_cltv_expiry_delta: TEST_FINAL_CLTV,
7466 let route = find_route(
7467 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
7468 None, nodes[0].logger, &scorer, &random_seed_bytes
7470 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
7471 check_added_monitors!(nodes[0], 1);
7472 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7473 assert_eq!(events.len(), 1);
7474 let ev = events.drain(..).next().unwrap();
7475 let payment_event = SendEvent::from_event(ev);
7476 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7477 check_added_monitors!(nodes[1], 0);
7478 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7479 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
7480 // fails), the second will process the resulting failure and fail the HTLC backward
7481 expect_pending_htlcs_forwardable!(nodes[1]);
7482 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
7483 check_added_monitors!(nodes[1], 1);
7484 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7485 assert!(updates.update_add_htlcs.is_empty());
7486 assert!(updates.update_fulfill_htlcs.is_empty());
7487 assert_eq!(updates.update_fail_htlcs.len(), 1);
7488 assert!(updates.update_fail_malformed_htlcs.is_empty());
7489 assert!(updates.update_fee.is_none());
7490 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7491 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7492 expect_payment_failed!(nodes[0], payment_hash, true);
7494 // Finally, claim the original payment.
7495 claim_payment(&nodes[0], &expected_route, payment_preimage);
7497 // To start (2), send a keysend payment but don't claim it.
7498 let payment_preimage = PaymentPreimage([42; 32]);
7499 let route = find_route(
7500 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
7501 None, nodes[0].logger, &scorer, &random_seed_bytes
7503 let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
7504 check_added_monitors!(nodes[0], 1);
7505 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7506 assert_eq!(events.len(), 1);
7507 let event = events.pop().unwrap();
7508 let path = vec![&nodes[1]];
7509 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
7511 // Next, attempt a regular payment and make sure it fails.
7512 let payment_secret = PaymentSecret([43; 32]);
7513 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
7514 check_added_monitors!(nodes[0], 1);
7515 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7516 assert_eq!(events.len(), 1);
7517 let ev = events.drain(..).next().unwrap();
7518 let payment_event = SendEvent::from_event(ev);
7519 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7520 check_added_monitors!(nodes[1], 0);
7521 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7522 expect_pending_htlcs_forwardable!(nodes[1]);
7523 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
7524 check_added_monitors!(nodes[1], 1);
7525 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7526 assert!(updates.update_add_htlcs.is_empty());
7527 assert!(updates.update_fulfill_htlcs.is_empty());
7528 assert_eq!(updates.update_fail_htlcs.len(), 1);
7529 assert!(updates.update_fail_malformed_htlcs.is_empty());
7530 assert!(updates.update_fee.is_none());
7531 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7532 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7533 expect_payment_failed!(nodes[0], payment_hash, true);
7535 // Finally, succeed the keysend payment.
7536 claim_payment(&nodes[0], &expected_route, payment_preimage);
7540 fn test_keysend_hash_mismatch() {
7541 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
7542 // preimage doesn't match the msg's payment hash.
7543 let chanmon_cfgs = create_chanmon_cfgs(2);
7544 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7545 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7546 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7548 let payer_pubkey = nodes[0].node.get_our_node_id();
7549 let payee_pubkey = nodes[1].node.get_our_node_id();
7550 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7551 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7553 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], channelmanager::provided_init_features(), channelmanager::provided_init_features());
7554 let route_params = RouteParameters {
7555 payment_params: PaymentParameters::for_keysend(payee_pubkey),
7556 final_value_msat: 10000,
7557 final_cltv_expiry_delta: 40,
7559 let network_graph = nodes[0].network_graph;
7560 let first_hops = nodes[0].node.list_usable_channels();
7561 let scorer = test_utils::TestScorer::with_penalty(0);
7562 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7563 let route = find_route(
7564 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
7565 nodes[0].logger, &scorer, &random_seed_bytes
7568 let test_preimage = PaymentPreimage([42; 32]);
7569 let mismatch_payment_hash = PaymentHash([43; 32]);
7570 let _ = nodes[0].node.send_payment_internal(&route, mismatch_payment_hash, &None, Some(test_preimage), None, None).unwrap();
7571 check_added_monitors!(nodes[0], 1);
7573 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7574 assert_eq!(updates.update_add_htlcs.len(), 1);
7575 assert!(updates.update_fulfill_htlcs.is_empty());
7576 assert!(updates.update_fail_htlcs.is_empty());
7577 assert!(updates.update_fail_malformed_htlcs.is_empty());
7578 assert!(updates.update_fee.is_none());
7579 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7581 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Payment preimage didn't match payment hash".to_string(), 1);
7585 fn test_keysend_msg_with_secret_err() {
7586 // Test that we error as expected if we receive a keysend payment that includes a payment secret.
7587 let chanmon_cfgs = create_chanmon_cfgs(2);
7588 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7589 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7590 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7592 let payer_pubkey = nodes[0].node.get_our_node_id();
7593 let payee_pubkey = nodes[1].node.get_our_node_id();
7594 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7595 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7597 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], channelmanager::provided_init_features(), channelmanager::provided_init_features());
7598 let route_params = RouteParameters {
7599 payment_params: PaymentParameters::for_keysend(payee_pubkey),
7600 final_value_msat: 10000,
7601 final_cltv_expiry_delta: 40,
7603 let network_graph = nodes[0].network_graph;
7604 let first_hops = nodes[0].node.list_usable_channels();
7605 let scorer = test_utils::TestScorer::with_penalty(0);
7606 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7607 let route = find_route(
7608 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
7609 nodes[0].logger, &scorer, &random_seed_bytes
7612 let test_preimage = PaymentPreimage([42; 32]);
7613 let test_secret = PaymentSecret([43; 32]);
7614 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
7615 let _ = nodes[0].node.send_payment_internal(&route, payment_hash, &Some(test_secret), Some(test_preimage), None, None).unwrap();
7616 check_added_monitors!(nodes[0], 1);
7618 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7619 assert_eq!(updates.update_add_htlcs.len(), 1);
7620 assert!(updates.update_fulfill_htlcs.is_empty());
7621 assert!(updates.update_fail_htlcs.is_empty());
7622 assert!(updates.update_fail_malformed_htlcs.is_empty());
7623 assert!(updates.update_fee.is_none());
7624 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7626 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "We don't support MPP keysend payments".to_string(), 1);
7630 fn test_multi_hop_missing_secret() {
7631 let chanmon_cfgs = create_chanmon_cfgs(4);
7632 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7633 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7634 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7636 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;
7637 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;
7638 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;
7639 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;
7641 // Marshall an MPP route.
7642 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
7643 let path = route.paths[0].clone();
7644 route.paths.push(path);
7645 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
7646 route.paths[0][0].short_channel_id = chan_1_id;
7647 route.paths[0][1].short_channel_id = chan_3_id;
7648 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
7649 route.paths[1][0].short_channel_id = chan_2_id;
7650 route.paths[1][1].short_channel_id = chan_4_id;
7652 match nodes[0].node.send_payment(&route, payment_hash, &None).unwrap_err() {
7653 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
7654 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err)) },
7655 _ => panic!("unexpected error")
7660 fn bad_inbound_payment_hash() {
7661 // Add coverage for checking that a user-provided payment hash matches the payment secret.
7662 let chanmon_cfgs = create_chanmon_cfgs(2);
7663 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7664 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7665 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7667 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
7668 let payment_data = msgs::FinalOnionHopData {
7670 total_msat: 100_000,
7673 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
7674 // payment verification fails as expected.
7675 let mut bad_payment_hash = payment_hash.clone();
7676 bad_payment_hash.0[0] += 1;
7677 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) {
7678 Ok(_) => panic!("Unexpected ok"),
7680 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment".to_string(), "Failing HTLC with user-generated payment_hash".to_string(), 1);
7684 // Check that using the original payment hash succeeds.
7685 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());
7689 fn test_id_to_peer_coverage() {
7690 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
7691 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
7692 // the channel is successfully closed.
7693 let chanmon_cfgs = create_chanmon_cfgs(2);
7694 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7695 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7696 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7698 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
7699 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7700 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
7701 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7702 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
7704 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
7705 let channel_id = &tx.txid().into_inner();
7707 // Ensure that the `id_to_peer` map is empty until either party has received the
7708 // funding transaction, and have the real `channel_id`.
7709 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
7710 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
7713 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
7715 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
7716 // as it has the funding transaction.
7717 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
7718 assert_eq!(nodes_0_lock.len(), 1);
7719 assert!(nodes_0_lock.contains_key(channel_id));
7721 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
7724 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
7726 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
7728 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
7729 assert_eq!(nodes_0_lock.len(), 1);
7730 assert!(nodes_0_lock.contains_key(channel_id));
7732 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
7733 // as it has the funding transaction.
7734 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
7735 assert_eq!(nodes_1_lock.len(), 1);
7736 assert!(nodes_1_lock.contains_key(channel_id));
7738 check_added_monitors!(nodes[1], 1);
7739 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
7740 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
7741 check_added_monitors!(nodes[0], 1);
7742 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
7743 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
7744 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
7746 nodes[0].node.close_channel(channel_id, &nodes[1].node.get_our_node_id()).unwrap();
7747 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()));
7748 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7749 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &nodes_1_shutdown);
7751 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
7752 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
7754 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
7755 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
7756 // fee for the closing transaction has been negotiated and the parties has the other
7757 // party's signature for the fee negotiated closing transaction.)
7758 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
7759 assert_eq!(nodes_0_lock.len(), 1);
7760 assert!(nodes_0_lock.contains_key(channel_id));
7762 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
7763 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
7764 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
7765 // kept in the `nodes[1]`'s `id_to_peer` map.
7766 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
7767 assert_eq!(nodes_1_lock.len(), 1);
7768 assert!(nodes_1_lock.contains_key(channel_id));
7771 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()));
7773 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
7774 // therefore has all it needs to fully close the channel (both signatures for the
7775 // closing transaction).
7776 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
7777 // fully closed by `nodes[0]`.
7778 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
7780 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
7781 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
7782 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
7783 assert_eq!(nodes_1_lock.len(), 1);
7784 assert!(nodes_1_lock.contains_key(channel_id));
7787 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
7789 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
7791 // Assert that the channel has now been removed from both parties `id_to_peer` map once
7792 // they both have everything required to fully close the channel.
7793 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
7795 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
7797 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
7798 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
7802 #[cfg(all(any(test, feature = "_test_utils"), feature = "_bench_unstable"))]
7805 use chain::chainmonitor::{ChainMonitor, Persist};
7806 use chain::keysinterface::{KeysManager, KeysInterface, InMemorySigner};
7807 use ln::channelmanager::{self, BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage};
7808 use ln::features::{InitFeatures, InvoiceFeatures};
7809 use ln::functional_test_utils::*;
7810 use ln::msgs::{ChannelMessageHandler, Init};
7811 use routing::gossip::NetworkGraph;
7812 use routing::router::{PaymentParameters, get_route};
7813 use util::test_utils;
7814 use util::config::UserConfig;
7815 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
7817 use bitcoin::hashes::Hash;
7818 use bitcoin::hashes::sha256::Hash as Sha256;
7819 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
7821 use sync::{Arc, Mutex};
7825 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
7826 node: &'a ChannelManager<InMemorySigner,
7827 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
7828 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
7829 &'a test_utils::TestLogger, &'a P>,
7830 &'a test_utils::TestBroadcaster, &'a KeysManager,
7831 &'a test_utils::TestFeeEstimator, &'a test_utils::TestLogger>
7836 fn bench_sends(bench: &mut Bencher) {
7837 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
7840 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
7841 // Do a simple benchmark of sending a payment back and forth between two nodes.
7842 // Note that this is unrealistic as each payment send will require at least two fsync
7844 let network = bitcoin::Network::Testnet;
7845 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
7847 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7848 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7850 let mut config: UserConfig = Default::default();
7851 config.channel_handshake_config.minimum_depth = 1;
7853 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
7854 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
7855 let seed_a = [1u8; 32];
7856 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
7857 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &logger_a, &keys_manager_a, config.clone(), ChainParameters {
7859 best_block: BestBlock::from_genesis(network),
7861 let node_a_holder = NodeHolder { node: &node_a };
7863 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
7864 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
7865 let seed_b = [2u8; 32];
7866 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
7867 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &logger_b, &keys_manager_b, config.clone(), ChainParameters {
7869 best_block: BestBlock::from_genesis(network),
7871 let node_b_holder = NodeHolder { node: &node_b };
7873 node_a.peer_connected(&node_b.get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7874 node_b.peer_connected(&node_a.get_our_node_id(), &Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7875 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
7876 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()));
7877 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()));
7880 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
7881 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
7882 value: 8_000_000, script_pubkey: output_script,
7884 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
7885 } else { panic!(); }
7887 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()));
7888 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()));
7890 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
7893 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
7896 Listen::block_connected(&node_a, &block, 1);
7897 Listen::block_connected(&node_b, &block, 1);
7899 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()));
7900 let msg_events = node_a.get_and_clear_pending_msg_events();
7901 assert_eq!(msg_events.len(), 2);
7902 match msg_events[0] {
7903 MessageSendEvent::SendChannelReady { ref msg, .. } => {
7904 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
7905 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
7909 match msg_events[1] {
7910 MessageSendEvent::SendChannelUpdate { .. } => {},
7914 let dummy_graph = NetworkGraph::new(genesis_hash, &logger_a);
7916 let mut payment_count: u64 = 0;
7917 macro_rules! send_payment {
7918 ($node_a: expr, $node_b: expr) => {
7919 let usable_channels = $node_a.list_usable_channels();
7920 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id())
7921 .with_features(channelmanager::provided_invoice_features());
7922 let scorer = test_utils::TestScorer::with_penalty(0);
7923 let seed = [3u8; 32];
7924 let keys_manager = KeysManager::new(&seed, 42, 42);
7925 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7926 let route = get_route(&$node_a.get_our_node_id(), &payment_params, &dummy_graph.read_only(),
7927 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), 10_000, TEST_FINAL_CLTV, &logger_a, &scorer, &random_seed_bytes).unwrap();
7929 let mut payment_preimage = PaymentPreimage([0; 32]);
7930 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
7932 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
7933 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200).unwrap();
7935 $node_a.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
7936 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
7937 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
7938 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
7939 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
7940 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
7941 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
7942 $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()));
7944 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
7945 expect_payment_received!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
7946 $node_b.claim_funds(payment_preimage);
7947 expect_payment_claimed!(NodeHolder { node: &$node_b }, payment_hash, 10_000);
7949 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
7950 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
7951 assert_eq!(node_id, $node_a.get_our_node_id());
7952 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
7953 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
7955 _ => panic!("Failed to generate claim event"),
7958 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
7959 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
7960 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
7961 $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()));
7963 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
7968 send_payment!(node_a, node_b);
7969 send_payment!(node_b, node_a);